Get workflow instance
GET/v1.0-beta1/workflows/:workflowComponentName/:instanceId
Get information about a given workflow instance.
Request
Path Parameters
workflowComponentName stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9_-]+$
Use "dapr" for Catalyst Workflows.
instanceId stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9_-]+$
Unique value created for each run of a specific workflow.
Responses
- 200
- 400
- 500
OK.
- application/json
- Schema
- Example (from schema)
Schema
createdAt date-time
instanceID string
Possible values: Value must match regular expression ^[a-zA-Z0-9_-]+$
lastUpdatedAt date-time
properties
object
property name* any
runtimeStatus string
Possible values: [RUNNING
, COMPLETED
, CONTINUED_AS_NEW
, FAILED
, CANCELED
, TERMINATED
, PENDING
, SUSPENDED
]
{
"createdAt": "2024-11-18T13:06:37.053Z",
"instanceID": "string",
"lastUpdatedAt": "2024-11-18T13:06:37.053Z",
"properties": {},
"runtimeStatus": "RUNNING"
}
Request was malformed.
Request formatted correctly, error in Catalyst code or underlying component.
Loading...