GET Tk-Ws/Export/GetLayoutTemplate?templateId={templateId}
Get the full Layout Template with the specified Id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
templateId |
the Id of the desired layout template |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
LayoutTemplateName | Description | Type | Additional information |
---|---|---|---|
Id |
The Id of the Layout Template |
globally unique identifier |
None. |
Name |
The Name of the Layout Template |
string |
None. |
OperationType |
The Operation Type of the Layout Template (Operational / Technical) |
string |
None. |
CategoryTree |
A tree that containing the Categories present in the current Layout Template Illustrates the parent-child relationships for the categories |
Collection of Category |
None. |
Terms |
Collection of Heidi Terms |
Collection of Term |
None. |
TreeControls |
Collection of Tree Controls |
Collection of TreeControl |
None. |
ExplanatoryFactorsAso |
Collection of Explanatory Factors Aso |
Collection of ExplanatoryFactor |
None. |
ExplanatoryFactorsOps |
Collection of Explanatory Factors Ops |
Collection of ExplanatoryFactor |
None. |
Barriers |
The List of RAT Barriers (for Explanatory Factors) |
Collection of BarrierDto |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "e1a9589b-f6cc-4956-9828-ae9c85a2a3c6", "Name": "sample string 2", "OperationType": "sample string 3", "CategoryTree": [ { "$id": "1", "Id": "630fbaec-97ba-42dc-b23f-00c2e9e289cf", "Name": "sample string 2", "Parent": { "$ref": "1" }, "Children": [ { "$ref": "1" }, { "$ref": "1" } ] }, { "$ref": "1" } ], "Terms": [ { "Id": "c42a1078-c28c-434b-8fed-d10943b64b10", "Name": "sample string 2", "Alias": "sample string 3", "Category": { "$ref": "1" }, "Mutipliable": true, "Required": true, "AutomaticResult": true, "Type": "sample string 7", "Inputs": [ { "Id": "aa76676a-cc56-4f4e-b36c-7b39a7eaf67a", "Name": "sample string 2", "Alias": "sample string 3", "InputType": "sample string 4", "Pattern": "sample string 5", "DefaultValue": "sample string 6", "AcceptedValues": [ "sample string 1", "sample string 2" ] }, { "Id": "aa76676a-cc56-4f4e-b36c-7b39a7eaf67a", "Name": "sample string 2", "Alias": "sample string 3", "InputType": "sample string 4", "Pattern": "sample string 5", "DefaultValue": "sample string 6", "AcceptedValues": [ "sample string 1", "sample string 2" ] } ] }, { "Id": "c42a1078-c28c-434b-8fed-d10943b64b10", "Name": "sample string 2", "Alias": "sample string 3", "Category": { "$ref": "1" }, "Mutipliable": true, "Required": true, "AutomaticResult": true, "Type": "sample string 7", "Inputs": [ { "Id": "aa76676a-cc56-4f4e-b36c-7b39a7eaf67a", "Name": "sample string 2", "Alias": "sample string 3", "InputType": "sample string 4", "Pattern": "sample string 5", "DefaultValue": "sample string 6", "AcceptedValues": [ "sample string 1", "sample string 2" ] }, { "Id": "aa76676a-cc56-4f4e-b36c-7b39a7eaf67a", "Name": "sample string 2", "Alias": "sample string 3", "InputType": "sample string 4", "Pattern": "sample string 5", "DefaultValue": "sample string 6", "AcceptedValues": [ "sample string 1", "sample string 2" ] } ] } ], "TreeControls": [ { "$id": "2", "Id": "9559df7c-e2dd-465e-b807-c45b7cfbf51e", "TermId": "b71942aa-7f7a-4b7d-8142-1ce114689757", "Name": "sample string 3", "TranslatedName": "sample string 4", "Selectable": true, "SequenceNumber": 6, "ParentNames": [ "sample string 1", "sample string 2" ], "Children": [ { "$ref": "2" }, { "$ref": "2" } ] }, { "$ref": "2" } ], "ExplanatoryFactorsAso": [ { "$id": "3", "Id": "9a869a8d-8d4f-47ee-ba59-f671fb022f7d", "Name": "sample string 2", "TranslatedName": "sample string 3", "SequenceNumber": 4, "ParentNames": [ "sample string 1", "sample string 2" ], "Children": [ { "$ref": "3" }, { "$ref": "3" } ] }, { "$ref": "3" } ], "ExplanatoryFactorsOps": [ { "$ref": "3" }, { "$ref": "3" } ], "Barriers": [ { "Id": "d8644997-5eb2-4431-9e74-5e76a816478f", "Name": "sample string 2" }, { "Id": "d8644997-5eb2-4431-9e74-5e76a816478f", "Name": "sample string 2" } ] }
application/xml, text/xml
Sample:
<LayoutTemplateWsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.LayouteTemplate"> <Barriers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Core.Rat.Persistence.Dto.Templates"> <d2p1:BarrierDto> <d2p1:Id>d8644997-5eb2-4431-9e74-5e76a816478f</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:BarrierDto> <d2p1:BarrierDto> <d2p1:Id>d8644997-5eb2-4431-9e74-5e76a816478f</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:BarrierDto> </Barriers> <CategoryTree xmlns:d2p1="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.LayouteTemplate.HeidiTermFactory"> <d2p1:LayoutCategoryWsDto z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <d2p1:Children> <d2p1:LayoutCategoryWsDto z:Ref="i1" /> <d2p1:LayoutCategoryWsDto z:Ref="i1" /> </d2p1:Children> <d2p1:Id>630fbaec-97ba-42dc-b23f-00c2e9e289cf</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Parent z:Ref="i1" /> </d2p1:LayoutCategoryWsDto> <d2p1:LayoutCategoryWsDto z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> </CategoryTree> <ExplanatoryFactorsAso> <ExplanatoryFactorWsDto z:Id="i2" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Children> <ExplanatoryFactorWsDto z:Ref="i2" /> <ExplanatoryFactorWsDto z:Ref="i2" /> </Children> <Id>9a869a8d-8d4f-47ee-ba59-f671fb022f7d</Id> <Name>sample string 2</Name> <ParentNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ParentNames> <SequenceNumber>4</SequenceNumber> <TranslatedName>sample string 3</TranslatedName> </ExplanatoryFactorWsDto> <ExplanatoryFactorWsDto z:Ref="i2" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> </ExplanatoryFactorsAso> <ExplanatoryFactorsOps> <ExplanatoryFactorWsDto z:Ref="i2" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> <ExplanatoryFactorWsDto z:Ref="i2" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> </ExplanatoryFactorsOps> <Id>e1a9589b-f6cc-4956-9828-ae9c85a2a3c6</Id> <Name>sample string 2</Name> <OperationType>sample string 3</OperationType> <Terms> <HeidiTermWsDto> <Alias>sample string 3</Alias> <AutomaticResult>true</AutomaticResult> <Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.LayouteTemplate.HeidiTermFactory" z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> <Id>c42a1078-c28c-434b-8fed-d10943b64b10</Id> <Inputs> <TermInputWsDto> <AcceptedValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </AcceptedValues> <Alias>sample string 3</Alias> <DefaultValue>sample string 6</DefaultValue> <Id>aa76676a-cc56-4f4e-b36c-7b39a7eaf67a</Id> <InputType>sample string 4</InputType> <Name>sample string 2</Name> <Pattern>sample string 5</Pattern> </TermInputWsDto> <TermInputWsDto> <AcceptedValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </AcceptedValues> <Alias>sample string 3</Alias> <DefaultValue>sample string 6</DefaultValue> <Id>aa76676a-cc56-4f4e-b36c-7b39a7eaf67a</Id> <InputType>sample string 4</InputType> <Name>sample string 2</Name> <Pattern>sample string 5</Pattern> </TermInputWsDto> </Inputs> <Mutipliable>true</Mutipliable> <Name>sample string 2</Name> <Required>true</Required> <Type>sample string 7</Type> </HeidiTermWsDto> <HeidiTermWsDto> <Alias>sample string 3</Alias> <AutomaticResult>true</AutomaticResult> <Category xmlns:d4p1="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.LayouteTemplate.HeidiTermFactory" z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> <Id>c42a1078-c28c-434b-8fed-d10943b64b10</Id> <Inputs> <TermInputWsDto> <AcceptedValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </AcceptedValues> <Alias>sample string 3</Alias> <DefaultValue>sample string 6</DefaultValue> <Id>aa76676a-cc56-4f4e-b36c-7b39a7eaf67a</Id> <InputType>sample string 4</InputType> <Name>sample string 2</Name> <Pattern>sample string 5</Pattern> </TermInputWsDto> <TermInputWsDto> <AcceptedValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </AcceptedValues> <Alias>sample string 3</Alias> <DefaultValue>sample string 6</DefaultValue> <Id>aa76676a-cc56-4f4e-b36c-7b39a7eaf67a</Id> <InputType>sample string 4</InputType> <Name>sample string 2</Name> <Pattern>sample string 5</Pattern> </TermInputWsDto> </Inputs> <Mutipliable>true</Mutipliable> <Name>sample string 2</Name> <Required>true</Required> <Type>sample string 7</Type> </HeidiTermWsDto> </Terms> <TreeControls> <TreeControlWsDto z:Id="i3" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Children> <TreeControlWsDto z:Ref="i3" /> <TreeControlWsDto z:Ref="i3" /> </Children> <Id>9559df7c-e2dd-465e-b807-c45b7cfbf51e</Id> <Name>sample string 3</Name> <ParentNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ParentNames> <Selectable>true</Selectable> <SequenceNumber>6</SequenceNumber> <TermId>b71942aa-7f7a-4b7d-8142-1ce114689757</TermId> <TranslatedName>sample string 4</TranslatedName> </TreeControlWsDto> <TreeControlWsDto z:Ref="i3" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" /> </TreeControls> </LayoutTemplateWsDto>