<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}/definition | Returns the template definition | |
|---|
| GET | /api/deploymenttemplates/{Name}/{Version}/definition | Returns the template definition | |
|---|
| GET | /deploymenttemplates/{Id}/definition | Returns the template definition | |
|---|
| GET | /deploymenttemplates/{Name}/{Version}/definition | Returns the template definition | |
|---|
GetDeploymentTemplateDefinition Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Id | path | string | No | |
| Name | path | string | No | |
| Version | path | string | No | |
| TenantName | header | string | Yes | |
| DefinitionFormat | query | TemplateLanguages | Yes | Allowable Values |
| IncludeDeleted | query | bool? | No | If true, also soft deleted items will be returned |
| IncludeReferencedObjects | query | bool? | No | |
TemplateLanguages Enum:| Json | |
| Yaml | |
TemplateDefinitionDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SchemaVersion | form | int | No | The schema version of the attached definition |
| Definition | form | string | Yes | The 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"}