Operations
Operation Model
API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
- Reinstatements
Assets
- Vehicles
Admin
- IAM
Operations
Operation Model
The resource type
Available options:
operations Example:
"operations"
The ID of the operation
Example:
"5852cf16-8ec8-4aba-809e-f8d828772c4e"
The name of the operation
Example:
"IMGA100000"
The code of the operation
Example:
"CODE001"
The description of the operation
Example:
"DESC-123456"
The status of the scheme
Available options:
In Planning, Live, On Hold, Complete, Cancelled Example:
"active"
The start date of the operation
Example:
"2024-06-13T00:00:00.000Z"
The end date of the operation
Example:
"2024-08-13T00:00:00.000Z"
An array of UPRN's (Unique Property Reference Number) related to the work order
Example:
[10022999531]
An array of USRN's (Unique Street Reference Number) related to the work order
Example:
[14924880]
{
"type": "operations",
"id": "5852cf16-8ec8-4aba-809e-f8d828772c4e",
"attributes": {
"name": "IMGA100000",
"code": "CODE001",
"description": "DESC-123456",
"status": "active",
"start_date": "2024-06-13T00:00:00.000Z",
"end_date": "2024-08-13T00:00:00.000Z",
"uprns": [
10022999531
],
"usrns": [
14924880
],
"labels": [
{
"key": "your-label",
"value": "abc123"
},
{
"key": "another-label",
"value": "meaningful-value"
}
]
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z"
},
"links": {
"self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e/work-orders/5852cf16-8ec8-4aba-809e-f8d828772c4e/operations/5852cf16-8ec8-4aba-809e-f8d828772c4e"
}
}