> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Revert a workflow instance > Move a workflow instance out of a terminal step (`completed`, `rejected` or `cancelled`) back to an earlier, non-terminal step of the definition version the instance is pinned to. Workflow definitions do not declare transitions out of terminal steps, so this is the only route back for a submission moved there by mistake. It requires the dedicated `workflow-instances:revert` permission, which no role bundles by default. A note explaining the revert is mandatory. The revert is recorded as a workflow transition record like any other movement, so it appears in the instance's history, in workflow insights and in the audit trail. The record is returned. Reverting an instance that is not on a terminal step returns 409 Conflict. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/workflow-instances/{workflow_instance_id}/revert openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/workflow-instances/{workflow_instance_id}/revert: post: tags: - Workflows summary: Revert a workflow instance out of a terminal step description: > Move a workflow instance out of a terminal step (`completed`, `rejected` or `cancelled`) back to an earlier, non-terminal step of the definition version the instance is pinned to. Workflow definitions do not declare transitions out of terminal steps, so this is the only route back for a submission moved there by mistake. It requires the dedicated `workflow-instances:revert` permission, which no role bundles by default. A note explaining the revert is mandatory. The revert is recorded as a workflow transition record like any other movement, so it appears in the instance's history, in workflow insights and in the audit trail. The record is returned. Reverting an instance that is not on a terminal step returns 409 Conflict. operationId: RevertWorkflowInstance parameters: - $ref: '#/components/parameters/workflow_instance_id' requestBody: $ref: '#/components/requestBodies/RevertWorkflowInstance' responses: '200': $ref: '#/components/responses/GetWorkflowTransitionRecord' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: workflow_instance_id: name: workflow_instance_id in: path required: true description: The unique identifier for the workflow instance. schema: type: string format: uuid example: c1d30b20-c5c4-4ce2-adb1-4486c3ffef19 requestBodies: RevertWorkflowInstance: required: true description: > The step to revert the workflow to, and the reason for reverting it. The destination must be a non-terminal step of the definition version the instance is pinned to; the note is mandatory. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type - attributes properties: type: type: string const: workflow-instance-revert attributes: type: object required: - to - note properties: to: type: string description: >- The identifier of the step to revert the workflow to, within its definition version. note: type: string description: >- Why the workflow is being reverted. Required, and recorded on the transition record. responses: GetWorkflowTransitionRecord: description: Get a workflow transition record. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/WorkflowTransitionRecord' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 NotFound: description: The requested resource could not be found headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f status: '404' title: Resource not found detail: The requested resource could not be found or does not exist. code: NOT_FOUND.001 Conflict: description: The request conflicts with the current state of the resource headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g status: '409' title: Conflict detail: The request conflicts with the current state of the resource. code: CONFLICT.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: WorkflowTransitionRecord: type: object description: A workflow transition record resource. required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the workflow transition record. type: type: string const: workflow-transition-records attributes: $ref: '#/components/schemas/WorkflowTransitionRecordAttributes' meta: $ref: '#/components/schemas/WorkflowTransitionRecordMeta' relationships: $ref: '#/components/schemas/WorkflowTransitionRecordRelationships' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. type: string examples: - AUTH.001 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include required: - id - status - title WorkflowTransitionRecordAttributes: type: object description: Attributes for a workflow transition record required: - note - from - to - revert properties: revert: type: boolean description: > Whether the record was written by the privileged revert endpoint rather than by an operator following the workflow. A revert moves the instance out of a terminal step, back to a step it has already visited. note: type: string description: The note recorded against the transition from: type: object description: The step the workflow moved out of required: - id - name - status properties: id: type: string description: >- The identifier of the step within the workflow definition version name: type: string description: The name of the step status: type: string description: > The type of the step, normally one of `initial`, `intermediate`, `completed`, `rejected` or `cancelled`. Workflow instances created directly through the API may carry another value. to: type: object description: The step the workflow moved in to required: - id - name - status properties: id: type: string description: >- The identifier of the step within the workflow definition version name: type: string description: The name of the step status: type: string description: > The type of the step, one of `initial`, `intermediate`, `completed`, `rejected` or `cancelled`. A record whose `to.status` is `completed`, `rejected` or `cancelled` is a terminal transition for the instance. WorkflowTransitionRecordMeta: type: object description: Metadata for a workflow transition record required: - duration - created_at properties: duration: type: integer format: int64 description: > The number of minutes spent in the previous step, rounded up, with a floor of 1. The floor holds only for records written since the field was introduced — records that predate it carry 0, because the value is stamped at write time and was never backfilled. Use the difference between `created_at` timestamps for precise timings, and for any record that might be old. created_at: type: string format: date-time description: The date and time when the workflow transition record was created WorkflowTransitionRecordRelationships: type: object description: Relationships for a workflow transition record required: - organisation properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' definition: type: object required: - data properties: data: $ref: '#/components/schemas/WorkflowDefinitionRelationship' definition_version: type: object required: - data properties: data: $ref: '#/components/schemas/WorkflowDefinitionVersionRelationship' instance: type: object required: - data properties: data: $ref: '#/components/schemas/WorkflowInstanceRelationship' submission: type: object required: - data properties: data: $ref: '#/components/schemas/FormSubmissionRelationship' user: type: object required: - data properties: data: $ref: '#/components/schemas/UserRelationship' OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations WorkflowDefinitionRelationship: type: object description: Represents a relationship to a workflow definition required: - id - type properties: id: type: string format: uuid description: The unique identifier of the workflow definition type: type: string const: workflow-definitions WorkflowDefinitionVersionRelationship: type: object description: Represents a relationship to a workflow definition version required: - id - type properties: id: type: string format: uuid description: The unique identifier of the workflow definition version type: type: string const: workflow-definition-versions WorkflowInstanceRelationship: type: object description: Represents a relationship to a workflow instance required: - id - type properties: id: type: string format: uuid description: The unique identifier of the workflow instance type: type: string const: workflow-instances FormSubmissionRelationship: type: object description: Represents a relationship to a form submission required: - id - type properties: id: type: string format: uuid description: The unique identifier of the form submission type: type: string const: form-submissions UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ````