GET Tk-Ws/Export/GetLayoutTemplatesByType?layoutType={layoutType}
Get the list of Layout Templates, by type (DataGathering / AtsReport).
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
layoutType |
Enum parameter. Only the following values are accepted: 0 = DataGathering, 1 = AtsReport |
LayoutTemplateType |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of LayoutTemplateForListName | Description | Type | Additional information |
---|---|---|---|
Id |
The Id of the Layout Template |
globally unique identifier |
None. |
Name |
The Name of the Layout Template |
string |
None. |
Invalid |
Whether the Layout Template is invalid or not Layout Templates might be invalid if they do not contain the mandatory fields or if any of the fields contained by the Layout Template has been modified or deleted |
boolean |
None. |
SequenceNumber |
The sequence number of the Layout Template. Used for displaying order |
integer |
None. |
Type |
The Type of Layout Template (0 = DataGathering, 1 = AtsReport) |
LayoutTemplateType |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "ffd77d88-828d-4fac-829e-830abf469e96", "Name": "sample string 2", "Invalid": true, "SequenceNumber": 4, "Type": 0 }, { "Id": "ffd77d88-828d-4fac-829e-830abf469e96", "Name": "sample string 2", "Invalid": true, "SequenceNumber": 4, "Type": 0 } ]
application/xml, text/xml
Sample:
<ArrayOfLayoutTemplateWsListDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.LayouteTemplate"> <LayoutTemplateWsListDto> <Id>ffd77d88-828d-4fac-829e-830abf469e96</Id> <Invalid>true</Invalid> <Name>sample string 2</Name> <SequenceNumber>4</SequenceNumber> <Type>DataGathering</Type> </LayoutTemplateWsListDto> <LayoutTemplateWsListDto> <Id>ffd77d88-828d-4fac-829e-830abf469e96</Id> <Invalid>true</Invalid> <Name>sample string 2</Name> <SequenceNumber>4</SequenceNumber> <Type>DataGathering</Type> </LayoutTemplateWsListDto> </ArrayOfLayoutTemplateWsListDto>