CoreService

<back to all web services

GetDeploymentTemplateStructure

DeploymentTemplate - CRUD

Returns an object describing the structure of the deployment template

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/deploymenttemplates/{Id}/structureReturns an object describing the structure of the deployment template
GET/deploymenttemplates/{Id}/structureReturns an object describing the structure of the deployment template
GetDeploymentTemplateStructure Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYes
TenantNameheaderstringYes
NestedHierarchyItemDto Parameters:
NameParameterData TypeRequiredDescription
ChildrenformList<NestedHierarchyItemDto>Yes
HierarchyItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
ConfigItemTypeformObjectTypesNo
NameformstringNo
DisplayNameformstringNo
DescriptionformstringNo
ObjectTypes Enum:
None
ConfigItem
Tenant
Collection
Resource
ComputeNode
VirtualMachine
PhysicalMachine
Disk
Subnet
IPAddress
Job
JobEvent
FreezePeriod
ResourceGroup
Deployment
ResourceGroupTemplate
DeploymentTemplate
ResourceProvider
GenericResource
Role
Permission
User
PatchingWindow
Update
ReportDefinition
TimeSeries
DataPoint
Action
ActionAssignment
UserNote

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/deploymenttemplates/{Id}/structure HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"children":[{"children":[{"children":[{"children":null,"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}],"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}],"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}],"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}