get_workflow
Retrieve status, inputs, outputs, errors, and metadata for a specific workflow using its application name and workflow ID. Diagnose issues and track progress.
Instructions
Get details of a specific workflow from DBOS Conductor.
Args: application_name (string, required): Name of the DBOS application workflow_id (string, required): ID of the workflow to retrieve
Returns: workflowId (string): The workflow ID status (string): PENDING, SUCCESS, ERROR, CANCELLED, ENQUEUED, DELAYED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED workflowName (string): The name of the workflow function workflowClass (string, optional): The name of the workflow's class, if any workflowConfig (string, optional): The name with which the workflow's class instance was configured, if any user (string, optional): The user who ran the workflow, if specified assumedRole (string, optional): The role with which the workflow ran, if specified roles (string, optional): All roles which the authenticated user could assume (JSON array) input (string, optional): The workflow input, in a human-readable representation output (string, optional): The workflow's output, if any, in a human-readable representation error (string, optional): The error the workflow threw, if any createdAt (string): Workflow start time (ISO 8601) updatedAt (string): Last time the workflow status was updated (ISO 8601) queueName (string, optional): If this workflow was enqueued, on which queue appVersion (string): The application version on which this workflow was started executorId (string, optional): The executor to most recently execute this workflow timeoutMs (int, optional): The start-to-close timeout of the workflow in ms deadline (string, optional): The deadline of the workflow, computed by adding its timeout to its start time (ISO 8601) deduplicationId (string, optional): Unique ID for deduplication on a queue priority (int): Priority of the workflow on the queue (1-2147483647, lower is higher priority) queuePartitionKey (string, optional): If this workflow is enqueued on a partitioned queue, its partition key forkedFrom (string, optional): If this workflow was forked from another, that workflow's ID parentWorkflowId (string, optional): If this is a child workflow, the ID of the parent workflow that started it dequeuedAt (string, optional): When this workflow was dequeued from its queue (ISO 8601) wasForkedFrom (bool): Whether another workflow has been forked from this one (true on the fork's source, not on the fork itself; a fork has forkedFrom set instead) delayUntil (string, optional): If this workflow has a delayed start, the time until which it is delayed (ISO 8601) completedAt (string, optional): When this workflow completed (ISO 8601) attributes (string, optional): Application-defined attributes attached to the workflow, if any scheduleName (string, optional): If this workflow was started by a schedule, that schedule's name applicationName (string, optional): Name of the application that owns the workflow
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes | ||
| application_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||