Platform API

<back to all web services

SaveAutoInspection

Add or update an inspection automation for an object

Requires Authentication
The following routes are available for this service:
PUT/api/automation/inspection/{AutomationId}
POST/api/automation/inspection
SaveAutoInspection Parameters:
NameParameterData TypeRequiredDescription
AutomationqueryAutoInspectionModelNoDetails of the automation to be added or updated.
AutomationIdpathGuidNoId of the automation.
AutoInspectionModel Parameters:
NameParameterData TypeRequiredDescription
InspectionTypeIdqueryGuidNoThe inspection type for the template.
InspectionTemplateIdqueryGuidNoThe template to base the new inspection on.
ContactRoleIdqueryGuidNoThe inspector chosen for this inspection will be a contact linked to the project in this role. If no one matches the description, the inspector is not set.
IgnoreIfExistsqueryboolNoIf this is true, then if a project inspection for this template already exists, we will not create another inspection.
AutomationModel Parameters:
NameParameterData TypeRequiredDescription
AutomationIdqueryGuidNoThe unique automation Id
AutomationTypeIdqueryGuidNoThe automation type Id
AutomationTypequerystringNoThe automation type
ObjectIdqueryGuidNoThe object this automation applies to
ObjectNamequerystringNoThe object name this automation applies to
RmsTableCtxIdObjectqueryGuidNoThe Id of the object type that this automation applies to.
RmsTableCtxNamequerystringNoThe name of the object type that this automation applies to.
ActionListqueryList<Guid>NoA guid list containing the selected system action Id's that trigger this automation.
ActionsquerystringNoA comma separated string of the selected system action names that trigger this automation.
NamequerystringNoName of the automation.
DescriptionquerystringNoDescription of the automation
OwnerContactIdqueryGuidNoOwner Contact Id
RecordStatusquerystringNoRecord Status of the automation.
GetAutomationsForObjectResponse Parameters:
NameParameterData TypeRequiredDescription
AutomationsformList<AutomationModel>NoList of automations.
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/automation/inspection HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Automation":{"InspectionTypeId":"00000000-0000-0000-0000-000000000000","InspectionTemplateId":"00000000-0000-0000-0000-000000000000","ContactRoleId":"00000000-0000-0000-0000-000000000000","IgnoreIfExists":false,"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"},"AutomationId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Automations":[{"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"}}}