| PUT | /api/automation/notification/{AutomationId} | ||
|---|---|---|---|
| POST | /api/automation/notification |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutomationModel:
# @ApiMember(Description="The unique automation Id", ParameterType="query")
automation_id: Optional[str] = None
"""
The unique automation Id
"""
# @ApiMember(Description="The automation type Id", ParameterType="query")
automation_type_id: Optional[str] = None
"""
The automation type Id
"""
# @ApiMember(Description="The automation type", ParameterType="query")
automation_type: Optional[str] = None
"""
The automation type
"""
# @ApiMember(Description="The object this automation applies to", ParameterType="query")
object_id: Optional[str] = None
"""
The object this automation applies to
"""
# @ApiMember(Description="The object name this automation applies to", ParameterType="query")
object_name: Optional[str] = None
"""
The object name this automation applies to
"""
# @ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")
rms_table_ctx_id_object: Optional[str] = None
"""
The Id of the object type that this automation applies to.
"""
# @ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")
rms_table_ctx_name: Optional[str] = None
"""
The name of the object type that this automation applies to.
"""
# @ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")
action_list: Optional[List[str]] = None
"""
A guid list containing the selected system action Id's that trigger this automation.
"""
# @ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")
actions: Optional[str] = None
"""
A comma separated string of the selected system action names that trigger this automation.
"""
# @ApiMember(Description="Name of the automation.", ParameterType="query")
name: Optional[str] = None
"""
Name of the automation.
"""
# @ApiMember(Description="Description of the automation", ParameterType="query")
description: Optional[str] = None
"""
Description of the automation
"""
# @ApiMember(Description="Owner Contact Id", ParameterType="query")
owner_contact_id: Optional[str] = None
"""
Owner Contact Id
"""
# @ApiMember(Description="Record Status of the automation.", ParameterType="query")
record_status: Optional[str] = None
"""
Record Status of the automation.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutoNotificationModel(AutomationModel):
# @ApiMember(Description="Contact Id of the licensee this notification has been created for.", ParameterType="query")
contact_id_licensee: Optional[str] = None
"""
Contact Id of the licensee this notification has been created for.
"""
# @ApiMember(Description="Contact Role Group Id. If the notification is setup for people in a specified contact role group.", ParameterType="query")
contact_role_group_id: Optional[str] = None
"""
Contact Role Group Id. If the notification is setup for people in a specified contact role group.
"""
# @ApiMember(Description="Contact Role Id. If the notification is setup for people in a specified role.", ParameterType="query")
contact_role_id: Optional[str] = None
"""
Contact Role Id. 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")
contact_role_name: Optional[str] = None
"""
Contact Role Name. If the notification is setup for people in a specified role.
"""
# @ApiMember(Description="Contact Id. If the notification is setup for a specific person.", ParameterType="query")
contact_id: Optional[str] = None
"""
Contact Id. If the notification is setup for a specific person.
"""
# @ApiMember(Description="If true, then only contacts who are connected to the relevant object are notified.", ParameterType="query")
object_contact_connection_required: bool = False
"""
If true, then only contacts who are connected to the relevant object are notified.
"""
# @ApiMember(Description="Document Notification: If true, then the notification will include a link to download the document.", ParameterType="query")
allow_direct_access: bool = False
"""
Document Notification: If true, then the notification will include a link to download the document.
"""
# @ApiMember(Description="If true, the notification is sent as soon as it can be processed", ParameterType="query")
send_immediately: bool = False
"""
If true, the notification is sent as soon as it can be processed
"""
# @ApiMember(Description="If true, the notification is flagged and sent out when subscription/batch emails are next sent.", ParameterType="query")
batched: bool = False
"""
If true, the notification is flagged and sent out when subscription/batch emails are next sent.
"""
# @ApiMember(Description="Document Notification: If true, the notification is sent when a document has a status of draft.", ParameterType="query")
draft_status: bool = False
"""
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 final.", ParameterType="query")
final_status: bool = False
"""
Document Notification: If true, the notification is sent when a document has a status of final.
"""
# @ApiMember(Description="True if we want to include a report on an email notification. ", ParameterType="query")
include_report: bool = False
"""
True if we want to include a report on an email notification.
"""
# @ApiMember(Description="True if this notification is based on a template.", ParameterType="query")
is_template_notification: bool = False
"""
True if this notification is based on a template.
"""
# @ApiMember(Description="When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.", ParameterType="query")
roles: Optional[List[str]] = None
"""
When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.
"""
# @ApiMember(Description="Communication Type Id.", ParameterType="query")
communication_type_id: Optional[str] = None
"""
Communication Type Id.
"""
# @ApiMember(Description="Communication Type.", ParameterType="query")
communication_type: Optional[str] = None
"""
Communication Type.
"""
# @ApiMember(Description="If communication type is email, this is the subject of the email to be sent.", ParameterType="query")
subject: Optional[str] = None
"""
If communication type is email, this is the subject of the email to be sent.
"""
# @ApiMember(Description="This is the notification details to be sent.", ParameterType="query")
body: Optional[str] = None
"""
This is the notification details to be sent.
"""
# @ApiMember(Description="If true, we will include the relevant project URL in the notification.", ParameterType="query")
include_u_r_l: bool = False
"""
If true, we will include the relevant project URL in the notification.
"""
# @ApiMember(Description="The notification Id of a notification setup in Workflow Notification Management to use for the notification.", ParameterType="query")
notification_id: Optional[str] = None
"""
The notification Id of 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")
notification_name: Optional[str] = None
"""
The notification nameof a notification setup in Workflow Notification Management to use for the notification.
"""
# @ApiMember(Description="The suite id the notification is setup for", ParameterType="query")
suite_id: Optional[str] = None
"""
The suite id the notification is setup for
"""
# @ApiMember(Description="The suite name the notification is setup for", ParameterType="query")
suite_name: Optional[str] = None
"""
The suite name the notification is setup for
"""
# @ApiResponse(Description="List of (automation) notifications that are setup for an object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAutomationNotificationsForObjectResponse:
# @ApiMember(Description="List of (automation) notifications.")
notifications: Optional[List[AutoNotificationModel]] = None
"""
List of (automation) notifications.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Add or update an (automation) notification for an object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveAutoNotification:
"""
Add or update an (automation) notification for an object
"""
# @ApiMember(Description="Details of the (automation) notification to be added or updated.", ParameterType="query")
notification: Optional[AutoNotificationModel] = None
"""
Details of the (automation) notification to be added or updated.
"""
# @ApiMember(Description="Id of the automation.", ParameterType="path")
automation_id: Optional[str] = None
"""
Id of the automation.
"""
Python SaveAutoNotification DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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: application/json
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"}}}