CoreService

<back to all web services

GetDeploymentTemplateDefinition

DeploymentTemplate - CRUD

Returns the template definition

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/deploymenttemplates/{Id}/definitionReturns the template definition
GET/api/deploymenttemplates/{Name}/{Version}/definitionReturns the template definition
GET/deploymenttemplates/{Id}/definitionReturns the template definition
GET/deploymenttemplates/{Name}/{Version}/definitionReturns the template definition
GetDeploymentTemplateDefinition Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
NamepathstringNo
VersionpathstringNo
TenantNameheaderstringYes
DefinitionFormatqueryTemplateLanguagesYes

Allowable Values

  • Json
  • Yaml
IncludeDeletedquerybool?NoIf true, also soft deleted items will be returned
IncludeReferencedObjectsquerybool?No
TemplateLanguages Enum:
Json
Yaml
TemplateDefinitionDto Parameters:
NameParameterData TypeRequiredDescription
SchemaVersionformintNoThe schema version of the attached definition
DefinitionformstringYesThe template definition/body either as json or yaml

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}/definition HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"schemaVersion":0,"definition":"String"}