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
"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 GetAutomationsForObjectResponse {
    /** @param {{Automations?:AutomationModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {AutomationModel[]}
     * @description List of automations. */
    Automations;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class AutoInspectionModel extends AutomationModel {
    /** @param {{InspectionTypeId?:string,InspectionTemplateId?:string,ContactRoleId?:string,IgnoreIfExists?:boolean,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 The inspection type for the template. */
    InspectionTypeId;
    /**
     * @type {string}
     * @description The template to base the new inspection on. */
    InspectionTemplateId;
    /**
     * @type {string}
     * @description 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.  */
    ContactRoleId;
    /**
     * @type {boolean}
     * @description If this is true, then if a project inspection for this template already exists, we will not create another inspection. */
    IgnoreIfExists;
}
export class SaveAutoInspection {
    /** @param {{Automation?:AutoInspectionModel,AutomationId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {AutoInspectionModel}
     * @description Details of the automation to be added or updated. */
    Automation;
    /**
     * @type {string}
     * @description Id of the automation. */
    AutomationId;
}

JavaScript SaveAutoInspection DTOs

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"}}}