Platform API

<back to all web services

SaveAutoNotification

Add or update an (automation) notification for an object

Requires Authentication
The following routes are available for this service:
PUT/api/automation/notification/{AutomationId}
POST/api/automation/notification
"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 AutoNotificationModel extends AutomationModel {
    /** @param {{ContactIdLicensee?:string,ContactRoleGroupId?:string,ContactRoleId?:string,ContactRoleName?:string,ContactId?:string,ObjectContactConnectionRequired?:boolean,AllowDirectAccess?:boolean,SendImmediately?:boolean,Batched?:boolean,DraftStatus?:boolean,FinalStatus?:boolean,IncludeReport?:boolean,IsTemplateNotification?:boolean,Roles?:string[],CommunicationTypeId?:string,CommunicationType?:string,Subject?:string,Body?:string,IncludeURL?:boolean,NotificationId?:string,NotificationName?:string,SuiteId?:string,SuiteName?:string,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 Contact Id of the licensee this notification has been created for. */
    ContactIdLicensee;
    /**
     * @type {string}
     * @description Contact Role Group Id. If the notification is setup for people in a specified contact role group. */
    ContactRoleGroupId;
    /**
     * @type {string}
     * @description Contact Role Id. If the notification is setup for people in a specified role. */
    ContactRoleId;
    /**
     * @type {string}
     * @description Contact Role Name. If the notification is setup for people in a specified role. */
    ContactRoleName;
    /**
     * @type {string}
     * @description Contact Id. If the notification is setup for a specific person. */
    ContactId;
    /**
     * @type {boolean}
     * @description If true, then only contacts who are connected to the relevant object are notified. */
    ObjectContactConnectionRequired;
    /**
     * @type {boolean}
     * @description Document Notification: If true, then the notification will include a link to download the document. */
    AllowDirectAccess;
    /**
     * @type {boolean}
     * @description If true, the notification is sent as soon as it can be processed */
    SendImmediately;
    /**
     * @type {boolean}
     * @description If true, the notification is flagged and sent out when subscription/batch emails are next sent. */
    Batched;
    /**
     * @type {boolean}
     * @description Document Notification: If true, the notification is sent when a document has a status of draft. */
    DraftStatus;
    /**
     * @type {boolean}
     * @description Document Notification: If true, the notification is sent when a document has a status of final. */
    FinalStatus;
    /**
     * @type {boolean}
     * @description True if we want to include a report on an email notification.  */
    IncludeReport;
    /**
     * @type {boolean}
     * @description True if this notification is based on a template. */
    IsTemplateNotification;
    /**
     * @type {string[]}
     * @description When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting. */
    Roles;
    /**
     * @type {string}
     * @description Communication Type Id. */
    CommunicationTypeId;
    /**
     * @type {string}
     * @description Communication Type. */
    CommunicationType;
    /**
     * @type {string}
     * @description If communication type is email, this is the subject of the email to be sent. */
    Subject;
    /**
     * @type {string}
     * @description This is the notification details to be sent. */
    Body;
    /**
     * @type {boolean}
     * @description If true, we will include the relevant project URL in the notification. */
    IncludeURL;
    /**
     * @type {string}
     * @description The notification Id of a notification setup in Workflow Notification Management to use for the notification. */
    NotificationId;
    /**
     * @type {string}
     * @description The notification nameof a notification setup in Workflow Notification Management to use for the notification. */
    NotificationName;
    /**
     * @type {string}
     * @description The suite id the notification is setup for */
    SuiteId;
    /**
     * @type {string}
     * @description The suite name the notification is setup for */
    SuiteName;
}
export class GetAutomationNotificationsForObjectResponse {
    /** @param {{Notifications?:AutoNotificationModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {AutoNotificationModel[]}
     * @description List of (automation) notifications. */
    Notifications;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SaveAutoNotification {
    /** @param {{Notification?:AutoNotificationModel,AutomationId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {AutoNotificationModel}
     * @description Details of the (automation) notification to be added or updated. */
    Notification;
    /**
     * @type {string}
     * @description Id of the automation. */
    AutomationId;
}

JavaScript SaveAutoNotification DTOs

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

HTTP + XML

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

POST /api/automation/notification HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveAutoNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <AutomationId>00000000-0000-0000-0000-000000000000</AutomationId>
  <Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ActionList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:ActionList>
    <d2p1:Actions>String</d2p1:Actions>
    <d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
    <d2p1:AutomationType>String</d2p1:AutomationType>
    <d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:ObjectName>String</d2p1:ObjectName>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
    <d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
    <d2p1:AllowDirectAccess>false</d2p1:AllowDirectAccess>
    <d2p1:Batched>false</d2p1:Batched>
    <d2p1:Body>String</d2p1:Body>
    <d2p1:CommunicationType>String</d2p1:CommunicationType>
    <d2p1:CommunicationTypeId>00000000-0000-0000-0000-000000000000</d2p1:CommunicationTypeId>
    <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
    <d2p1:ContactIdLicensee>00000000-0000-0000-0000-000000000000</d2p1:ContactIdLicensee>
    <d2p1:ContactRoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleGroupId>
    <d2p1:ContactRoleId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleId>
    <d2p1:ContactRoleName>String</d2p1:ContactRoleName>
    <d2p1:DraftStatus>false</d2p1:DraftStatus>
    <d2p1:FinalStatus>false</d2p1:FinalStatus>
    <d2p1:IncludeReport>false</d2p1:IncludeReport>
    <d2p1:IncludeURL>false</d2p1:IncludeURL>
    <d2p1:IsTemplateNotification>false</d2p1:IsTemplateNotification>
    <d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
    <d2p1:NotificationName>String</d2p1:NotificationName>
    <d2p1:ObjectContactConnectionRequired>false</d2p1:ObjectContactConnectionRequired>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:Roles>
    <d2p1:SendImmediately>false</d2p1:SendImmediately>
    <d2p1:Subject>String</d2p1:Subject>
    <d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
    <d2p1:SuiteName>String</d2p1:SuiteName>
  </Notification>
</SaveAutoNotification>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAutomationNotificationsForObjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:AutoNotificationModel>
      <d2p1:ActionList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </d2p1:ActionList>
      <d2p1:Actions>String</d2p1:Actions>
      <d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
      <d2p1:AutomationType>String</d2p1:AutomationType>
      <d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
      <d2p1:ObjectName>String</d2p1:ObjectName>
      <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
      <d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
      <d2p1:AllowDirectAccess>false</d2p1:AllowDirectAccess>
      <d2p1:Batched>false</d2p1:Batched>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:CommunicationType>String</d2p1:CommunicationType>
      <d2p1:CommunicationTypeId>00000000-0000-0000-0000-000000000000</d2p1:CommunicationTypeId>
      <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
      <d2p1:ContactIdLicensee>00000000-0000-0000-0000-000000000000</d2p1:ContactIdLicensee>
      <d2p1:ContactRoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleGroupId>
      <d2p1:ContactRoleId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleId>
      <d2p1:ContactRoleName>String</d2p1:ContactRoleName>
      <d2p1:DraftStatus>false</d2p1:DraftStatus>
      <d2p1:FinalStatus>false</d2p1:FinalStatus>
      <d2p1:IncludeReport>false</d2p1:IncludeReport>
      <d2p1:IncludeURL>false</d2p1:IncludeURL>
      <d2p1:IsTemplateNotification>false</d2p1:IsTemplateNotification>
      <d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
      <d2p1:NotificationName>String</d2p1:NotificationName>
      <d2p1:ObjectContactConnectionRequired>false</d2p1:ObjectContactConnectionRequired>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </d2p1:Roles>
      <d2p1:SendImmediately>false</d2p1:SendImmediately>
      <d2p1:Subject>String</d2p1:Subject>
      <d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
      <d2p1:SuiteName>String</d2p1:SuiteName>
    </d2p1:AutoNotificationModel>
  </Notifications>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetAutomationNotificationsForObjectResponse>