Platform API

<back to all web services

GetAutomationsForObject

Get automations that are setup for an object

Requires Authentication
The following routes are available for this service:
GET/api/automation/{ObjectId}/list
"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 GetAutomationsForObject {
    /** @param {{ObjectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Object to retrieve automations for. */
    ObjectId;
}

JavaScript GetAutomationsForObject 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.

GET /api/automation/{ObjectId}/list HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv

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