| Required role: | TenantReader |
| GET | /api/actions/{Id}/definition | Returns the action definition | |
|---|---|---|---|
| GET | /actions/{Id}/definition | Returns the action definition |
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class TemplateDefinitionDto implements JsonSerializable
{
public function __construct(
/** @description The schema version of the attached definition */
/** @var int */
public int $schemaVersion=0,
/** @description The template definition/body either as json or yaml */
/** @var string */
public string $definition=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['schemaVersion'])) $this->schemaVersion = $o['schemaVersion'];
if (isset($o['definition'])) $this->definition = $o['definition'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->schemaVersion)) $o['schemaVersion'] = $this->schemaVersion;
if (isset($this->definition)) $o['definition'] = $this->definition;
return empty($o) ? new class(){} : $o;
}
}
enum TemplateLanguages : string
{
case Json = 'Json';
case Yaml = 'Yaml';
}
/** @description Returns the definition */
// @Api(Description="Returns the definition")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType="typeof(CoreService.ServiceModel.Dtos.Base.Responses.TemplateDefinitionDto)", StatusCode=200)
class GetActionDefinition implements IGetSingleRequest, IHasTenantName, IGet, JsonSerializable
{
public function __construct(
// @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
/** @var string */
public string $id='',
// @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
// @Validate(Validator="NotEmpty")
/** @var string */
public string $tenantName='',
// @ApiMember(IsRequired=true, ParameterType="query")
/** @var TemplateLanguages|null */
public ?TemplateLanguages $definitionFormat=null,
/** @description If true, also soft deleted items will be returned */
// @ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
/** @var bool|null */
public ?bool $includeDeleted=null,
// @ApiMember(ParameterType="query", Verb="GET")
/** @var bool|null */
public ?bool $includeReferencedObjects=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['tenantName'])) $this->tenantName = $o['tenantName'];
if (isset($o['definitionFormat'])) $this->definitionFormat = JsonConverters::from('TemplateLanguages', $o['definitionFormat']);
if (isset($o['includeDeleted'])) $this->includeDeleted = $o['includeDeleted'];
if (isset($o['includeReferencedObjects'])) $this->includeReferencedObjects = $o['includeReferencedObjects'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->tenantName)) $o['tenantName'] = $this->tenantName;
if (isset($this->definitionFormat)) $o['definitionFormat'] = JsonConverters::to('TemplateLanguages', $this->definitionFormat);
if (isset($this->includeDeleted)) $o['includeDeleted'] = $this->includeDeleted;
if (isset($this->includeReferencedObjects)) $o['includeReferencedObjects'] = $this->includeReferencedObjects;
return empty($o) ? new class(){} : $o;
}
}
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
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"}