CoreService

<back to all web services

GetActionDefinition

Action - CRUD

Returns the definition

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/actions/{Id}/definitionReturns the action definition
GET/actions/{Id}/definitionReturns the action definition
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Returns the definition
*/
@Api(Description="Returns the definition")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=TemplateDefinitionDto::class, StatusCode=200)
open class GetActionDefinition : IGetSingleRequest, IHasTenantName, IGet
{
    @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
    open var id:UUID? = null

    @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    @Validate(Validator="NotEmpty")
    override var tenantName:String? = null

    @ApiMember(IsRequired=true, ParameterType="query")
    open var definitionFormat:TemplateLanguages? = null

    /**
    * If true, also soft deleted items will be returned
    */
    @ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
    override var includeDeleted:Boolean? = null

    @ApiMember(ParameterType="query", Verb="GET")
    override var includeReferencedObjects:Boolean? = null
}

enum class TemplateLanguages
{
    Json,
    Yaml,
}

open class TemplateDefinitionDto
{
    /**
    * The schema version of the attached definition
    */
    open var schemaVersion:Int? = null
    /**
    * The template definition/body either as json or yaml
    */
    open var definition:String? = null
}

Kotlin GetActionDefinition 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/actions/{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"}