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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Workflows":[{"WorkflowId":0,"SourceKey":"String","Name":"String","Vertical":"String","Pack":"String","Status":"String","VersionNum":0,"Description":"String","OwnerRole":"String","GraphJson":"String","Ok30":0,"Fail30":0,"Waiting":0,"UpdatedBy":"String","UpdatedAt":"0001-01-01T00:00:00.0000000","Versions":[{"VersionNum":0,"Status":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","PublishedAt":"0001-01-01T00:00:00.0000000"}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}