| GET | /api/automation/{ObjectId}/list |
|---|
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.
"""
# @ApiResponse(Description="List of automations that are setup for an object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAutomationsForObjectResponse:
# @ApiMember(Description="List of automations.")
automations: Optional[List[AutomationModel]] = None
"""
List of automations.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get automations that are setup for an object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAutomationsForObject:
"""
Get automations that are setup for an object
"""
# @ApiMember(Description="Object to retrieve automations for.", ParameterType="path")
object_id: Optional[str] = None
"""
Object to retrieve automations for.
"""
Python GetAutomationsForObject 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.
GET /api/automation/{ObjectId}/list HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetAutomationsForObjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Automations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:AutomationModel>
<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:AutomationModel>
</Automations>
<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>
</GetAutomationsForObjectResponse>