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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.Templates.Deployment.Crud
Imports CoreService.ServiceModel.Enums
Imports CoreService.ServiceModel.Dtos.Base.Responses

Namespace Global

    Namespace CoreService.ServiceModel.Dtos.Base.Responses

        Public Partial Class TemplateDefinitionDto
            '''<Summary>
            '''The schema version of the attached definition
            '''</Summary>
            Public Overridable Property SchemaVersion As Integer
            '''<Summary>
            '''The template definition/body either as json or yaml
            '''</Summary>
            Public Overridable Property Definition As String
        End Class
    End Namespace

    Namespace CoreService.ServiceModel.Dtos.Templates.Deployment.Crud

        '''<Summary>
        '''Returns the template definition
        '''</Summary>
        <Api(Description:="Returns the template definition")>
        <ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(TemplateDefinitionDto), StatusCode:=200)>
        Public Partial Class GetDeploymentTemplateDefinition
            Implements IGetSingleRequest
            Implements IHasTenantName
            Implements IGet
            <ApiMember(DataType:="string", Format:="guid", ParameterType:="path")>
            Public Overridable Property Id As Guid?

            <ApiMember(DataType:="string", ParameterType:="path")>
            Public Overridable Property Name As String

            <ApiMember(DataType:="string", ParameterType:="path")>
            Public Overridable Property Version As String

            <ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property TenantName As String Implements IHasTenantName.TenantName

            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property DefinitionFormat As TemplateLanguages

            '''<Summary>
            '''If true, also soft deleted items will be returned
            '''</Summary>
            <ApiMember(Description:="If true, also soft deleted items will be returned", ParameterType:="query")>
            Public Overridable Property IncludeDeleted As Boolean? Implements IGetSingleRequest.IncludeDeleted

            <ApiMember(ParameterType:="query", Verb:="GET")>
            Public Overridable Property IncludeReferencedObjects As Boolean? Implements IGetSingleRequest.IncludeReferencedObjects
        End Class
    End Namespace

    Namespace CoreService.ServiceModel.Enums

        Public Enum TemplateLanguages
            Json
            Yaml
        End Enum
    End Namespace
End Namespace

VB.NET GetDeploymentTemplateDefinition DTOs

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"}