Platform API

<back to all web services

GetAutomationTypesByObjectType

Get automation types available for the specified object type (rmsTableCtxId)

Requires Authentication
The following routes are available for this service:
GET/api/automation/availabletypes/{RmsTableCtxId}

export class ListItemModel
{
    public ListItemId: string;
    public Name: string;
    public Description: string;
    public ShortName: string;
    public IsDefault: boolean;
    public Order: number;
    public ListItemTrafficLightId: string;
    public PrimaryListItemImageId: string;
    public PrimaryListItemImageUrl: string;
    public PrimaryImageThumbnailUrl: string;
    public OwnerContactId: string;
    public RecordStatus: string;

    public constructor(init?: Partial<ListItemModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="A list of automation types assignable to a particular object type")
export class GetAutomationTypesByObjectTypeResponse
{
    /** @description List of applicable automation types. */
    // @ApiMember(Description="List of applicable automation types.")
    public AutomationTypes: ListItemModel[];

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAutomationTypesByObjectTypeResponse>) { (Object as any).assign(this, init); }
}

/** @description Get automation types available for the specified object type (rmsTableCtxId) */
// @Api(Description="Get automation types available for the specified object type (rmsTableCtxId)")
export class GetAutomationTypesByObjectType
{
    /** @description RmsTableCtx Id to filter available automation types by */
    // @ApiMember(Description="RmsTableCtx Id to filter available automation types by", ParameterType="path")
    public RmsTableCtxId: string;

    public constructor(init?: Partial<GetAutomationTypesByObjectType>) { (Object as any).assign(this, init); }
}

TypeScript GetAutomationTypesByObjectType 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/automation/availabletypes/{RmsTableCtxId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AutomationTypes":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}