| GET,OPTIONS | /v1/engine/runs |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | query | string | No | |
| WorkflowId | query | int | No | |
| Top | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Runs | form | List<WorkflowRunView> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RunId | form | int | No | |
| RunKey | form | string | No | |
| WorkflowId | form | int | No | |
| WorkflowName | form | string | No | |
| VersionNum | form | int | No | |
| Status | form | string | No | |
| RecordLabel | form | string | No | |
| RecordHref | form | string | No | |
| WaitReason | form | string | No | |
| RunAfter | form | DateTime? | No | |
| Attempts | form | int | No | |
| MaxAttempts | form | int | No | |
| StartedAt | form | DateTime | No | |
| FinishedAt | form | DateTime? | No | |
| DurationMs | form | int | No | |
| Steps | form | List<WorkflowRunStepView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StepId | form | int | No | |
| NodeId | form | string | No | |
| Name | form | string | No | |
| Kind | form | string | No | |
| Status | form | string | No | |
| DurationMs | form | int | No | |
| Input | form | string | No | |
| Output | form | string | No | |
| Note | form | string | No | |
| BranchReason | form | string | No | |
| Attempts | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}