Platform API

SaveAutoInspection

Add or update an inspection automation for an object

The following routes are available for this service:
PUT	/api/automation/inspection/{AutomationId}
POST	/api/automation/inspection

**SaveAutoInspection** Parameters:
Name	Parameter	Data Type	Required	Description
Automation	query	AutoInspectionModel	No	Details of the automation to be added or updated.
AutomationId	path	Guid	No	Id of the automation.

**AutoInspectionModel** Parameters:
Name	Parameter	Data Type	Required	Description
InspectionTypeId	query	Guid	No	The inspection type for the template.
InspectionTemplateId	query	Guid	No	The template to base the new inspection on.
ContactRoleId	query	Guid	No	The 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.
IgnoreIfExists	query	bool	No	If this is true, then if a project inspection for this template already exists, we will not create another inspection.

**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.

**GetAutomationsForObjectResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Automations	form	List<AutomationModel>	No	List of automations.
ResponseStatus	form	ResponseStatus	No

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.

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

{
	Automation: 
	{
		IgnoreIfExists: False,
		AutomationType: String,
		ObjectName: String,
		RmsTableCtxName: String,
		ActionList: 
		[
			00000000-0000-0000-0000-000000000000
		],
		Actions: String,
		Name: String,
		Description: String,
		RecordStatus: String
	}
}

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

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