GET api/sitetypes/{siteTypeName}/tabularreports
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteTypeName | string |
Required |
|
Id | integer |
None. |
|
Name | string |
Required Max length: 50 |
|
Description | string |
Max length: 1024 |
|
HasSummary |
True if the report has a summary section |
boolean |
None. |
Title |
The report title |
string |
Max length: 256 |
Subtitle |
The report subtitle |
string |
Max length: 256 |
TimePeriod | ReportTimePeriod |
None. |
|
DefaultDuration |
The default timespan of the report in seconds |
integer |
None. |
MaximumDuration |
The maximum timespan of the report in seconds |
integer |
None. |
Parameters | Collection of TabularReportParameterViewModel |
None. |
|
DecimalPlaces | integer |
None. |
|
Links |
Gets the links. |
Collection of LinkModel |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of TabularReportViewModelName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Name | string |
Required Max length: 50 |
|
DisplayName | string |
Max length: 255 |
|
Type | TabularReportType |
None. |
|
Description | string |
Max length: 1024 |
|
HasSummary |
True if the report has a summary section |
boolean |
None. |
Title |
The report title |
string |
Max length: 256 |
Subtitle |
The report subtitle |
string |
Max length: 256 |
TimePeriod | ReportTimePeriod |
None. |
|
DefaultDuration |
The default timespan of the report in seconds |
integer |
None. |
MaximumDuration |
The maximum timespan of the report in seconds |
integer |
None. |
DecimalPlaces | integer |
None. |
|
OwnerUsername | string |
Max length: 128 |
|
Parameters | Collection of TabularReportParameterViewModel |
None. |
|
IsCore | boolean |
None. |
|
Links |
Gets the links. |
Collection of LinkModel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "name": "sample string 2", "displayName": "sample string 3", "type": 0, "description": "sample string 5", "hasSummary": true, "title": "sample string 7", "subtitle": "sample string 8", "timePeriod": 0, "defaultDuration": 9, "maximumDuration": 1, "decimalPlaces": 1, "ownerUsername": "sample string 10", "parameters": [ { "parameterId": 2, "name": "sample string 3", "type": 1, "minValues": 4, "maxValues": 5, "defaultValue": "sample string 6" }, { "parameterId": 2, "name": "sample string 3", "type": 1, "minValues": 4, "maxValues": 5, "defaultValue": "sample string 6" } ], "isCore": true }, { "id": 1, "name": "sample string 2", "displayName": "sample string 3", "type": 0, "description": "sample string 5", "hasSummary": true, "title": "sample string 7", "subtitle": "sample string 8", "timePeriod": 0, "defaultDuration": 9, "maximumDuration": 1, "decimalPlaces": 1, "ownerUsername": "sample string 10", "parameters": [ { "parameterId": 2, "name": "sample string 3", "type": 1, "minValues": 4, "maxValues": 5, "defaultValue": "sample string 6" }, { "parameterId": 2, "name": "sample string 3", "type": 1, "minValues": 4, "maxValues": 5, "defaultValue": "sample string 6" } ], "isCore": true } ]
application/xml, text/xml
Sample:
<ArrayOfTabularReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models"> <TabularReportViewModel> <DecimalPlaces>1</DecimalPlaces> <DefaultDuration>9</DefaultDuration> <Description>sample string 5</Description> <DisplayName>sample string 3</DisplayName> <HasSummary>true</HasSummary> <Id>1</Id> <IsCore>true</IsCore> <MaximumDuration>1</MaximumDuration> <Name>sample string 2</Name> <OwnerUsername>sample string 10</OwnerUsername> <Parameters> <TabularReportParameterViewModel> <DefaultValue>sample string 6</DefaultValue> <MaxValues>5</MaxValues> <MinValues>4</MinValues> <Name>sample string 3</Name> <ParameterId>2</ParameterId> <Type>Datetime</Type> </TabularReportParameterViewModel> <TabularReportParameterViewModel> <DefaultValue>sample string 6</DefaultValue> <MaxValues>5</MaxValues> <MinValues>4</MinValues> <Name>sample string 3</Name> <ParameterId>2</ParameterId> <Type>Datetime</Type> </TabularReportParameterViewModel> </Parameters> <Subtitle>sample string 8</Subtitle> <TimePeriod>Custom</TimePeriod> <Title>sample string 7</Title> <Type>Database</Type> </TabularReportViewModel> <TabularReportViewModel> <DecimalPlaces>1</DecimalPlaces> <DefaultDuration>9</DefaultDuration> <Description>sample string 5</Description> <DisplayName>sample string 3</DisplayName> <HasSummary>true</HasSummary> <Id>1</Id> <IsCore>true</IsCore> <MaximumDuration>1</MaximumDuration> <Name>sample string 2</Name> <OwnerUsername>sample string 10</OwnerUsername> <Parameters> <TabularReportParameterViewModel> <DefaultValue>sample string 6</DefaultValue> <MaxValues>5</MaxValues> <MinValues>4</MinValues> <Name>sample string 3</Name> <ParameterId>2</ParameterId> <Type>Datetime</Type> </TabularReportParameterViewModel> <TabularReportParameterViewModel> <DefaultValue>sample string 6</DefaultValue> <MaxValues>5</MaxValues> <MinValues>4</MinValues> <Name>sample string 3</Name> <ParameterId>2</ParameterId> <Type>Datetime</Type> </TabularReportParameterViewModel> </Parameters> <Subtitle>sample string 8</Subtitle> <TimePeriod>Custom</TimePeriod> <Title>sample string 7</Title> <Type>Database</Type> </TabularReportViewModel> </ArrayOfTabularReportViewModel>