Trendsic Platform Service

<back to all web services

EngineRunsRequest

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

export class WorkflowRunStepView
{
    public StepId: number;
    public NodeId: string;
    public Name: string;
    public Kind: string;
    public Status: string;
    public DurationMs: number;
    public Input: string;
    public Output: string;
    public Note: string;
    public BranchReason: string;
    public Attempts: number;

    public constructor(init?: Partial<WorkflowRunStepView>) { (Object as any).assign(this, init); }
}

export class WorkflowRunView
{
    public RunId: number;
    public RunKey: string;
    public WorkflowId: number;
    public WorkflowName: string;
    public VersionNum: number;
    public Status: string;
    public RecordLabel: string;
    public RecordHref: string;
    public WaitReason: string;
    public RunAfter?: string;
    public Attempts: number;
    public MaxAttempts: number;
    public StartedAt: string;
    public FinishedAt?: string;
    public DurationMs: number;
    public Steps: WorkflowRunStepView[] = [];

    public constructor(init?: Partial<WorkflowRunView>) { (Object as any).assign(this, init); }
}

export class EngineRunsResponse
{
    public Runs: WorkflowRunView[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<EngineRunsResponse>) { (Object as any).assign(this, init); }
}

export class EngineRunsRequest
{
    public Status: string;
    public WorkflowId: number;
    public Top: number;

    public constructor(init?: Partial<EngineRunsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}