Trendsic Platform Service

<back to all web services

EngineWorkflowPauseRequest

Requires Authentication
The following routes are available for this service:
POST/v1/engine/workflows/{WorkflowId}/pause
POST/v1/engine/workflows/{WorkflowId}/resume
"use strict";
export class EngineWorkflowMutationResponse {
    /** @param {{WorkflowId?:number,VersionNum?:number,Forked?:boolean,Status?:string,ChangeRequestId?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
    /** @type {number} */
    VersionNum;
    /** @type {boolean} */
    Forked;
    /** @type {string} */
    Status;
    /** @type {number} */
    ChangeRequestId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineWorkflowPauseRequest {
    /** @param {{WorkflowId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkflowId;
}

JavaScript EngineWorkflowPauseRequest 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}/pause HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"WorkflowId":0}

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

{"WorkflowId":0,"VersionNum":0,"Forked":false,"Status":"String","ChangeRequestId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}