| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetDocumentationAutomationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Automation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ActionList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
</d2p1:ActionList>
<d2p1:Actions>String</d2p1:Actions>
<d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
<d2p1:AutomationType>String</d2p1:AutomationType>
<d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:Name>String</d2p1:Name>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:ObjectName>String</d2p1:ObjectName>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
<d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
<d2p1:DocumentStatus>String</d2p1:DocumentStatus>
<d2p1:DocumentStatusId>00000000-0000-0000-0000-000000000000</d2p1:DocumentStatusId>
<d2p1:DocumentType>String</d2p1:DocumentType>
<d2p1:DocumentTypeId>00000000-0000-0000-0000-000000000000</d2p1:DocumentTypeId>
<d2p1:Report>String</d2p1:Report>
<d2p1:ReportId>00000000-0000-0000-0000-000000000000</d2p1:ReportId>
</Automation>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetDocumentationAutomationResponse>