Platform API

GetDocumentationAutomation

Get details of a specific documentation automation

The following routes are available for this service:
GET	/api/automation/{AutomationId}/documentation

**GetDocumentationAutomation** Parameters:
Name	Parameter	Data Type	Required	Description
AutomationId	path	Guid	No	Automation Id.

**GetDocumentationAutomationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Automation	form	AutoDocumentationModel	No	Documentation Automation
ResponseStatus	form	ResponseStatus	No

**AutoDocumentationModel** Parameters:
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

**AutomationModel** Parameters:
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 .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}