| GET | /api/automation/systemactions/{AutomationTypeId} |
|---|
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 system actions that can be used with a specified automation type")
export class GetSystemActionsForAutomationTypeResponse
{
/** @description List of applicable system actions. */
// @ApiMember(Description="List of applicable system actions.")
public SystemActions: ListItemModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetSystemActionsForAutomationTypeResponse>) { (Object as any).assign(this, init); }
}
/** @description Get system actions for the specified automation type */
// @Api(Description="Get system actions for the specified automation type")
export class GetSystemActionsForAutomationType
{
/** @description Automation Type Id to get the system actions for. */
// @ApiMember(Description="Automation Type Id to get the system actions for.", ParameterType="path")
public AutomationTypeId: string;
/** @description RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to. */
// @ApiMember(Description="RmsTableCtx Id of the object type the automation is for. System Actions can change based on the type they apply to.", ParameterType="path")
public RmsTableCtxId: string;
public constructor(init?: Partial<GetSystemActionsForAutomationType>) { (Object as any).assign(this, init); }
}
TypeScript 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
}
}
}