| GET | /api/automation/{AutomationId}/documentation |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutomationId | path | Guid | No | Automation Id. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Automation | form | AutoDocumentationModel | No | Documentation Automation |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportId | query | Guid | No | Report Id |
| Report | query | string | No | Report Name |
| DocumentTypeId | query | Guid | No | Document Type Id |
| DocumentType | query | string | No | Document Type |
| DocumentStatusId | query | Guid | No | Document Status Id |
| DocumentStatus | query | string | No | The Document Status |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutomationId | query | Guid | No | The unique automation Id |
| AutomationTypeId | query | Guid | No | The automation type Id |
| AutomationType | query | string | No | The automation type |
| ObjectId | query | Guid | No | The object this automation applies to |
| ObjectName | query | string | No | The object name this automation applies to |
| RmsTableCtxIdObject | query | Guid | No | The Id of the object type that this automation applies to. |
| RmsTableCtxName | query | string | No | The name of the object type that this automation applies to. |
| ActionList | query | List<Guid> | No | A guid list containing the selected system action Id's that trigger this automation. |
| Actions | query | string | No | A comma separated string of the selected system action names that trigger this automation. |
| Name | query | string | No | Name of the automation. |
| Description | query | string | No | Description of the automation |
| OwnerContactId | query | Guid | No | Owner Contact Id |
| RecordStatus | query | string | No | Record Status of the automation. |
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
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Automation":{"ReportId":"00000000-0000-0000-0000-000000000000","Report":"String","DocumentTypeId":"00000000-0000-0000-0000-000000000000","DocumentType":"String","DocumentStatusId":"00000000-0000-0000-0000-000000000000","DocumentStatus":"String","AutomationId":"00000000-0000-0000-0000-000000000000","AutomationTypeId":"00000000-0000-0000-0000-000000000000","AutomationType":"String","ObjectId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","RmsTableCtxIdObject":"00000000-0000-0000-0000-000000000000","RmsTableCtxName":"String","ActionList":["00000000-0000-0000-0000-000000000000"],"Actions":"String","Name":"String","Description":"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"}}}