| PUT | /api/automation/notification/{AutomationId} | ||
|---|---|---|---|
| POST | /api/automation/notification |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Add or update an (automation) notification for an object
*/
@Api(Description="Add or update an (automation) notification for an object")
public static class SaveAutoNotification
{
/**
* Details of the (automation) notification to be added or updated.
*/
@ApiMember(Description="Details of the (automation) notification to be added or updated.", ParameterType="query")
public AutoNotificationModel Notification = null;
/**
* Id of the automation.
*/
@ApiMember(Description="Id of the automation.", ParameterType="path")
public UUID AutomationId = null;
public AutoNotificationModel getNotification() { return Notification; }
public SaveAutoNotification setNotification(AutoNotificationModel value) { this.Notification = value; return this; }
public UUID getAutomationId() { return AutomationId; }
public SaveAutoNotification setAutomationId(UUID value) { this.AutomationId = value; return this; }
}
public static class AutoNotificationModel extends AutomationModel
{
/**
* Contact Id of the licensee this notification has been created for.
*/
@ApiMember(Description="Contact Id of the licensee this notification has been created for.", ParameterType="query")
public UUID ContactIdLicensee = null;
/**
* Contact Role Group Id. If the notification is setup for people in a specified contact role group.
*/
@ApiMember(Description="Contact Role Group Id. If the notification is setup for people in a specified contact role group.", ParameterType="query")
public UUID ContactRoleGroupId = null;
/**
* Contact Role Id. If the notification is setup for people in a specified role.
*/
@ApiMember(Description="Contact Role Id. If the notification is setup for people in a specified role.", ParameterType="query")
public UUID ContactRoleId = null;
/**
* Contact Role Name. If the notification is setup for people in a specified role.
*/
@ApiMember(Description="Contact Role Name. If the notification is setup for people in a specified role.", ParameterType="query")
public String ContactRoleName = null;
/**
* Contact Id. If the notification is setup for a specific person.
*/
@ApiMember(Description="Contact Id. If the notification is setup for a specific person.", ParameterType="query")
public UUID ContactId = null;
/**
* If true, then only contacts who are connected to the relevant object are notified.
*/
@ApiMember(Description="If true, then only contacts who are connected to the relevant object are notified.", ParameterType="query")
public Boolean ObjectContactConnectionRequired = null;
/**
* Document Notification: If true, then the notification will include a link to download the document.
*/
@ApiMember(Description="Document Notification: If true, then the notification will include a link to download the document.", ParameterType="query")
public Boolean AllowDirectAccess = null;
/**
* If true, the notification is sent as soon as it can be processed
*/
@ApiMember(Description="If true, the notification is sent as soon as it can be processed", ParameterType="query")
public Boolean SendImmediately = null;
/**
* If true, the notification is flagged and sent out when subscription/batch emails are next sent.
*/
@ApiMember(Description="If true, the notification is flagged and sent out when subscription/batch emails are next sent.", ParameterType="query")
public Boolean Batched = null;
/**
* Document Notification: If true, the notification is sent when a document has a status of draft.
*/
@ApiMember(Description="Document Notification: If true, the notification is sent when a document has a status of draft.", ParameterType="query")
public Boolean DraftStatus = null;
/**
* Document Notification: If true, the notification is sent when a document has a status of final.
*/
@ApiMember(Description="Document Notification: If true, the notification is sent when a document has a status of final.", ParameterType="query")
public Boolean FinalStatus = null;
/**
* True if we want to include a report on an email notification.
*/
@ApiMember(Description="True if we want to include a report on an email notification. ", ParameterType="query")
public Boolean IncludeReport = null;
/**
* True if this notification is based on a template.
*/
@ApiMember(Description="True if this notification is based on a template.", ParameterType="query")
public Boolean IsTemplateNotification = null;
/**
* When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.
*/
@ApiMember(Description="When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.", ParameterType="query")
public ArrayList<UUID> Roles = null;
/**
* Communication Type Id.
*/
@ApiMember(Description="Communication Type Id.", ParameterType="query")
public UUID CommunicationTypeId = null;
/**
* Communication Type.
*/
@ApiMember(Description="Communication Type.", ParameterType="query")
public String CommunicationType = null;
/**
* If communication type is email, this is the subject of the email to be sent.
*/
@ApiMember(Description="If communication type is email, this is the subject of the email to be sent.", ParameterType="query")
public String Subject = null;
/**
* This is the notification details to be sent.
*/
@ApiMember(Description="This is the notification details to be sent.", ParameterType="query")
public String Body = null;
/**
* If true, we will include the relevant project URL in the notification.
*/
@ApiMember(Description="If true, we will include the relevant project URL in the notification.", ParameterType="query")
public Boolean IncludeURL = null;
/**
* The notification Id of a notification setup in Workflow Notification Management to use for the notification.
*/
@ApiMember(Description="The notification Id of a notification setup in Workflow Notification Management to use for the notification.", ParameterType="query")
public UUID NotificationId = null;
/**
* The notification nameof a notification setup in Workflow Notification Management to use for the notification.
*/
@ApiMember(Description="The notification nameof a notification setup in Workflow Notification Management to use for the notification.", ParameterType="query")
public String NotificationName = null;
/**
* The suite id the notification is setup for
*/
@ApiMember(Description="The suite id the notification is setup for", ParameterType="query")
public UUID SuiteId = null;
/**
* The suite name the notification is setup for
*/
@ApiMember(Description="The suite name the notification is setup for", ParameterType="query")
public String SuiteName = null;
public UUID getContactIdLicensee() { return ContactIdLicensee; }
public AutoNotificationModel setContactIdLicensee(UUID value) { this.ContactIdLicensee = value; return this; }
public UUID getContactRoleGroupId() { return ContactRoleGroupId; }
public AutoNotificationModel setContactRoleGroupId(UUID value) { this.ContactRoleGroupId = value; return this; }
public UUID getContactRoleId() { return ContactRoleId; }
public AutoNotificationModel setContactRoleId(UUID value) { this.ContactRoleId = value; return this; }
public String getContactRoleName() { return ContactRoleName; }
public AutoNotificationModel setContactRoleName(String value) { this.ContactRoleName = value; return this; }
public UUID getContactId() { return ContactId; }
public AutoNotificationModel setContactId(UUID value) { this.ContactId = value; return this; }
public Boolean isObjectContactConnectionRequired() { return ObjectContactConnectionRequired; }
public AutoNotificationModel setObjectContactConnectionRequired(Boolean value) { this.ObjectContactConnectionRequired = value; return this; }
public Boolean isAllowDirectAccess() { return AllowDirectAccess; }
public AutoNotificationModel setAllowDirectAccess(Boolean value) { this.AllowDirectAccess = value; return this; }
public Boolean isSendImmediately() { return SendImmediately; }
public AutoNotificationModel setSendImmediately(Boolean value) { this.SendImmediately = value; return this; }
public Boolean isBatched() { return Batched; }
public AutoNotificationModel setBatched(Boolean value) { this.Batched = value; return this; }
public Boolean isDraftStatus() { return DraftStatus; }
public AutoNotificationModel setDraftStatus(Boolean value) { this.DraftStatus = value; return this; }
public Boolean isFinalStatus() { return FinalStatus; }
public AutoNotificationModel setFinalStatus(Boolean value) { this.FinalStatus = value; return this; }
public Boolean isIncludeReport() { return IncludeReport; }
public AutoNotificationModel setIncludeReport(Boolean value) { this.IncludeReport = value; return this; }
public Boolean getIsTemplateNotification() { return IsTemplateNotification; }
public AutoNotificationModel setIsTemplateNotification(Boolean value) { this.IsTemplateNotification = value; return this; }
public ArrayList<UUID> getRoles() { return Roles; }
public AutoNotificationModel setRoles(ArrayList<UUID> value) { this.Roles = value; return this; }
public UUID getCommunicationTypeId() { return CommunicationTypeId; }
public AutoNotificationModel setCommunicationTypeId(UUID value) { this.CommunicationTypeId = value; return this; }
public String getCommunicationType() { return CommunicationType; }
public AutoNotificationModel setCommunicationType(String value) { this.CommunicationType = value; return this; }
public String getSubject() { return Subject; }
public AutoNotificationModel setSubject(String value) { this.Subject = value; return this; }
public String getBody() { return Body; }
public AutoNotificationModel setBody(String value) { this.Body = value; return this; }
public Boolean isIncludeURL() { return IncludeURL; }
public AutoNotificationModel setIncludeURL(Boolean value) { this.IncludeURL = value; return this; }
public UUID getNotificationId() { return NotificationId; }
public AutoNotificationModel setNotificationId(UUID value) { this.NotificationId = value; return this; }
public String getNotificationName() { return NotificationName; }
public AutoNotificationModel setNotificationName(String value) { this.NotificationName = value; return this; }
public UUID getSuiteId() { return SuiteId; }
public AutoNotificationModel setSuiteId(UUID value) { this.SuiteId = value; return this; }
public String getSuiteName() { return SuiteName; }
public AutoNotificationModel setSuiteName(String value) { this.SuiteName = value; return this; }
}
public static class AutomationModel
{
/**
* The unique automation Id
*/
@ApiMember(Description="The unique automation Id", ParameterType="query")
public UUID AutomationId = null;
/**
* The automation type Id
*/
@ApiMember(Description="The automation type Id", ParameterType="query")
public UUID AutomationTypeId = null;
/**
* The automation type
*/
@ApiMember(Description="The automation type", ParameterType="query")
public String AutomationType = null;
/**
* The object this automation applies to
*/
@ApiMember(Description="The object this automation applies to", ParameterType="query")
public UUID ObjectId = null;
/**
* The object name this automation applies to
*/
@ApiMember(Description="The object name this automation applies to", ParameterType="query")
public String ObjectName = null;
/**
* 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 UUID RmsTableCtxIdObject = null;
/**
* 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 String RmsTableCtxName = null;
/**
* 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 ArrayList<UUID> ActionList = null;
/**
* 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 String Actions = null;
/**
* Name of the automation.
*/
@ApiMember(Description="Name of the automation.", ParameterType="query")
public String Name = null;
/**
* Description of the automation
*/
@ApiMember(Description="Description of the automation", ParameterType="query")
public String Description = null;
/**
* Owner Contact Id
*/
@ApiMember(Description="Owner Contact Id", ParameterType="query")
public UUID OwnerContactId = null;
/**
* Record Status of the automation.
*/
@ApiMember(Description="Record Status of the automation.", ParameterType="query")
public String RecordStatus = null;
public UUID getAutomationId() { return AutomationId; }
public AutomationModel setAutomationId(UUID value) { this.AutomationId = value; return this; }
public UUID getAutomationTypeId() { return AutomationTypeId; }
public AutomationModel setAutomationTypeId(UUID value) { this.AutomationTypeId = value; return this; }
public String getAutomationType() { return AutomationType; }
public AutomationModel setAutomationType(String value) { this.AutomationType = value; return this; }
public UUID getObjectId() { return ObjectId; }
public AutomationModel setObjectId(UUID value) { this.ObjectId = value; return this; }
public String getObjectName() { return ObjectName; }
public AutomationModel setObjectName(String value) { this.ObjectName = value; return this; }
public UUID getRmsTableCtxIdObject() { return RmsTableCtxIdObject; }
public AutomationModel setRmsTableCtxIdObject(UUID value) { this.RmsTableCtxIdObject = value; return this; }
public String getRmsTableCtxName() { return RmsTableCtxName; }
public AutomationModel setRmsTableCtxName(String value) { this.RmsTableCtxName = value; return this; }
public ArrayList<UUID> getActionList() { return ActionList; }
public AutomationModel setActionList(ArrayList<UUID> value) { this.ActionList = value; return this; }
public String getActions() { return Actions; }
public AutomationModel setActions(String value) { this.Actions = value; return this; }
public String getName() { return Name; }
public AutomationModel setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public AutomationModel setDescription(String value) { this.Description = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public AutomationModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public AutomationModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
}
@ApiResponse(Description="List of (automation) notifications that are setup for an object.")
public static class GetAutomationNotificationsForObjectResponse
{
/**
* List of (automation) notifications.
*/
@ApiMember(Description="List of (automation) notifications.")
public ArrayList<AutoNotificationModel> Notifications = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<AutoNotificationModel> getNotifications() { return Notifications; }
public GetAutomationNotificationsForObjectResponse setNotifications(ArrayList<AutoNotificationModel> value) { this.Notifications = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetAutomationNotificationsForObjectResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
Java SaveAutoNotification DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>