Trendsic Platform Service

<back to all web services

EngineRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/runs
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowRunStepView() = 
        member val StepId:Int32 = new Int32() with get,set
        member val NodeId:String = null with get,set
        member val Name:String = null with get,set
        member val Kind:String = null with get,set
        member val Status:String = null with get,set
        member val DurationMs:Int32 = new Int32() with get,set
        member val Input:String = null with get,set
        member val Output:String = null with get,set
        member val Note:String = null with get,set
        member val BranchReason:String = null with get,set
        member val Attempts:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type WorkflowRunView() = 
        member val RunId:Int32 = new Int32() with get,set
        member val RunKey:String = null with get,set
        member val WorkflowId:Int32 = new Int32() with get,set
        member val WorkflowName:String = null with get,set
        member val VersionNum:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val RecordLabel:String = null with get,set
        member val RecordHref:String = null with get,set
        member val WaitReason:String = null with get,set
        member val RunAfter:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Attempts:Int32 = new Int32() with get,set
        member val MaxAttempts:Int32 = new Int32() with get,set
        member val StartedAt:DateTime = new DateTime() with get,set
        member val FinishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DurationMs:Int32 = new Int32() with get,set
        member val Steps:ResizeArray<WorkflowRunStepView> = new ResizeArray<WorkflowRunStepView>() with get,set

    [<AllowNullLiteral>]
    type EngineRunsResponse() = 
        member val Runs:ResizeArray<WorkflowRunView> = new ResizeArray<WorkflowRunView>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type EngineRunsRequest() = 
        member val Status:String = null with get,set
        member val WorkflowId:Int32 = new Int32() with get,set
        member val Top:Int32 = new Int32() with get,set

F# EngineRunsRequest DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}