Fleet
The following endpoints allow you to retrieve the list of all equipments and manage their identity.
Returns the list of all equipments and their identity. This endpoint is paginated.
The numbers of items to return
20The number of items to skip before starting to collect the result set
0By default, customFields are not included. If set to one, the custom fields will be included in the response
0By default, data sources related to the equipment are not included. If set to one, the data sources will be included in the response
0This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.
{"value":0,"summary":"Filter by not in progress sharing"}List of equipment
Unable to authenticate the token
GET /v2/fleet/equipments HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
{
"data": {
"total": 1,
"rows": [
{
"id": 1,
"name": "D8000-1",
"make": "Caterpillar",
"model": "8000",
"serialNumber": "YVR001988",
"workspaces": [
"Workspace 1"
],
"customFields": [
{
"name": "Custom Field 1",
"value": "Value 1"
}
]
}
]
}
}Returns the identity of a the requested equipment
ID of the equipment
By default, customFields are not included. If set to one, the custom fields will be included in the response
0List of equipment
Unable to authenticate the token
GET /v2/fleet/equipments/{id} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 1,
"name": "D8000-1",
"make": "Caterpillar",
"model": "8000",
"serialNumber": "YVR001988",
"workspaces": [
"Workspace 1"
],
"customFields": [
{
"name": "Custom Field 1",
"value": "Value 1"
}
]
}
}Marks the specified equipment as deleted. The equipment must be archived before it can be mark as deleted.
ID of the equipment
Equipment deleted successfully (no content)
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Equipment cannot be deleted unless it is archived first, or if it is currently involved in an in progress sharing process.
DELETE /v2/fleet/equipments/{id} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
No content
Returns the current status of the specified equipment. The response includes metadata depending on the status
ID of the equipment
Equipment status retrieved successfully
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
GET /v2/fleet/equipments/{id}/status HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
{
"status": "archived",
"metadata": {
"date": "2024-12-01T10:30:00Z",
"comment": "End-of-life; replaced by new model"
}
}Marks the specified equipment as archived. Archived equipment will no longer be active, but can be restored later using the /status/active endpoint.
ID of the equipment
Reason or note for archiving the equipment
Equipment is no longer in use and has been replacedEquipment archived successfully (no content)
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Equipment must be active before it can be archived
POST /v2/fleet/equipments/{id}/status/archived HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"comment": "Equipment is no longer in use and has been replaced"
}No content
Restores a previously archived equipment to active status.
ID of the equipment
Equipment unarchived successfully (no content)
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Equipment must be archived before it can be unarchived
POST /v2/fleet/equipments/{id}/status/active HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
No content
Was this helpful?