Trendsic Platform Service

<back to all web services

EngineRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/runs
import Foundation
import ServiceStack

public class EngineRunsRequest : Codable
{
    public var status:String
    public var workflowId:Int
    public var top:Int

    required public init(){}
}

public class EngineRunsResponse : Codable
{
    public var runs:[WorkflowRunView] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WorkflowRunView : Codable
{
    public var runId:Int
    public var runKey:String
    public var workflowId:Int
    public var workflowName:String
    public var versionNum:Int
    public var status:String
    public var recordLabel:String
    public var recordHref:String
    public var waitReason:String
    public var runAfter:Date?
    public var attempts:Int
    public var maxAttempts:Int
    public var startedAt:Date
    public var finishedAt:Date?
    public var durationMs:Int
    public var steps:[WorkflowRunStepView] = []

    required public init(){}
}

public class WorkflowRunStepView : Codable
{
    public var stepId:Int
    public var nodeId:String
    public var name:String
    public var kind:String
    public var status:String
    public var durationMs:Int
    public var input:String
    public var output:String
    public var note:String
    public var branchReason:String
    public var attempts:Int

    required public init(){}
}


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

{"Runs":[{"RunId":0,"RunKey":"String","WorkflowId":0,"WorkflowName":"String","VersionNum":0,"Status":"String","RecordLabel":"String","RecordHref":"String","WaitReason":"String","RunAfter":"0001-01-01T00:00:00.0000000","Attempts":0,"MaxAttempts":0,"StartedAt":"0001-01-01T00:00:00.0000000","FinishedAt":"0001-01-01T00:00:00.0000000","DurationMs":0,"Steps":[{"StepId":0,"NodeId":"String","Name":"String","Kind":"String","Status":"String","DurationMs":0,"Input":"String","Output":"String","Note":"String","BranchReason":"String","Attempts":0}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}