> ## 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. # Update an operation > Update an existing operation ## OpenAPI ````yaml /api-reference/openapi.yaml put /v3/operations/{operation_id} 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: | 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: | 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: | 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: > 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/operations/{operation_id}: put: tags: - Operations summary: Update an existing operation description: Update an existing operation operationId: UpdateOperation parameters: - $ref: '#/components/parameters/operation_id' requestBody: $ref: '#/components/requestBodies/UpdateOperation' responses: '200': $ref: '#/components/responses/UpdateOperation' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: operation_id: name: operation_id in: path required: true description: The unique identifier for the operation. schema: type: string format: uuid example: a8a41819-be0c-48b9-9883-1378fc63a637 requestBodies: UpdateOperation: required: true description: The operation to update. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - id - type - attributes - relationships properties: id: type: string format: uuid description: The unique identifier of the operation. type: type: string const: operations attributes: type: object required: - name - status properties: name: type: string minLength: 1 description: The name of the operation examples: - Installation Operation code: type: string description: The operation code examples: - OP001 description: type: string description: Description of the operation examples: - Install new equipment at customer property dates: type: object description: Operation dates properties: scheduled: type: object description: Scheduled dates for the operation properties: start: type: string format: date-time description: Scheduled start date and time examples: - '2024-01-15T09:00:00Z' end: type: string format: date-time description: Scheduled end date and time examples: - '2024-01-15T17:00:00Z' labels: type: array description: Labels associated with the operation items: $ref: '#/components/schemas/Label' requirements: oneOf: - type: object description: Operation requirements properties: forms: oneOf: - type: array description: Required forms for the operation items: type: object required: - id - required properties: id: type: string format: uuid description: Form ID required: type: boolean description: Whether the form is required - {} - {} status: type: string description: Current status of the operation enum: - done - in_progress - todo examples: - in_progress done_reason: type: - string - 'null' description: Reason for completion when status is done enum: - aborted - completed - cancelled - null examples: - completed allOf: - if: properties: status: const: done then: required: - done_reason relationships: type: object required: - work_order properties: work_order: type: object properties: data: $ref: '#/components/schemas/WorkOrderRelationship' template: type: object properties: data: $ref: '#/components/schemas/OperationTemplateRelationship' type: type: object properties: data: $ref: '#/components/schemas/OperationTypeRelationship' responses: UpdateOperation: description: The updated operation 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/Operation' - $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 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. schemas: Label: type: object description: A label object required: - key - value properties: key: type: string minLength: 1 examples: - Your label key value: type: string examples: - Your label value WorkOrderRelationship: type: object description: Represents a relationship to a work order required: - id - type properties: id: type: string format: uuid description: The unique identifier of the work order type: type: string const: work-orders OperationTemplateRelationship: type: object description: Represents a relationship to an operation template required: - id - type properties: id: type: string format: uuid description: The unique identifier of the operation template type: type: string const: operation-templates OperationTypeRelationship: type: object description: Represents a relationship to an operation type required: - id - type properties: id: type: string format: uuid description: The unique identifier of the operation type type: type: string const: operation-types Operation: type: object description: An operation required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the operation. type: type: string const: operations attributes: $ref: '#/components/schemas/OperationAttributes' meta: $ref: '#/components/schemas/OperationMeta' relationships: $ref: '#/components/schemas/OperationRelationships' 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 OperationAttributes: type: object description: Attributes for an operation required: - name - status properties: name: type: string code: type: string description: type: string dates: type: object properties: scheduled: type: object properties: start: type: string format: date-time end: type: string format: date-time labels: type: array items: $ref: '#/components/schemas/Label' requirements: oneOf: - type: object properties: forms: oneOf: - type: array items: type: object required: - id - required properties: id: type: string format: uuid required: type: boolean - type: 'null' - type: 'null' status: type: string enum: - done - in_progress - todo done_reason: type: - string - 'null' enum: - aborted - completed - cancelled - null allOf: - if: properties: status: const: done then: required: - done_reason OperationMeta: type: object description: Metadata for an operation required: - created_at - updated_at - counts properties: created_at: type: string format: date-time description: The date and time when the operation was created updated_at: type: string format: date-time description: The date and time when the operation was last updated counts: type: object required: - streets - properties properties: streets: type: integer description: The number of streets in this operation format: int64 minimum: 0 default: 0 properties: type: integer description: The number of properties in this operation format: int64 minimum: 0 default: 0 related_data: type: object description: Related resources for the operation properties: properties: type: array description: Array of property IDs with postcodes items: type: object description: Property ID and Postcode required: - id - postcode properties: id: type: string format: uuid description: The ID of the property postcode: type: string description: Postcode of the property OperationRelationships: type: object description: Relationships for an operation required: - work_order - scheme - organisation properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' appointment: type: object required: - data properties: data: $ref: '#/components/schemas/AppointmentRelationship' scheme: type: object required: - data properties: data: $ref: '#/components/schemas/SchemeRelationship' work_order: type: object required: - data properties: data: $ref: '#/components/schemas/WorkOrderRelationship' permits: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/PermitRelationship' template: type: object required: - data properties: data: $ref: '#/components/schemas/OperationTemplateRelationship' type: type: object properties: data: $ref: '#/components/schemas/OperationTypeRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' assignees: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserRelationship' properties: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/PropertyRelationship' streets: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/StreetRelationship' 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 AppointmentRelationship: type: object description: Represents a relationship to an appointment required: - id - type properties: id: type: string format: uuid description: The unique identifier of the appointment type: type: string const: appointments SchemeRelationship: type: object description: Represents a relationship to a scheme required: - id - type properties: id: type: string format: uuid description: The unique identifier of the scheme type: type: string const: schemes PermitRelationship: type: object description: Represents a relationship to a permit required: - id - type properties: id: type: string format: uuid description: The unique identifier of the permit type: type: string const: permits TeamRelationship: type: object description: Represents a relationship to a team required: - id - type properties: id: type: string format: uuid description: The unique identifier of the team type: type: string const: teams 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 PropertyRelationship: type: object description: Represents a relationship to a property required: - id - type properties: id: type: string format: uuid description: The unique identifier of the property type: type: string const: properties StreetRelationship: type: object description: Represents a relationship to a street required: - id - type properties: id: type: string format: uuid description: The unique identifier of the street type: type: string const: streets 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 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 ````