Sign in

v1

latestOpenAPI 3.0.0Apache-2.02026-07-172384109.4 KB

get a workflow's status and results(if completed & requested)

post/api/v1/workflow/get

Request body

workflowIdstring required
workflowRunIdstring
needsResultsboolean
waitTimeSecondsinteger

Example request

{
  "waitTimeSeconds": 0,
  "needsResults": true,
  "workflowRunId": "workflowRunId",
  "workflowId": "workflowId"
}

Response

successful operation

workflowRunIdstring required
workflowStatus'RUNNING' | 'COMPLETED' | 'FAILED' | 'TIMEOUT' | 'TERMINATED' | 'CANCELED' | 'CONTINUED_AS_NEW' required
errorType'STATE_DECISION_FAILING_WORKFLOW_ERROR_TYPE' | 'CLIENT_API_FAILING_WORKFLOW_ERROR_TYPE' | 'STATE_API_FAIL_ERROR_TYPE' | 'INVALID_USER_WORKFLOW_CODE_ERROR_TYPE' | 'RPC_ACQUIRE_LOCK_FAILURE' | 'SERVER_INTERNAL_ERROR_TYPE'
errorMessagestring

Example response

{
  "workflowStatus": null,
  "errorType": null,
  "errorMessage": "errorMessage",
  "workflowRunId": "workflowRunId",
  "results": [
    {
      "completedStateOutput": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "completedStateExecutionId": "completedStateExecutionId",
      "completedStateId": "completedStateId"
    },
    {
      "completedStateOutput": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "completedStateExecutionId": "completedStateExecutionId",
      "completedStateId": "completedStateId"
    }
  ]
}