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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class EngineRunsRequest
{
    open var Status:String? = null
    open var WorkflowId:Int? = null
    open var Top:Int? = null
}

open class EngineRunsResponse
{
    open var Runs:ArrayList<WorkflowRunView> = ArrayList<WorkflowRunView>()
    open var ResponseStatus:ResponseStatus? = null
}

open class WorkflowRunView
{
    open var RunId:Int? = null
    open var RunKey:String? = null
    open var WorkflowId:Int? = null
    open var WorkflowName:String? = null
    open var VersionNum:Int? = null
    open var Status:String? = null
    open var RecordLabel:String? = null
    open var RecordHref:String? = null
    open var WaitReason:String? = null
    open var RunAfter:Date? = null
    open var Attempts:Int? = null
    open var MaxAttempts:Int? = null
    open var StartedAt:Date? = null
    open var FinishedAt:Date? = null
    open var DurationMs:Int? = null
    open var Steps:ArrayList<WorkflowRunStepView> = ArrayList<WorkflowRunStepView>()
}

open class WorkflowRunStepView
{
    open var StepId:Int? = null
    open var NodeId:String? = null
    open var Name:String? = null
    open var Kind:String? = null
    open var Status:String? = null
    open var DurationMs:Int? = null
    open var Input:String? = null
    open var Output:String? = null
    open var Note:String? = null
    open var BranchReason:String? = null
    open var Attempts:Int? = null
}

Kotlin EngineRunsRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			Attempts: 0,
			MaxAttempts: 0,
			StartedAt: 0001-01-01,
			FinishedAt: 0001-01-01,
			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
		}
	}
}