| PUT | /api/automation/notification/{AutomationId} | ||
|---|---|---|---|
| POST | /api/automation/notification |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Notification | query | AutoNotificationModel | No | Details of the (automation) notification to be added or updated. |
| AutomationId | path | Guid | No | Id of the automation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactIdLicensee | query | Guid | No | Contact Id of the licensee this notification has been created for. |
| ContactRoleGroupId | query | Guid | No | Contact Role Group Id. If the notification is setup for people in a specified contact role group. |
| ContactRoleId | query | Guid | No | Contact Role Id. If the notification is setup for people in a specified role. |
| ContactRoleName | query | string | No | Contact Role Name. If the notification is setup for people in a specified role. |
| ContactId | query | Guid | No | Contact Id. If the notification is setup for a specific person. |
| ObjectContactConnectionRequired | query | bool | No | If true, then only contacts who are connected to the relevant object are notified. |
| AllowDirectAccess | query | bool | No | Document Notification: If true, then the notification will include a link to download the document. |
| SendImmediately | query | bool | No | If true, the notification is sent as soon as it can be processed |
| Batched | query | bool | No | If true, the notification is flagged and sent out when subscription/batch emails are next sent. |
| DraftStatus | query | bool | No | Document Notification: If true, the notification is sent when a document has a status of draft. |
| FinalStatus | query | bool | No | Document Notification: If true, the notification is sent when a document has a status of final. |
| IncludeReport | query | bool | No | True if we want to include a report on an email notification. |
| IsTemplateNotification | query | bool | No | True if this notification is based on a template. |
| Roles | query | List<Guid> | No | When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting. |
| CommunicationTypeId | query | Guid | No | Communication Type Id. |
| CommunicationType | query | string | No | Communication Type. |
| Subject | query | string | No | If communication type is email, this is the subject of the email to be sent. |
| Body | query | string | No | This is the notification details to be sent. |
| IncludeURL | query | bool | No | If true, we will include the relevant project URL in the notification. |
| NotificationId | query | Guid | No | The notification Id of a notification setup in Workflow Notification Management to use for the notification. |
| NotificationName | query | string | No | The notification nameof a notification setup in Workflow Notification Management to use for the notification. |
| SuiteId | query | Guid | No | The suite id the notification is setup for |
| SuiteName | query | string | No | The suite name the notification is setup for |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Notifications | form | List<AutoNotificationModel> | No | List of (automation) notifications. |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"Notification":{"ContactIdLicensee":"00000000-0000-0000-0000-000000000000","ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","ContactId":"00000000-0000-0000-0000-000000000000","ObjectContactConnectionRequired":false,"AllowDirectAccess":false,"SendImmediately":false,"Batched":false,"DraftStatus":false,"FinalStatus":false,"IncludeReport":false,"IsTemplateNotification":false,"Roles":["00000000-0000-0000-0000-000000000000"],"CommunicationTypeId":"00000000-0000-0000-0000-000000000000","CommunicationType":"String","Subject":"String","Body":"String","IncludeURL":false,"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","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
{"Notifications":[{"ContactIdLicensee":"00000000-0000-0000-0000-000000000000","ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","ContactId":"00000000-0000-0000-0000-000000000000","ObjectContactConnectionRequired":false,"AllowDirectAccess":false,"SendImmediately":false,"Batched":false,"DraftStatus":false,"FinalStatus":false,"IncludeReport":false,"IsTemplateNotification":false,"Roles":["00000000-0000-0000-0000-000000000000"],"CommunicationTypeId":"00000000-0000-0000-0000-000000000000","CommunicationType":"String","Subject":"String","Body":"String","IncludeURL":false,"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","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"}}}