Skip to main content

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​

OK.

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]

Loading...