> ## 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. # Create a pre-construction information > Create a pre-construction information. See the request body for who can. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/pre-construction-informations 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: > Copies of a mobile device's local database, sent by the operative on request so that people in their organisation can recover work that never reached the server. Kept for 30 days, and visible to people granted `device-backups:view` in the organisation each is filed against. name: Device Backups - 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: > Competency: the assessments, training items, inductions and registrations an organisation requires, and the specifications that combine them. 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: > Bulk loads of locations from an uploaded CSV. An import matches rows on the organisation's own `reference`, so re-importing a corrected file updates what is already there rather than doubling the population, and the import record is the audit trail for the whole load: the bulk write path deliberately emits no per-row events. name: Location Imports - 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: | Your personal inbox. A notification is the thing you receive: an envelope that carries what happened to one or more channels. Email is one of those channels, the inbox is another, and this is where the ones delivered to your inbox are listed, read, saved and archived. name: Notifications - 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: > A Construction Phase Plan is the Principal Contractor's plan for managing health and safety on a scheme, under CDM 2015. Its risks are control measures written against the hazards on the scheme's Pre-Construction Information. Each section is owned by one duty-holder role. name: Construction Phase Plans - description: > A Pre-Construction Information pack is the Client's information about a scheme under CDM 2015, with its site hazards. A scheme has at most one. Each section is owned by one duty-holder role, and only that role can write it. name: Pre-Construction Information - description: > Site attendances record who was on site and when, whether or not they hold an account. There is no daily register resource: a day's register and who is currently on site are both queries over the attendances themselves. name: Site Attendances - 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/pre-construction-informations: post: tags: - Pre-Construction Information summary: Create a pre-construction information description: | Create a pre-construction information. See the request body for who can. operationId: CreatePreConstructionInformation requestBody: $ref: '#/components/requestBodies/CreatePreConstructionInformation' responses: '200': $ref: '#/components/responses/GetPreConstructionInformation' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: requestBodies: CreatePreConstructionInformation: required: true description: > Create the scheme's Pre-Construction Information pack. Only the organisation that owns the scheme can, and a scheme has at most one. Every section is optional here and can be written later. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type properties: type: type: string const: pre-construction-informations attributes: type: object additionalProperties: false properties: project_information: $ref: '#/components/schemas/PCIProjectInformation' notifiability: $ref: '#/components/schemas/PCINotifiability' duty_holders: $ref: '#/components/schemas/PCIDutyHolders' planning_information: $ref: '#/components/schemas/PCIPlanningInformation' file_log: $ref: '#/components/schemas/PCIFileLog' relationships: type: object additionalProperties: false required: - scheme properties: scheme: type: object required: - data properties: data: $ref: '#/components/schemas/SchemeRelationship' principal_contractor: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' responses: GetPreConstructionInformation: description: A pre-construction information. 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/PreConstructionInformation' included: $ref: '#/components/schemas/PreConstructionInformationIncludes' - $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 Forbidden: description: >- The authenticated principal does not hold the grant required for this action 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: errors: - id: 1b3f2c30-2d56-4d3a-9c44-9be9c2cbf2f0 status: '403' title: Forbidden detail: You do not hold the grant required for this action. code: AUTH.002 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. schemas: PCIProjectInformation: type: object description: Project information. Owned by the Client and Principal Designer. x-cdm-owner: client_and_principal_designer additionalProperties: false properties: description: type: - string - 'null' description: What the project is. location: type: - string - 'null' description: Where the work is. planned_start_date: type: - string - 'null' format: date planned_end_date: type: - string - 'null' format: date existing_information: type: - string - 'null' description: Drawings, surveys and records available for the site. client_requirements: type: - string - 'null' description: >- The Client's requirements for managing health and safety, such as permits, security and welfare. PCINotifiability: type: object description: >- The Client's estimates for the CDM 2015 Reg 6 notifiability test. Owned by the Client and Principal Designer. Each is a whole number, and is absent until given. x-cdm-owner: client_and_principal_designer additionalProperties: false properties: person_days: type: - integer - 'null' minimum: 0 description: >- The estimated total of days worked by everyone on the project. More than 500 is notifiable on its own. working_days: type: - integer - 'null' minimum: 0 description: >- Every day on which construction work is likely to be carried out, including weekends and holidays, as HSE counts them. Not the planned end date minus the start date when work will not happen every day. peak_workers: type: - integer - 'null' minimum: 0 description: The most workers expected on site at the same time. PCIDutyHolders: type: object description: > Duty-holder details. Owned by the Client and Principal Designer. The Principal Contractor nomination is the document's `principal_contractor` relationship, and belongs to this section. x-cdm-owner: client_and_principal_designer additionalProperties: false properties: client: $ref: '#/components/schemas/CDMContact' principal_designer: $ref: '#/components/schemas/CDMContact' designers: type: array items: $ref: '#/components/schemas/CDMContact' PCIPlanningInformation: type: object description: > Pre-construction planning information, one field per topic. Owned by the Client and Principal Designer. x-cdm-owner: client_and_principal_designer additionalProperties: false properties: existing_services: $ref: '#/components/schemas/PCIPlanningTopic' ground_conditions: $ref: '#/components/schemas/PCIPlanningTopic' contaminated_land: $ref: '#/components/schemas/PCIPlanningTopic' asbestos: $ref: '#/components/schemas/PCIPlanningTopic' existing_structures: $ref: '#/components/schemas/PCIPlanningTopic' hazardous_materials: $ref: '#/components/schemas/PCIPlanningTopic' adjacent_land_use: $ref: '#/components/schemas/PCIPlanningTopic' access_and_traffic: $ref: '#/components/schemas/PCIPlanningTopic' working_hours_restrictions: $ref: '#/components/schemas/PCIPlanningTopic' security: $ref: '#/components/schemas/PCIPlanningTopic' environmental_constraints: $ref: '#/components/schemas/PCIPlanningTopic' unexploded_ordnance: $ref: '#/components/schemas/PCIPlanningTopic' PCIFileLog: type: array description: >- The pre-construction file log. Owned by the Client and Principal Designer. x-cdm-owner: client_and_principal_designer items: type: object additionalProperties: false required: - title properties: title: type: string minLength: 1 reference: type: - string - 'null' issued_on: type: - string - 'null' format: date notes: type: - string - 'null' 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 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 PreConstructionInformation: type: object description: >- The Client's Pre-Construction Information pack for a scheme. A scheme has at most one. required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string const: pre-construction-informations attributes: $ref: '#/components/schemas/PreConstructionInformationAttributes' relationships: $ref: '#/components/schemas/PreConstructionInformationRelationships' PreConstructionInformationIncludes: type: array description: >- Related resources that can be included with a pre-construction information items: discriminator: propertyName: type mapping: schemes: '#/components/schemas/Scheme' oneOf: - $ref: '#/components/schemas/Scheme' 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. `CH.003.080` (403) means the organisation in `meta.organisation_id` requires two-factor authentication and the caller's session does not satisfy it. The caller must set up or use a second factor, or sign in through their organisation's SAML single sign-on. Other OIDC sign-ins do not count. type: string examples: - AUTH.001 - CH.003.080 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 meta: description: >- A JSON object containing additional information about the error. When a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error. When `code` is `CH.003.080`, `organisation_id` names the organisation that requires two-factor authentication, which the caller's session does not satisfy. type: object properties: resource: type: string description: >- The resource a parameter error relates to, such as an unsupported include. organisation_id: type: string format: uuid examples: - c000c344-8847-47da-a091-32e75902d3b1 additionalProperties: true required: - id - status - title CDMContact: type: object description: A named person at a duty-holder. additionalProperties: false properties: name: type: - string - 'null' organisation: type: - string - 'null' phone: type: - string - 'null' email: type: - string - 'null' user_id: type: - string - 'null' format: uuid description: >- The user this contact is, when they have an account. The name is kept as written either way. organisation_id: type: - string - 'null' format: uuid description: >- The organisation this contact works for, when it is a party to the scheme. The name is kept as written either way. PCIPlanningTopic: type: object description: One planning topic. additionalProperties: false properties: relevant: type: - boolean - 'null' description: Whether the topic is relevant to this project. Null until answered. comments: type: - string - 'null' PreConstructionInformationAttributes: type: object description: > Attributes for a Pre-Construction Information pack. Each section declares the duty-holder role that owns it in `x-cdm-owner`. Every party reads the whole pack; only the owning role writes a section. required: - project_information - notifiability - notifiability_result - notification_due - f10_count - duty_holders - planning_information - file_log - hazard_sequence - attestations - current_revision - access - created_at - updated_at properties: project_information: $ref: '#/components/schemas/PCIProjectInformation' notifiability: $ref: '#/components/schemas/PCINotifiability' notifiability_result: $ref: '#/components/schemas/NotifiabilityResult' notification_due: type: boolean readOnly: true description: >- Whether the project is notifiable and no F10 has been recorded against it. f10_count: type: integer readOnly: true description: How many F10 notifications have been recorded against the pack. duty_holders: $ref: '#/components/schemas/PCIDutyHolders' planning_information: $ref: '#/components/schemas/PCIPlanningInformation' file_log: $ref: '#/components/schemas/PCIFileLog' hazard_sequence: type: integer readOnly: true description: The last hazard number issued on this pack. attestations: $ref: '#/components/schemas/CDMAttestations' current_revision: type: integer readOnly: true description: >- The latest revision's number, or 0 before handover. After handover every change goes through a proposed change. handed_over_at: type: - string - 'null' format: date-time readOnly: true access: $ref: '#/components/schemas/CDMAccess' created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PreConstructionInformationRelationships: type: object description: Relationships for a pre-construction information pack required: - organisation - scheme properties: organisation: type: object description: The organisation that owns the scheme. required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' scheme: type: object description: The scheme the pack is for. required: - data properties: data: $ref: '#/components/schemas/SchemeRelationship' principal_contractor: type: object description: >- The nominated Principal Contractor. Part of the duty_holders section, owned by the Client. properties: data: $ref: '#/components/schemas/OrganisationRelationship' media_folder: type: object description: The managed folder holding a folder per hazard. properties: data: $ref: '#/components/schemas/FolderRelationship' Scheme: type: object description: A scheme required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the scheme. type: type: string const: schemes attributes: $ref: '#/components/schemas/SchemeAttributes' meta: $ref: '#/components/schemas/SchemeMeta' relationships: $ref: '#/components/schemas/SchemeRelationships' NotifiabilityResult: type: object readOnly: true description: >- The CDM 2015 Reg 6 test applied to the pack's notifiability inputs, computed on every read. Limb one is more than 30 working days and more than 20 workers at the same time. Limb two is more than 500 person-days. Either limb met makes the project notifiable. Every threshold is exclusive. required: - outcome - limb_one - limb_two properties: outcome: $ref: '#/components/schemas/NotifiabilityOutcome' limb_one: $ref: '#/components/schemas/NotifiabilityLimb' limb_two: $ref: '#/components/schemas/NotifiabilityLimb' CDMAttestations: type: array readOnly: true description: Every sign-off of the document's sections, oldest first. items: $ref: '#/components/schemas/CDMAttestation' CDMAccess: type: object readOnly: true description: > The caller's standing on this document, resolved from live data on the request. A client uses it to decide which sections to offer for editing, rather than inferring ownership. required: - acting_role - writable_sections - owned_sections - can_hand_over - can_propose_changes properties: acting_role: $ref: '#/components/schemas/CDMRole' writable_sections: type: array description: >- The sections the caller may write directly now. Empty once the document has been handed over. items: type: string owned_sections: type: array description: The sections the caller's role owns, and so may sign off. items: type: string can_hand_over: type: boolean description: Whether the caller may hand the document over now. can_propose_changes: type: boolean description: >- Whether the caller may propose changes. True for the Client and the Principal Contractor once the document has been handed over. FolderRelationship: type: object description: Represents a relationship to a folder required: - id - type properties: id: type: string format: uuid description: The unique identifier of the folder type: type: string const: folders SchemeAttributes: type: object description: Attributes for a scheme required: - name - status properties: name: type: string status: $ref: '#/components/schemas/LifecycleStatus' code: type: string description: type: string dates: type: object properties: anticipated: type: object properties: start: type: string format: date-time end: type: string format: date-time labels: type: array items: $ref: '#/components/schemas/Label' SchemeMeta: type: object description: Metadata for a scheme required: - created_at - updated_at - from_template - modified_at - dates - completeness - counts - is_default properties: created_at: type: string format: date-time updated_at: type: string format: date-time modified_at: type: string format: date-time imported_at: type: string format: date-time from_template: description: Whether this scheme was created from a template. type: boolean dates: type: object properties: scheduled: type: object properties: start: type: string format: date-time end: type: string format: date-time counts: type: object properties: operations: type: integer description: >- The number of operations in this scheme (from all of the work orders). format: int64 minimum: 0 default: 0 permits: type: integer description: >- The number of permits in this scheme (from all of the operations in all of the work orders). format: int64 minimum: 0 default: 0 properties: type: integer description: >- The number of properties in this scheme (from all of the operations in all of the work orders). format: int64 minimum: 0 default: 0 locations: type: integer description: >- The number of organisation-managed locations in this scheme (from all of the operations in all of the work orders) format: int64 minimum: 0 default: 0 streets: type: integer description: >- The number of streets in this scheme (from all of the operations in all of the work orders). format: int64 minimum: 0 default: 0 work_orders: type: integer description: The number of work orders in this scheme. format: int64 minimum: 0 default: 0 completeness: type: object required: - counts - percentage - statuses - done_reasons properties: percentage: type: object required: - completed - aborted - unknown - cancelled properties: completed: type: number minimum: 0 maximum: 100 default: 0 aborted: type: number minimum: 0 maximum: 100 default: 0 unknown: type: number minimum: 0 maximum: 100 default: 100 cancelled: type: number minimum: 0 maximum: 100 default: 0 counts: type: object required: - completed - aborted - unknown - cancelled properties: completed: type: integer minimum: 0 default: 0 aborted: type: integer minimum: 0 default: 0 unknown: type: integer minimum: 0 default: 1 cancelled: type: integer minimum: 0 default: 0 statuses: type: object required: - counts - percentages properties: counts: type: object required: - done - in_progress - todo properties: done: type: integer minimum: 0 default: 0 in_progress: type: integer minimum: 0 default: 0 todo: type: integer minimum: 0 default: 0 percentages: type: object required: - done - in_progress - todo properties: done: type: number minimum: 0 maximum: 100 default: 0 in_progress: type: number minimum: 0 maximum: 100 default: 0 todo: type: number minimum: 0 maximum: 100 default: 0 done_reasons: type: object required: - counts - percentages properties: counts: type: object required: - aborted - cancelled - completed properties: aborted: type: integer minimum: 0 default: 0 cancelled: type: integer minimum: 0 default: 0 completed: type: integer minimum: 0 default: 0 percentages: type: object required: - aborted - cancelled - completed properties: aborted: type: number minimum: 0 maximum: 100 default: 0 cancelled: type: number minimum: 0 maximum: 100 default: 0 completed: type: number minimum: 0 maximum: 100 default: 0 is_default: type: boolean default: false SchemeRelationships: type: object description: Relationships for a scheme required: - organisation properties: scheme_template: type: object required: - data properties: data: $ref: '#/components/schemas/SchemeTemplateRelationship' work_orders: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/WorkOrderRelationship' template: type: object required: - data properties: data: $ref: '#/components/schemas/SchemeTemplateRelationship' site_managers: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserRelationship' assignees: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' folder: type: object required: - data properties: data: $ref: '#/components/schemas/FolderRelationship' contracts: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/SchemeContractRelationship' locations: type: object description: > The organisation-managed locations this scheme's work is against, aggregated from the operations beneath it. Read-only here: the relationship is owned by the operation. required: - data properties: data: type: array items: $ref: '#/components/schemas/LocationRelationship' created_by_user: type: object description: > The user who created this scheme. Absent when it was created by a service account or by a v2 subscriber, and on every scheme created before the creator was recorded. Set by the server. required: - data properties: data: $ref: '#/components/schemas/UserRelationship' created_by_service_account: type: object description: > The service account that created this scheme. Absent when it was created by a user or by a v2 subscriber, and on every scheme created before the creator was recorded. Set by the server. required: - data properties: data: $ref: '#/components/schemas/ServiceAccountRelationship' NotifiabilityOutcome: type: string description: >- Unknown means an input the result depends on has not been given. It never means not notifiable. enum: - notifiable - not_notifiable - unknown NotifiabilityLimb: type: object description: One limb of the notifiability test, and the inputs it used. required: - outcome properties: outcome: $ref: '#/components/schemas/NotifiabilityOutcome' working_days: type: - integer - 'null' peak_workers: type: - integer - 'null' person_days: type: - integer - 'null' CDMAttestation: type: object description: > A sign-off of one section. Every field is derived on the server from the authenticated request, and none is accepted from a client. required: - section - acting_role - attested_at - attested_by_type - attested_by_id - revision properties: section: type: string description: The section that was signed off. acting_role: $ref: '#/components/schemas/CDMRole' organisation_id: type: string format: uuid description: The organisation the principal acted for. attested_at: type: string format: date-time attested_by_type: type: string enum: - users - service-accounts description: >- Whether a user or a service account signed it off. A client shows the two differently. attested_by_id: type: string format: uuid revision: type: integer description: >- The document's revision when the section was signed off. 0 means before handover. CDMRole: type: string description: > A CDM 2015 duty-holder role on a scheme. The scheme owner is the Client and Principal Designer. The organisation nominated on the Pre-Construction Information is the Principal Contractor. Any other organisation the scheme is shared with is a reader. enum: - client_and_principal_designer - principal_contractor - reader LifecycleStatus: type: string description: > The lifecycle status of a contract, scheme or work order. - `in_planning`: work is being scoped and prepared; nothing is underway yet - `in_progress`: work is actively underway - `on_hold`: work has been paused and is expected to resume - `complete`: all work has been finished Any status may move to any other status; there are no restricted transitions. Resources created before this field existed, and resources created through the API, both start as `in_planning`. This is distinct from the operation status rollups under `meta`, which are derived from child operations and describe progress rather than intent. enum: - in_planning - in_progress - on_hold - complete 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 SchemeTemplateRelationship: type: object description: Represents a relationship to a scheme template required: - id - type properties: id: type: string format: uuid description: The unique identifier of the scheme template type: type: string const: scheme-templates 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 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 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 SchemeContractRelationship: type: object description: Represents a relationship to a scheme contract required: - id - type properties: id: type: string format: uuid description: The unique identifier of the scheme contract type: type: string const: scheme-contracts LocationRelationship: type: object description: Represents a relationship to a location required: - id - type properties: id: type: string format: uuid description: The unique identifier of the location type: type: string const: locations ServiceAccountRelationship: type: object description: Represents a relationship to a service account required: - id - type properties: id: type: string format: uuid description: The unique identifier of the service account type: type: string const: service-accounts 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.