Work Orders
Get a Work Order
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
Work Orders
Get a Work Order
Returns a scheme
GET
/
v3
/
orgs
/
{orgId}
/
governance
/
schemes
/
{schemeId}
/
work-orders
/
{workOrderId}
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes/{schemeId}/work-orders/{workOrderId} \
--header 'Authorization: Bearer <token>'
{
"data": {
"type": "work-orders",
"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"
}
}
}
Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
The ID of the scheme
The ID of the work order
Response
200
application/json
The resource type
Available options:
work-orders
The ID of the work orders
The name of the work orders
The code of the work orders
The description of the work orders
The status of the scheme
Available options:
In Planning
, Live
, On Hold
, Complete
, Cancelled
The start date of the work orders
The end date of the work orders
An array of UPRN's (Unique Property Reference Number) related to the work order
An array of USRN's (Unique Street Reference Number) related to the work order
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes/{schemeId}/work-orders/{workOrderId} \
--header 'Authorization: Bearer <token>'
{
"data": {
"type": "work-orders",
"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"
}
}
}