Trendsic Platform Service

<back to all web services

MessagingWorkflowActionRequest

Requires Authentication
The following routes are available for this service:
POST/v1/messaging/workflows/{WorkflowId}/replace
POST/v1/messaging/workflows/{WorkflowId}/keep
"use strict";
export class CompileResult {
    /** @param {{RuleKey?:string,BranchId?:string,LineId?:string,StepId?:string,WorkflowId?:number,VersionNum?:number,Action?:string,Name?:string,Note?:string,Customized?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RuleKey;
    /** @type {string} */
    BranchId;
    /** @type {?string} */
    LineId;
    /** @type {string} */
    StepId;
    /** @type {?number} */
    WorkflowId;
    /** @type {?number} */
    VersionNum;
    /** @type {string} */
    Action;
    /** @type {string} */
    Name;
    /** @type {string} */
    Note;
    /** @type {boolean} */
    Customized;
}
export class MessagingCompileResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Results?:CompileResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CompileResult[]} */
    Results = [];
}
export class MessagingWorkflowActionRequest {
    /** @param {{WorkflowId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
}

JavaScript MessagingWorkflowActionRequest 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.

POST /v1/messaging/workflows/{WorkflowId}/replace HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MessagingWorkflowActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <WorkflowId>0</WorkflowId>
</MessagingWorkflowActionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessagingCompileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Results>
    <QueueMessagingService.CompileResult>
      <Action>String</Action>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <Customized>false</Customized>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <Name>String</Name>
      <Note>String</Note>
      <RuleKey>String</RuleKey>
      <StepId>String</StepId>
      <VersionNum>0</VersionNum>
      <WorkflowId>0</WorkflowId>
    </QueueMessagingService.CompileResult>
  </Results>
</MessagingCompileResponse>