| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Rules:
[
{
WorkflowId: 0,
Name: String,
Sentence: String,
State: String,
StateText: String,
Numbers: String,
Warn: String,
AnyApplication: False,
AlsoOthers: False,
SharedText: String,
FromStarter: False,
EngineLink: String
}
],
Starters:
[
{
Key: String,
Name: String,
Text: String,
Added: False
}
],
Mapping:
[
{
Field: String,
FieldKey: String,
Target: String,
Tone: String,
Note: String
}
],
MapSummary: String,
CanAdd: False,
AddRefusal: String,
CanToggle: False,
CanRemove: False,
CanOpenEngine: False,
ReservedKeys:
[
String
],
TestableFields:
[
String
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}