{
"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"
}
{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}
{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}
{
"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"
}
{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}
{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}
The equipment item to create. reference, serial and asset_number are all
required. asset_number must be unique within the organisation; duplicate
serial values within the same organisation are allowed.
manufacturer and model are both optional, but if model is supplied with a
non-null data then manufacturer MUST also be supplied with a non-null data
and the model must belong to that manufacturer.
Related resources that can be included when an equipment item is returned.
An equipment manufacturer
Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ctrl Hub","colors":{"primary":"#051737","light":"#2B66FF","dark":"#2B66FF"},"logo":{"light":"https://mintcdn.com/ctrlhub-2ae4bef7/PIDSeF8_-LaiA-F2/logo/light.svg?fit=max\u0026auto=format\u0026n=PIDSeF8_-LaiA-F2\u0026q=85\u0026s=042271625d0e2e8a33fea01ac79f26b9","dark":"https://mintcdn.com/ctrlhub-2ae4bef7/PIDSeF8_-LaiA-F2/logo/dark.svg?fit=max\u0026auto=format\u0026n=PIDSeF8_-LaiA-F2\u0026q=85\u0026s=aecc6afe5673b3c768a2c6b92b601480"},"favicon":"https://mintcdn.com/ctrlhub-2ae4bef7/PIDSeF8_-LaiA-F2/favicon.svg?fit=max\u0026auto=format\u0026n=PIDSeF8_-LaiA-F2\u0026q=85\u0026s=94d5b7711b223480a20becc82908a635","styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ctrlhub-2ae4bef7","hasAudioNarration":false,"actualSubdomain":"ctrlhub-2ae4bef7","customDomains":["docs.ctrl-hub.com"],"gitSource":{"type":"github","owner":"ctrl-hub","repo":"doc.public","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb8b9b4f52b64814ba5d93","collectionId":"287bcde0-c276-4d80-869b-74fbe6bff7fe","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb8b9b4f52b64814ba5d93"},"entitlements":{},"buildId":"6adb8b9b4f52b64814ba5d93","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":755},{"language":"default","tag":"Equipment","count":69},{"language":"default","tag":"Vehicles","count":69},{"language":"default","tag":"Qualifications","count":47},{"language":"default","tag":"Operations","count":35},{"language":"default","tag":"Costs","count":32},{"language":"default","tag":"Pre-Construction Information","count":24},{"language":"default","tag":"Workforce","count":23},{"language":"default","tag":"Guides","count":22},{"language":"default","tag":"Construction Phase Plans","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/equipment/create-a-new-equipment-item","slug":"/api-reference/equipment/create-a-new-equipment-item","pageMetadata":{"title":"Create an equipment item","description":"Create a new equipment item for an organisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-items","href":"/api-reference/equipment/create-a-new-equipment-item","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new equipment item for an organisation.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an equipment item","description":"Create a new equipment item for an organisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-items","href":"/api-reference/equipment/create-a-new-equipment-item","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a new equipment item for an organisation.","operationId":"CreateEquipmentItem","requestBody":"e90f2799-fda6-40e0-8756-640948cd8588","responses":{"201":"9c8da775-ede3-4b69-81fd-39fe2942c9c2","400":"a3060c6a-9443-43bf-aa5a-56402d4f0ede","401":"d03bf6ec-5dd9-4e55-8578-f064f326c91e","409":"9c571eaf-9008-4c60-87c7-61cd03b375ea","500":"e2107e4c-eec5-4f55-8590-cc07ef1de93d"},"security":["12391aeb-d50e-4378-ab82-ecce386d3f1f","fddd13ee-2386-4cb1-9525-21e84c239a08","174b2481-2604-4193-a8c8-a6a8dfe3b576"],"summary":"Create a new equipment item","tags":["Equipment"],"x-ctrl-hub":{"domain":"equipment"},"x-mint":{"metadata":{"title":"Create an equipment item"}},"method":"post","type":"path","servers":["3be900a1-8516-4b10-a38f-14b0ab73163f","a989bcaa-3778-4fd2-90b1-101bcec8a7c2","e001bbe3-f76d-456b-b481-b2f8b4ff5843"],"path":"/v3/equipment-items","baseUrlOptions":["https://api.ctrl-hub.com","https://api.ctrl-hub.dev","https://api.ctrl-hub.run"],"title":"Create a new equipment item","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"description":"The equipment item to create. `reference`, `serial` and `asset_number` are all\nrequired. `asset_number` must be unique within the organisation; duplicate\n`serial` values within the same organisation are allowed.\n`manufacturer` and `model` are both optional, but if `model` is supplied with a\nnon-null `data` then `manufacturer` MUST also be supplied with a non-null `data`\nand the model must belong to that manufacturer.\n","content":{"application/vnd.api+json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","const":"equipment-items","isRequired":true,"uniqueKey":"data.type","typeLabel":"string"},"attributes":{"type":"object","required":["reference","serial","asset_number"],"properties":{"reference":{"type":"string","minLength":1,"examples":["REF-001"],"isRequired":true,"uniqueKey":"data.attributes.reference","typeLabel":"string"},"serial":{"type":"string","minLength":1,"examples":["CH-001"],"isRequired":true,"uniqueKey":"data.attributes.serial","typeLabel":"string"},"asset_number":{"type":"string","minLength":1,"description":"A unique asset number for the equipment item (unique within the organisation).","examples":["A-12345"],"isRequired":true,"uniqueKey":"data.attributes.asset_number","typeLabel":"string"},"is_rented":{"type":"boolean","uniqueKey":"data.attributes.is_rented","typeLabel":"boolean"},"purchased_at":{"oneOf":[{"type":"string","format":"date","examples":["2024-01-15T00:00:00.000Z"],"uniqueKey":"data.attributes.purchased_at.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","examples":["2024-01-15T00:00:00.000Z"],"uniqueKey":"data.attributes.purchased_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.purchased_at","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.attributes.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.attributes","typeLabel":"object"},"relationships":{"type":"object","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"data.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.relationships.organisation","typeLabel":"object"},"manufacturer":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an equipment manufacturer","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment manufacturer","isRequired":true,"uniqueKey":"data.relationships.manufacturer.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-manufacturers","isRequired":true,"uniqueKey":"data.relationships.manufacturer.data.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"data.relationships.manufacturer.data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.relationships.manufacturer.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.manufacturer.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.manufacturer","typeLabel":"object"},"model":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an equipment model","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment model","isRequired":true,"uniqueKey":"data.relationships.model.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-models","isRequired":true,"uniqueKey":"data.relationships.model.data.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"data.relationships.model.data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.relationships.model.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.model.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.model","typeLabel":"object"},"business_area":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to a business area","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the business area","isRequired":true,"uniqueKey":"data.relationships.business_area.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"business-areas","isRequired":true,"uniqueKey":"data.relationships.business_area.data.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.business_area.data.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.relationships.business_area.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.business_area.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.business_area","typeLabel":"object"},"owner":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an owner","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the owner","isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"owners","isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.owner.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.owner","typeLabel":"object"},"status":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an equipment status","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment status","isRequired":true,"uniqueKey":"data.relationships.status.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-statuses","isRequired":true,"uniqueKey":"data.relationships.status.data.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"data.relationships.status.data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.relationships.status.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.status.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.status","typeLabel":"object"},"categories":{"type":"object","description":"The categories assigned directly to this item.","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an equipment category","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment category","isRequired":true,"uniqueKey":"data.relationships.categories.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-categories","isRequired":true,"uniqueKey":"data.relationships.categories.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.relationships.categories.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.relationships.categories.data","typeLabel":"object[]"}},"uniqueKey":"data.relationships.categories","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.relationships","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"type":"equipment-items","attributes":{"reference":"REF-001","serial":"CH-001","asset_number":"A-12345","is_rented":true,"purchased_at":"2024-01-15T00:00:00.000Z","description":"\u003cstring>"},"relationships":{"organisation":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"organisations"}},"manufacturer":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-manufacturers"}},"model":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-models"}},"status":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-statuses"}}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9c8da775-ede3-4b69-81fd-39fe2942c9c2":{"description":"Get a list of equipment in the organisation.","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"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","description":"JSON API response object","required":["jsonapi","data"],"properties":{"data":{"type":"object","description":"An equipment item","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment item.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-items","isRequired":true,"uniqueKey":"data.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for an equipment item","required":["reference","serial","asset_number"],"properties":{"reference":{"type":"string","description":"The reference for the equipment item.","examples":["REF-001"],"isRequired":true,"uniqueKey":"data.attributes.reference","typeLabel":"string"},"serial":{"type":"string","description":"The serial number of the equipment item.","examples":["CH-001"],"isRequired":true,"uniqueKey":"data.attributes.serial","typeLabel":"string"},"asset_number":{"type":"string","description":"The asset number for the equipment item (unique within the organisation).","examples":["A-12345"],"isRequired":true,"uniqueKey":"data.attributes.asset_number","typeLabel":"string"},"is_rented":{"type":"boolean","description":"Whether the equipment item is rented rather than owned.","uniqueKey":"data.attributes.is_rented","typeLabel":"boolean"},"purchased_at":{"oneOf":[{"type":"string","format":"date","description":"The date the equipment item was purchased (date only).","examples":["2024-01-15T00:00:00.000Z"],"uniqueKey":"data.attributes.purchased_at.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the equipment item was purchased (date only).","examples":["2024-01-15T00:00:00.000Z"],"uniqueKey":"data.attributes.purchased_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.purchased_at","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"type":"string","description":"An optional description of the equipment item.","uniqueKey":"data.attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional description of the equipment item.","uniqueKey":"data.attributes.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.description","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"The equipment item's status (e.g. active, retired, in-service).","uniqueKey":"data.attributes.status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The equipment item's status (e.g. active, retired, in-service).","uniqueKey":"data.attributes.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.status","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for an equipment item","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time when the equipment item was created","isRequired":true,"uniqueKey":"data.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the equipment item was last updated","isRequired":true,"uniqueKey":"data.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for an equipment item. `manufacturer` and `model` are both\noptional; if `model` is set then `manufacturer` is also set and the model\nbelongs to that manufacturer.\n","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"data.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.relationships.organisation","typeLabel":"object"},"manufacturer":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an equipment manufacturer","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment manufacturer","isRequired":true,"uniqueKey":"data.relationships.manufacturer.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-manufacturers","isRequired":true,"uniqueKey":"data.relationships.manufacturer.data.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"data.relationships.manufacturer.data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.relationships.manufacturer.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.manufacturer.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.manufacturer","typeLabel":"object"},"model":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an equipment model","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment model","isRequired":true,"uniqueKey":"data.relationships.model.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-models","isRequired":true,"uniqueKey":"data.relationships.model.data.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"data.relationships.model.data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.relationships.model.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.model.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.model","typeLabel":"object"},"business_area":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to a business area","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the business area","isRequired":true,"uniqueKey":"data.relationships.business_area.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"business-areas","isRequired":true,"uniqueKey":"data.relationships.business_area.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.business_area.data","typeLabel":"object"}},"uniqueKey":"data.relationships.business_area","typeLabel":"object"},"owner":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an owner","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the owner","isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"owners","isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.relationships.owner.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.owner.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.owner","typeLabel":"object"},"status":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to an equipment status","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment status","isRequired":true,"uniqueKey":"data.relationships.status.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-statuses","isRequired":true,"uniqueKey":"data.relationships.status.data.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.status.data.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.relationships.status.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.status.data","typeLabel":"object | null"}},"uniqueKey":"data.relationships.status","typeLabel":"object"},"categories":{"type":"object","description":"The categories assigned directly to this item.","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an equipment category","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment category","isRequired":true,"uniqueKey":"data.relationships.categories.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-categories","isRequired":true,"uniqueKey":"data.relationships.categories.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.relationships.categories.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.relationships.categories.data","typeLabel":"object[]"}},"uniqueKey":"data.relationships.categories","typeLabel":"object"},"inherited_categories":{"type":"object","readOnly":true,"description":"Read-only. The categories this item inherits from its model, copied onto the item when its model or model assignment changes. Not accepted on write.","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an equipment category","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment category","isRequired":true,"uniqueKey":"data.relationships.inherited_categories.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-categories","isRequired":true,"uniqueKey":"data.relationships.inherited_categories.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.relationships.inherited_categories.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.relationships.inherited_categories.data","typeLabel":"object[]"}},"uniqueKey":"data.relationships.inherited_categories","typeLabel":"object"},"certifications":{"type":"object","readOnly":true,"description":"Read-only. The certifications this item is required to hold (its required-certification list). Managed via the item's /relationships/certifications endpoints, not accepted on item write.","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an equipment certification","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment certification","isRequired":true,"uniqueKey":"data.relationships.certifications.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-certifications","isRequired":true,"uniqueKey":"data.relationships.certifications.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.relationships.certifications.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.relationships.certifications.data","typeLabel":"object[]"}},"uniqueKey":"data.relationships.certifications","typeLabel":"object"},"allocated_person":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.allocated_person.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"data.relationships.allocated_person.data.type","typeLabel":"string"}},"uniqueKey":"data.relationships.allocated_person.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_person.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_person.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.allocated_person.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.relationships.allocated_person.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.allocated_person","typeLabel":"object"},"allocated_scheme":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.allocated_scheme.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"schemes","isRequired":true,"uniqueKey":"data.relationships.allocated_scheme.data.type","typeLabel":"string"}},"uniqueKey":"data.relationships.allocated_scheme.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_scheme.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_scheme.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.allocated_scheme.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.relationships.allocated_scheme.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.allocated_scheme","typeLabel":"object"},"allocated_work_order":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.allocated_work_order.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"work-orders","isRequired":true,"uniqueKey":"data.relationships.allocated_work_order.data.type","typeLabel":"string"}},"uniqueKey":"data.relationships.allocated_work_order.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_work_order.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_work_order.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.allocated_work_order.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.relationships.allocated_work_order.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.allocated_work_order","typeLabel":"object"},"allocated_location":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.allocated_location.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"locations","isRequired":true,"uniqueKey":"data.relationships.allocated_location.data.type","typeLabel":"string"}},"uniqueKey":"data.relationships.allocated_location.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_location.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_location.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.allocated_location.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.relationships.allocated_location.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.allocated_location","typeLabel":"object"},"allocated_vehicle":{"type":"object","properties":{"data":{"type":"object","description":"Represents a relationship to a vehicle","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the vehicle","isRequired":true,"uniqueKey":"data.relationships.allocated_vehicle.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicles","isRequired":true,"uniqueKey":"data.relationships.allocated_vehicle.data.type","typeLabel":"string"}},"uniqueKey":"data.relationships.allocated_vehicle.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_vehicle.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"data.relationships.allocated_vehicle.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.allocated_vehicle.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.relationships.allocated_vehicle.meta","typeLabel":"object"}},"uniqueKey":"data.relationships.allocated_vehicle","typeLabel":"object"},"pre_allocations":{"type":"object","description":"Read-only. Planned pre-allocation reservations for the item.","readOnly":true,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.relationships.pre_allocations.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-item-pre-allocations","isRequired":true,"uniqueKey":"data.relationships.pre_allocations.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.relationships.pre_allocations.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.relationships.pre_allocations.data","typeLabel":"object[]"}},"uniqueKey":"data.relationships.pre_allocations","typeLabel":"object"},"folder":{"type":"object","description":"The equipment item's general documents root folder.","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"data.relationships.folder.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"folders","isRequired":true,"uniqueKey":"data.relationships.folder.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.folder.data","typeLabel":"object"}},"uniqueKey":"data.relationships.folder","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.relationships","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"jsonapi":{"type":"object","required":["version"],"properties":{"version":{"type":"string","description":"The version of the JSON API specification","examples":["1.0"],"isRequired":true,"uniqueKey":"jsonapi.version","typeLabel":"string"}},"isRequired":true,"uniqueKey":"jsonapi","typeLabel":"object"},"included":{"type":"array","description":"Related resources that can be included when an equipment item is returned.","items":{"oneOf":[{"type":"object","description":"An equipment manufacturer","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment manufacturer.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-manufacturers","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for an equipment manufacturer","required":["name"],"properties":{"name":{"type":"string","description":"The manufacturer name.","examples":["Festool"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for an equipment manufacturer","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for an equipment manufacturer","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.organisation","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"An equipment model","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment model.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-models","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for an equipment model","required":["name"],"properties":{"name":{"type":"string","description":"The model name.","examples":["TS 55 REQ-Plus"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"A short description of the model.","uniqueKey":"included.items.[INDEX].oneOf.1.attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short description of the model.","uniqueKey":"included.items.[INDEX].oneOf.1.attributes.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.description","typeLabel":"string | null"},"specification":{"oneOf":[{"type":"object","description":"Specification data, including HAVS-related vibration magnitude used by exposure calculations.","properties":{"vibration":{"type":"object","description":"Vibration magnitude exposed by the manufacturer for this model.","properties":{"magnitude":{"type":"number","description":"Vibration magnitude in m/s². Used as the source value for HAVS exposure calculations against this model.","examples":[2.7],"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.specification.oneOf.0.vibration.magnitude","typeLabel":"number"}},"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.specification.oneOf.0.vibration","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.specification.oneOf.0","typeLabel":"object"},{"type":"null","description":"Specification data, including HAVS-related vibration magnitude used by exposure calculations.","properties":{"vibration":{"type":"object","description":"Vibration magnitude exposed by the manufacturer for this model.","properties":{"magnitude":{"type":"number","description":"Vibration magnitude in m/s². Used as the source value for HAVS exposure calculations against this model.","examples":[2.7]}}}},"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.specification.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.specification","typeLabel":"object | null"},"documentation":{"type":"array","description":"Documentation links for this model.","items":{"type":"object","required":["name","link"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.documentation.items.[INDEX].name","typeLabel":"string"},"link":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.documentation.items.[INDEX].link","typeLabel":"string\u003curi>"},"description":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.1.attributes.documentation.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.documentation.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.documentation","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for an equipment model","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for an equipment model","required":["manufacturer","organisation"],"properties":{"manufacturer":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to an equipment manufacturer","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment manufacturer","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.manufacturer.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-manufacturers","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.manufacturer.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.manufacturer.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.manufacturer","typeLabel":"object"},"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.organisation","typeLabel":"object"},"categories":{"type":"object","description":"The categories assigned to this model. Its items inherit a copy of these categories.","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an equipment category","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment category","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.categories.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-categories","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.categories.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.categories.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.categories.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.categories","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"An organisation","required":["id","type","attributes","meta"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the organisation.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for an organisation","required":["name","slug","sandbox"],"properties":{"name":{"type":"string","description":"The name of the organisation.","examples":["Acme Construction Ltd"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.name","typeLabel":"string"},"slug":{"type":"string","description":"The URL-friendly identifier for the organisation.","examples":["acme-construction"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.slug","typeLabel":"string"},"sandbox":{"type":"boolean","description":"Whether the organisation is a sandbox (i.e. a test organisation)","examples":[false],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.sandbox","typeLabel":"boolean"},"description":{"type":"string","description":"A short description of the organisation.","examples":["Leading construction company specializing in infrastructure projects"],"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.description","typeLabel":"string"},"settings":{"type":"object","properties":{"teams":{"type":"object","description":"Team-related settings for the organisation.","properties":{"customer_representatives":{"type":"array","description":"IDs of teams within this organisation whose members act as\ncustomer service representatives. Each entry must reference a\nteam that belongs to this organisation.\n","items":{"type":"string","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.2.attributes.settings.teams.customer_representatives.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueItems":true,"examples":[["b234c567-8901-2345-6789-abcdef012345"]],"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.settings.teams.customer_representatives","typeLabel":"string\u003cuuid>[]"}},"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.settings.teams","typeLabel":"object"},"security":{"type":"object","description":"Security settings for the organisation.","properties":{"require_mfa":{"type":"boolean","description":"Whether people must use a second factor to see this organisation's data:\nits members, and anyone working in it through a grant without being a\nmember, such as a contractor. A SAML single sign-on sign-in counts as\none; other OIDC sign-ins do not. Service accounts are exempt.\n","examples":[false],"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.settings.security.require_mfa","typeLabel":"boolean"}},"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.settings.security","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.settings","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Meta information for an organisation","required":["v3","status"],"properties":{"v3":{"type":"boolean","description":"Whether the organisation is using version 3 exclusively.","examples":[true],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.meta.v3","typeLabel":"boolean"},"status":{"type":"string","enum":["active","inactive"],"default":"active","description":"The current status of the organisation.","examples":["active"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.meta.status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the organisation.","examples":["2023-01-15T10:30:00.000Z"],"uniqueKey":"included.items.[INDEX].oneOf.2.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The last update time of the organisation.","examples":["2023-02-20T14:45:00.000Z"],"uniqueKey":"included.items.[INDEX].oneOf.2.meta.updated_at","typeLabel":"string\u003cdate-time>"},"features":{"type":"array","description":"Available features and their limits for the organisation.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the feature.","examples":["advanced_reporting"],"uniqueKey":"included.items.[INDEX].oneOf.2.meta.features.items.[INDEX].name","typeLabel":"string"},"enabled":{"type":"boolean","description":"Whether the feature is enabled.","examples":[true],"uniqueKey":"included.items.[INDEX].oneOf.2.meta.features.items.[INDEX].enabled","typeLabel":"boolean"},"limit":{"type":"integer","description":"The usage limit for this feature (if applicable).","examples":[1000],"uniqueKey":"included.items.[INDEX].oneOf.2.meta.features.items.[INDEX].limit","typeLabel":"integer"}},"uniqueKey":"included.items.[INDEX].oneOf.2.meta.features.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.items.[INDEX].oneOf.2.meta.features","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for an organisation","properties":{"users":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.users.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.users.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.users.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.users.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.users","typeLabel":"object"},"service_accounts":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.service_accounts.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"service-accounts","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.service_accounts.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.service_accounts.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.service_accounts.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.service_accounts","typeLabel":"object"},"groups":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to a group","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the group","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.groups.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"groups","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.groups.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.groups.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.groups.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.groups","typeLabel":"object"},"teams":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.teams.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"teams","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.teams.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.teams.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.teams.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.teams","typeLabel":"object"},"nomenclature":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to a nomenclature resource","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the nomenclature resource","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.nomenclature.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"nomenclature","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.nomenclature.data.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.nomenclature.data.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.nomenclature.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.nomenclature.data","typeLabel":"object | null"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.nomenclature","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A user","required":["id","type","attributes"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the user.","examples":["123e4567-e89b-12d3-a456-426614174000"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for a user","required":["email","profile"],"properties":{"email":{"type":"string","format":"email","description":"The email address of the user.","examples":["john.doe@example.com"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.email","typeLabel":"string\u003cemail>"},"profile":{"type":"object","required":["work","personal","contact","address","settings"],"properties":{"work":{"type":"object","required":["occupation","cscs","eusr","start_date"],"properties":{"occupation":{"type":"string","description":"The occupation of the user.","examples":["Site Manager"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.work.occupation","typeLabel":"string"},"cscs":{"type":"string","description":"The CSCS card number of the user.","examples":["CSC123456"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.work.cscs","typeLabel":"string"},"eusr":{"type":"string","description":"The EUSR card number of the user.","examples":["EUR789123"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.work.eusr","typeLabel":"string"},"start_date":{"type":"string","format":"date","description":"The start date of the user's employment.","examples":["2020-03-01T00:00:00.000Z"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.work.start_date","typeLabel":"string\u003cdate>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.work","typeLabel":"object"},"personal":{"type":"object","required":["first_name","last_name","dob","username"],"properties":{"first_name":{"type":"string","description":"The first name of the user.","examples":["John"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.personal.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"The last name of the user.","examples":["Doe"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.personal.last_name","typeLabel":"string"},"dob":{"type":"string","format":"date","description":"The date of birth of the user.","examples":["1985-06-15T00:00:00.000Z"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.personal.dob","typeLabel":"string\u003cdate>"},"username":{"type":"string","description":"The username of the user.","examples":["johndoe"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.personal.username","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.personal","typeLabel":"object"},"contact":{"type":"object","required":["mobile","landline"],"properties":{"mobile":{"type":"string","description":"The mobile number of the user.","examples":["+44 7700 900123"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.contact.mobile","typeLabel":"string"},"landline":{"type":"string","description":"The landline of the user.","examples":["+44 20 7946 0958"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.contact.landline","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.contact","typeLabel":"object"},"address":{"type":"object","required":["name","number","street","area","town","county","postcode","country_code","what3words"],"properties":{"name":{"type":"string","description":"Building or location name","examples":["Tech Tower"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.name","typeLabel":"string"},"number":{"type":"string","description":"The house number of the user's address.","default":"","examples":["42"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.number","typeLabel":"string"},"street":{"type":"string","description":"The street of the user's address.","examples":["High Street"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.street","typeLabel":"string"},"area":{"type":"string","description":"The area of the user's address.","examples":["Westminster"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.area","typeLabel":"string"},"town":{"type":"string","description":"The town of the user's address.","examples":["London"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.town","typeLabel":"string"},"county":{"type":"string","description":"The county of the user's address.","examples":["Greater London"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.county","typeLabel":"string"},"postcode":{"type":"string","description":"The postcode of the user's address.","examples":["SW1A 1AA"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.postcode","typeLabel":"string"},"country_code":{"type":"string","description":"The country code of the user's address.","examples":["GB"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.country_code","typeLabel":"string"},"what3words":{"type":"string","description":"The what3words location of the user's address.","examples":["filled.count.soap"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address.what3words","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.address","typeLabel":"object"},"settings":{"type":"object","required":["preferred_language","timezone"],"properties":{"preferred_language":{"type":"string","description":"The preferred language of the user.","default":"en-GB","examples":["en-GB"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.settings.preferred_language","typeLabel":"string"},"timezone":{"type":"string","description":"The timezone of the user.","examples":["Europe/London"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.settings.timezone","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile.settings","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.profile","typeLabel":"object"},"status":{"type":"string","enum":["active","inactive","pending","unknown"],"description":"The membership status of this user in the organisation in the request URL.\nOnly populated on org-scoped member endpoints; absent on global user\nendpoints.\n","examples":["active"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.status","typeLabel":"enum\u003cstring>"},"seat_class":{"type":"string","enum":["full","field","record"],"description":"The user's seat class in the organisation in the request URL. Only\npopulated on org-scoped member endpoints, like `status`; `memberships`\ncarries it everywhere.\n\n- `full`: a member who signs in and manages the organisation.\n- `field`: a member who signs in to capture data, usually on mobile.\n Nothing stops a field member using the console.\n- `record`: a member with no login who is never emailed. A record member\n can be the subject of competency records and organisation-level job\n roles, and cannot be assigned work.\n\nA membership stored before seat classes existed is `full`.\n","examples":["full"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.seat_class","typeLabel":"enum\u003cstring>"},"memberships":{"type":"array","description":"The user's membership of each organisation they belong to. A removed\nmembership is left out.\n","items":{"type":"object","required":["organisation","status","seat_class"],"properties":{"organisation":{"type":"string","format":"uuid","description":"The organisation's id.","examples":["2f1e5a4c-8b7d-4c3e-9a1f-6d5b4c3a2e10"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.memberships.items.[INDEX].organisation","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["active","inactive","pending","unknown"],"description":"The membership status in that organisation.","examples":["active"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.memberships.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"seat_class":{"type":"string","enum":["full","field","record"],"description":"The seat class in that organisation, as `seat_class` describes.","examples":["record"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.memberships.items.[INDEX].seat_class","typeLabel":"enum\u003cstring>"},"external_reference":{"type":"string","description":"The organisation's own reference for the member, such as a staff\nnumber. Absent when it has none.\n","examples":["GR-0042"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.memberships.items.[INDEX].external_reference","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.memberships.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.memberships","typeLabel":"object[]"},"password_set_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the user last set a password. Null if they never have, or if it is\nunknown because the user was created before this was tracked. Set by the\nserver; it cannot be written through the API.\n","examples":["2026-09-25T10:15:00.000Z"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.password_set_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the user last set a password. Null if they never have, or if it is\nunknown because the user was created before this was tracked. Set by the\nserver; it cannot be written through the API.\n","examples":["2026-09-25T10:15:00.000Z"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.password_set_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.password_set_at","typeLabel":"string\u003cdate-time> | null"},"mfa_enabled_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the user set up two-factor authentication with an authenticator app\n(TOTP). Null when they have none, including after they turn it off.\nRecovery codes on their own do not count. Set by the server from the\nidentity provider; it cannot be written through the API.\n","examples":["2026-10-06T09:30:00.000Z"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.mfa_enabled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the user set up two-factor authentication with an authenticator app\n(TOTP). Null when they have none, including after they turn it off.\nRecovery codes on their own do not count. Set by the server from the\nidentity provider; it cannot be written through the API.\n","examples":["2026-10-06T09:30:00.000Z"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.mfa_enabled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.mfa_enabled_at","typeLabel":"string\u003cdate-time> | null"},"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the identity.","examples":["39ce13b8-1116-416a-ad5f-3c5edfd44f53"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"platform":{"type":"string","description":"The platform of the identity.","examples":["multi_tenant"],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities.items.[INDEX].platform","typeLabel":"string"},"meta":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Additional metadata for the identity.","uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Additional metadata for the identity.","uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.items.[INDEX].oneOf.3.attributes.identities","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a user","properties":{"managed_type":{"type":"string","enum":["none","scim","organisation","unknown"],"description":"How this user is managed.","uniqueKey":"included.items.[INDEX].oneOf.3.meta.managed_type","typeLabel":"enum\u003cstring>"},"withheld_organisations":{"type":"array","description":"Returned on `/v3/whoami` only. The organisations whose access is withheld\nfrom this session, because each requires two-factor authentication and the\nsession does not satisfy it. This includes organisations the caller works in\nthrough a grant without being a member, such as a contractor in the owner's\norganisation. Absent when there are none. Requests to those organisations'\nroutes answer 403 with code `CH.003.080`.\n","items":{"type":"string","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.3.meta.withheld_organisations.items.[INDEX]","typeLabel":"string\u003cuuid>"},"examples":[["c000c344-8847-47da-a091-32e75902d3b1"]],"uniqueKey":"included.items.[INDEX].oneOf.3.meta.withheld_organisations","typeLabel":"string\u003cuuid>[]"},"reach":{"type":"string","enum":["direct","chain","secondary"],"description":"Returned on My people only. How the caller manages this person: `direct` when the caller\nis their primary manager, `chain` when the caller is a primary manager higher up their\nprimary chain, and `secondary` when the caller is one of their secondary managers.\n","uniqueKey":"included.items.[INDEX].oneOf.3.meta.reach","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.items.[INDEX].oneOf.3.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for a user","properties":{"organisations":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.organisations.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.organisations.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.organisations.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.organisations.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.organisations","typeLabel":"object"},"teams":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.teams.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"teams","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.teams.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.teams.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.teams.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.teams","typeLabel":"object"},"managing_organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.managing_organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.managing_organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.managing_organisation.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.3.relationships.managing_organisation","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.3.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"A scheme","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the scheme.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"schemes","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for a scheme","required":["name","status"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.name","typeLabel":"string"},"status":{"type":"string","description":"The lifecycle status of a contract, scheme or work order.\n\n- `in_planning`: work is being scoped and prepared; nothing is underway yet\n- `in_progress`: work is actively underway\n- `on_hold`: work has been paused and is expected to resume\n- `complete`: all work has been finished\n- `cancelled`: the work has been called off and will not go ahead\n\nAny status may move to any other status; there are no restricted\ntransitions. Resources created before this field existed, and resources\ncreated through the API, both start as `in_planning`.\n\nThis is distinct from the operation status rollups under `meta`, which are\nderived from child operations and describe progress rather than intent.\n","enum":["in_planning","in_progress","on_hold","complete","cancelled"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.4.attributes.code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.4.attributes.description","typeLabel":"string"},"dates":{"type":"object","properties":{"anticipated":{"type":"object","properties":{"start":{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.4.attributes.dates.anticipated.start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.4.attributes.dates.anticipated.end","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.dates.anticipated","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.dates","typeLabel":"object"},"labels":{"type":"array","items":{"type":"object","description":"A label object","required":["key","value"],"properties":{"key":{"type":"string","minLength":1,"examples":["Your label key"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.labels.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","examples":["Your label value"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.labels.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.labels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.items.[INDEX].oneOf.4.attributes.labels","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.attributes","typeLabel":"object"},"meta":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.updated_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.modified_at","typeLabel":"string\u003cdate-time>"},"from_template":{"description":"Whether this scheme was created from a template.","type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.from_template","typeLabel":"boolean"},"dates":{"type":"object","properties":{"scheduled":{"type":"object","properties":{"start":{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.4.meta.dates.scheduled.start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.4.meta.dates.scheduled.end","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"included.items.[INDEX].oneOf.4.meta.dates.scheduled","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.dates","typeLabel":"object"},"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,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts.operations","typeLabel":"integer\u003cint64>"},"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,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts.permits","typeLabel":"integer\u003cint64>"},"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,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts.properties","typeLabel":"integer\u003cint64>"},"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,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts.locations","typeLabel":"integer\u003cint64>"},"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,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts.streets","typeLabel":"integer\u003cint64>"},"work_orders":{"type":"integer","description":"The number of work orders in this scheme.","format":"int64","minimum":0,"default":0,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts.work_orders","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.counts","typeLabel":"object"},"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,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.percentage.completed","typeLabel":"number"},"aborted":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.percentage.aborted","typeLabel":"number"},"unknown":{"type":"number","minimum":0,"maximum":100,"default":100,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.percentage.unknown","typeLabel":"number"},"cancelled":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.percentage.cancelled","typeLabel":"number"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.percentage","typeLabel":"object"},"counts":{"type":"object","required":["completed","aborted","unknown","cancelled"],"properties":{"completed":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.counts.completed","typeLabel":"integer"},"aborted":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.counts.aborted","typeLabel":"integer"},"unknown":{"type":"integer","minimum":0,"default":1,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.counts.unknown","typeLabel":"integer"},"cancelled":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.counts.cancelled","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.counts","typeLabel":"object"},"statuses":{"type":"object","required":["counts","percentages"],"properties":{"counts":{"type":"object","required":["done","in_progress","todo"],"properties":{"done":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.counts.done","typeLabel":"integer"},"in_progress":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.counts.in_progress","typeLabel":"integer"},"todo":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.counts.todo","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.counts","typeLabel":"object"},"percentages":{"type":"object","required":["done","in_progress","todo"],"properties":{"done":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.percentages.done","typeLabel":"number"},"in_progress":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.percentages.in_progress","typeLabel":"number"},"todo":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.percentages.todo","typeLabel":"number"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses.percentages","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.statuses","typeLabel":"object"},"done_reasons":{"type":"object","required":["counts","percentages"],"properties":{"counts":{"type":"object","required":["aborted","cancelled","completed"],"properties":{"aborted":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.counts.aborted","typeLabel":"integer"},"cancelled":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.counts.cancelled","typeLabel":"integer"},"completed":{"type":"integer","minimum":0,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.counts.completed","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.counts","typeLabel":"object"},"percentages":{"type":"object","required":["aborted","cancelled","completed"],"properties":{"aborted":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.percentages.aborted","typeLabel":"number"},"cancelled":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.percentages.cancelled","typeLabel":"number"},"completed":{"type":"number","minimum":0,"maximum":100,"default":0,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.percentages.completed","typeLabel":"number"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons.percentages","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness.done_reasons","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.completeness","typeLabel":"object"},"is_default":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta.is_default","typeLabel":"boolean"},"imported_at":{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.4.meta.imported_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for a scheme","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.organisation","typeLabel":"object"},"scheme_template":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.scheme_template.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"scheme-templates","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.scheme_template.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.scheme_template.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.scheme_template","typeLabel":"object"},"work_orders":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.work_orders.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"work-orders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.work_orders.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.work_orders.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.work_orders.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.work_orders","typeLabel":"object"},"template":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.template.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"scheme-templates","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.template.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.template.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.template","typeLabel":"object"},"site_managers":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.site_managers.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.site_managers.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.site_managers.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.site_managers.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.site_managers","typeLabel":"object"},"assignees":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.assignees.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.assignees.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.assignees.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.assignees.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.assignees","typeLabel":"object"},"teams":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.teams.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"teams","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.teams.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.teams.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.teams.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.teams","typeLabel":"object"},"folder":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.folder.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"folders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.folder.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.folder.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.folder","typeLabel":"object"},"contracts":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.contracts.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"scheme-contracts","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.contracts.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.contracts.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.contracts.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.contracts","typeLabel":"object"},"locations":{"type":"object","description":"The organisation-managed locations this scheme's work is against, aggregated\nfrom the operations beneath it. Read-only here: the relationship is owned by\nthe operation.\n","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.locations.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"locations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.locations.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.locations.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.locations.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.locations","typeLabel":"object"},"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\nsubscriber, and on every scheme created before the creator was recorded. Set by the server.\n","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_user.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_user.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_user.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_user","typeLabel":"object"},"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\nsubscriber, and on every scheme created before the creator was recorded. Set by the server.\n","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_service_account.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"service-accounts","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_service_account.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_service_account.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4.relationships.created_by_service_account","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.4.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"A work order","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the work order.","examples":["fb082ee5-b678-4451-b02b-8269aaf262a3"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"work-orders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for a work order","required":["name","status"],"properties":{"name":{"type":"string","description":"The name of the work order","examples":["Infrastructure Maintenance Work Order"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.name","typeLabel":"string"},"status":{"type":"string","description":"The lifecycle status of a contract, scheme or work order.\n\n- `in_planning`: work is being scoped and prepared; nothing is underway yet\n- `in_progress`: work is actively underway\n- `on_hold`: work has been paused and is expected to resume\n- `complete`: all work has been finished\n- `cancelled`: the work has been called off and will not go ahead\n\nAny status may move to any other status; there are no restricted\ntransitions. Resources created before this field existed, and resources\ncreated through the API, both start as `in_planning`.\n\nThis is distinct from the operation status rollups under `meta`, which are\nderived from child operations and describe progress rather than intent.\n","enum":["in_planning","in_progress","on_hold","complete","cancelled"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"The code of the work order","examples":["WO-2025-001"],"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.code","typeLabel":"string"},"description":{"type":"string","description":"The description of the work order","examples":["Routine maintenance and inspection of electrical infrastructure"],"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.description","typeLabel":"string"},"dates":{"type":"object","description":"The dates associated with the work order","properties":{"anticipated":{"type":"object","description":"The anticipated start and end dates","properties":{"start":{"type":"string","format":"date-time","description":"The anticipated start date","examples":["2025-08-01T09:00:00Z"],"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.dates.anticipated.start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","description":"The anticipated end date","examples":["2025-08-15T17:00:00Z"],"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.dates.anticipated.end","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.dates.anticipated","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.dates","typeLabel":"object"},"labels":{"type":"array","description":"The labels associated with the work order","items":{"type":"object","description":"A label object","required":["key","value"],"properties":{"key":{"type":"string","minLength":1,"examples":["Your label key"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.labels.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","examples":["Your label value"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.labels.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.labels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.items.[INDEX].oneOf.5.attributes.labels","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a work order","required":["created_at","updated_at","modified_at","counts","dates","completeness"],"properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time when the work order was created","examples":["2025-05-06T18:37:12Z"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the work order was last updated","examples":["2025-05-07T21:12:46Z"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.updated_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","description":"The date and time when the work order was last modified","examples":["2025-05-07T21:12:46Z"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.modified_at","typeLabel":"string\u003cdate-time>"},"dates":{"type":"object","description":"The scheduled dates for the work order","properties":{"scheduled":{"type":"object","description":"The scheduled start and end dates","properties":{"start":{"type":"string","format":"date-time","description":"The scheduled start date","examples":["2025-08-01T09:00:00Z"],"uniqueKey":"included.items.[INDEX].oneOf.5.meta.dates.scheduled.start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","description":"The scheduled end date","examples":["2025-08-15T17:00:00Z"],"uniqueKey":"included.items.[INDEX].oneOf.5.meta.dates.scheduled.end","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"included.items.[INDEX].oneOf.5.meta.dates.scheduled","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.dates","typeLabel":"object"},"counts":{"type":"object","description":"The counts of related entities","required":["operations","properties","locations","streets"],"properties":{"operations":{"type":"integer","description":"The number of operations in this work order","format":"int64","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.counts.operations","typeLabel":"integer\u003cint64>"},"streets":{"type":"integer","description":"The number of streets in this work order (from all of the operations in this work order)","format":"int64","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.counts.streets","typeLabel":"integer\u003cint64>"},"properties":{"type":"integer","description":"The number of properties in this work order (from all of the operations in this work order)","format":"int64","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.counts.properties","typeLabel":"integer\u003cint64>"},"locations":{"type":"integer","description":"The number of organisation-managed locations in this work order (from all of the operations in this work order)","format":"int64","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.counts.locations","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.counts","typeLabel":"object"},"completeness":{"type":"object","description":"The completeness statistics for the work order","required":["percentage","counts","statuses","done_reasons"],"properties":{"percentage":{"type":"object","description":"The percentage breakdown of completion status","required":["completed","aborted","unknown","cancelled"],"properties":{"completed":{"type":"number","minimum":0,"maximum":100,"default":0,"description":"The percentage of completed operations","examples":[25],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.percentage.completed","typeLabel":"number"},"aborted":{"type":"number","minimum":0,"maximum":100,"default":0,"description":"The percentage of aborted operations","examples":[0],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.percentage.aborted","typeLabel":"number"},"unknown":{"type":"number","minimum":0,"maximum":100,"default":0,"description":"The percentage of operations with unknown status","examples":[75],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.percentage.unknown","typeLabel":"number"},"cancelled":{"type":"number","minimum":0,"maximum":100,"default":0,"description":"The percentage of cancelled operations","examples":[0],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.percentage.cancelled","typeLabel":"number"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.percentage","typeLabel":"object"},"counts":{"type":"object","description":"The count breakdown of completion status","required":["completed","aborted","unknown","cancelled"],"properties":{"completed":{"type":"integer","minimum":0,"default":0,"description":"The number of completed operations","examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.counts.completed","typeLabel":"integer"},"aborted":{"type":"integer","minimum":0,"default":0,"description":"The number of aborted operations","examples":[0],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.counts.aborted","typeLabel":"integer"},"unknown":{"type":"integer","minimum":0,"default":0,"description":"The number of operations with unknown status","examples":[3],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.counts.unknown","typeLabel":"integer"},"cancelled":{"type":"integer","minimum":0,"default":0,"description":"The number of cancelled operations","examples":[0],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.counts.cancelled","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.counts","typeLabel":"object"},"statuses":{"type":"object","required":["counts","percentages"],"properties":{"counts":{"type":"object","required":["done","in_progress","todo"],"properties":{"done":{"type":"integer","minimum":0,"default":0,"examples":[3],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.counts.done","typeLabel":"integer"},"in_progress":{"type":"integer","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.counts.in_progress","typeLabel":"integer"},"todo":{"type":"integer","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.counts.todo","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.counts","typeLabel":"object"},"percentages":{"type":"object","required":["done","in_progress","todo"],"properties":{"done":{"type":"number","minimum":0,"maximum":100,"default":0,"examples":[60],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.percentages.done","typeLabel":"number"},"in_progress":{"type":"number","minimum":0,"maximum":100,"default":0,"examples":[20],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.percentages.in_progress","typeLabel":"number"},"todo":{"type":"number","minimum":0,"maximum":100,"default":0,"examples":[20],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.percentages.todo","typeLabel":"number"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses.percentages","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.statuses","typeLabel":"object"},"done_reasons":{"type":"object","required":["counts","percentages"],"properties":{"counts":{"type":"object","required":["aborted","cancelled","completed"],"properties":{"aborted":{"type":"integer","minimum":0,"default":0,"examples":[1],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.counts.aborted","typeLabel":"integer"},"cancelled":{"type":"integer","minimum":0,"default":0,"examples":[2],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.counts.cancelled","typeLabel":"integer"},"completed":{"type":"integer","minimum":0,"default":0,"examples":[2],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.counts.completed","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.counts","typeLabel":"object"},"percentages":{"type":"object","required":["aborted","cancelled","completed"],"properties":{"aborted":{"type":"number","minimum":0,"maximum":100,"default":0,"examples":[20],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.percentages.aborted","typeLabel":"number"},"cancelled":{"type":"number","minimum":0,"maximum":100,"default":0,"examples":[40],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.percentages.cancelled","typeLabel":"number"},"completed":{"type":"number","minimum":0,"maximum":100,"default":0,"examples":[40],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.percentages.completed","typeLabel":"number"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons.percentages","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness.done_reasons","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta.completeness","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for a work order","required":["organisation","scheme","operations"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.organisation","typeLabel":"object"},"scheme":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.scheme.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"schemes","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.scheme.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.scheme.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.scheme","typeLabel":"object"},"operations":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an operation","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the operation","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.operations.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"operations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.operations.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.operations.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.operations.data","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.operations","typeLabel":"object"},"assignees":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.assignees.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.assignees.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.assignees.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.assignees.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.assignees","typeLabel":"object"},"teams":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.teams.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"teams","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.teams.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.teams.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.teams.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.teams","typeLabel":"object"},"template":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to a work order template","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the work order template","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.template.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"work-order-templates","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.template.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.template.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.template","typeLabel":"object"},"site_managers":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.site_managers.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.site_managers.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.site_managers.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.site_managers.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.site_managers","typeLabel":"object"},"folder":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.folder.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"folders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.folder.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.folder.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.folder","typeLabel":"object"},"locations":{"type":"object","description":"The organisation-managed locations this work order's work is against, aggregated\nfrom the operations beneath it. Read-only here: the relationship is owned by\nthe operation.\n","required":["data"],"properties":{"data":{"type":"array","items":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.locations.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"locations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.locations.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.locations.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.locations.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.locations","typeLabel":"object"},"created_by_user":{"type":"object","description":"The user who created this work order. Absent when it was created by a service account or by a v2\nsubscriber, and on every work order created before the creator was recorded. Set by the server.\n","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_user.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_user.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_user.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_user","typeLabel":"object"},"created_by_service_account":{"type":"object","description":"The service account that created this work order. Absent when it was created by a user or by a v2\nsubscriber, and on every work order created before the creator was recorded. Set by the server.\n","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_service_account.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"service-accounts","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_service_account.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_service_account.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.5.relationships.created_by_service_account","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.5.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","description":"A vehicle","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the vehicle.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicles","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for a vehicle","required":["registration"],"properties":{"registration":{"type":"string","description":"The vehicle's registration number (VRM). Stored uppercase with spaces stripped.","examples":["BX10GKJ"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.attributes.registration","typeLabel":"string"},"vin":{"oneOf":[{"type":"string","description":"The vehicle identification number.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.vin.oneOf.0","typeLabel":"string"},{"type":"null","description":"The vehicle identification number.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.vin.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.attributes.vin","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"A free-text description of the vehicle.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A free-text description of the vehicle.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.attributes.description","typeLabel":"string | null"},"colour":{"oneOf":[{"type":"string","description":"The vehicle's colour.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"The vehicle's colour.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.attributes.colour","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"The vehicle's status. A free-form string (e.g. active, off-road, retired, sorn). When the vehicle is SORN according to DVLA the status is automatically set to `sorn`.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The vehicle's status. A free-form string (e.g. active, off-road, retired, sorn). When the vehicle is SORN according to DVLA the status is automatically set to `sorn`.","uniqueKey":"included.items.[INDEX].oneOf.6.attributes.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.attributes.status","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a vehicle. Includes timestamps, derived counts, the rolled-up MOT/tax/SORN\nstatus from DVLA, the most recent inspection and inventory check references, and the\nfull DVLA payload.\n","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.meta.updated_at","typeLabel":"string\u003cdate-time>"},"sorn":{"type":"boolean","description":"Whether the vehicle is SORN according to DVLA.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.sorn","typeLabel":"boolean"},"has_recall":{"type":"boolean","description":"Whether DVLA reports an outstanding recall.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.has_recall","typeLabel":"boolean"},"last_odometer_reading":{"oneOf":[{"type":"integer","description":"The most recent odometer reading taken from MOT records.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.last_odometer_reading.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The most recent odometer reading taken from MOT records.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.last_odometer_reading.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.last_odometer_reading","typeLabel":"integer | null"},"counts":{"type":"object","properties":{"equipment":{"type":"integer","description":"Number of equipment items currently assigned.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.counts.equipment","typeLabel":"integer"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.counts","typeLabel":"object"},"mot":{"type":"object","description":"Rolled-up MOT status.","properties":{"is_valid":{"oneOf":[{"type":"boolean","description":"Derived validity; null when the expiry is unknown, false when expired.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.is_valid.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Derived validity; null when the expiry is unknown, false when expired.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.is_valid.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.is_valid","typeLabel":"boolean | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"The current MOT expiry date (latest MOT test), or null if unknown.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The current MOT expiry date (latest MOT test), or null if unknown.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.expires_at","typeLabel":"string\u003cdate-time> | null"},"due_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the vehicle's first MOT falls due, for a vehicle DVSA has never tested. Null once the vehicle has MOT history (use expires_at then), and null when DVLA holds no details. Kept separate from expires_at so a not-yet-due date is never fed into the risk band.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.due_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the vehicle's first MOT falls due, for a vehicle DVSA has never tested. Null once the vehicle has MOT history (use expires_at then), and null when DVLA holds no details. Kept separate from expires_at so a not-yet-due date is never fed into the risk band.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.due_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.due_at","typeLabel":"string\u003cdate-time> | null"},"risk":{"type":"string","enum":["none","low","medium","high","critical"],"description":"Platform risk band derived from the MOT expiry using fixed 30/20/10-day thresholds for low/medium/high; an expired MOT is critical.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.risk","typeLabel":"enum\u003cstring>"},"records":{"type":"integer","description":"Number of MOT records on file.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.records","typeLabel":"integer"},"last":{"type":"object","properties":{"at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last.at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last.id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot.last","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.mot","typeLabel":"object"},"tax":{"type":"object","description":"Rolled-up tax status.","properties":{"is_valid":{"oneOf":[{"type":"boolean","description":"Derived validity; null when the expiry is unknown, false when expired.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.is_valid.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Derived validity; null when the expiry is unknown, false when expired.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.is_valid.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.is_valid","typeLabel":"boolean | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"The current tax expiry date, or null if unknown or the vehicle is SORN.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The current tax expiry date, or null if unknown or the vehicle is SORN.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.expires_at","typeLabel":"string\u003cdate-time> | null"},"risk":{"type":"string","enum":["none","low","medium","high","critical"],"description":"Platform risk band derived from the tax expiry using fixed 30/20/10-day thresholds for low/medium/high; expired tax is critical.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.risk","typeLabel":"enum\u003cstring>"},"due":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.due.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.due.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax.due","typeLabel":"string | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.tax","typeLabel":"object"},"checks":{"type":"object","description":"Rolled-up inspection and inventory check references.","properties":{"inventory":{"type":"object","properties":{"count":{"type":"integer","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.count","typeLabel":"integer"},"last":{"type":"object","properties":{"at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last.at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last.id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory.last","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inventory","typeLabel":"object"},"inspection":{"type":"object","properties":{"count":{"type":"integer","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.count","typeLabel":"integer"},"last":{"type":"object","properties":{"at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last.at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last.id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection.last","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks.inspection","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.checks","typeLabel":"object"},"dvla":{"oneOf":[{"type":"object","description":"The full DVLA VES + MOT payload as last seen.","properties":{"mot":{"oneOf":[{"type":"object","properties":{"exists":{"type":"boolean","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.exists","typeLabel":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.last_sync.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.last_sync.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.last_sync","typeLabel":"string\u003cdate-time> | null"},"data":{"oneOf":[{"type":"object","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.make.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.make.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.make","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.model.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.model","typeLabel":"string | null"},"first_used":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.first_used.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.first_used.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.first_used","typeLabel":"string\u003cdate-time> | null"},"fuel_type":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.fuel_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.fuel_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.fuel_type","typeLabel":"string | null"},"colour":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.colour.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.colour","typeLabel":"string | null"},"registration_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.registration_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.registration_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.registration_date","typeLabel":"string\u003cdate-time> | null"},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.manufacture_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.manufacture_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.manufacture_date","typeLabel":"string\u003cdate-time> | null"},"engine_size":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.engine_size.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.engine_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.engine_size","typeLabel":"string | null"},"has_outstanding_recall":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.has_outstanding_recall.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.has_outstanding_recall.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.has_outstanding_recall","typeLabel":"string | null"},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.mot_test_due_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records.","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.mot_test_due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0.mot_test_due_date","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0.data","typeLabel":"object | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"exists":{"type":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"data":{"oneOf":[{"type":"object","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}}},{"type":"null","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}}}]}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.mot","typeLabel":"object | null"},"ves":{"oneOf":[{"type":"object","properties":{"exists":{"type":"boolean","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.exists","typeLabel":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.last_sync.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.last_sync.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.last_sync","typeLabel":"string\u003cdate-time> | null"},"data":{"oneOf":[{"type":"object","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.art_end_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.art_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.art_end_date","typeLabel":"string | null"},"co2_emissions":{"oneOf":[{"type":"integer","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.co2_emissions.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.co2_emissions.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.co2_emissions","typeLabel":"integer | null"},"colour":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.colour.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.colour","typeLabel":"string | null"},"date_of_last_v5c_issued":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.date_of_last_v5c_issued.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.date_of_last_v5c_issued.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.date_of_last_v5c_issued","typeLabel":"string | null"},"engine_capacity":{"oneOf":[{"type":"integer","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.engine_capacity.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.engine_capacity.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.engine_capacity","typeLabel":"integer | null"},"euro_status":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.euro_status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.euro_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.euro_status","typeLabel":"string | null"},"fuel_type":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.fuel_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.fuel_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.fuel_type","typeLabel":"string | null"},"make":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.make.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.make.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.make","typeLabel":"string | null"},"marked_for_export":{"oneOf":[{"type":"boolean","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.marked_for_export.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.marked_for_export.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.marked_for_export","typeLabel":"boolean | null"},"month_of_first_registration":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.month_of_first_registration.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.month_of_first_registration.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.month_of_first_registration","typeLabel":"string | null"},"mot_status":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.mot_status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.mot_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.mot_status","typeLabel":"string | null"},"real_driving_emissions":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.real_driving_emissions.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.real_driving_emissions.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.real_driving_emissions","typeLabel":"string | null"},"registration_number":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.registration_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.registration_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.registration_number","typeLabel":"string | null"},"revenue_weight":{"oneOf":[{"type":"integer","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.revenue_weight.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.revenue_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.revenue_weight","typeLabel":"integer | null"},"tax_due_date":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.tax_due_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.tax_due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.tax_due_date","typeLabel":"string | null"},"tax_status":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.tax_status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.tax_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.tax_status","typeLabel":"string | null"},"type_approval":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.type_approval.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.type_approval.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.type_approval","typeLabel":"string | null"},"wheelplan":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.wheelplan.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.wheelplan.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.wheelplan","typeLabel":"string | null"},"year_of_manufacture":{"oneOf":[{"type":"integer","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.year_of_manufacture.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.year_of_manufacture.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0.year_of_manufacture","typeLabel":"integer | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0.data","typeLabel":"object | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"exists":{"type":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"data":{"oneOf":[{"type":"object","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}}},{"type":"null","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}}}]}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0.ves","typeLabel":"object | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.0","typeLabel":"object"},{"type":"null","description":"The full DVLA VES + MOT payload as last seen.","properties":{"mot":{"oneOf":[{"type":"object","properties":{"exists":{"type":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"data":{"oneOf":[{"type":"object","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}}},{"type":"null","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}}}]}}},{"type":"null","properties":{"exists":{"type":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"data":{"oneOf":[{"type":"object","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}}},{"type":"null","description":"DVLA MOT history summary.","properties":{"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"model":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_used":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"manufacture_date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"engine_size":{"oneOf":[{"type":"string"},{"type":"null"}]},"has_outstanding_recall":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_test_due_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."},{"type":"null","format":"date-time","description":"The date the vehicle's first MOT test is due. DVSA sends this only for a vehicle that has never been tested, in place of its MOT records."}]}}}]}}}]},"ves":{"oneOf":[{"type":"object","properties":{"exists":{"type":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"data":{"oneOf":[{"type":"object","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}}},{"type":"null","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}}}]}}},{"type":"null","properties":{"exists":{"type":"boolean"},"last_sync":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"data":{"oneOf":[{"type":"object","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}}},{"type":"null","description":"DVLA Vehicle Enquiry Service (VES) data.","properties":{"art_end_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"co2_emissions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"colour":{"oneOf":[{"type":"string"},{"type":"null"}]},"date_of_last_v5c_issued":{"oneOf":[{"type":"string"},{"type":"null"}]},"engine_capacity":{"oneOf":[{"type":"integer"},{"type":"null"}]},"euro_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"fuel_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"make":{"oneOf":[{"type":"string"},{"type":"null"}]},"marked_for_export":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"month_of_first_registration":{"oneOf":[{"type":"string"},{"type":"null"}]},"mot_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"real_driving_emissions":{"oneOf":[{"type":"string"},{"type":"null"}]},"registration_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"revenue_weight":{"oneOf":[{"type":"integer"},{"type":"null"}]},"tax_due_date":{"oneOf":[{"type":"string"},{"type":"null"}]},"tax_status":{"oneOf":[{"type":"string"},{"type":"null"}]},"type_approval":{"oneOf":[{"type":"string"},{"type":"null"}]},"wheelplan":{"oneOf":[{"type":"string"},{"type":"null"}]},"year_of_manufacture":{"oneOf":[{"type":"integer"},{"type":"null"}]}}}]}}}]}},"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.meta.dvla","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for a vehicle","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.organisation","typeLabel":"object"},"specification":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to a vehicle specification","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the vehicle specification","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.specification.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicle-specifications","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.specification.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.specification.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.specification","typeLabel":"object"},"equipment":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to an equipment item","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment item","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.equipment.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-items","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.equipment.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.equipment.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.equipment.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.equipment","typeLabel":"object"},"categories":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to a vehicle category","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the vehicle category","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.categories.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicle-categories","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.categories.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.categories.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.categories.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.categories","typeLabel":"object"},"certifications":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","description":"Represents a relationship to a vehicle certification","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the vehicle certification","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.certifications.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicle-certifications","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.certifications.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.certifications.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.certifications.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.certifications","typeLabel":"object"},"allocated_person":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.data.type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person.meta","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_person","typeLabel":"object"},"allocated_scheme":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"schemes","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.data.type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme.meta","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_scheme","typeLabel":"object"},"allocated_work_order":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"work-orders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.data.type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order.meta","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_work_order","typeLabel":"object"},"allocated_location":{"type":"object","properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"locations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.data.type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a current-allocation relationship.","properties":{"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.meta.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the allocation should take effect.","uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.meta.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.meta.starts_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location.meta","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.allocated_location","typeLabel":"object"},"pre_allocations":{"type":"object","description":"Read-only. Planned pre-allocation reservations for the vehicle.","readOnly":true,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.pre_allocations.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicle-pre-allocations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.pre_allocations.data.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.pre_allocations.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.pre_allocations.data","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.pre_allocations","typeLabel":"object"},"folder":{"type":"object","description":"The vehicle's general documents root folder.","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.folder.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"folders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.folder.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.folder.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6.relationships.folder","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.6.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","description":"A location","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the location.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"locations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for a location","properties":{"reference":{"type":"string","description":"The organisation's own lookup key for the place, such as a pole number or\nan internal property reference. Unique within the organisation, and what\nidentifies a location: it is the key a bulk import matches rows on.\n\nRequired on create. Absent only on locations that predate the field, which\nis why it is not marked required here - the resource has to describe those\nas well as the ones written since.\n","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.reference","typeLabel":"string"},"name":{"type":"string","description":"What the place is called, where it is called anything. Optional: a place\nidentified by its reference does not need a name invented for it.\n","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.name","typeLabel":"string"},"description":{"type":"string","description":"A description of the location","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.description","typeLabel":"string"},"location":{"oneOf":[{"type":"object","title":"BritishNationalGridPoint","description":"A point on the ground, given in either British National Grid eastings and\nnorthings or in latitude and longitude.\n\nSupply one standard, not both. The platform stores what it is given and does\nnot convert between the two, so a point carries the standard it was entered in\nand only that one is populated on read. Supplying both is rejected: choosing\none would silently discard the other.\n\nEach coordinate must be complete. Half a coordinate locates nothing, and a\nmissing member would otherwise be read as a zero, putting a pole in the Gulf of\nGuinea or off the Isles of Scilly.\n\nThe `oneOf` below is what makes that rule part of the contract rather than\nonly prose, so a generated client cannot construct a point the API refuses.\nThe third branch is the point that carries neither standard, which is how an\nempty `{}` clears a coordinate.\n","required":["british_national_grid"],"properties":{"british_national_grid":{"type":"object","required":["easting","northing"],"properties":{"easting":{"type":"number","format":"double","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.0.british_national_grid.easting","typeLabel":"number\u003cdouble>"},"northing":{"type":"number","format":"double","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.0.british_national_grid.northing","typeLabel":"number\u003cdouble>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.0.british_national_grid","typeLabel":"object"},"lat_long":{"type":"null","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.0.lat_long","typeLabel":"null"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.0","typeLabel":"BritishNationalGridPoint · object"},{"type":"object","title":"LatLongPoint","description":"A point on the ground, given in either British National Grid eastings and\nnorthings or in latitude and longitude.\n\nSupply one standard, not both. The platform stores what it is given and does\nnot convert between the two, so a point carries the standard it was entered in\nand only that one is populated on read. Supplying both is rejected: choosing\none would silently discard the other.\n\nEach coordinate must be complete. Half a coordinate locates nothing, and a\nmissing member would otherwise be read as a zero, putting a pole in the Gulf of\nGuinea or off the Isles of Scilly.\n\nThe `oneOf` below is what makes that rule part of the contract rather than\nonly prose, so a generated client cannot construct a point the API refuses.\nThe third branch is the point that carries neither standard, which is how an\nempty `{}` clears a coordinate.\n","required":["lat_long"],"properties":{"lat_long":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.1.lat_long.latitude","typeLabel":"number\u003cdouble>"},"longitude":{"type":"number","format":"double","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.1.lat_long.longitude","typeLabel":"number\u003cdouble>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.1.lat_long","typeLabel":"object"},"british_national_grid":{"type":"null","required":["easting","northing"],"properties":{"easting":{"type":"number","format":"double"},"northing":{"type":"number","format":"double"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.1.british_national_grid","typeLabel":"null"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.1","typeLabel":"LatLongPoint · object"},{"type":"object","title":"NoPoint","description":"A point on the ground, given in either British National Grid eastings and\nnorthings or in latitude and longitude.\n\nSupply one standard, not both. The platform stores what it is given and does\nnot convert between the two, so a point carries the standard it was entered in\nand only that one is populated on read. Supplying both is rejected: choosing\none would silently discard the other.\n\nEach coordinate must be complete. Half a coordinate locates nothing, and a\nmissing member would otherwise be read as a zero, putting a pole in the Gulf of\nGuinea or off the Isles of Scilly.\n\nThe `oneOf` below is what makes that rule part of the contract rather than\nonly prose, so a generated client cannot construct a point the API refuses.\nThe third branch is the point that carries neither standard, which is how an\nempty `{}` clears a coordinate.\n","properties":{"british_national_grid":{"type":"null","required":["easting","northing"],"properties":{"easting":{"type":"number","format":"double"},"northing":{"type":"number","format":"double"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.2.british_national_grid","typeLabel":"null"},"lat_long":{"type":"null","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.2.lat_long","typeLabel":"null"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location.oneOf.2","typeLabel":"NoPoint · object"}],"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.location","typeLabel":"BritishNationalGridPoint · object | LatLongPoint · object | NoPoint · object"},"address":{"type":"object","description":"A structured postal address.\n\nEvery field is optional: an address is often partial, and a place that has one\nat all is better recorded incompletely than not at all.\n","properties":{"description":{"type":"string","description":"The address as a single line, as it would be written on an envelope.","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.description","typeLabel":"string"},"department":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.department","typeLabel":"string"},"organisation":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.organisation","typeLabel":"string"},"number":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.number","typeLabel":"string"},"name":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.name","typeLabel":"string"},"thoroughfare":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.thoroughfare","typeLabel":"string"},"dependent_thoroughfare":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.dependent_thoroughfare","typeLabel":"string"},"post_town":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.post_town","typeLabel":"string"},"postcode":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.postcode","typeLabel":"string"},"po_box":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.po_box","typeLabel":"string"},"country":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address.country","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.7.attributes.address","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a location","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time when the location was created","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the location was last updated","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for a location","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.organisation","typeLabel":"object"},"location_type":{"type":"object","description":"The location type assigned to this location, if any.","properties":{"data":{"oneOf":[{"type":"object","description":"Represents a relationship to a location type","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the location type","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.location_type.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"location-types","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.location_type.data.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.location_type.data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"included.items.[INDEX].oneOf.7.relationships.location_type.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.location_type.data","typeLabel":"object | null"}},"uniqueKey":"included.items.[INDEX].oneOf.7.relationships.location_type","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.7.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"An equipment category","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment category.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-categories","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for an equipment category","properties":{"name":{"type":"string","description":"The equipment category name","uniqueKey":"included.items.[INDEX].oneOf.8.attributes.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for an equipment category","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time when the equipment category was created","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the equipment category was last updated","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for an equipment category","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.relationships.organisation","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.8.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"An equipment certification","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the equipment certification.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-certifications","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes for an equipment certification","required":["name"],"properties":{"name":{"type":"string","description":"The name of the equipment certification.","examples":["PAT Test"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"A description of the equipment certification.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the equipment certification.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.description","typeLabel":"string | null"},"renewal_period":{"oneOf":[{"type":"integer","minimum":1,"description":"The number of days between renewals. Null if no renewal is required.","examples":[365],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.renewal_period.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"The number of days between renewals. Null if no renewal is required.","examples":[365],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.renewal_period.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.renewal_period","typeLabel":"integer | null"},"high_risk_duration":{"oneOf":[{"type":"integer","minimum":1,"description":"Days before expiry at which high risk begins. Null if not configured.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.high_risk_duration.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Days before expiry at which high risk begins. Null if not configured.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.high_risk_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.high_risk_duration","typeLabel":"integer | null"},"medium_risk_duration":{"oneOf":[{"type":"integer","minimum":1,"description":"Days before expiry at which medium risk begins. Requires high_risk_duration to be set and must be greater than or equal to high_risk_duration.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.medium_risk_duration.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Days before expiry at which medium risk begins. Requires high_risk_duration to be set and must be greater than or equal to high_risk_duration.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.medium_risk_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.medium_risk_duration","typeLabel":"integer | null"},"low_risk_duration":{"oneOf":[{"type":"integer","minimum":1,"description":"Days before expiry at which low risk begins. Requires medium_risk_duration to be set and must be greater than or equal to medium_risk_duration.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.low_risk_duration.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Days before expiry at which low risk begins. Requires medium_risk_duration to be set and must be greater than or equal to medium_risk_duration.","uniqueKey":"included.items.[INDEX].oneOf.9.attributes.low_risk_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.9.attributes.low_risk_duration","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for an equipment certification","required":["created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for an equipment certification","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.relationships.organisation","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.9.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","description":"A folder","required":["id","type","attributes","meta","relationships"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the folder.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"folders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.type","typeLabel":"string"},"attributes":{"type":"object","description":"Attributes of a folder","required":["name"],"properties":{"name":{"type":"string","description":"The folder name","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.attributes.name","typeLabel":"string"},"managed_by":{"oneOf":[{"type":"string","description":"The domain that owns this folder's contents, such as `cdm`. Set by the server only, and\nabsent or null for an ordinary folder. Documents in a managed folder can only be added, changed or removed\nthrough that domain's endpoints, so every write through the documents API is refused\nwith 403.\n","uniqueKey":"included.items.[INDEX].oneOf.10.attributes.managed_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"The domain that owns this folder's contents, such as `cdm`. Set by the server only, and\nabsent or null for an ordinary folder. Documents in a managed folder can only be added, changed or removed\nthrough that domain's endpoints, so every write through the documents API is refused\nwith 403.\n","uniqueKey":"included.items.[INDEX].oneOf.10.attributes.managed_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.10.attributes.managed_by","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.attributes","typeLabel":"object"},"meta":{"type":"object","description":"Metadata for a folder","required":["created_at"],"properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the folder was created","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.meta.created_at","typeLabel":"string\u003cdate-time>"},"document_count":{"type":"integer","description":"The number of documents in the folder. This does not include subfolders.","uniqueKey":"included.items.[INDEX].oneOf.10.meta.document_count","typeLabel":"integer"},"size":{"type":"integer","description":"The size of the folder in bytes. This includes subfolders.","uniqueKey":"included.items.[INDEX].oneOf.10.meta.size","typeLabel":"integer"},"path":{"type":"string","description":"The path of the folder.","uniqueKey":"included.items.[INDEX].oneOf.10.meta.path","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the folder was last updated","uniqueKey":"included.items.[INDEX].oneOf.10.meta.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.meta","typeLabel":"object"},"relationships":{"type":"object","description":"Relationships for a folder","required":["organisation"],"properties":{"organisation":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.organisation.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"organisations","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.organisation.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.organisation.data","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.organisation","typeLabel":"object"},"author":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.author.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"users","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.author.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.author.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.author","typeLabel":"object"},"parent":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.parent.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"folders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.parent.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.parent.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.parent","typeLabel":"object"},"scheme":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.scheme.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"schemes","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.scheme.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.scheme.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.scheme","typeLabel":"object"},"work_order":{"type":"object","required":["data"],"properties":{"data":{"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","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.work_order.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"work-orders","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.work_order.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.work_order.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.work_order","typeLabel":"object"},"qualification_award":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"The qualification award an award evidence folder was created for. Qualification awards are retired and have no API resource; the relationship lets clients recognise these folders.","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the qualification award","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.qualification_award.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"qualification-awards","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.qualification_award.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.qualification_award.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.qualification_award","typeLabel":"object"},"training_completion":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to a training completion","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the training completion","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.training_completion.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"training-completions","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.training_completion.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.training_completion.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.training_completion","typeLabel":"object"},"induction_completion":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to an induction completion","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the induction completion","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.induction_completion.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"induction-completions","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.induction_completion.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.induction_completion.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.induction_completion","typeLabel":"object"},"assessment_record":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to an assessment record","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the assessment record","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.assessment_record.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"assessment-records","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.assessment_record.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.assessment_record.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.assessment_record","typeLabel":"object"},"vehicle_certificate":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to a vehicle certificate","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the vehicle certificate","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle_certificate.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicle-certificates","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle_certificate.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle_certificate.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle_certificate","typeLabel":"object"},"equipment_certificate":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to an equipment certificate","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment certificate","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_certificate.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-certificates","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_certificate.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_certificate.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_certificate","typeLabel":"object"},"vehicle":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to a vehicle","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the vehicle","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"vehicles","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.vehicle","typeLabel":"object"},"equipment_item":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Represents a relationship to an equipment item","required":["id","type"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the equipment item","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_item.data.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"equipment-items","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_item.data.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_item.data","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10.relationships.equipment_item","typeLabel":"object"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.10.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.10","typeLabel":"object"}],"uniqueKey":"included.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-items","attributes":{"reference":"REF-001","serial":"CH-001","asset_number":"A-12345","is_rented":true,"purchased_at":"2024-01-15T00:00:00.000Z","description":"\u003cstring>","status":"\u003cstring>"},"meta":{"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"relationships":{"organisation":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"organisations"}},"manufacturer":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-manufacturers"}},"model":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-models"}},"business_area":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"business-areas"}},"owner":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"owners"}},"status":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-statuses"}},"categories":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-categories"}]},"inherited_categories":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-categories"}]},"certifications":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-certifications"}]},"allocated_person":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"users"},"meta":{"starts_at":"2023-11-07T05:31:56Z"}},"allocated_scheme":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"schemes"},"meta":{"starts_at":"2023-11-07T05:31:56Z"}},"allocated_work_order":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"work-orders"},"meta":{"starts_at":"2023-11-07T05:31:56Z"}},"allocated_location":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"locations"},"meta":{"starts_at":"2023-11-07T05:31:56Z"}},"allocated_vehicle":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"vehicles"},"meta":{"starts_at":"2023-11-07T05:31:56Z"}},"pre_allocations":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-item-pre-allocations"}]},"folder":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"folders"}}}},"jsonapi":{"version":"1.0"},"included":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"equipment-manufacturers","attributes":{"name":"Festool"},"meta":{"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"relationships":{"organisation":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"organisations"}}}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"a3060c6a-9443-43bf-aa5a-56402d4f0ede":{"description":"There was an error with the request - this could be due to an invalid body, query parameters,\nor headers that were sent to the API.\n","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"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"description":"A human readable title for the error.","type":"string","examples":["You are not authorised to access this resource"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"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."],"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"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.\n`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"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"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"],"uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"description":"A string indicating which query parameter in the request caused the error.","type":"string","examples":["include"],"uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"description":"A JSON object containing additional information about the error.\nWhen a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error.\nWhen `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.","uniqueKey":"errors.items.[INDEX].meta.resource","typeLabel":"string"},"organisation_id":{"type":"string","format":"uuid","examples":["c000c344-8847-47da-a091-32e75902d3b1"],"uniqueKey":"errors.items.[INDEX].meta.organisation_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"required":["id","status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"98ca4a78-b66f-4234-9719-aaf832ee6669","status":"400","title":"A validation error was encountered","source":{"parameter":"include"},"meta":{"resource":"wrong_value"}},"examples":{"Example":{"title":"Example","value":{"id":"98ca4a78-b66f-4234-9719-aaf832ee6669","status":"400","title":"A validation error was encountered","source":{"parameter":"include"},"meta":{"resource":"wrong_value"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d03bf6ec-5dd9-4e55-8578-f064f326c91e":{"description":"Authentication failed","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"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"description":"A human readable title for the error.","type":"string","examples":["You are not authorised to access this resource"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"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."],"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"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.\n`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"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"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"],"uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"description":"A string indicating which query parameter in the request caused the error.","type":"string","examples":["include"],"uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"description":"A JSON object containing additional information about the error.\nWhen a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error.\nWhen `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.","uniqueKey":"errors.items.[INDEX].meta.resource","typeLabel":"string"},"organisation_id":{"type":"string","format":"uuid","examples":["c000c344-8847-47da-a091-32e75902d3b1"],"uniqueKey":"errors.items.[INDEX].meta.organisation_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"required":["id","status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"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"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"examples"}},"exampleType":"examples"},"9c571eaf-9008-4c60-87c7-61cd03b375ea":{"description":"The request conflicts with the current state of the resource","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"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"description":"A human readable title for the error.","type":"string","examples":["You are not authorised to access this resource"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"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."],"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"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.\n`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"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"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"],"uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"description":"A string indicating which query parameter in the request caused the error.","type":"string","examples":["include"],"uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"description":"A JSON object containing additional information about the error.\nWhen a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error.\nWhen `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.","uniqueKey":"errors.items.[INDEX].meta.resource","typeLabel":"string"},"organisation_id":{"type":"string","format":"uuid","examples":["c000c344-8847-47da-a091-32e75902d3b1"],"uniqueKey":"errors.items.[INDEX].meta.organisation_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"required":["id","status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"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"},"examples":{"Example":{"title":"Example","value":{"id":"8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g","status":"409","title":"Conflict","detail":"The request conflicts with the current state of the resource.","code":"CONFLICT.001"}}},"exampleType":"examples"}},"exampleType":"examples"},"e2107e4c-eec5-4f55-8590-cc07ef1de93d":{"description":"There was a problem handling the request on the server side","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"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"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"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"title":{"description":"A human readable title for the error.","type":"string","examples":["You are not authorised to access this resource"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"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."],"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"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.\n`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"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"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"],"uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"description":"A string indicating which query parameter in the request caused the error.","type":"string","examples":["include"],"uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"description":"A JSON object containing additional information about the error.\nWhen a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error.\nWhen `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.","uniqueKey":"errors.items.[INDEX].meta.resource","typeLabel":"string"},"organisation_id":{"type":"string","format":"uuid","examples":["c000c344-8847-47da-a091-32e75902d3b1"],"uniqueKey":"errors.items.[INDEX].meta.organisation_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"required":["id","status","title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"fe9d9a69-f0a7-4fdc-bb2c-176027f316c5","status":"500","title":"Internal Server Error","detail":"An unexpected error occurred on the server."},"examples":{"Example":{"title":"Example","value":{"id":"fe9d9a69-f0a7-4fdc-bb2c-176027f316c5","status":"500","title":"Internal Server Error","detail":"An unexpected error occurred on the server."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"12391aeb-d50e-4378-ab82-ecce386d3f1f":{"Session":{"description":"Session token for authentication.\n","in":"header","name":"X-Session-Token","type":"apiKey","scopes":[],"schemeName":"Session"}},"fddd13ee-2386-4cb1-9525-21e84c239a08":{"Cookie":{"description":"Cookie token for authentication.\n","in":"cookie","name":"ctrl_hub_session","type":"apiKey","scopes":[],"schemeName":"Cookie"}},"174b2481-2604-4193-a8c8-a6a8dfe3b576":{"OAuth2":{"description":"OAuth2 token for authentication.\n","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://auth.ctrl-hub.com/oauth2/token"}},"type":"oauth2","scopes":[],"schemeName":"OAuth2"}}},"servers":{"3be900a1-8516-4b10-a38f-14b0ab73163f":{"description":"Production","url":"https://api.ctrl-hub.com"},"a989bcaa-3778-4fd2-90b1-101bcec8a7c2":{"description":"Staging","url":"https://api.ctrl-hub.dev"},"e001bbe3-f76d-456b-b481-b2f8b4ff5843":{"description":"Development","url":"https://api.ctrl-hub.run"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Session token for authentication.\n","in":"header","name":"X-Session-Token","type":"apiKey","scopes":[],"schemeName":"Session"},"schema":{"title":"X-Session-Token","type":"string","description":"Session token for authentication.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Session","name":"X-Session-Token"}],"title":"Session"},{"schemes":[{"scheme":{"description":"Cookie token for authentication.\n","in":"cookie","name":"ctrl_hub_session","type":"apiKey","scopes":[],"schemeName":"Cookie"},"schema":{"title":"ctrl_hub_session","type":"string","description":"Cookie token for authentication.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Cookie","name":"ctrl_hub_session"}],"title":"Cookie"},{"schemes":[{"scheme":{"description":"OAuth2 token for authentication.\n","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://auth.ctrl-hub.com/oauth2/token"}},"type":"oauth2","scopes":[],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 token for authentication.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"ctrlhub-2ae4bef7","siteName":"Ctrl Hub","title":"Create an equipment item - Ctrl Hub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T16:30:38.422Z","originalFileLocation":"api-reference/equipment/create-a-new-equipment-item.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new equipment item for an organisation.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ctrl Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an equipment item - Ctrl Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new equipment item for an organisation.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ctrl Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ctrlhub-2ae4bef7.mintlify.app/_mintlify/api/og/v2?division=Equipment\u0026amp;title=Create+an+equipment+item\u0026amp;description=Create+a+new+equipment+item+for+an+organisation.\u0026amp;theme=4057edff07f86baa3a518be3\u0026amp;signature=eba8a88a3044ffc37a8333c3bf38a1aeec03a1410ac962f6d0f38711214a4188\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an equipment item - Ctrl Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new equipment item for an organisation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ctrlhub-2ae4bef7.mintlify.app/_mintlify/api/og/v2?division=Equipment\u0026amp;title=Create+an+equipment+item\u0026amp;description=Create+a+new+equipment+item+for+an+organisation.\u0026amp;theme=4057edff07f86baa3a518be3\u0026amp;signature=eba8a88a3044ffc37a8333c3bf38a1aeec03a1410ac962f6d0f38711214a4188\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ctrlhub-2ae4bef7/3yP0v1Sa3ugLhZQi/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ctrl Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#051737\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/equipment/create-a-new-equipment-item.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ctrl-hub.com/#organization\",\"name\":\"Ctrl Hub\",\"url\":\"https://docs.ctrl-hub.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ctrlhub-2ae4bef7/PIDSeF8_-LaiA-F2/logo/light.svg?fit=max\u0026auto=format\u0026n=PIDSeF8_-LaiA-F2\u0026q=85\u0026s=042271625d0e2e8a33fea01ac79f26b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ctrl-hub.com#website\",\"name\":\"Ctrl Hub\",\"url\":\"https://docs.ctrl-hub.com\",\"publisher\":{\"@id\":\"https://docs.ctrl-hub.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item#webpage\",\"url\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item\",\"name\":\"Create an equipment item\",\"description\":\"Create a new equipment item for an organisation.\",\"dateModified\":\"2026-10-23T16:30:38.422Z\",\"isPartOf\":{\"@id\":\"https://docs.ctrl-hub.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Equipment\",\"item\":\"https://docs.ctrl-hub.com/api-reference/equipment/get-v3business-areas\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an equipment item\",\"item\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item#apireference\",\"headline\":\"Create an equipment item\",\"name\":\"Create an equipment item\",\"description\":\"Create a new equipment item for an organisation.\",\"url\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ctrl-hub.com/api-reference/equipment/create-a-new-equipment-item#webpage\"},\"dateModified\":\"2026-10-23T16:30:38.422Z\",\"publisher\":{\"@id\":\"https://docs.ctrl-hub.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ctrl-hub.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ctrl Hub\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ctrl Hub","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"square-terminal","pages":[{"title":"Guides","href":"/guides/what-is-ctrl-hub"}]},{"tab":"API Guide","icon":"square-terminal","pages":[{"title":"API Guide","href":"/api-reference/introduction"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Service Accounts","pages":[{"title":"List system service accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /admin/v3/service-accounts","href":"/api-reference/service-accounts/get-adminv3service-accounts"},{"title":"Create a system service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /admin/v3/service-accounts","href":"/api-reference/service-accounts/create-a-system-service-account"},{"title":"Get a system service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /admin/v3/service-accounts/{service_account_id}","href":"/api-reference/service-accounts/get-adminv3service-accounts-1"},{"title":"Create a key for a system service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /admin/v3/service-accounts/{service_account_id}/keys","href":"/api-reference/service-accounts/create-a-system-service-account-key"},{"title":"List service accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/service-accounts","href":"/api-reference/service-accounts/get-v3orgs-iamservice-accounts"},{"title":"Create a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/iam/service-accounts","href":"/api-reference/service-accounts/create-a-service-account"},{"title":"Get a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/service-accounts/{service_account_id}","href":"/api-reference/service-accounts/get-v3orgs-iamservice-accounts-1"},{"title":"Update a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/iam/service-accounts/{service_account_id}","href":"/api-reference/service-accounts/update-a-service-accounts-enabled-status"},{"title":"Create a key for a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/iam/service-accounts/{service_account_id}/keys","href":"/api-reference/service-accounts/create-a-service-account-key"},{"title":"Delete a key of a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/orgs/{org_id}/iam/service-accounts/{service_account_id}/keys/{key_id}","href":"/api-reference/service-accounts/delete-a-service-account-key"},{"title":"List logs for a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/service-accounts/{service_account_id}/logs","href":"/api-reference/service-accounts/get-v3orgs-iamservice-accounts-logs"},{"title":"Get a log for a service account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/service-accounts/{service_account_id}/logs/{log_id}","href":"/api-reference/service-accounts/get-v3orgs-iamservice-accounts-logs-1"}]},{"group":"Specifications","pages":[{"title":"Get this spec (JSON)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /spec.json","href":"/api-reference/specifications/get-specjson"},{"title":"Get this spec (YAML)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /spec.yaml","href":"/api-reference/specifications/get-specyaml"}]},{"group":"Street Manager","pages":[{"title":"Create a new activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /street-manager/activities","href":"/api-reference/street-manager/post-street-manageractivities"},{"title":"Create a new permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /street-manager/permits","href":"/api-reference/street-manager/post-street-managerpermits"},{"title":"Create a new protection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /street-manager/protections","href":"/api-reference/street-manager/post-street-managerprotections"},{"title":"List permits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/street-manager/permits","href":"/api-reference/street-manager/get-v3street-managerpermits"},{"title":"Get a permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/street-manager/permits/{permit_id}","href":"/api-reference/street-manager/get-v3street-managerpermits-1"},{"title":"List versions of a permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/street-manager/permits/{permit_id}/versions","href":"/api-reference/street-manager/get-v3street-managerpermits-versions"},{"title":"Get a permit version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/street-manager/permits/{permit_id}/versions/{version_id}","href":"/api-reference/street-manager/get-v3street-managerpermits-versions-1"}]},{"group":"Actions","pages":[{"title":"List actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/actions","href":"/api-reference/actions/list-actions"},{"title":"Create an action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/actions","href":"/api-reference/actions/create-a-new-action"},{"title":"Get an action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/actions/{action_id}","href":"/api-reference/actions/get-an-action"},{"title":"Delete an action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/actions/{action_id}","href":"/api-reference/actions/delete-an-action"},{"title":"Update an action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/actions/{action_id}","href":"/api-reference/actions/update-an-action"},{"title":"Close an action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/actions/{action_id}/close","href":"/api-reference/actions/close-an-action"},{"title":"Reopen an action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/actions/{action_id}/reopen","href":"/api-reference/actions/reopen-an-action"}]},{"group":"Properties","pages":[{"title":"Resolve addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/address-resolutions","href":"/api-reference/properties/resolve-addresses"},{"title":"List meters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/meters","href":"/api-reference/properties/get-v3meters"},{"title":"Create a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/meters","href":"/api-reference/properties/create-a-meter"},{"title":"Get a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/meters/{meter_id}","href":"/api-reference/properties/get-v3meters-1"},{"title":"Update a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/meters/{meter_id}","href":"/api-reference/properties/update-an-existing-meter"},{"title":"Delete a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/meters/{meter_id}","href":"/api-reference/properties/delete-a-meter"},{"title":"Search by postcode","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/postcode-lookups/{postcode}","href":"/api-reference/properties/get-v3postcode-lookups"},{"title":"List properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/properties","href":"/api-reference/properties/get-v3properties"},{"title":"Get a property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/properties/{property_id}","href":"/api-reference/properties/get-v3properties-1"},{"title":"Search for properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/property-search-results","href":"/api-reference/properties/get-v3property-search-results"},{"title":"List PSR records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/psrs","href":"/api-reference/properties/get-v3psrs"},{"title":"Create a PSR record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/psrs","href":"/api-reference/properties/create-a-psr-record"},{"title":"Get a PSR record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/psrs/{psr_id}","href":"/api-reference/properties/get-v3psrs-1"},{"title":"Update a PSR record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/psrs/{psr_id}","href":"/api-reference/properties/update-an-existing-psr-record"},{"title":"Delete a PSR record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/psrs/{psr_id}","href":"/api-reference/properties/delete-a-psr-record"}]},{"group":"Agent Issues","pages":[{"title":"List agent issues","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agent-issues","href":"/api-reference/agent-issues/get-v3agent-issues"},{"title":"Create an agent issue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/agent-issues","href":"/api-reference/agent-issues/create-a-new-agent-issue"},{"title":"Get an agent issue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agent-issues/{agent_issue_id}","href":"/api-reference/agent-issues/get-v3agent-issues-1"},{"title":"Update an agent issue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/agent-issues/{agent_issue_id}","href":"/api-reference/agent-issues/update-an-existing-agent-issue"}]},{"group":"Agent Templates","pages":[{"title":"List agent templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agent-templates","href":"/api-reference/agent-templates/get-v3agent-templates"},{"title":"Create an agent template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/agent-templates","href":"/api-reference/agent-templates/create-a-new-agent-template"},{"title":"Get an agent template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agent-templates/{agent_template_id}","href":"/api-reference/agent-templates/get-v3agent-templates-1"},{"title":"Update an agent template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/agent-templates/{agent_template_id}","href":"/api-reference/agent-templates/update-an-agent-template"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agents","href":"/api-reference/agents/get-v3agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/agents","href":"/api-reference/agents/create-a-new-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agents/{agent_id}","href":"/api-reference/agents/get-v3agents-1"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/agents/{agent_id}","href":"/api-reference/agents/update-an-existing-agent"}]},{"group":"Briefings","pages":[{"title":"List briefings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agents/{agent_id}/briefings","href":"/api-reference/briefings/get-v3agents-briefings"},{"title":"Create a briefing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/agents/{agent_id}/briefings","href":"/api-reference/briefings/create-a-new-briefing"},{"title":"Get a briefing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/agents/{agent_id}/briefings/{briefing_id}","href":"/api-reference/briefings/get-v3agents-briefings-1"},{"title":"Generate a briefing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/agents/{agent_id}/generate-briefing","href":"/api-reference/briefings/generate-a-briefing-using-ai"}]},{"group":"Qualifications","pages":[{"title":"List assessment definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/assessment-definitions","href":"/api-reference/qualifications/get-v3assessment-definitions"},{"title":"Create an assessment definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/assessment-definitions","href":"/api-reference/qualifications/create-a-new-assessment-definition"},{"title":"Get an assessment definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/assessment-definitions/{assessment_definition_id}","href":"/api-reference/qualifications/get-v3assessment-definitions-1"},{"title":"Update an assessment definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/assessment-definitions/{assessment_definition_id}","href":"/api-reference/qualifications/update-an-existing-assessment-definition"},{"title":"Delete an assessment definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/assessment-definitions/{assessment_definition_id}","href":"/api-reference/qualifications/delete-an-assessment-definition"},{"title":"List assessments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/assessments","href":"/api-reference/qualifications/get-v3assessments"},{"title":"Create an assessment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/assessments","href":"/api-reference/qualifications/create-a-new-assessment"},{"title":"Get an assessment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/assessments/{assessment_id}","href":"/api-reference/qualifications/get-v3assessments-1"},{"title":"Update an assessment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/assessments/{assessment_id}","href":"/api-reference/qualifications/update-an-existing-assessment"},{"title":"List competency requirement specifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/competency-requirement-specifications","href":"/api-reference/qualifications/get-v3competency-requirement-specifications"},{"title":"Create a competency requirement specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/competency-requirement-specifications","href":"/api-reference/qualifications/create-a-new-competency-requirement-specification"},{"title":"Get a competency requirement specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/competency-requirement-specifications/{competency_requirement_specification_id}","href":"/api-reference/qualifications/get-v3competency-requirement-specifications-1"},{"title":"Update a competency requirement specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/competency-requirement-specifications/{competency_requirement_specification_id}","href":"/api-reference/qualifications/update-an-existing-competency-requirement-specification"},{"title":"Delete a competency requirement specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/competency-requirement-specifications/{competency_requirement_specification_id}","href":"/api-reference/qualifications/delete-a-competency-requirement-specification"},{"title":"Evaluate group compliance for a CRS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/competency-requirement-specifications/{competency_requirement_specification_id}/compliance","href":"/api-reference/qualifications/post-v3competency-requirement-specifications-compliance"},{"title":"List induction completions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/induction-completions","href":"/api-reference/qualifications/get-v3induction-completions"},{"title":"Create an induction completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/induction-completions","href":"/api-reference/qualifications/create-a-new-induction-completion"},{"title":"Get an induction completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/induction-completions/{induction_completion_id}","href":"/api-reference/qualifications/get-v3induction-completions-1"},{"title":"Update an induction completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/induction-completions/{induction_completion_id}","href":"/api-reference/qualifications/update-an-existing-induction-completion"},{"title":"Delete an induction completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/induction-completions/{induction_completion_id}","href":"/api-reference/qualifications/delete-an-induction-completion"},{"title":"List inductions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/inductions","href":"/api-reference/qualifications/get-v3inductions"},{"title":"Create an induction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/inductions","href":"/api-reference/qualifications/create-a-new-induction"},{"title":"Get an induction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/inductions/{induction_id}","href":"/api-reference/qualifications/get-v3inductions-1"},{"title":"Update an induction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/inductions/{induction_id}","href":"/api-reference/qualifications/update-an-existing-induction"},{"title":"Delete an induction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/inductions/{induction_id}","href":"/api-reference/qualifications/delete-an-induction"},{"title":"List registrations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/registrations","href":"/api-reference/qualifications/get-v3registrations"},{"title":"Create a registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/registrations","href":"/api-reference/qualifications/create-a-new-registration"},{"title":"Get a registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/registrations/{registration_id}","href":"/api-reference/qualifications/get-v3registrations-1"},{"title":"Update a registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/registrations/{registration_id}","href":"/api-reference/qualifications/update-an-existing-registration"},{"title":"Delete a registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/registrations/{registration_id}","href":"/api-reference/qualifications/delete-a-registration"},{"title":"List skills register scheme categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/skills-register-scheme-categories","href":"/api-reference/qualifications/get-v3skills-register-scheme-categories"},{"title":"Create a skills register scheme category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/skills-register-scheme-categories","href":"/api-reference/qualifications/create-a-new-skills-register-scheme-category"},{"title":"Get a skills register scheme category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/skills-register-scheme-categories/{skills_register_scheme_category_id}","href":"/api-reference/qualifications/get-v3skills-register-scheme-categories-1"},{"title":"Update a skills register scheme category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/skills-register-scheme-categories/{skills_register_scheme_category_id}","href":"/api-reference/qualifications/update-an-existing-skills-register-scheme-category"},{"title":"List skills register schemes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/skills-register-schemes","href":"/api-reference/qualifications/get-v3skills-register-schemes"},{"title":"Create a skills register scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/skills-register-schemes","href":"/api-reference/qualifications/create-a-new-skills-register-scheme"},{"title":"Get a skills register scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/skills-register-schemes/{skills_register_scheme_id}","href":"/api-reference/qualifications/get-v3skills-register-schemes-1"},{"title":"Update a skills register scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/skills-register-schemes/{skills_register_scheme_id}","href":"/api-reference/qualifications/update-an-existing-skills-register-scheme"},{"title":"List skills registers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/skills-registers","href":"/api-reference/qualifications/get-v3skills-registers"},{"title":"Create a skills register","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/skills-registers","href":"/api-reference/qualifications/create-a-new-skills-register"},{"title":"Get a skills register","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/skills-registers/{skills_register_id}","href":"/api-reference/qualifications/get-v3skills-registers-1"},{"title":"Update a skills register","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/skills-registers/{skills_register_id}","href":"/api-reference/qualifications/update-an-existing-skills-register"},{"title":"List training items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/training-items","href":"/api-reference/qualifications/get-v3training-items"},{"title":"Create a training item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/training-items","href":"/api-reference/qualifications/create-a-new-training-item"},{"title":"Get a training item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/training-items/{training_item_id}","href":"/api-reference/qualifications/get-v3training-items-1"},{"title":"Update a training item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/training-items/{training_item_id}","href":"/api-reference/qualifications/update-an-existing-training-item"},{"title":"Delete a training item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/training-items/{training_item_id}","href":"/api-reference/qualifications/delete-a-training-item"}]},{"group":"Workforce","pages":[{"title":"List assessment records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/assessment-records","href":"/api-reference/workforce/get-v3assessment-records"},{"title":"Create an assessment record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/assessment-records","href":"/api-reference/workforce/create-a-new-assessment-record"},{"title":"Get an assessment record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/assessment-records/{assessment_record_id}","href":"/api-reference/workforce/get-v3assessment-records-1"},{"title":"Update an assessment record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/assessment-records/{assessment_record_id}","href":"/api-reference/workforce/update-an-existing-assessment-record"},{"title":"Delete an assessment record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/assessment-records/{assessment_record_id}","href":"/api-reference/workforce/delete-an-assessment-record"},{"title":"List category registrations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/category-registrations","href":"/api-reference/workforce/get-v3category-registrations"},{"title":"Create a category registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/category-registrations","href":"/api-reference/workforce/create-a-new-category-registration"},{"title":"Get a category registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/category-registrations/{category_registration_id}","href":"/api-reference/workforce/get-v3category-registrations-1"},{"title":"Update a category registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/category-registrations/{category_registration_id}","href":"/api-reference/workforce/update-an-existing-category-registration"},{"title":"Delete a category registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/category-registrations/{category_registration_id}","href":"/api-reference/workforce/delete-a-category-registration"},{"title":"List scheme registrations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-registrations","href":"/api-reference/workforce/get-v3scheme-registrations"},{"title":"Create a scheme registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/scheme-registrations","href":"/api-reference/workforce/create-a-new-scheme-registration"},{"title":"Get a scheme registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-registrations/{scheme_registration_id}","href":"/api-reference/workforce/get-v3scheme-registrations-1"},{"title":"Update a scheme registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/scheme-registrations/{scheme_registration_id}","href":"/api-reference/workforce/update-an-existing-scheme-registration"},{"title":"Delete a scheme registration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/scheme-registrations/{scheme_registration_id}","href":"/api-reference/workforce/delete-a-scheme-registration"},{"title":"List training completions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/training-completions","href":"/api-reference/workforce/get-v3training-completions"},{"title":"Create a training completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/training-completions","href":"/api-reference/workforce/create-a-new-training-completion"},{"title":"Get a training completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/training-completions/{training_completion_id}","href":"/api-reference/workforce/get-v3training-completions-1"},{"title":"Update a training completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/training-completions/{training_completion_id}","href":"/api-reference/workforce/update-an-existing-training-completion"},{"title":"Delete a training completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/training-completions/{training_completion_id}","href":"/api-reference/workforce/delete-a-training-completion"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/verifications","href":"/api-reference/workforce/list-verifications"},{"title":"Create a verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/verifications","href":"/api-reference/workforce/create-a-verification"},{"title":"Get a verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/verifications/{verification_id}","href":"/api-reference/workforce/retrieve-a-verification"}]},{"group":"Audit Events","pages":[{"title":"List audit events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/audit-events","href":"/api-reference/audit-events/get-v3audit-events"},{"title":"Get an audit event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/audit-events/{audit_event_id}","href":"/api-reference/audit-events/get-v3audit-events-1"}]},{"group":"Equipment","pages":[{"title":"List business areas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/business-areas","href":"/api-reference/equipment/get-v3business-areas"},{"title":"Create a business area","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/business-areas","href":"/api-reference/equipment/create-a-new-business-area"},{"title":"Get a business area","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/business-areas/{business_area_id}","href":"/api-reference/equipment/get-v3business-areas-1"},{"title":"Update a business area","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/business-areas/{business_area_id}","href":"/api-reference/equipment/update-a-business-area"},{"title":"Delete a business area","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/business-areas/{business_area_id}","href":"/api-reference/equipment/delete-a-business-area"},{"title":"List equipment categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-categories","href":"/api-reference/equipment/get-v3equipment-categories"},{"title":"Create an equipment category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-categories","href":"/api-reference/equipment/create-a-new-equipment-category"},{"title":"Get an equipment category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-categories/{equipment_category_id}","href":"/api-reference/equipment/get-v3equipment-categories-1"},{"title":"Update an equipment category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/equipment-categories/{equipment_category_id}","href":"/api-reference/equipment/update-an-equipment-category"},{"title":"Delete an equipment category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-categories/{equipment_category_id}","href":"/api-reference/equipment/delete-an-equipment-category"},{"title":"List equipment certificates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-certificates","href":"/api-reference/equipment/list-equipment-certificates"},{"title":"Create an equipment certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-certificates","href":"/api-reference/equipment/create-a-new-equipment-certificate"},{"title":"Get an equipment certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-certificates/{equipment_certificate_id}","href":"/api-reference/equipment/get-v3equipment-certificates"},{"title":"Update an equipment certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/equipment-certificates/{equipment_certificate_id}","href":"/api-reference/equipment/update-an-equipment-certificate"},{"title":"Delete an equipment certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-certificates/{equipment_certificate_id}","href":"/api-reference/equipment/delete-an-equipment-certificate"},{"title":"List equipment certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-certifications","href":"/api-reference/equipment/get-v3equipment-certifications"},{"title":"Create an equipment certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-certifications","href":"/api-reference/equipment/create-a-new-equipment-certification"},{"title":"Get an equipment certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-certifications/{equipment_certification_id}","href":"/api-reference/equipment/get-v3equipment-certifications-1"},{"title":"Update an equipment certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/equipment-certifications/{equipment_certification_id}","href":"/api-reference/equipment/update-an-equipment-certification"},{"title":"Delete an equipment certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-certifications/{equipment_certification_id}","href":"/api-reference/equipment/delete-an-equipment-certification"},{"title":"List equipment items","description":"Retrieve a list of equipment items. Filter by organisation with `?filter=eq(organisation,xxx)`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-items","href":"/api-reference/equipment/get-v3equipment-items"},{"title":"Create an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-items","href":"/api-reference/equipment/create-a-new-equipment-item"},{"title":"Get an equipment item","description":"Retrieve a specific equipment item by its unique identifier.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-items/{equipment_item_id}","href":"/api-reference/equipment/get-v3equipment-items-1"},{"title":"Update an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/equipment-items/{equipment_item_id}","href":"/api-reference/equipment/update-an-equipment-item"},{"title":"Delete an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-items/{equipment_item_id}","href":"/api-reference/equipment/delete-an-equipment-item"},{"title":"Get an equipment item's compliance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-items/{equipment_item_id}/compliance","href":"/api-reference/equipment/get-v3equipment-items-compliance"},{"title":"Get v3equipment items pre allocations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-items/{equipment_item_id}/pre-allocations","href":"/api-reference/equipment/get-v3equipment-items-pre-allocations"},{"title":"Create an equipment item pre-allocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-items/{equipment_item_id}/pre-allocations","href":"/api-reference/equipment/create-an-equipment-item-pre-allocation"},{"title":"Cancel an equipment item pre-allocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-items/{equipment_item_id}/pre-allocations/{pre_allocation_id}","href":"/api-reference/equipment/cancel-an-equipment-item-pre-allocation"},{"title":"location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-items/{equipment_item_id}/relationships/allocated_location","href":"/api-reference/equipment/location"},{"title":"person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-items/{equipment_item_id}/relationships/allocated_person","href":"/api-reference/equipment/person"},{"title":"scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-items/{equipment_item_id}/relationships/allocated_scheme","href":"/api-reference/equipment/scheme"},{"title":"vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-items/{equipment_item_id}/relationships/allocated_vehicle","href":"/api-reference/equipment/vehicle"},{"title":"work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-items/{equipment_item_id}/relationships/allocated_work_order","href":"/api-reference/equipment/work-order"},{"title":"Attach certificates to an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-items/{equipment_item_id}/relationships/certificates","href":"/api-reference/equipment/attach-certificates-to-an-equipment-item"},{"title":"Detach certificates from an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-items/{equipment_item_id}/relationships/certificates","href":"/api-reference/equipment/detach-certificates-from-an-equipment-item"},{"title":"Add certifications to an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-items/{equipment_item_id}/relationships/certifications","href":"/api-reference/equipment/add-certifications-to-an-equipment-item"},{"title":"Remove certifications from an equipment item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-items/{equipment_item_id}/relationships/certifications","href":"/api-reference/equipment/remove-certifications-from-an-equipment-item"},{"title":"Replace an equipment item's certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-items/{equipment_item_id}/relationships/certifications","href":"/api-reference/equipment/replace-an-equipment-items-certifications"},{"title":"List equipment manufacturers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-manufacturers","href":"/api-reference/equipment/get-v3equipment-manufacturers"},{"title":"Create an equipment manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-manufacturers","href":"/api-reference/equipment/create-a-new-equipment-manufacturer"},{"title":"Get an equipment manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-manufacturers/{equipment_manufacturer_id}","href":"/api-reference/equipment/get-v3equipment-manufacturers-1"},{"title":"Delete an equipment manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-manufacturers/{equipment_manufacturer_id}","href":"/api-reference/equipment/delete-an-equipment-manufacturer"},{"title":"Update an equipment manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-manufacturers/{equipment_manufacturer_id}","href":"/api-reference/equipment/update-an-equipment-manufacturer"},{"title":"List equipment models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-models","href":"/api-reference/equipment/get-v3equipment-models"},{"title":"Create an equipment model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-models","href":"/api-reference/equipment/create-a-new-equipment-model"},{"title":"Get an equipment model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-models/{equipment_model_id}","href":"/api-reference/equipment/get-v3equipment-models-1"},{"title":"Delete an equipment model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-models/{equipment_model_id}","href":"/api-reference/equipment/delete-an-equipment-model"},{"title":"Update an equipment model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/equipment-models/{equipment_model_id}","href":"/api-reference/equipment/update-an-equipment-model"},{"title":"List equipment statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-statuses","href":"/api-reference/equipment/get-v3equipment-statuses"},{"title":"Create an equipment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/equipment-statuses","href":"/api-reference/equipment/create-a-new-equipment-status"},{"title":"Get an equipment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/equipment-statuses/{equipment_status_id}","href":"/api-reference/equipment/get-v3equipment-statuses-1"},{"title":"Update an equipment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/equipment-statuses/{equipment_status_id}","href":"/api-reference/equipment/update-an-equipment-status"},{"title":"Delete an equipment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/equipment-statuses/{equipment_status_id}","href":"/api-reference/equipment/delete-an-equipment-status"},{"title":"List HAVS equipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/havs-equipment","href":"/api-reference/equipment/get-v3havs-equipment"},{"title":"Create a HAVS equipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/havs-equipment","href":"/api-reference/equipment/create-a-new-havs-equipment-record"},{"title":"Get a HAVS equipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/havs-equipment/{havs_equipment_id}","href":"/api-reference/equipment/get-v3havs-equipment-1"},{"title":"Update a HAVS equipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/havs-equipment/{havs_equipment_id}","href":"/api-reference/equipment/update-a-havs-equipment-record"},{"title":"Delete a HAVS equipment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/havs-equipment/{havs_equipment_id}","href":"/api-reference/equipment/delete-a-havs-equipment-record"},{"title":"List HAVS exposures","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/havs-exposures","href":"/api-reference/equipment/list-havs-exposures"},{"title":"Record a HAVS exposure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/havs-exposures","href":"/api-reference/equipment/record-a-havs-exposure"},{"title":"Get a HAVS exposure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/havs-exposures/{havs_exposure_id}","href":"/api-reference/equipment/get-a-havs-exposure"},{"title":"Correct a HAVS exposure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/havs-exposures/{havs_exposure_id}","href":"/api-reference/equipment/correct-a-havs-exposure"},{"title":"Delete a HAVS exposure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/havs-exposures/{havs_exposure_id}","href":"/api-reference/equipment/delete-a-havs-exposure"},{"title":"List owners","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/owners","href":"/api-reference/equipment/get-v3owners"},{"title":"Create an owner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/owners","href":"/api-reference/equipment/create-a-new-owner"},{"title":"Get an owner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/owners/{owner_id}","href":"/api-reference/equipment/get-v3owners-1"},{"title":"Update an owner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/owners/{owner_id}","href":"/api-reference/equipment/update-an-owner"},{"title":"Delete an owner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/owners/{owner_id}","href":"/api-reference/equipment/delete-an-owner"}]},{"group":"Comments","pages":[{"title":"List comments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/comments","href":"/api-reference/comments/get-v3comments"},{"title":"Create a comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/comments","href":"/api-reference/comments/create-a-new-comment"},{"title":"Get a comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/comments/{comment_id}","href":"/api-reference/comments/get-v3comments-1"},{"title":"Delete a comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/comments/{comment_id}","href":"/api-reference/comments/delete-a-comment"},{"title":"Update a comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/comments/{comment_id}","href":"/api-reference/comments/update-a-comment"}]},{"group":"Competency","pages":[{"title":"List expiring competency records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/competency-expiring-records","href":"/api-reference/competency/get-v3competency-expiring-records"},{"title":"List competency holders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/competency-holders","href":"/api-reference/competency/get-v3competency-holders"}]},{"group":"Construction Phase Plans","pages":[{"title":"List construction phase plan risk resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plan-risks","href":"/api-reference/construction-phase-plans/list-construction-phase-plan-risk-resources"},{"title":"Create a construction phase plan risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plan-risks","href":"/api-reference/construction-phase-plans/create-a-construction-phase-plan-risk"},{"title":"Get a construction phase plan risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plan-risks/{construction_phase_plan_risk_id}","href":"/api-reference/construction-phase-plans/get-a-construction-phase-plan-risk"},{"title":"Delete a construction phase plan risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/construction-phase-plan-risks/{construction_phase_plan_risk_id}","href":"/api-reference/construction-phase-plans/delete-a-construction-phase-plan-risk"},{"title":"Update a construction phase plan risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/construction-phase-plan-risks/{construction_phase_plan_risk_id}","href":"/api-reference/construction-phase-plans/update-a-construction-phase-plan-risk"},{"title":"Attach a file to a construction phase plan risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plan-risks/{construction_phase_plan_risk_id}/attachments","href":"/api-reference/construction-phase-plans/attach-a-file-to-a-construction-phase-plan-risk"},{"title":"Remove a file from a construction phase plan risk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/construction-phase-plan-risks/{construction_phase_plan_risk_id}/attachments/{document_id}","href":"/api-reference/construction-phase-plans/remove-a-file-from-a-construction-phase-plan-risk"},{"title":"List construction phase plan resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plans","href":"/api-reference/construction-phase-plans/list-construction-phase-plan-resources"},{"title":"Create a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plans","href":"/api-reference/construction-phase-plans/create-a-construction-phase-plan"},{"title":"Get a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plans/{construction_phase_plan_id}","href":"/api-reference/construction-phase-plans/get-a-construction-phase-plan"},{"title":"Update a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/construction-phase-plans/{construction_phase_plan_id}","href":"/api-reference/construction-phase-plans/update-a-construction-phase-plan"},{"title":"Sign off a construction phase plan section","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plans/{construction_phase_plan_id}/attestations","href":"/api-reference/construction-phase-plans/sign-off-a-construction-phase-plan-section"},{"title":"Hand over a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plans/{construction_phase_plan_id}/handover","href":"/api-reference/construction-phase-plans/hand-over-a-construction-phase-plan"},{"title":"List the changes proposed to a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plans/{construction_phase_plan_id}/proposed-changes","href":"/api-reference/construction-phase-plans/list-the-changes-proposed-to-a-construction-phase-plan"},{"title":"Propose a change to a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plans/{construction_phase_plan_id}/proposed-changes","href":"/api-reference/construction-phase-plans/propose-a-change-to-a-construction-phase-plan"},{"title":"Get a change proposed to a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plans/{construction_phase_plan_id}/proposed-changes/{construction_phase_plan_proposed_change_id}","href":"/api-reference/construction-phase-plans/get-a-change-proposed-to-a-construction-phase-plan"},{"title":"Accept a change proposed to a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plans/{construction_phase_plan_id}/proposed-changes/{construction_phase_plan_proposed_change_id}/acceptance","href":"/api-reference/construction-phase-plans/accept-a-change-proposed-to-a-construction-phase-plan"},{"title":"Reject a change proposed to a construction phase plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/construction-phase-plans/{construction_phase_plan_id}/proposed-changes/{construction_phase_plan_proposed_change_id}/rejection","href":"/api-reference/construction-phase-plans/reject-a-change-proposed-to-a-construction-phase-plan"},{"title":"List a construction phase plan's revisions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plans/{construction_phase_plan_id}/revisions","href":"/api-reference/construction-phase-plans/list-a-construction-phase-plans-revisions"},{"title":"Read a construction phase plan as at a revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/construction-phase-plans/{construction_phase_plan_id}/revisions/{revision_number}","href":"/api-reference/construction-phase-plans/read-a-construction-phase-plan-as-at-a-revision"}]},{"group":"Costs","pages":[{"title":"List cost item versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-item-versions","href":"/api-reference/costs/list-cost-item-versions"},{"title":"Create a cost item version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-item-versions","href":"/api-reference/costs/create-a-cost-item-version"},{"title":"Get a cost item version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-item-versions/{cost_item_version_id}","href":"/api-reference/costs/get-a-cost-item-version"},{"title":"Update a cost item version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/cost-item-versions/{cost_item_version_id}","href":"/api-reference/costs/update-a-cost-item-version"},{"title":"Delete a cost item version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/cost-item-versions/{cost_item_version_id}","href":"/api-reference/costs/delete-a-cost-item-version"},{"title":"List cost items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-items","href":"/api-reference/costs/list-cost-items"},{"title":"Create a cost item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-items","href":"/api-reference/costs/create-a-cost-item"},{"title":"Get a cost item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-items/{cost_item_id}","href":"/api-reference/costs/get-a-cost-item"},{"title":"Update a cost item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/cost-items/{cost_item_id}","href":"/api-reference/costs/update-a-cost-item"},{"title":"Delete a cost item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/cost-items/{cost_item_id}","href":"/api-reference/costs/delete-a-cost-item"},{"title":"List cost kit lines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-kit-lines","href":"/api-reference/costs/list-cost-kit-lines"},{"title":"Add a rate code to a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-kit-lines","href":"/api-reference/costs/add-a-rate-code-to-a-cost-kit"},{"title":"Get a cost kit line","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-kit-lines/{cost_kit_line_id}","href":"/api-reference/costs/get-a-cost-kit-line"},{"title":"Update a cost kit line","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/cost-kit-lines/{cost_kit_line_id}","href":"/api-reference/costs/update-a-cost-kit-line"},{"title":"Remove a rate code from a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/cost-kit-lines/{cost_kit_line_id}","href":"/api-reference/costs/remove-a-rate-code-from-a-cost-kit"},{"title":"List cost kits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-kits","href":"/api-reference/costs/list-cost-kits"},{"title":"Create a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-kits","href":"/api-reference/costs/create-a-cost-kit"},{"title":"Get a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-kits/{cost_kit_id}","href":"/api-reference/costs/get-a-cost-kit"},{"title":"Update a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/cost-kits/{cost_kit_id}","href":"/api-reference/costs/update-a-cost-kit"},{"title":"Delete a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/cost-kits/{cost_kit_id}","href":"/api-reference/costs/delete-a-cost-kit"},{"title":"Apply a cost kit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-kits/{cost_kit_id}/apply","href":"/api-reference/costs/apply-a-cost-kit-to-a-cost-sheet"},{"title":"List cost lines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-lines","href":"/api-reference/costs/list-cost-lines"},{"title":"Create a cost line","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-lines","href":"/api-reference/costs/create-a-cost-line"},{"title":"Get a cost line","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-lines/{cost_line_id}","href":"/api-reference/costs/get-a-cost-line"},{"title":"Update a cost line","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/cost-lines/{cost_line_id}","href":"/api-reference/costs/update-a-cost-line"},{"title":"Delete a cost line","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/cost-lines/{cost_line_id}","href":"/api-reference/costs/delete-a-cost-line"},{"title":"List cost roll-ups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-rollups","href":"/api-reference/costs/list-cost-roll-ups"},{"title":"List cost sheets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-sheets","href":"/api-reference/costs/list-cost-sheets"},{"title":"Create a cost sheet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/cost-sheets","href":"/api-reference/costs/create-a-cost-sheet"},{"title":"Get a cost sheet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/cost-sheets/{cost_sheet_id}","href":"/api-reference/costs/get-a-cost-sheet"},{"title":"Update a cost sheet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/cost-sheets/{cost_sheet_id}","href":"/api-reference/costs/update-a-cost-sheet"},{"title":"Delete a cost sheet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/cost-sheets/{cost_sheet_id}","href":"/api-reference/costs/delete-a-cost-sheet"}]},{"group":"Dashboards","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/dashboards","href":"/api-reference/dashboards/get-v3dashboards"},{"title":"Create a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/dashboards","href":"/api-reference/dashboards/create-a-new-dashboard"},{"title":"Get a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/dashboards/{dashboard_id}","href":"/api-reference/dashboards/get-v3dashboards-1"},{"title":"Update a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/dashboards/{dashboard_id}","href":"/api-reference/dashboards/update-an-existing-dashboard"},{"title":"Delete a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/dashboards/{dashboard_id}","href":"/api-reference/dashboards/delete-a-dashboard"}]},{"group":"Device Backups","pages":[{"title":"List device backups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/device-backups","href":"/api-reference/device-backups/get-v3device-backups"},{"title":"Send a device backup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/device-backups","href":"/api-reference/device-backups/send-a-devices-database-to-ctrl-hub"},{"title":"Get a device backup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/device-backups/{device_backup_id}","href":"/api-reference/device-backups/get-v3device-backups-1"},{"title":"Download a device backup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/device-backups/{device_backup_id}/download","href":"/api-reference/device-backups/download-a-device-backups-database"}]},{"group":"Documents","pages":[{"title":"List downloads for all documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/document-downloads","href":"/api-reference/documents/get-v3document-downloads"},{"title":"Upload a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/document-uploads","href":"/api-reference/documents/upload-a-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/documents","href":"/api-reference/documents/get-v3documents"},{"title":"Create a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/documents","href":"/api-reference/documents/create-a-document"},{"title":"Get a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/documents/{document_id}","href":"/api-reference/documents/get-v3documents-1"},{"title":"Update a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/documents/{document_id}","href":"/api-reference/documents/update-an-existing-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/documents/{document_id}","href":"/api-reference/documents/delete-a-document"},{"title":"List document contents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/documents/{document_id}/contents","href":"/api-reference/documents/get-v3documents-contents"},{"title":"Add content to a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/documents/{document_id}/contents","href":"/api-reference/documents/create-document-content"},{"title":"Create the content of a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/documents/{document_id}/contents/{document_content_id}","href":"/api-reference/documents/get-v3documents-contents-1"},{"title":"Download the content of a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/documents/{document_id}/contents/{document_content_id}/download","href":"/api-reference/documents/download-document-content"},{"title":"List downloads of a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/documents/{document_id}/downloads","href":"/api-reference/documents/get-v3documents-downloads"},{"title":"Change a documents folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/documents/{document_id}/relationships/folder","href":"/api-reference/documents/update-the-folder-that-a-document-is-in"}]},{"group":"Document Reviews","pages":[{"title":"Make a decision for a review","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/document-review-decisions/{document_review_decision_id}","href":"/api-reference/document-reviews/submit-a-review-decision"},{"title":"List request for document reviews","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/document-review-requests","href":"/api-reference/document-reviews/get-v3document-review-requests"},{"title":"Request a document review","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/document-review-requests","href":"/api-reference/document-reviews/create-a-document-review-request"},{"title":"Get a request for a document review","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/document-review-requests/{document_review_request_id}","href":"/api-reference/document-reviews/get-v3document-review-requests-1"},{"title":"Update a request for a document review","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/document-review-requests/{document_review_request_id}","href":"/api-reference/document-reviews/put-v3document-review-requests"},{"title":"Delete a request for a document review","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/document-review-requests/{document_review_request_id}","href":"/api-reference/document-reviews/delete-v3document-review-requests"}]},{"group":"Organisations","pages":[{"title":"List reviewers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/document-reviewers","href":"/api-reference/organisations/get-v3document-reviewers"},{"title":"List organisations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs","href":"/api-reference/organisations/get-v3orgs"},{"title":"Create an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs","href":"/api-reference/organisations/create-an-organisation"},{"title":"Get an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}","href":"/api-reference/organisations/get-v3orgs-1"},{"title":"Get member stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/member-stats","href":"/api-reference/organisations/get-v3orgs-iammember-stats"},{"title":"List members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/members","href":"/api-reference/organisations/get-v3orgs-iammembers"},{"title":"Get a member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/members/{member_id}","href":"/api-reference/organisations/get-v3orgs-iammembers-1"},{"title":"Update a member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/iam/members/{member_id}","href":"/api-reference/organisations/update-a-members-status"},{"title":"List my people","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/my-people","href":"/api-reference/organisations/get-v3orgs-iammy-people"},{"title":"Update organisation team settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/settings/teams","href":"/api-reference/organisations/update-an-organisations-team-settings"}]},{"group":"Exports","pages":[{"title":"List exports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/exports","href":"/api-reference/exports/get-v3exports"},{"title":"Request an export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/exports","href":"/api-reference/exports/request-an-export"},{"title":"Get an export","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/exports/{export_id}","href":"/api-reference/exports/get-v3exports-1"},{"title":"Download an export's artefact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/exports/{export_id}/download","href":"/api-reference/exports/download-an-exports-artefact"}]},{"group":"Pre-Construction Information","pages":[{"title":"List F10 notification resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/f10-notifications","href":"/api-reference/pre-construction-information/list-f10-notification-resources"},{"title":"Record an F10 notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/f10-notifications","href":"/api-reference/pre-construction-information/record-an-f10-notification"},{"title":"Get an F10 notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/f10-notifications/{f10_notification_id}","href":"/api-reference/pre-construction-information/get-an-f10-notification"},{"title":"Attach a file to an F10 notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/f10-notifications/{f10_notification_id}/attachments","href":"/api-reference/pre-construction-information/attach-a-file-to-an-f10-notification"},{"title":"List pre-construction information hazard resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-information-hazards","href":"/api-reference/pre-construction-information/list-pre-construction-information-hazard-resources"},{"title":"Create a pre-construction information hazard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-information-hazards","href":"/api-reference/pre-construction-information/create-a-pre-construction-information-hazard"},{"title":"Get a pre-construction information hazard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-information-hazards/{pre_construction_information_hazard_id}","href":"/api-reference/pre-construction-information/get-a-pre-construction-information-hazard"},{"title":"Delete a pre-construction information hazard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/pre-construction-information-hazards/{pre_construction_information_hazard_id}","href":"/api-reference/pre-construction-information/delete-a-pre-construction-information-hazard"},{"title":"Update a pre-construction information hazard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/pre-construction-information-hazards/{pre_construction_information_hazard_id}","href":"/api-reference/pre-construction-information/update-a-pre-construction-information-hazard"},{"title":"Attach a file to a pre-construction information hazard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-information-hazards/{pre_construction_information_hazard_id}/attachments","href":"/api-reference/pre-construction-information/attach-a-file-to-a-pre-construction-information-hazard"},{"title":"Remove a file from a pre-construction information hazard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/pre-construction-information-hazards/{pre_construction_information_hazard_id}/attachments/{document_id}","href":"/api-reference/pre-construction-information/remove-a-file-from-a-pre-construction-information-hazard"},{"title":"List pre-construction information resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-informations","href":"/api-reference/pre-construction-information/list-pre-construction-information-resources"},{"title":"Create a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-informations","href":"/api-reference/pre-construction-information/create-a-pre-construction-information"},{"title":"Get a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-informations/{pre_construction_information_id}","href":"/api-reference/pre-construction-information/get-a-pre-construction-information"},{"title":"Update a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/pre-construction-informations/{pre_construction_information_id}","href":"/api-reference/pre-construction-information/update-a-pre-construction-information"},{"title":"Sign off a pre-construction information section","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-informations/{pre_construction_information_id}/attestations","href":"/api-reference/pre-construction-information/sign-off-a-pre-construction-information-section"},{"title":"Hand over a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-informations/{pre_construction_information_id}/handover","href":"/api-reference/pre-construction-information/hand-over-a-pre-construction-information"},{"title":"List the changes proposed to a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes","href":"/api-reference/pre-construction-information/list-the-changes-proposed-to-a-pre-construction-information"},{"title":"Propose a change to a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes","href":"/api-reference/pre-construction-information/propose-a-change-to-a-pre-construction-information"},{"title":"Get a change proposed to a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes/{pre_construction_information_proposed_change_id}","href":"/api-reference/pre-construction-information/get-a-change-proposed-to-a-pre-construction-information"},{"title":"Accept a change proposed to a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes/{pre_construction_information_proposed_change_id}/acceptance","href":"/api-reference/pre-construction-information/accept-a-change-proposed-to-a-pre-construction-information"},{"title":"Reject a change proposed to a pre-construction information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes/{pre_construction_information_proposed_change_id}/rejection","href":"/api-reference/pre-construction-information/reject-a-change-proposed-to-a-pre-construction-information"},{"title":"List a pre-construction information's revisions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-informations/{pre_construction_information_id}/revisions","href":"/api-reference/pre-construction-information/list-a-pre-construction-informations-revisions"},{"title":"Read a pre-construction information as at a revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/pre-construction-informations/{pre_construction_information_id}/revisions/{revision_number}","href":"/api-reference/pre-construction-information/read-a-pre-construction-information-as-at-a-revision"}]},{"group":"Feature Configurations","pages":[{"title":"List feature configurations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/feature-configurations","href":"/api-reference/feature-configurations/get-v3feature-configurations"},{"title":"Create a feature configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/feature-configurations","href":"/api-reference/feature-configurations/create-a-new-feature-configuration"},{"title":"Get a feature configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/feature-configurations/{feature_configuration_id}","href":"/api-reference/feature-configurations/get-v3feature-configurations-1"},{"title":"Update a feature configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/feature-configurations/{feature_configuration_id}","href":"/api-reference/feature-configurations/update-an-existing-feature-configuration"},{"title":"Delete a feature configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/feature-configurations/{feature_configuration_id}","href":"/api-reference/feature-configurations/delete-a-feature-configuration"}]},{"group":"Feature Registry","pages":[{"title":"List features","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/features","href":"/api-reference/feature-registry/get-v3features"}]},{"group":"Folders","pages":[{"title":"List folders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/folders","href":"/api-reference/folders/get-v3folders"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/folders","href":"/api-reference/folders/create-a-folder"},{"title":"Get a folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/folders/{folder_id}","href":"/api-reference/folders/get-v3folders-1"},{"title":"Update a folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/folders/{folder_id}","href":"/api-reference/folders/update-an-existing-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/folders/{folder_id}","href":"/api-reference/folders/delete-a-folder"},{"title":"Change a folders parent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/folders/{folder_id}/relationships/parent","href":"/api-reference/folders/update-the-parent-of-an-existing-folder"}]},{"group":"Forms, Schemas and Categories","pages":[{"title":"List form categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-categories","href":"/api-reference/forms-schemas-and-categories/get-v3form-categories"},{"title":"Create a form category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-categories","href":"/api-reference/forms-schemas-and-categories/create-a-new-form-category"},{"title":"Get a form category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-categories/{form_category_id}","href":"/api-reference/forms-schemas-and-categories/get-v3form-categories-1"},{"title":"Add a form to a category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-categories/{form_category_id}/relationships/forms","href":"/api-reference/forms-schemas-and-categories/post-v3form-categories-relationshipsforms"},{"title":"Remove a form from a category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/form-categories/{form_category_id}/relationships/forms","href":"/api-reference/forms-schemas-and-categories/delete-v3form-categories-relationshipsforms"},{"title":"Update the category for a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/form-categories/{form_category_id}/relationships/forms","href":"/api-reference/forms-schemas-and-categories/patch-v3form-categories-relationshipsforms"},{"title":"List form field maps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-field-maps","href":"/api-reference/forms-schemas-and-categories/list-form-field-maps"},{"title":"Create a form field map version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-field-maps","href":"/api-reference/forms-schemas-and-categories/create-a-form-field-map-version"},{"title":"Get a form field map","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-field-maps/{form_field_map_id}","href":"/api-reference/forms-schemas-and-categories/get-a-form-field-map"},{"title":"List form schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-schemas","href":"/api-reference/forms-schemas-and-categories/get-v3form-schemas"},{"title":"Create a schema for a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-schemas","href":"/api-reference/forms-schemas-and-categories/create-a-new-form-schema"},{"title":"Get a form schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-schemas/{schema_id}","href":"/api-reference/forms-schemas-and-categories/get-v3form-schemas-1"},{"title":"List x-source options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-schemas/{schema_id}/x-sources/{field_id}/options","href":"/api-reference/forms-schemas-and-categories/get-v3form-schemas-x-sources-options"},{"title":"List forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/forms","href":"/api-reference/forms-schemas-and-categories/get-v3forms"},{"title":"Create a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/forms","href":"/api-reference/forms-schemas-and-categories/create-a-new-form"},{"title":"Get a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/forms/{form_id}","href":"/api-reference/forms-schemas-and-categories/get-v3forms-1"},{"title":"Update a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/forms/{form_id}","href":"/api-reference/forms-schemas-and-categories/update-an-existing-form"}]},{"group":"Submissions","pages":[{"title":"List archived submission documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submission-artefacts","href":"/api-reference/submissions/list-archived-submission-documents"},{"title":"Save a draft submission for a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-submission-drafts","href":"/api-reference/submissions/save-a-draft-form-submission"},{"title":"Get form submission stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submission-stats","href":"/api-reference/submissions/get-v3form-submission-stats"},{"title":"Get all versions of form submissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submission-versions","href":"/api-reference/submissions/get-v3form-submission-versions"},{"title":"Create a submission for a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-submission-versions","href":"/api-reference/submissions/create-a-form-submission"},{"title":"Get a version of a form submission","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submission-versions/{version_id}","href":"/api-reference/submissions/get-v3form-submission-versions-1"},{"title":"Download a submitted version's archived document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submission-versions/{version_id}/artefact","href":"/api-reference/submissions/download-a-submitted-versions-archived-document"},{"title":"List all submissions for a form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submissions","href":"/api-reference/submissions/get-v3form-submissions"},{"title":"Get a form submission","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/form-submissions/{submission_id}","href":"/api-reference/submissions/get-v3form-submissions-1"},{"title":"Delete a draft submission","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/form-submissions/{submission_id}","href":"/api-reference/submissions/delete-a-draft-submission"},{"title":"Search submissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/form-submissions/search","href":"/api-reference/submissions/post-v3form-submissionssearch"}]},{"group":"Streets","pages":[{"title":"List streets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/geo/streets","href":"/api-reference/streets/get-v3geostreets"},{"title":"Get a street","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/geo/streets/{street_id}","href":"/api-reference/streets/get-v3geostreets-1"}]},{"group":"IAM Grants","pages":[{"title":"List grants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/grants","href":"/api-reference/iam-grants/get-v3grants"},{"title":"Create a grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/grants","href":"/api-reference/iam-grants/create-a-grant"},{"title":"Get a grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/grants/{grant_id}","href":"/api-reference/iam-grants/get-v3grants-1"},{"title":"Update a grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/grants/{grant_id}","href":"/api-reference/iam-grants/update-an-existing-grant"},{"title":"Delete a grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/grants/{grant_id}","href":"/api-reference/iam-grants/delete-a-grant"}]},{"group":"IAM Role Groups","pages":[{"title":"List role group members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/groups/{group_id}/members","href":"/api-reference/iam-role-groups/get-v3groups-members"},{"title":"List role groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/groups","href":"/api-reference/iam-role-groups/get-v3orgs-iamgroups"},{"title":"Create a role group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/iam/groups","href":"/api-reference/iam-role-groups/create-a-role-group"},{"title":"Get a role group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/iam/groups/{group_id}","href":"/api-reference/iam-role-groups/get-v3orgs-iamgroups-1"},{"title":"Update a role group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/iam/groups/{group_id}","href":"/api-reference/iam-role-groups/update-a-role-group"},{"title":"Replace group members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/iam/groups/{group_id}/relationships/members","href":"/api-reference/iam-role-groups/patch-v3orgs-iamgroups-relationshipsmembers"}]},{"group":"Whoami","pages":[{"title":"Get information about the currently authenticated principal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/iam/whoami","href":"/api-reference/whoami/get-v3iamwhoami"},{"title":"Get the authenticated user's grants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/whatcanido","href":"/api-reference/whoami/get-v3whatcanido"},{"title":"Get information about the currently authenticated principal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/whoami","href":"/api-reference/whoami/get-v3whoami"}]},{"group":"Images","pages":[{"title":"List images","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/images","href":"/api-reference/images/get-v3images"},{"title":"Create an image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/images","href":"/api-reference/images/creates-a-new-image"},{"title":"Get an image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/images/{image_id}","href":"/api-reference/images/get-v3images-1"},{"title":"Get an image at a specified size","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/images/{image_id}/{size}","href":"/api-reference/images/get-v3images-"}]},{"group":"Import Templates","pages":[{"title":"List import templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/import-templates","href":"/api-reference/import-templates/get-v3import-templates"},{"title":"Create an import template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/import-templates","href":"/api-reference/import-templates/create-an-import-template"},{"title":"Get import template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/import-templates/{import_template_id}","href":"/api-reference/import-templates/get-v3import-templates-1"},{"title":"Update an import template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/import-templates/{import_template_id}","href":"/api-reference/import-templates/update-an-import-template"},{"title":"Delete import template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/import-templates/{import_template_id}","href":"/api-reference/import-templates/delete-v3import-templates"}]},{"group":"Job Roles","pages":[{"title":"List job role assignments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-role-assignments","href":"/api-reference/job-roles/retrieve-job-role-assignments"},{"title":"Assign a job role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/job-role-assignments","href":"/api-reference/job-roles/create-a-new-job-role-assignment"},{"title":"Get a job role assignment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-role-assignments/{job_role_assignment_id}","href":"/api-reference/job-roles/retrieve-a-job-role-assignment"},{"title":"Unassign a job role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/job-role-assignments/{job_role_assignment_id}","href":"/api-reference/job-roles/delete-a-job-role-assignment"},{"title":"List job role subject assignments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-role-subject-assignments","href":"/api-reference/job-roles/list-job-role-subject-assignments"},{"title":"Create a job role subject assignment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/job-role-subject-assignments","href":"/api-reference/job-roles/create-a-new-job-role-subject-assignment"},{"title":"Get a job role subject assignment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-role-subject-assignments/{job_role_subject_assignment_id}","href":"/api-reference/job-roles/get-a-job-role-subject-assignment"},{"title":"Delete a job role subject assignment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/job-role-subject-assignments/{job_role_subject_assignment_id}","href":"/api-reference/job-roles/delete-a-job-role-subject-assignment"},{"title":"List job roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-roles","href":"/api-reference/job-roles/retrieve-job-roles"},{"title":"Create a job role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/job-roles","href":"/api-reference/job-roles/create-a-new-job-role"},{"title":"Get a job role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-roles/{job_role_id}","href":"/api-reference/job-roles/retrieve-a-job-role"},{"title":"Update a job role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/job-roles/{job_role_id}","href":"/api-reference/job-roles/update-an-existing-job-role"},{"title":"Delete a job role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/job-roles/{job_role_id}","href":"/api-reference/job-roles/delete-a-job-role"},{"title":"List suggested job role permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/job-roles/{job_role_id}/suggested-permissions","href":"/api-reference/job-roles/get-v3job-roles-suggested-permissions"}]},{"group":"Learnings","pages":[{"title":"List learnings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/learnings","href":"/api-reference/learnings/get-v3learnings"},{"title":"Create a learning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/learnings","href":"/api-reference/learnings/create-a-new-learning"},{"title":"Get a learning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/learnings/{learning_id}","href":"/api-reference/learnings/get-v3learnings-1"},{"title":"Delete a learning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/learnings/{learning_id}","href":"/api-reference/learnings/delete-a-learning"},{"title":"Update a learning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/learnings/{learning_id}","href":"/api-reference/learnings/update-an-existing-learning"}]},{"group":"Location Imports","pages":[{"title":"List location imports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/location-imports","href":"/api-reference/location-imports/get-v3location-imports"},{"title":"Load a file of locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/location-imports","href":"/api-reference/location-imports/load-a-file-of-locations"},{"title":"Get a location import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/location-imports/{location_import_id}","href":"/api-reference/location-imports/get-v3location-imports-1"}]},{"group":"Locations","pages":[{"title":"List location types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/location-types","href":"/api-reference/locations/get-v3location-types"},{"title":"Create a location type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/location-types","href":"/api-reference/locations/create-a-new-location-type"},{"title":"Get a location type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/location-types/{location_type_id}","href":"/api-reference/locations/get-v3location-types-1"},{"title":"Update a location type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/location-types/{location_type_id}","href":"/api-reference/locations/update-a-location-type"},{"title":"Delete a location type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/location-types/{location_type_id}","href":"/api-reference/locations/delete-a-location-type"},{"title":"List locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/locations","href":"/api-reference/locations/get-v3locations"},{"title":"Create a location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/locations","href":"/api-reference/locations/create-a-new-location"},{"title":"Get a location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/locations/{location_id}","href":"/api-reference/locations/get-v3locations-1"},{"title":"Update a location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/locations/{location_id}","href":"/api-reference/locations/update-a-location"},{"title":"Delete a location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/locations/{location_id}","href":"/api-reference/locations/delete-a-location"}]},{"group":"Management","pages":[{"title":"List management relationships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/management-relationships","href":"/api-reference/management/list-management-relationships"},{"title":"Create a management relationship","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/management-relationships","href":"/api-reference/management/create-a-management-relationship"},{"title":"Get a management relationship","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/management-relationships/{management_relationship_id}","href":"/api-reference/management/get-a-management-relationship"},{"title":"Update a management relationship","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/management-relationships/{management_relationship_id}","href":"/api-reference/management/update-a-management-relationship"},{"title":"Delete a management relationship","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/management-relationships/{management_relationship_id}","href":"/api-reference/management/delete-a-management-relationship"},{"title":"List manager roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/manager-roles","href":"/api-reference/management/list-manager-roles"},{"title":"Create a manager role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/manager-roles","href":"/api-reference/management/create-a-manager-role"},{"title":"Get a manager role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/manager-roles/{manager_role_id}","href":"/api-reference/management/get-a-manager-role"},{"title":"Update a manager role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/manager-roles/{manager_role_id}","href":"/api-reference/management/update-a-manager-role"},{"title":"Delete a manager role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/manager-roles/{manager_role_id}","href":"/api-reference/management/delete-a-manager-role"}]},{"group":"Settings","pages":[{"title":"Create nomenclature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/nomenclature","href":"/api-reference/settings/create-nomenclature-settings"},{"title":"Update nomenclature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/nomenclature/{nomenclature_id}","href":"/api-reference/settings/update-nomenclature-settings"},{"title":"List time bands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/settings/time-bands","href":"/api-reference/settings/get-v3orgs-settingstime-bands"},{"title":"Create a time band","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/settings/time-bands","href":"/api-reference/settings/create-a-new-time-band"},{"title":"Get a time band","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/settings/time-bands/{time_band_id}","href":"/api-reference/settings/get-v3orgs-settingstime-bands-1"},{"title":"Update a time band","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/settings/time-bands/{time_band_id}","href":"/api-reference/settings/update-an-existing-time-band"}]},{"group":"Notifications","pages":[{"title":"List your notifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/notifications","href":"/api-reference/notifications/list-your-notifications"},{"title":"Update several notifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/notifications","href":"/api-reference/notifications/update-several-of-your-notifications"},{"title":"Get a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/notifications/{notification_id}","href":"/api-reference/notifications/get-one-of-your-notifications"},{"title":"Update a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/notifications/{notification_id}","href":"/api-reference/notifications/update-one-of-your-notifications"},{"title":"Archive everything you have read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/notifications/archive-all-read","href":"/api-reference/notifications/archive-everything-you-have-read"},{"title":"Mark your inbox read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/notifications/mark-all-read","href":"/api-reference/notifications/mark-your-whole-inbox-read"}]},{"group":"Operations","pages":[{"title":"List operation types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/operation-types","href":"/api-reference/operations/list-operation-types"},{"title":"Create an operation type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operation-types","href":"/api-reference/operations/create-an-operation-type"},{"title":"Get an operation type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/operation-types/{operation_type_id}","href":"/api-reference/operations/get-an-operation-type"},{"title":"Update an operation type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/operation-types/{operation_type_id}","href":"/api-reference/operations/update-an-operation-type"},{"title":"Delete an operation type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operation-types/{operation_type_id}","href":"/api-reference/operations/delete-an-operation-type"},{"title":"List operations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/operations","href":"/api-reference/operations/get-v3operations"},{"title":"Create an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations","href":"/api-reference/operations/create-a-new-operation"},{"title":"Get an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/operations/{operation_id}","href":"/api-reference/operations/get-v3operations-1"},{"title":"Update an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/operations/{operation_id}","href":"/api-reference/operations/update-an-existing-operation"},{"title":"Delete an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}","href":"/api-reference/operations/delete-an-operation"},{"title":"Patch an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}","href":"/api-reference/operations/partially-update-an-existing-operation"},{"title":"Allocate an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/allocate","href":"/api-reference/operations/allocate-an-operation-to-a-work-order"},{"title":"Replace the appointment on an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/appointment","href":"/api-reference/operations/patch-v3operations-relationshipsappointment"},{"title":"Assign users to an operation","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/relationships/assignees","href":"/api-reference/operations/post-v3operations-relationshipsassignees"},{"title":"Remove assignees from an operation","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}/relationships/assignees","href":"/api-reference/operations/delete-v3operations-relationshipsassignees"},{"title":"Replace assignees to an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/assignees","href":"/api-reference/operations/patch-v3operations-relationshipsassignees"},{"title":"Assign locations to an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/relationships/locations","href":"/api-reference/operations/post-v3operations-relationshipslocations"},{"title":"Remove locations from an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}/relationships/locations","href":"/api-reference/operations/delete-v3operations-relationshipslocations"},{"title":"Replace locations on an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/locations","href":"/api-reference/operations/patch-v3operations-relationshipslocations"},{"title":"Assign permits to an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/relationships/permits","href":"/api-reference/operations/post-v3operations-relationshipspermits"},{"title":"Remove permits from an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}/relationships/permits","href":"/api-reference/operations/delete-v3operations-relationshipspermits"},{"title":"Replace the permits on an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/permits","href":"/api-reference/operations/patch-v3operations-relationshipspermits"},{"title":"Assign properties to an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/relationships/properties","href":"/api-reference/operations/post-v3operations-relationshipsproperties"},{"title":"Remove properties from an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}/relationships/properties","href":"/api-reference/operations/delete-v3operations-relationshipsproperties"},{"title":"Replace properties on an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/properties","href":"/api-reference/operations/patch-v3operations-relationshipsproperties"},{"title":"Assign streets to an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/relationships/streets","href":"/api-reference/operations/post-v3operations-relationshipsstreets"},{"title":"Remove streets from an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}/relationships/streets","href":"/api-reference/operations/delete-v3operations-relationshipsstreets"},{"title":"Replace the streets on an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/streets","href":"/api-reference/operations/patch-v3operations-relationshipsstreets"},{"title":"Assign teams to an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/operations/{operation_id}/relationships/teams","href":"/api-reference/operations/post-v3operations-relationshipsteams"},{"title":"Remove teams from an operation","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/operations/{operation_id}/relationships/teams","href":"/api-reference/operations/delete-v3operations-relationshipsteams"},{"title":"Replace the teams on an operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/operations/{operation_id}/relationships/teams","href":"/api-reference/operations/patch-v3operations-relationshipsteams"},{"title":"List operation templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/operation-templates","href":"/api-reference/operations/get-v3orgs-projectsoperation-templates"},{"title":"Create an operation template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/projects/operation-templates","href":"/api-reference/operations/create-a-new-operation-template"},{"title":"Get an operation template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/operation-templates/{template_id}","href":"/api-reference/operations/get-v3orgs-projectsoperation-templates-1"},{"title":"Update an operation template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/projects/operation-templates/{template_id}","href":"/api-reference/operations/update-an-existing-operation-template"}]},{"group":"Customer Accounts and Contacts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/accounts","href":"/api-reference/customer-accounts-and-contacts/get-v3orgs-customersaccounts"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/accounts","href":"/api-reference/customer-accounts-and-contacts/post-v3orgs-customersaccounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/accounts/{customer_account_id}","href":"/api-reference/customer-accounts-and-contacts/get-v3orgs-customersaccounts-1"},{"title":"Update an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/customers/accounts/{customer_account_id}","href":"/api-reference/customer-accounts-and-contacts/put-v3orgs-customersaccounts"},{"title":"Associate a contact to an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/accounts/{customer_account_id}/relationships/contacts","href":"/api-reference/customer-accounts-and-contacts/post-v3orgs-customersaccounts-relationshipscontacts"},{"title":"Remove contacts from an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/orgs/{org_id}/customers/accounts/{customer_account_id}/relationships/contacts","href":"/api-reference/customer-accounts-and-contacts/delete-v3orgs-customersaccounts-relationshipscontacts"},{"title":"Update the contacts for an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/accounts/{customer_account_id}/relationships/contacts","href":"/api-reference/customer-accounts-and-contacts/patch-v3orgs-customersaccounts-relationshipscontacts"},{"title":"Associate a property to an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/accounts/{customer_account_id}/relationships/properties","href":"/api-reference/customer-accounts-and-contacts/post-v3orgs-customersaccounts-relationshipsproperties"},{"title":"Remove properties from an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/orgs/{org_id}/customers/accounts/{customer_account_id}/relationships/properties","href":"/api-reference/customer-accounts-and-contacts/delete-v3orgs-customersaccounts-relationshipsproperties"},{"title":"Update the properties for an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/accounts/{customer_account_id}/relationships/properties","href":"/api-reference/customer-accounts-and-contacts/patch-v3orgs-customersaccounts-relationshipsproperties"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/contacts","href":"/api-reference/customer-accounts-and-contacts/get-v3orgs-customerscontacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/contacts","href":"/api-reference/customer-accounts-and-contacts/post-v3orgs-customerscontacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/contacts/{contact_id}","href":"/api-reference/customer-accounts-and-contacts/get-v3orgs-customerscontacts-1"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/customers/contacts/{contact_id}","href":"/api-reference/customer-accounts-and-contacts/put-v3orgs-customerscontacts"}]},{"group":"Customer Appointments","pages":[{"title":"List appointments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/appointments","href":"/api-reference/customer-appointments/get-v3orgs-customersappointments"},{"title":"Create an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/appointments","href":"/api-reference/customer-appointments/post-v3orgs-customersappointments"},{"title":"Get an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/appointments/{appointment_id}","href":"/api-reference/customer-appointments/get-v3orgs-customersappointments-1"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/customers/appointments/{appointment_id}","href":"/api-reference/customer-appointments/put-v3orgs-customersappointments"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/appointments/{appointment_id}/actions/cancel","href":"/api-reference/customer-appointments/post-v3orgs-customersappointments-actionscancel"},{"title":"Update appointment interactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/appointments/{appointment_id}/relationships/interaction","href":"/api-reference/customer-appointments/patch-v3orgs-customersappointments-relationshipsinteraction"},{"title":"Update appointment operations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/appointments/{appointment_id}/relationships/operation","href":"/api-reference/customer-appointments/patch-v3orgs-customersappointments-relationshipsoperation"},{"title":"Update an appointment time band","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/appointments/{appointment_id}/relationships/time-band","href":"/api-reference/customer-appointments/patch-v3orgs-customersappointments-relationshipstime-band"}]},{"group":"Customer Interactions","pages":[{"title":"List interactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/interactions","href":"/api-reference/customer-interactions/get-v3orgs-customersinteractions"},{"title":"Create an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/customers/interactions","href":"/api-reference/customer-interactions/post-v3orgs-customersinteractions"},{"title":"Get an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/customers/interactions/{customer_interaction_id}","href":"/api-reference/customer-interactions/get-v3orgs-customersinteractions-1"},{"title":"Update an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/customers/interactions/{customer_interaction_id}","href":"/api-reference/customer-interactions/put-v3orgs-customersinteractions"},{"title":"Update the account for an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/interactions/{customer_interaction_id}/relationships/account","href":"/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipsaccount"},{"title":"Update the contact for an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/interactions/{customer_interaction_id}/relationships/contact","href":"/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipscontact"},{"title":"Update the property for an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/interactions/{customer_interaction_id}/relationships/property","href":"/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipsproperty"},{"title":"Update the prepresentative for an interaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/customers/interactions/{customer_interaction_id}/relationships/representative","href":"/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipsrepresentative"}]},{"group":"Bridges","pages":[{"title":"List bridge requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/organisation-bridge-requests","href":"/api-reference/bridges/get-v3orgs-organisation-bridge-requests"},{"title":"Create a bridge request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/organisation-bridge-requests","href":"/api-reference/bridges/generate-a-code-that-will-allow-another-organisation-to-request-a-bridge-to-your-organisation"},{"title":"Get a bridge request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/organisation-bridge-requests/{bridge_request_id}","href":"/api-reference/bridges/get-v3orgs-organisation-bridge-requests-1"},{"title":"Update a bridge request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/organisation-bridge-requests/{bridge_request_id}","href":"/api-reference/bridges/update-an-existing-organisation-bridge-request"},{"title":"List bridges","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/organisation-bridges","href":"/api-reference/bridges/get-v3orgs-organisation-bridges"},{"title":"Get a bridge","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/organisation-bridges/{bridge_id}","href":"/api-reference/bridges/get-v3orgs-organisation-bridges-1"},{"title":"Replace bridge notification recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/organisation-bridges/{bridge_id}/relationships/notification-recipients","href":"/api-reference/bridges/patch-v3orgs-organisation-bridges-relationshipsnotification-recipients"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/people/teams","href":"/api-reference/teams/get-v3orgs-peopleteams"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/people/teams","href":"/api-reference/teams/create-a-team"},{"title":"Get a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/people/teams/{team_id}","href":"/api-reference/teams/get-v3orgs-peopleteams-1"},{"title":"Update a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/people/teams/{team_id}","href":"/api-reference/teams/update-a-team"},{"title":"Replace team members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/orgs/{org_id}/people/teams/{team_id}/relationships/members","href":"/api-reference/teams/patch-v3orgs-peopleteams-relationshipsmembers"}]},{"group":"Permits","pages":[{"title":"List permits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/permits","href":"/api-reference/permits/get-v3orgs-projectspermits"},{"title":"Create a permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/projects/permits","href":"/api-reference/permits/create-a-new-permit"},{"title":"Get a permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/permits/{permit_id}","href":"/api-reference/permits/get-v3orgs-projectspermits-1"},{"title":"Get permit insights","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/permit-insights","href":"/api-reference/permits/get-v3permit-insights"}]},{"group":"Schemes","pages":[{"title":"List scheme templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/scheme-templates","href":"/api-reference/schemes/get-v3orgs-projectsscheme-templates"},{"title":"Get a scheme template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/projects/scheme-templates","href":"/api-reference/schemes/create-a-new-scheme-template"},{"title":"Get a scheme template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/scheme-templates/{template_id}","href":"/api-reference/schemes/get-v3orgs-projectsscheme-templates-1"},{"title":"Update a scheme template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/projects/scheme-templates/{template_id}","href":"/api-reference/schemes/update-an-existing-scheme-template"},{"title":"List schemes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/schemes","href":"/api-reference/schemes/get-v3orgs-projectsschemes"},{"title":"Create a scheme","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/projects/schemes","href":"/api-reference/schemes/create-a-new-scheme"},{"title":"Get a scheme","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/schemes/{scheme_id}","href":"/api-reference/schemes/get-v3orgs-projectsschemes-1"},{"title":"Update a scheme","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/projects/schemes/{scheme_id}","href":"/api-reference/schemes/update-an-existing-scheme"},{"title":"List schemes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/schemes","href":"/api-reference/schemes/get-v3schemes"},{"title":"Get a scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/schemes/{scheme_id}","href":"/api-reference/schemes/get-v3schemes-1"},{"title":"Delete a scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/schemes/{scheme_id}","href":"/api-reference/schemes/delete-a-scheme"}]},{"group":"Work Orders","pages":[{"title":"List work order templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/work-order-templates","href":"/api-reference/work-orders/get-v3orgs-projectswork-order-templates"},{"title":"Create a work order template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/orgs/{org_id}/projects/work-order-templates","href":"/api-reference/work-orders/create-a-new-work-order-template"},{"title":"Get a work order template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/orgs/{org_id}/projects/work-order-templates/{template_id}","href":"/api-reference/work-orders/get-v3orgs-projectswork-order-templates-1"},{"title":"Update a work order template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/orgs/{org_id}/projects/work-order-templates/{template_id}","href":"/api-reference/work-orders/update-an-existing-work-order-template"},{"title":"List work orders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/work-orders","href":"/api-reference/work-orders/get-v3work-orders"},{"title":"Create a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/work-orders","href":"/api-reference/work-orders/create-a-new-work-order"},{"title":"Get a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/work-orders/{work_order_id}","href":"/api-reference/work-orders/get-v3work-orders-1"},{"title":"Update a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/work-orders/{work_order_id}","href":"/api-reference/work-orders/update-an-existing-work-order"},{"title":"Delete a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/work-orders/{work_order_id}","href":"/api-reference/work-orders/delete-a-work-order"},{"title":"Assign permits to a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/work-orders/{work_order_id}/relationships/permits","href":"/api-reference/work-orders/post-v3work-orders-relationshipspermits"},{"title":"Remove permits from a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/work-orders/{work_order_id}/relationships/permits","href":"/api-reference/work-orders/delete-v3work-orders-relationshipspermits"},{"title":"Replace permits on a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/work-orders/{work_order_id}/relationships/permits","href":"/api-reference/work-orders/patch-v3work-orders-relationshipspermits"},{"title":"Assign site managers to a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/work-orders/{work_order_id}/relationships/site-managers","href":"/api-reference/work-orders/post-v3work-orders-relationshipssite-managers"},{"title":"Remove site managers from a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/work-orders/{work_order_id}/relationships/site-managers","href":"/api-reference/work-orders/delete-v3work-orders-relationshipssite-managers"},{"title":"Replace site managers on a work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/work-orders/{work_order_id}/relationships/site-managers","href":"/api-reference/work-orders/patch-v3work-orders-relationshipssite-managers"}]},{"group":"IAM Permissions","pages":[{"title":"List permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/permissions","href":"/api-reference/iam-permissions/get-v3permissions"},{"title":"Get a permission","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/permissions/{permission_id}","href":"/api-reference/iam-permissions/get-v3permissions-1"}]},{"group":"Plane Goals","pages":[{"title":"List plane goals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-goals","href":"/api-reference/plane-goals/get-v3plane-goals"},{"title":"Create a plane goal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/plane-goals","href":"/api-reference/plane-goals/create-a-new-plane-goal"},{"title":"Get a plane goal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-goals/{plane_goal_id}","href":"/api-reference/plane-goals/get-v3plane-goals-1"},{"title":"Update a plane goal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/plane-goals/{plane_goal_id}","href":"/api-reference/plane-goals/update-an-existing-plane-goal"}]},{"group":"Plane Plans","pages":[{"title":"List plane plans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-plans","href":"/api-reference/plane-plans/get-v3plane-plans"},{"title":"Create a plane plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/plane-plans","href":"/api-reference/plane-plans/create-a-new-plane-plan"},{"title":"Get a plane plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-plans/{plane_plan_id}","href":"/api-reference/plane-plans/get-v3plane-plans-1"},{"title":"Update a plane plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/plane-plans/{plane_plan_id}","href":"/api-reference/plane-plans/update-an-existing-plane-plan"}]},{"group":"Plane Projects","pages":[{"title":"List plane projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-projects","href":"/api-reference/plane-projects/get-v3plane-projects"},{"title":"Create a plane project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/plane-projects","href":"/api-reference/plane-projects/create-a-new-plane-project"},{"title":"Get a plane project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-projects/{plane_project_id}","href":"/api-reference/plane-projects/get-v3plane-projects-1"},{"title":"Update a plane project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/plane-projects/{plane_project_id}","href":"/api-reference/plane-projects/update-an-existing-plane-project"}]},{"group":"Plane Session Events","pages":[{"title":"List plane session events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-session-events","href":"/api-reference/plane-session-events/get-v3plane-session-events"},{"title":"Create a plane session event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/plane-session-events","href":"/api-reference/plane-session-events/create-a-new-plane-session-event"},{"title":"Get a plane session event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-session-events/{plane_session_event_id}","href":"/api-reference/plane-session-events/get-v3plane-session-events-1"}]},{"group":"Plane Sessions","pages":[{"title":"List plane sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-sessions","href":"/api-reference/plane-sessions/get-v3plane-sessions"},{"title":"Create a plane session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/plane-sessions","href":"/api-reference/plane-sessions/create-a-new-plane-session"},{"title":"Get a plane session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/plane-sessions/{plane_session_id}","href":"/api-reference/plane-sessions/get-v3plane-sessions-1"},{"title":"Update a plane session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/plane-sessions/{plane_session_id}","href":"/api-reference/plane-sessions/update-an-existing-plane-session"}]},{"group":"Queries","pages":[{"title":"List queries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/queries","href":"/api-reference/queries/get-v3queries"},{"title":"Create a query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/queries","href":"/api-reference/queries/create-a-new-query"},{"title":"Get a query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/queries/{query_id}","href":"/api-reference/queries/get-v3queries-1"},{"title":"Delete a query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/queries/{query_id}","href":"/api-reference/queries/delete-a-query"},{"title":"Update a query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/queries/{query_id}","href":"/api-reference/queries/update-an-existing-query"},{"title":"Export a query as CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/queries/{query_id}/export","href":"/api-reference/queries/get-v3queries-export"},{"title":"Run a query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/queries/{query_id}/results","href":"/api-reference/queries/get-v3queries-results"},{"title":"Preview a query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/queries/preview","href":"/api-reference/queries/post-v3queriespreview"},{"title":"X-source resolution catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/query-resolution-catalogue","href":"/api-reference/queries/get-v3query-resolution-catalogue"}]},{"group":"Reports","pages":[{"title":"List report runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/report-runs","href":"/api-reference/reports/get-v3report-runs"},{"title":"Get a report run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/report-runs/{report_run_id}","href":"/api-reference/reports/get-v3report-runs-1"},{"title":"Download a report run's artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/report-runs/{report_run_id}/artifact","href":"/api-reference/reports/download-a-report-runs-artifact"},{"title":"List reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/reports","href":"/api-reference/reports/get-v3reports"},{"title":"Create a report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/reports","href":"/api-reference/reports/create-a-new-report"},{"title":"Get a report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/reports/{report_id}","href":"/api-reference/reports/get-v3reports-1"},{"title":"Delete a report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/reports/{report_id}","href":"/api-reference/reports/delete-a-report"},{"title":"Update a report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/reports/{report_id}","href":"/api-reference/reports/update-a-report"},{"title":"Run a report now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/reports/{report_id}/run","href":"/api-reference/reports/run-a-report-now"}]},{"group":"IAM Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/roles","href":"/api-reference/iam-roles/get-v3roles"},{"title":"Get a role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/roles/{role_id}","href":"/api-reference/iam-roles/get-v3roles-1"}]},{"group":"Scheme Contracts","pages":[{"title":"List scheme contracts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-contracts","href":"/api-reference/scheme-contracts/list-scheme-contracts"},{"title":"Create a scheme contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/scheme-contracts","href":"/api-reference/scheme-contracts/create-a-new-scheme-contract"},{"title":"Get a scheme contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-contracts/{scheme_contract_id}","href":"/api-reference/scheme-contracts/get-a-scheme-contract"},{"title":"Update a scheme contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/scheme-contracts/{scheme_contract_id}","href":"/api-reference/scheme-contracts/update-an-existing-scheme-contract"},{"title":"Delete a scheme contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/scheme-contracts/{scheme_contract_id}","href":"/api-reference/scheme-contracts/delete-a-scheme-contract"}]},{"group":"Scheme Shares","pages":[{"title":"List scheme shares","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-shares","href":"/api-reference/scheme-shares/list-scheme-share-resources"},{"title":"Create a scheme share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/scheme-shares","href":"/api-reference/scheme-shares/create-a-new-resource-share-between-2-organisations"},{"title":"Get a scheme share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-shares/{scheme_share_id}","href":"/api-reference/scheme-shares/get-a-scheme-share-resource"},{"title":"Update a scheme share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/scheme-shares/{scheme_share_id}","href":"/api-reference/scheme-shares/update-an-existing-scheme-share"},{"title":"Delete a scheme share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/scheme-shares/{scheme_share_id}","href":"/api-reference/scheme-shares/delete-a-scheme-share"},{"title":"Get the removal impact of a scheme share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/scheme-shares/{scheme_share_id}/removal-impact","href":"/api-reference/scheme-shares/get-the-removal-impact-of-a-scheme-share"}]},{"group":"Search","pages":[{"title":"Perform a search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/search","href":"/api-reference/search/get-v3search"},{"title":"Search shared resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/shared-search","href":"/api-reference/search/get-v3shared-search"}]},{"group":"Security Settings","pages":[{"title":"List security settings impacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/security-settings-impacts","href":"/api-reference/security-settings/list-who-requiring-mfa-would-affect"},{"title":"Update security settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/security-settings/{security_settings_id}","href":"/api-reference/security-settings/update-an-organisations-security-settings"}]},{"group":"Site Attendances","pages":[{"title":"List site attendances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/site-attendances","href":"/api-reference/site-attendances/list-site-attendance-resources"},{"title":"Sign a person in to site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/site-attendances","href":"/api-reference/site-attendances/sign-a-person-in-to-site"},{"title":"Get a site attendance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/site-attendances/{site_attendance_id}","href":"/api-reference/site-attendances/get-a-site-attendance-resource"},{"title":"Sign a person out of site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/site-attendances/{site_attendance_id}","href":"/api-reference/site-attendances/sign-a-person-out-or-correct-their-attendance"},{"title":"Sign several people out of site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/site-attendances/sign-out","href":"/api-reference/site-attendances/sign-several-people-out-of-site-at-once"}]},{"group":"SSO Providers","pages":[{"title":"Match an SSO provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/sso-provider-matches","href":"/api-reference/sso-providers/get-v3sso-provider-matches"},{"title":"List SSO providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/sso-providers","href":"/api-reference/sso-providers/get-v3sso-providers"},{"title":"Create an SSO provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/sso-providers","href":"/api-reference/sso-providers/create-an-sso-provider"},{"title":"Get an SSO provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/sso-providers/{sso_provider_id}","href":"/api-reference/sso-providers/get-v3sso-providers-1"},{"title":"Update an SSO provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/sso-providers/{sso_provider_id}","href":"/api-reference/sso-providers/update-an-existing-sso-provider"},{"title":"Delete an SSO provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/sso-providers/{sso_provider_id}","href":"/api-reference/sso-providers/delete-an-sso-provider"}]},{"group":"Status","pages":[{"title":"Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/status","href":"/api-reference/status/get-v3status"}]},{"group":"Geo","pages":[{"title":"Search for streets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/street-search-results","href":"/api-reference/geo/get-v3street-search-results"}]},{"group":"Uploads","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/uploads","href":"/api-reference/uploads/upload-a-file"}]},{"group":"Invitations","pages":[{"title":"List invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/user-invitations","href":"/api-reference/invitations/get-v3user-invitations"},{"title":"Invite a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/user-invitations","href":"/api-reference/invitations/creates-a-user-invitation-to-join-the-organisation"},{"title":"Get an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/user-invitations/{user_invitation_id}","href":"/api-reference/invitations/get-v3user-invitations-1"},{"title":"Delete an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/user-invitations/{user_invitation_id}","href":"/api-reference/invitations/delete-a-user-invitation"},{"title":"Update an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/user-invitations/{user_invitation_id}","href":"/api-reference/invitations/update-an-existing-user-invitation"},{"title":"Send an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/user-invitations/{user_invitation_id}/send","href":"/api-reference/invitations/send-the-invitation-email-for-a-user-invitation"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/users","href":"/api-reference/users/list-users"},{"title":"Create a managed user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/users","href":"/api-reference/users/create-a-new-managed-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/users/{user_id}","href":"/api-reference/users/update-a-user"},{"title":"Change a seat class","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/users/{user_id}/seat-class-changes","href":"/api-reference/users/change-a-members-seat-class"},{"title":"Send an access email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/users/{user_id}/send-access-email","href":"/api-reference/users/send-a-setup-or-password-reset-email-to-a-member"}]},{"group":"IAM","pages":[{"title":"List the app versions a user has used","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/users/{user_id}/app-versions","href":"/api-reference/iam/list-the-app-versions-a-user-has-used"},{"title":"Get v3users grants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/users/{user_id}/grants","href":"/api-reference/iam/get-v3users-grants"}]},{"group":"Vehicles","pages":[{"title":"List vehicle categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-categories","href":"/api-reference/vehicles/get-v3vehicle-categories"},{"title":"Create a vehicle category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-categories","href":"/api-reference/vehicles/create-a-new-vehicle-category"},{"title":"Get a vehicle category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-categories/{vehicle_category_id}","href":"/api-reference/vehicles/get-v3vehicle-categories-1"},{"title":"Delete a vehicle category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-categories/{vehicle_category_id}","href":"/api-reference/vehicles/delete-a-vehicle-category"},{"title":"Update a vehicle category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-categories/{vehicle_category_id}","href":"/api-reference/vehicles/update-a-vehicle-category"},{"title":"Add certifications to a vehicle category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-categories/{vehicle_category_id}/relationships/certifications","href":"/api-reference/vehicles/add-certifications-to-a-vehicle-category"},{"title":"Remove certifications from a vehicle category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-categories/{vehicle_category_id}/relationships/certifications","href":"/api-reference/vehicles/remove-certifications-from-a-vehicle-category"},{"title":"Replace a vehicle category's certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-categories/{vehicle_category_id}/relationships/certifications","href":"/api-reference/vehicles/replace-a-vehicle-categorys-certifications"},{"title":"List vehicle certificates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-certificates","href":"/api-reference/vehicles/get-v3vehicle-certificates"},{"title":"Create a vehicle certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-certificates","href":"/api-reference/vehicles/create-a-new-vehicle-certificate"},{"title":"Get a vehicle certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-certificates/{vehicle_certificate_id}","href":"/api-reference/vehicles/get-v3vehicle-certificates-1"},{"title":"Delete a vehicle certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-certificates/{vehicle_certificate_id}","href":"/api-reference/vehicles/delete-a-vehicle-certificate"},{"title":"Update a vehicle certificate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-certificates/{vehicle_certificate_id}","href":"/api-reference/vehicles/update-a-vehicle-certificate"},{"title":"List vehicle certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-certifications","href":"/api-reference/vehicles/get-v3vehicle-certifications"},{"title":"Create a vehicle certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-certifications","href":"/api-reference/vehicles/create-a-new-vehicle-certification"},{"title":"Get a vehicle certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-certifications/{vehicle_certification_id}","href":"/api-reference/vehicles/get-v3vehicle-certifications-1"},{"title":"Delete a vehicle certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-certifications/{vehicle_certification_id}","href":"/api-reference/vehicles/delete-a-vehicle-certification"},{"title":"Update a vehicle certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-certifications/{vehicle_certification_id}","href":"/api-reference/vehicles/update-a-vehicle-certification"},{"title":"List vehicle enquiries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-enquiries","href":"/api-reference/vehicles/get-v3vehicle-enquiries"},{"title":"Perform a vehicle enquiry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-enquiries","href":"/api-reference/vehicles/perform-a-new-vehicle-enquiry"},{"title":"Get a vehicle enquiry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-enquiries/{vehicle_enquiry_id}","href":"/api-reference/vehicles/get-v3vehicle-enquiries-1"},{"title":"List vehicle inspections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-inspections","href":"/api-reference/vehicles/get-v3vehicle-inspections"},{"title":"Create a vehicle inspection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-inspections","href":"/api-reference/vehicles/create-a-new-vehicle-inspection"},{"title":"Get a vehicle inspection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-inspections/{vehicle_inspection_id}","href":"/api-reference/vehicles/get-v3vehicle-inspections-1"},{"title":"Delete a vehicle inspection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-inspections/{vehicle_inspection_id}","href":"/api-reference/vehicles/delete-a-vehicle-inspection"},{"title":"Update a vehicle inspection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-inspections/{vehicle_inspection_id}","href":"/api-reference/vehicles/update-a-vehicle-inspection"},{"title":"List vehicle inventory checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-inventory-checks","href":"/api-reference/vehicles/get-v3vehicle-inventory-checks"},{"title":"Create a vehicle inventory check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-inventory-checks","href":"/api-reference/vehicles/create-a-new-vehicle-inventory-check"},{"title":"Get a vehicle inventory check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-inventory-checks/{vehicle_inventory_check_id}","href":"/api-reference/vehicles/get-v3vehicle-inventory-checks-1"},{"title":"Delete a vehicle inventory check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-inventory-checks/{vehicle_inventory_check_id}","href":"/api-reference/vehicles/delete-a-vehicle-inventory-check"},{"title":"Update a vehicle inventory check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-inventory-checks/{vehicle_inventory_check_id}","href":"/api-reference/vehicles/update-a-vehicle-inventory-check"},{"title":"List vehicle manufacturers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-manufacturers","href":"/api-reference/vehicles/get-v3vehicle-manufacturers"},{"title":"Create a vehicle manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-manufacturers","href":"/api-reference/vehicles/create-a-new-vehicle-manufacturer"},{"title":"Get a vehicle manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-manufacturers/{vehicle_manufacturer_id}","href":"/api-reference/vehicles/get-v3vehicle-manufacturers-1"},{"title":"Delete a vehicle manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-manufacturers/{vehicle_manufacturer_id}","href":"/api-reference/vehicles/delete-a-vehicle-manufacturer"},{"title":"Update a vehicle manufacturer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-manufacturers/{vehicle_manufacturer_id}","href":"/api-reference/vehicles/update-a-vehicle-manufacturer"},{"title":"List vehicle models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-models","href":"/api-reference/vehicles/get-v3vehicle-models"},{"title":"Create a vehicle model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-models","href":"/api-reference/vehicles/create-a-new-vehicle-model"},{"title":"Get a vehicle model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-models/{vehicle_model_id}","href":"/api-reference/vehicles/get-v3vehicle-models-1"},{"title":"Delete a vehicle model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-models/{vehicle_model_id}","href":"/api-reference/vehicles/delete-a-vehicle-model"},{"title":"Update a vehicle model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-models/{vehicle_model_id}","href":"/api-reference/vehicles/update-a-vehicle-model"},{"title":"List MOT records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-mot-records","href":"/api-reference/vehicles/get-v3vehicle-mot-records"},{"title":"Get an MOT record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-mot-records/{vehicle_mot_record_id}","href":"/api-reference/vehicles/get-v3vehicle-mot-records-1"},{"title":"List vehicle specifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-specifications","href":"/api-reference/vehicles/get-v3vehicle-specifications"},{"title":"Create a vehicle specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicle-specifications","href":"/api-reference/vehicles/create-a-new-vehicle-specification"},{"title":"Get a vehicle specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicle-specifications/{vehicle_specification_id}","href":"/api-reference/vehicles/get-v3vehicle-specifications-1"},{"title":"Delete a vehicle specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicle-specifications/{vehicle_specification_id}","href":"/api-reference/vehicles/delete-a-vehicle-specification"},{"title":"Update a vehicle specification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicle-specifications/{vehicle_specification_id}","href":"/api-reference/vehicles/update-a-vehicle-specification"},{"title":"List vehicles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicles","href":"/api-reference/vehicles/get-v3vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicles","href":"/api-reference/vehicles/create-a-new-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicles/{vehicle_id}","href":"/api-reference/vehicles/get-v3vehicles-1"},{"title":"Delete a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicles/{vehicle_id}","href":"/api-reference/vehicles/delete-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}","href":"/api-reference/vehicles/update-a-vehicle"},{"title":"Get a vehicle's compliance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicles/{vehicle_id}/compliance","href":"/api-reference/vehicles/get-v3vehicles-compliance"},{"title":"Get v3vehicles pre allocations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/vehicles/{vehicle_id}/pre-allocations","href":"/api-reference/vehicles/get-v3vehicles-pre-allocations"},{"title":"Create a vehicle pre-allocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicles/{vehicle_id}/pre-allocations","href":"/api-reference/vehicles/create-a-vehicle-pre-allocation"},{"title":"Cancel a vehicle pre-allocation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicles/{vehicle_id}/pre-allocations/{pre_allocation_id}","href":"/api-reference/vehicles/cancel-a-vehicle-pre-allocation"},{"title":"location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}/relationships/allocated_location","href":"/api-reference/vehicles/location"},{"title":"person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}/relationships/allocated_person","href":"/api-reference/vehicles/person"},{"title":"scheme","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}/relationships/allocated_scheme","href":"/api-reference/vehicles/scheme"},{"title":"work order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}/relationships/allocated_work_order","href":"/api-reference/vehicles/work-order"},{"title":"Add categories to a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicles/{vehicle_id}/relationships/categories","href":"/api-reference/vehicles/add-categories-to-a-vehicle"},{"title":"Remove categories from a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicles/{vehicle_id}/relationships/categories","href":"/api-reference/vehicles/remove-categories-from-a-vehicle"},{"title":"Replace a vehicle's categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}/relationships/categories","href":"/api-reference/vehicles/replace-a-vehicles-categories"},{"title":"Attach certificate records to a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicles/{vehicle_id}/relationships/certificates","href":"/api-reference/vehicles/attach-certificate-records-to-a-vehicle"},{"title":"Detach certificate records from a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicles/{vehicle_id}/relationships/certificates","href":"/api-reference/vehicles/detach-certificate-records-from-a-vehicle"},{"title":"Add certifications to a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/vehicles/{vehicle_id}/relationships/certifications","href":"/api-reference/vehicles/add-certifications-to-a-vehicle"},{"title":"Remove certifications from a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/vehicles/{vehicle_id}/relationships/certifications","href":"/api-reference/vehicles/remove-certifications-from-a-vehicle"},{"title":"Replace a vehicle's certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/vehicles/{vehicle_id}/relationships/certifications","href":"/api-reference/vehicles/replace-a-vehicles-certifications"}]},{"group":"Videos","pages":[{"title":"List videos","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/videos","href":"/api-reference/videos/get-v3videos"},{"title":"Create a video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/videos","href":"/api-reference/videos/create-a-video"},{"title":"Get a video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/videos/{video_id}","href":"/api-reference/videos/get-v3videos-1"},{"title":"Get a video poster","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/videos/{video_id}/poster.jpg","href":"/api-reference/videos/get-v3videos-posterjpg"},{"title":"Stream a video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/videos/{video_id}/stream","href":"/api-reference/videos/get-v3videos-stream"}]},{"group":"Waste Brokers","pages":[{"title":"Get v3waste brokers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-brokers","href":"/api-reference/waste-brokers/get-v3waste-brokers"},{"title":"Create a waste broker for an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/waste-brokers","href":"/api-reference/waste-brokers/create-a-waste-broker-for-an-organisation"},{"title":"Get v3waste brokers 1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-brokers/{waste_broker_id}","href":"/api-reference/waste-brokers/get-v3waste-brokers-1"},{"title":"Delete a waste broker","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/waste-brokers/{waste_broker_id}","href":"/api-reference/waste-brokers/delete-a-waste-broker"},{"title":"Update a waste broker","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/waste-brokers/{waste_broker_id}","href":"/api-reference/waste-brokers/update-a-waste-broker"}]},{"group":"Waste Carriers","pages":[{"title":"Get v3waste carriers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-carriers","href":"/api-reference/waste-carriers/get-v3waste-carriers"},{"title":"Create a waste carrier for an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/waste-carriers","href":"/api-reference/waste-carriers/create-a-waste-carrier-for-an-organisation"},{"title":"Get v3waste carriers 1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-carriers/{waste_carrier_id}","href":"/api-reference/waste-carriers/get-v3waste-carriers-1"},{"title":"Delete a waste carrier","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/waste-carriers/{waste_carrier_id}","href":"/api-reference/waste-carriers/delete-a-waste-carrier"},{"title":"Update a waste carrier","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/waste-carriers/{waste_carrier_id}","href":"/api-reference/waste-carriers/update-a-waste-carrier"}]},{"group":"Waste Reference Data","pages":[{"title":"Get v3waste container types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-container-types","href":"/api-reference/waste-reference-data/get-v3waste-container-types"},{"title":"Get v3waste disposal recovery codes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-disposal-recovery-codes","href":"/api-reference/waste-reference-data/get-v3waste-disposal-recovery-codes"},{"title":"Get v3waste ewc codes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-ewc-codes","href":"/api-reference/waste-reference-data/get-v3waste-ewc-codes"},{"title":"Get v3waste hazardous property codes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-hazardous-property-codes","href":"/api-reference/waste-reference-data/get-v3waste-hazardous-property-codes"},{"title":"Get v3waste pop names","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-pop-names","href":"/api-reference/waste-reference-data/get-v3waste-pop-names"}]},{"group":"Waste Movements","pages":[{"title":"Get v3waste movements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-movements","href":"/api-reference/waste-movements/get-v3waste-movements"},{"title":"Create a new waste movement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/waste-movements","href":"/api-reference/waste-movements/create-a-new-waste-movement"},{"title":"Get v3waste movements 1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-movements/{waste_movement_id}","href":"/api-reference/waste-movements/get-v3waste-movements-1"},{"title":"Update an existing waste movement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/waste-movements/{waste_movement_id}","href":"/api-reference/waste-movements/update-an-existing-waste-movement"}]},{"group":"Waste Settings","pages":[{"title":"Get v3waste settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-settings","href":"/api-reference/waste-settings/get-v3waste-settings"},{"title":"Create waste settings for an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/waste-settings","href":"/api-reference/waste-settings/create-waste-settings-for-an-organisation"},{"title":"Get v3waste settings 1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-settings/{waste_settings_id}","href":"/api-reference/waste-settings/get-v3waste-settings-1"},{"title":"Update an organisation's waste settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/waste-settings/{waste_settings_id}","href":"/api-reference/waste-settings/update-an-organisations-waste-settings"}]},{"group":"Waste Sites","pages":[{"title":"Get v3waste sites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-sites","href":"/api-reference/waste-sites/get-v3waste-sites"},{"title":"Create a waste site for an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/waste-sites","href":"/api-reference/waste-sites/create-a-waste-site-for-an-organisation"},{"title":"Get v3waste sites 1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-sites/{waste_site_id}","href":"/api-reference/waste-sites/get-v3waste-sites-1"},{"title":"Delete a waste site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v3/waste-sites/{waste_site_id}","href":"/api-reference/waste-sites/delete-a-waste-site"},{"title":"Update a waste site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/waste-sites/{waste_site_id}","href":"/api-reference/waste-sites/update-a-waste-site"}]},{"group":"Waste Submissions","pages":[{"title":"Get v3waste submissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-submissions","href":"/api-reference/waste-submissions/get-v3waste-submissions"},{"title":"Get v3waste submissions 1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/waste-submissions/{waste_submission_id}","href":"/api-reference/waste-submissions/get-v3waste-submissions-1"}]},{"group":"Work Permits","pages":[{"title":"List work permits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/work-permits","href":"/api-reference/work-permits/list-work-permits"},{"title":"Create a work permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/work-permits","href":"/api-reference/work-permits/create-a-work-permit"},{"title":"Get a work permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/work-permits/{work_permit_id}","href":"/api-reference/work-permits/get-a-work-permit"},{"title":"Update a work permit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v3/work-permits/{work_permit_id}","href":"/api-reference/work-permits/update-a-work-permit"}]},{"group":"Workflows","pages":[{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-definition-versions","href":"/api-reference/workflows/get-v3workflow-definition-versions"},{"title":"Create a workflow version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/workflow-definition-versions","href":"/api-reference/workflows/creates-a-new-workflow-definition-version"},{"title":"Get a workflow version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-definition-versions/{workflow_definition_version_id}","href":"/api-reference/workflows/get-v3workflow-definition-versions-1"},{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-definitions","href":"/api-reference/workflows/get-v3workflow-definitions"},{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/workflow-definitions","href":"/api-reference/workflows/creates-a-new-workflow-definition"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-definitions/{workflow_definition_id}","href":"/api-reference/workflows/get-v3workflow-definitions-1"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v3/workflow-definitions/{workflow_definition_id}","href":"/api-reference/workflows/update-an-existing-workflow-definition"},{"title":"Get workflow insights","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-definitions/{workflow_definition_id}/insights","href":"/api-reference/workflows/get-v3workflow-definitions-insights"},{"title":"List workflow submission journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-definitions/{workflow_definition_id}/insights/submissions","href":"/api-reference/workflows/get-v3workflow-definitions-insightssubmissions"},{"title":"Revert a workflow instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/workflow-instances/{workflow_instance_id}/revert","href":"/api-reference/workflows/revert-a-workflow-instance-out-of-a-terminal-step"},{"title":"List workflow transition records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-transition-records","href":"/api-reference/workflows/get-v3workflow-transition-records"},{"title":"Create a workflow transition record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v3/workflow-transition-records","href":"/api-reference/workflows/post-v3workflow-transition-records"},{"title":"Get a workflow transition record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v3/workflow-transition-records/{workflow_transition_record_id}","href":"/api-reference/workflows/get-v3workflow-transition-records-1"}]}]},{"tab":"What's Next","icon":"square-terminal","hidden":true,"pages":[{"title":"What's Next","href":"/roadmap/whats-next"}]},{"tab":"Changelog","icon":"square-terminal","hidden":true,"pages":[{"title":"Changelog","href":"/changelog/v3"}]}]},"title":"Create an equipment item - Ctrl Hub","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}