| GET | /v1/forms/{FormUID}/automations |
|---|
"use strict";
export class FormAutomationRule {
/** @param {{WorkflowId?:number,Name?:string,Sentence?:string,State?:string,StateText?:string,Numbers?:string,Warn?:string,AnyApplication?:boolean,AlsoOthers?:boolean,SharedText?:string,FromStarter?:boolean,EngineLink?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
WorkflowId;
/** @type {string} */
Name;
/** @type {string} */
Sentence;
/** @type {string} */
State;
/** @type {string} */
StateText;
/** @type {string} */
Numbers;
/** @type {string} */
Warn;
/** @type {boolean} */
AnyApplication;
/** @type {boolean} */
AlsoOthers;
/** @type {string} */
SharedText;
/** @type {boolean} */
FromStarter;
/** @type {string} */
EngineLink;
}
export class FormAutomationStarter {
/** @param {{Key?:string,Name?:string,Text?:string,Added?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Name;
/** @type {string} */
Text;
/** @type {boolean} */
Added;
}
export class FormMappingRow {
/** @param {{Field?:string,FieldKey?:string,Target?:string,Tone?:string,Note?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Field;
/** @type {string} */
FieldKey;
/** @type {string} */
Target;
/** @type {string} */
Tone;
/** @type {string} */
Note;
}
export class FormAutomationsResponse {
/** @param {{Rules?:FormAutomationRule[],Starters?:FormAutomationStarter[],Mapping?:FormMappingRow[],MapSummary?:string,CanAdd?:boolean,AddRefusal?:string,CanToggle?:boolean,CanRemove?:boolean,CanOpenEngine?:boolean,ReservedKeys?:string[],TestableFields?:string[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FormAutomationRule[]} */
Rules = [];
/** @type {FormAutomationStarter[]} */
Starters = [];
/** @type {FormMappingRow[]} */
Mapping = [];
/** @type {string} */
MapSummary;
/** @type {boolean} */
CanAdd;
/** @type {string} */
AddRefusal;
/** @type {boolean} */
CanToggle;
/** @type {boolean} */
CanRemove;
/** @type {boolean} */
CanOpenEngine;
/** @type {string[]} */
ReservedKeys = [];
/** @type {string[]} */
TestableFields = [];
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormAutomationsRequest {
/** @param {{FormUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FormUID;
}
JavaScript 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>