| GET | /api/automation/{AutomationId}/documentation |
|---|
"use strict";
export class AutomationModel {
/** @param {{AutomationId?:string,AutomationTypeId?:string,AutomationType?:string,ObjectId?:string,ObjectName?:string,RmsTableCtxIdObject?:string,RmsTableCtxName?:string,ActionList?:string[],Actions?:string,Name?:string,Description?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique automation Id */
AutomationId;
/**
* @type {string}
* @description The automation type Id */
AutomationTypeId;
/**
* @type {string}
* @description The automation type */
AutomationType;
/**
* @type {string}
* @description The object this automation applies to */
ObjectId;
/**
* @type {string}
* @description The object name this automation applies to */
ObjectName;
/**
* @type {string}
* @description The Id of the object type that this automation applies to. */
RmsTableCtxIdObject;
/**
* @type {string}
* @description The name of the object type that this automation applies to. */
RmsTableCtxName;
/**
* @type {string[]}
* @description A guid list containing the selected system action Id's that trigger this automation. */
ActionList;
/**
* @type {string}
* @description A comma separated string of the selected system action names that trigger this automation. */
Actions;
/**
* @type {string}
* @description Name of the automation. */
Name;
/**
* @type {string}
* @description Description of the automation */
Description;
/**
* @type {string}
* @description Owner Contact Id */
OwnerContactId;
/**
* @type {string}
* @description Record Status of the automation. */
RecordStatus;
}
export class AutoDocumentationModel extends AutomationModel {
/** @param {{ReportId?:string,Report?:string,DocumentTypeId?:string,DocumentType?:string,DocumentStatusId?:string,DocumentStatus?:string,AutomationId?:string,AutomationTypeId?:string,AutomationType?:string,ObjectId?:string,ObjectName?:string,RmsTableCtxIdObject?:string,RmsTableCtxName?:string,ActionList?:string[],Actions?:string,Name?:string,Description?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Report Id */
ReportId;
/**
* @type {string}
* @description Report Name */
Report;
/**
* @type {string}
* @description Document Type Id */
DocumentTypeId;
/**
* @type {string}
* @description Document Type */
DocumentType;
/**
* @type {string}
* @description Document Status Id */
DocumentStatusId;
/**
* @type {string}
* @description The Document Status */
DocumentStatus;
}
export class GetDocumentationAutomationResponse {
/** @param {{Automation?:AutoDocumentationModel,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {AutoDocumentationModel}
* @description Documentation Automation */
Automation;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetDocumentationAutomation {
/** @param {{AutomationId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Automation Id. */
AutomationId;
}
JavaScript GetDocumentationAutomation 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/{AutomationId}/documentation HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Automation:
{
Report: String,
DocumentType: String,
DocumentStatus: String,
AutomationType: String,
ObjectName: String,
RmsTableCtxName: String,
ActionList:
[
00000000-0000-0000-0000-000000000000
],
Actions: String,
Name: String,
Description: String,
RecordStatus: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}