Trendsic Platform Service

<back to all web services

FormAutomationsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/automations

export class FormAutomationRule
{
    public WorkflowId: number;
    public Name: string;
    public Sentence: string;
    public State: string;
    public StateText: string;
    public Numbers: string;
    public Warn: string;
    public AnyApplication: boolean;
    public AlsoOthers: boolean;
    public SharedText: string;
    public FromStarter: boolean;
    public EngineLink: string;

    public constructor(init?: Partial<FormAutomationRule>) { (Object as any).assign(this, init); }
}

export class FormAutomationStarter
{
    public Key: string;
    public Name: string;
    public Text: string;
    public Added: boolean;

    public constructor(init?: Partial<FormAutomationStarter>) { (Object as any).assign(this, init); }
}

export class FormMappingRow
{
    public Field: string;
    public FieldKey: string;
    public Target: string;
    public Tone: string;
    public Note: string;

    public constructor(init?: Partial<FormMappingRow>) { (Object as any).assign(this, init); }
}

export class FormAutomationsResponse
{
    public Rules: FormAutomationRule[] = [];
    public Starters: FormAutomationStarter[] = [];
    public Mapping: FormMappingRow[] = [];
    public MapSummary: string;
    public CanAdd: boolean;
    public AddRefusal: string;
    public CanToggle: boolean;
    public CanRemove: boolean;
    public CanOpenEngine: boolean;
    public ReservedKeys: string[] = [];
    public TestableFields: string[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormAutomationsResponse>) { (Object as any).assign(this, init); }
}

export class FormAutomationsRequest
{
    public FormUID: string;

    public constructor(init?: Partial<FormAutomationsRequest>) { (Object as any).assign(this, init); }
}

TypeScript FormAutomationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>