Trendsic Platform Service

<back to all web services

EngineWorkflowsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/workflows
"use strict";
export class WorkflowVersionInfo {
    /** @param {{VersionNum?:number,Status?:string,CreatedBy?:string,CreatedAt?:string,PublishedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    VersionNum;
    /** @type {string} */
    Status;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    CreatedAt;
    /** @type {?string} */
    PublishedAt;
}
export class WorkflowView {
    /** @param {{WorkflowId?:number,SourceKey?:string,Name?:string,Vertical?:string,Pack?:string,Status?:string,VersionNum?:number,Description?:string,OwnerRole?:string,GraphJson?:string,Ok30?:number,Fail30?:number,Waiting?:number,UpdatedBy?:string,UpdatedAt?:string,Versions?:WorkflowVersionInfo[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
    /** @type {string} */
    SourceKey;
    /** @type {string} */
    Name;
    /** @type {string} */
    Vertical;
    /** @type {string} */
    Pack;
    /** @type {string} */
    Status;
    /** @type {number} */
    VersionNum;
    /** @type {string} */
    Description;
    /** @type {string} */
    OwnerRole;
    /** @type {string} */
    GraphJson;
    /** @type {number} */
    Ok30;
    /** @type {number} */
    Fail30;
    /** @type {number} */
    Waiting;
    /** @type {string} */
    UpdatedBy;
    /** @type {?string} */
    UpdatedAt;
    /** @type {WorkflowVersionInfo[]} */
    Versions = [];
}
export class EngineWorkflowsResponse {
    /** @param {{Workflows?:WorkflowView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowView[]} */
    Workflows = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineWorkflowsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript EngineWorkflowsRequest 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/engine/workflows HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineWorkflowsResponse 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>
  <Workflows>
    <WorkflowView>
      <Description>String</Description>
      <Fail30>0</Fail30>
      <GraphJson>String</GraphJson>
      <Name>String</Name>
      <Ok30>0</Ok30>
      <OwnerRole>String</OwnerRole>
      <Pack>String</Pack>
      <SourceKey>String</SourceKey>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UpdatedBy>String</UpdatedBy>
      <VersionNum>0</VersionNum>
      <Versions>
        <WorkflowVersionInfo>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <PublishedAt>0001-01-01T00:00:00</PublishedAt>
          <Status>String</Status>
          <VersionNum>0</VersionNum>
        </WorkflowVersionInfo>
      </Versions>
      <Vertical>String</Vertical>
      <Waiting>0</Waiting>
      <WorkflowId>0</WorkflowId>
    </WorkflowView>
  </Workflows>
</EngineWorkflowsResponse>