ROrossum
Workflow Run

Reset workflow run

Resetting the workflow run leads to:

  • change its workflow status to in_review
  • empty annotation's assignees
  • set the annotation status to to_review
  • create workflow activity of action pushed_back
<Callout type="info"> Resetting is allowed only for workflow runs with related annotation in `in_workflow` state. See [Annotation Lifecycle](/guides/annotation-lifecycle) for more information about states. </Callout>
post/api/v1/workflow_runs/{workflowRunID}/reset

Request

Path parameters

workflowRunIDinteger required

A unique integer value identifying this workflow run.

Request body

note_contentstring

String note for the reset action

Example request

{
  "note_content": "Resetting due to invalid due date."
}

Response

OK

annotation_statusstring

New status of the annotation (to_review)

workflow_statusstring

New workflow status (in_review)

Example response

{
  "annotation_status": "to_review",
  "workflow_status": "in_review"
}

Changes

No recorded changes to this operation across all 14 revisions of this API.