Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}