Objects

The WorkflowRun Summary object

The WorkflowRun Summary object is returned by the List Workflow Runs endpoint.

Full details for a run are available by calling the Get WorkflowRun endpoint.

id
string

The workflow run ID.

batchId
string

The batch ID of the WorkflowRun. If that WorkflowRun was created from a batch of files, all runs in that batch will have the same batch ID.

status
string

The status of the workflow run.

Possible values include:

  • PENDING: if the run queued and is waiting to be processed
  • PROCESSING: if the run has started processing
  • NEEDS_REVIEW: if the run needs to be manually reviewed in the UI
  • REJECTED: if the run was manually rejected
  • PROCESSED: if the run is fully processed
  • FAILED: if the run failed
initialRunAt
string

The time (in UTC) at which the workflow was initially run.

reviewed
boolean

Whether the workflow run has been reviewed.

reviewedByUser
string

The email address of the person who reviewed the workflow run.

reviewedAt
string

The time (in UTC) at which the workflow run was reviewed.

startTime
string

The start time (in UTC) of the workflow run.

endTime
string

The end time (in UTC) of the workflow run.

workflowId
string

The ID of the workflow that was run.

workflowName
string

The name of the workflow that was run.

workflowVersionId
string

The ID of the workflow version that was run.

batchId
string

The ID of the batch that the workflow run belongs to.

rejectionNote
string

The note that was added when the workflow run was rejected.

createdAt
string

The time (in UTC) at which the workflow run was created.

updatedAt
string

The time (in UTC) at which the workflow run was last updated.