Trendsic Platform Service

<back to all web services

EngineRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/runs
"use strict";
export class WorkflowRunStepView {
    /** @param {{StepId?:number,NodeId?:string,Name?:string,Kind?:string,Status?:string,DurationMs?:number,Input?:string,Output?:string,Note?:string,BranchReason?:string,Attempts?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StepId;
    /** @type {string} */
    NodeId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Status;
    /** @type {number} */
    DurationMs;
    /** @type {string} */
    Input;
    /** @type {string} */
    Output;
    /** @type {string} */
    Note;
    /** @type {string} */
    BranchReason;
    /** @type {number} */
    Attempts;
}
export class WorkflowRunView {
    /** @param {{RunId?:number,RunKey?:string,WorkflowId?:number,WorkflowName?:string,VersionNum?:number,Status?:string,RecordLabel?:string,RecordHref?:string,WaitReason?:string,RunAfter?:string,Attempts?:number,MaxAttempts?:number,StartedAt?:string,FinishedAt?:string,DurationMs?:number,Steps?:WorkflowRunStepView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RunId;
    /** @type {string} */
    RunKey;
    /** @type {number} */
    WorkflowId;
    /** @type {string} */
    WorkflowName;
    /** @type {number} */
    VersionNum;
    /** @type {string} */
    Status;
    /** @type {string} */
    RecordLabel;
    /** @type {string} */
    RecordHref;
    /** @type {string} */
    WaitReason;
    /** @type {?string} */
    RunAfter;
    /** @type {number} */
    Attempts;
    /** @type {number} */
    MaxAttempts;
    /** @type {string} */
    StartedAt;
    /** @type {?string} */
    FinishedAt;
    /** @type {number} */
    DurationMs;
    /** @type {WorkflowRunStepView[]} */
    Steps = [];
}
export class EngineRunsResponse {
    /** @param {{Runs?:WorkflowRunView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowRunView[]} */
    Runs = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineRunsRequest {
    /** @param {{Status?:string,WorkflowId?:number,Top?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Status;
    /** @type {number} */
    WorkflowId;
    /** @type {number} */
    Top;
}

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

<EngineRunsResponse 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>
  <Runs>
    <WorkflowRunView>
      <Attempts>0</Attempts>
      <DurationMs>0</DurationMs>
      <FinishedAt>0001-01-01T00:00:00</FinishedAt>
      <MaxAttempts>0</MaxAttempts>
      <RecordHref>String</RecordHref>
      <RecordLabel>String</RecordLabel>
      <RunAfter>0001-01-01T00:00:00</RunAfter>
      <RunId>0</RunId>
      <RunKey>String</RunKey>
      <StartedAt>0001-01-01T00:00:00</StartedAt>
      <Status>String</Status>
      <Steps>
        <WorkflowRunStepView>
          <Attempts>0</Attempts>
          <BranchReason>String</BranchReason>
          <DurationMs>0</DurationMs>
          <Input>String</Input>
          <Kind>String</Kind>
          <Name>String</Name>
          <NodeId>String</NodeId>
          <Note>String</Note>
          <Output>String</Output>
          <Status>String</Status>
          <StepId>0</StepId>
        </WorkflowRunStepView>
      </Steps>
      <VersionNum>0</VersionNum>
      <WaitReason>String</WaitReason>
      <WorkflowId>0</WorkflowId>
      <WorkflowName>String</WorkflowName>
    </WorkflowRunView>
  </Runs>
</EngineRunsResponse>