Trendsic Platform Service

<back to all web services

EngineRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/runs
EngineRunsRequest Parameters:
NameParameterData TypeRequiredDescription
StatusquerystringNo
WorkflowIdqueryintNo
TopqueryintNo
EngineRunsResponse Parameters:
NameParameterData TypeRequiredDescription
RunsformList<WorkflowRunView>No
ResponseStatusformResponseStatusNo
WorkflowRunView Parameters:
NameParameterData TypeRequiredDescription
RunIdformintNo
RunKeyformstringNo
WorkflowIdformintNo
WorkflowNameformstringNo
VersionNumformintNo
StatusformstringNo
RecordLabelformstringNo
RecordHrefformstringNo
WaitReasonformstringNo
RunAfterformDateTime?No
AttemptsformintNo
MaxAttemptsformintNo
StartedAtformDateTimeNo
FinishedAtformDateTime?No
DurationMsformintNo
StepsformList<WorkflowRunStepView>No
WorkflowRunStepView Parameters:
NameParameterData TypeRequiredDescription
StepIdformintNo
NodeIdformstringNo
NameformstringNo
KindformstringNo
StatusformstringNo
DurationMsformintNo
InputformstringNo
OutputformstringNo
NoteformstringNo
BranchReasonformstringNo
AttemptsformintNo

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