| GET | /api/automation/systemactions/{AutomationTypeId} |
|---|
"use strict";
export class ListItemModel {
/** @param {{ListItemId?:string,Name?:string,Description?:string,ShortName?:string,IsDefault?:boolean,Order?:number,ListItemTrafficLightId?:string,PrimaryListItemImageId?:string,PrimaryListItemImageUrl?:string,PrimaryImageThumbnailUrl?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ListItemId;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
ShortName;
/** @type {boolean} */
IsDefault;
/** @type {number} */
Order;
/** @type {string} */
ListItemTrafficLightId;
/** @type {string} */
PrimaryListItemImageId;
/** @type {string} */
PrimaryListItemImageUrl;
/** @type {string} */
PrimaryImageThumbnailUrl;
/** @type {string} */
OwnerContactId;
/** @type {string} */
RecordStatus;
}
export class GetSystemActionsForAutomationTypeResponse {
/** @param {{SystemActions?:ListItemModel[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ListItemModel[]}
* @description List of applicable system actions. */
SystemActions;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetSystemActionsForAutomationType {
/** @param {{AutomationTypeId?:string,RmsTableCtxId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Automation Type Id to get the system actions for. */
AutomationTypeId;
/**
* @type {string}
* @description RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to. */
RmsTableCtxId;
}
JavaScript GetSystemActionsForAutomationType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/systemactions/{AutomationTypeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
SystemActions:
[
{
Name: String,
Description: String,
ShortName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}