Trendsic Platform Service

<back to all web services

EngineSandboxRequest

Requires Authentication
The following routes are available for this service:
POST/v1/engine/workflows/{WorkflowId}/test
"use strict";
export class WorkflowSandboxStepView {
    /** @param {{NodeId?:string,Title?:string,Kind?:string,Outcome?:string,Detail?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NodeId;
    /** @type {string} */
    Title;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Outcome;
    /** @type {string} */
    Detail;
}
export class WorkflowSandboxWriteView {
    /** @param {{What?:string,Detail?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    What;
    /** @type {string} */
    Detail;
}
export class EngineSandboxResponse {
    /** @param {{Record?:string,Results?:WorkflowSandboxStepView[],Suppressed?:WorkflowSandboxWriteView[],NotReached?:string[],Unreachable?:string[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Record;
    /** @type {WorkflowSandboxStepView[]} */
    Results = [];
    /** @type {WorkflowSandboxWriteView[]} */
    Suppressed = [];
    /** @type {string[]} */
    NotReached = [];
    /** @type {string[]} */
    Unreachable = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineSandboxRequest {
    /** @param {{WorkflowId?:number,GraphJson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
    /** @type {string} */
    GraphJson;
}

JavaScript EngineSandboxRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"WorkflowId":0,"GraphJson":"String"}

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

{"Record":"String","Results":[{"NodeId":"String","Title":"String","Kind":"String","Outcome":"String","Detail":"String"}],"Suppressed":[{"What":"String","Detail":"String"}],"NotReached":["String"],"Unreachable":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}