| GET | /v1/forms/{FormUID}/automations |
|---|
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 FormAutomationRule:
workflow_id: int = 0
name: Optional[str] = None
sentence: Optional[str] = None
state: Optional[str] = None
state_text: Optional[str] = None
numbers: Optional[str] = None
warn: Optional[str] = None
any_application: bool = False
also_others: bool = False
shared_text: Optional[str] = None
from_starter: bool = False
engine_link: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormAutomationStarter:
key: Optional[str] = None
name: Optional[str] = None
text: Optional[str] = None
added: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormMappingRow:
field: Optional[str] = None
field_key: Optional[str] = None
target: Optional[str] = None
tone: Optional[str] = None
note: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormAutomationsResponse:
rules: List[FormAutomationRule] = field(default_factory=list)
starters: List[FormAutomationStarter] = field(default_factory=list)
mapping: List[FormMappingRow] = field(default_factory=list)
map_summary: Optional[str] = None
can_add: bool = False
add_refusal: Optional[str] = None
can_toggle: bool = False
can_remove: bool = False
can_open_engine: bool = False
reserved_keys: List[str] = field(default_factory=list)
testable_fields: List[str] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormAutomationsRequest:
form_u_i_d: Optional[str] = None
Python FormAutomationsRequest 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 /v1/forms/{FormUID}/automations HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormAutomationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AddRefusal>String</AddRefusal>
<CanAdd>false</CanAdd>
<CanOpenEngine>false</CanOpenEngine>
<CanRemove>false</CanRemove>
<CanToggle>false</CanToggle>
<MapSummary>String</MapSummary>
<Mapping>
<FormMappingRow>
<Field>String</Field>
<FieldKey>String</FieldKey>
<Note>String</Note>
<Target>String</Target>
<Tone>String</Tone>
</FormMappingRow>
</Mapping>
<ReservedKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ReservedKeys>
<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>
<Rules>
<FormAutomationRule>
<AlsoOthers>false</AlsoOthers>
<AnyApplication>false</AnyApplication>
<EngineLink>String</EngineLink>
<FromStarter>false</FromStarter>
<Name>String</Name>
<Numbers>String</Numbers>
<Sentence>String</Sentence>
<SharedText>String</SharedText>
<State>String</State>
<StateText>String</StateText>
<Warn>String</Warn>
<WorkflowId>0</WorkflowId>
</FormAutomationRule>
</Rules>
<Starters>
<FormAutomationStarter>
<Added>false</Added>
<Key>String</Key>
<Name>String</Name>
<Text>String</Text>
</FormAutomationStarter>
</Starters>
<TestableFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TestableFields>
</FormAutomationsResponse>