| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<EngineRunsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Runs>
<WorkflowRunView>
<Attempts>0</Attempts>
<DurationMs>0</DurationMs>
<FinishedAt>0001-01-01T00:00:00</FinishedAt>
<MaxAttempts>0</MaxAttempts>
<RecordHref>String</RecordHref>
<RecordLabel>String</RecordLabel>
<RunAfter>0001-01-01T00:00:00</RunAfter>
<RunId>0</RunId>
<RunKey>String</RunKey>
<StartedAt>0001-01-01T00:00:00</StartedAt>
<Status>String</Status>
<Steps>
<WorkflowRunStepView>
<Attempts>0</Attempts>
<BranchReason>String</BranchReason>
<DurationMs>0</DurationMs>
<Input>String</Input>
<Kind>String</Kind>
<Name>String</Name>
<NodeId>String</NodeId>
<Note>String</Note>
<Output>String</Output>
<Status>String</Status>
<StepId>0</StepId>
</WorkflowRunStepView>
</Steps>
<VersionNum>0</VersionNum>
<WaitReason>String</WaitReason>
<WorkflowId>0</WorkflowId>
<WorkflowName>String</WorkflowName>
</WorkflowRunView>
</Runs>
</EngineRunsResponse>