| GET,OPTIONS | /v1/engine/runs |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowRunStepView:
step_id: int = 0
node_id: Optional[str] = None
name: Optional[str] = None
kind: Optional[str] = None
status: Optional[str] = None
duration_ms: int = 0
input: Optional[str] = None
output: Optional[str] = None
note: Optional[str] = None
branch_reason: Optional[str] = None
attempts: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowRunView:
run_id: int = 0
run_key: Optional[str] = None
workflow_id: int = 0
workflow_name: Optional[str] = None
version_num: int = 0
status: Optional[str] = None
record_label: Optional[str] = None
record_href: Optional[str] = None
wait_reason: Optional[str] = None
run_after: Optional[datetime.datetime] = None
attempts: int = 0
max_attempts: int = 0
started_at: datetime.datetime = datetime.datetime(1, 1, 1)
finished_at: Optional[datetime.datetime] = None
duration_ms: int = 0
steps: List[WorkflowRunStepView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineRunsResponse:
runs: List[WorkflowRunView] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineRunsRequest:
status: Optional[str] = None
workflow_id: int = 0
top: int = 0
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
}
}
}