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

export class AutomationModel
{
    /** @description The unique automation Id */
    // @ApiMember(Description="The unique automation Id", ParameterType="query")
    public AutomationId: string;

    /** @description The automation type Id */
    // @ApiMember(Description="The automation type Id", ParameterType="query")
    public AutomationTypeId: string;

    /** @description The automation type */
    // @ApiMember(Description="The automation type", ParameterType="query")
    public AutomationType: string;

    /** @description The object this automation applies to */
    // @ApiMember(Description="The object this automation applies to", ParameterType="query")
    public ObjectId: string;

    /** @description The object name this automation applies to */
    // @ApiMember(Description="The object name this automation applies to", ParameterType="query")
    public ObjectName: string;

    /** @description The Id of the object type that this automation applies to.  */
    // @ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")
    public RmsTableCtxIdObject: string;

    /** @description The name of the object type that this automation applies to. */
    // @ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")
    public RmsTableCtxName: string;

    /** @description A guid list containing the selected system action Id's that trigger this automation. */
    // @ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")
    public ActionList: string[];

    /** @description A comma separated string of the selected system action names that trigger this automation. */
    // @ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")
    public Actions: string;

    /** @description Name of the automation. */
    // @ApiMember(Description="Name of the automation.", ParameterType="query")
    public Name: string;

    /** @description Description of the automation */
    // @ApiMember(Description="Description of the automation", ParameterType="query")
    public Description: string;

    /** @description Owner Contact Id */
    // @ApiMember(Description="Owner Contact Id", ParameterType="query")
    public OwnerContactId: string;

    /** @description Record Status of the automation. */
    // @ApiMember(Description="Record Status of the automation.", ParameterType="query")
    public RecordStatus: string;

    public constructor(init?: Partial<AutomationModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of automations that are setup for an object")
export class GetAutomationsForObjectResponse
{
    /** @description List of automations. */
    // @ApiMember(Description="List of automations.")
    public Automations: AutomationModel[];

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAutomationsForObjectResponse>) { (Object as any).assign(this, init); }
}

export class AutoInspectionModel extends AutomationModel
{
    /** @description The inspection type for the template. */
    // @ApiMember(Description="The inspection type for the template.", ParameterType="query")
    public InspectionTypeId: string;

    /** @description The template to base the new inspection on. */
    // @ApiMember(Description="The template to base the new inspection on.", ParameterType="query")
    public InspectionTemplateId: 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.  */
    // @ApiMember(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. ", ParameterType="query")
    public ContactRoleId: string;

    /** @description If this is true, then if a project inspection for this template already exists, we will not create another inspection. */
    // @ApiMember(Description="If this is true, then if a project inspection for this template already exists, we will not create another inspection.", ParameterType="query")
    public IgnoreIfExists: boolean;

    public constructor(init?: Partial<AutoInspectionModel>) { super(init); (Object as any).assign(this, init); }
}

/** @description Add or update an inspection automation for an object */
// @Api(Description="Add or update an inspection automation for an object")
export class SaveAutoInspection
{
    /** @description Details of the automation to be added or updated. */
    // @ApiMember(Description="Details of the automation to be added or updated.", ParameterType="query")
    public Automation: AutoInspectionModel;

    /** @description Id of the automation. */
    // @ApiMember(Description="Id of the automation.", ParameterType="path")
    public AutomationId: string;

    public constructor(init?: Partial<SaveAutoInspection>) { (Object as any).assign(this, init); }
}

TypeScript SaveAutoInspection DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}}}