Fleet

get

Returns the list of all equipments and their identity. This endpoint is paginated.

Authorizations

Query parameters

limitinteger · int64 · max: 50Optional

The numbers of items to return

Default: 20

offsetinteger · int64Optional

The number of items to skip before starting to collect the result set

Default: 0

includeCustomFieldsinteger · int64Optional

By default, customFields are not included. If set to one, the custom fields will be included in the response

Default: 0

includeDataSourcesinteger · int64Optional

By default, data sources related to the equipment are not included. If set to one, the data sources will be included in the response

Default: 0

Responses

200

List of equipment

application/json

401

Unable to authenticate the token

get

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",
            "Workspace 2"
          ]
        ],
        "customFields": [
          {
            "name": "Custom Field 1",
            "value": "Value 1"
          }
        ]
      }
    ]
  }
}

Equipment

get

Returns the identity of a the requested equipment

Authorizations

Path parameters

idinteger · int64Required

ID of the equipment

Query parameters

includeCustomFieldsinteger · int64Optional

By default, customFields are not included. If set to one, the custom fields will be included in the response

Default: 0

Responses

200

List of equipment

application/json

401

Unable to authenticate the token

get

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",
        "Workspace 2"
      ]
    ],
    "customFields": [
      {
        "name": "Custom Field 1",
        "value": "Value 1"
      }
    ]
  }
}

Delete an equipment

delete

Marks the specified equipment as deleted. The equipment must be archived before it can be mark as deleted.

Authorizations

Path parameters

idinteger · int64Required

ID of the equipment

Responses

204

Equipment deleted successfully (no content)

401

Unable to authenticate the token

403

Insufficient permissions to access the resource

404

Equipment not found

409

Equipment cannot be deleted unless it is archived first, or if it is currently involved in an in progress sharing process.

delete

DELETE /v2/fleet/equipments/{id} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

No content

Get equipment status

get

Returns the current status of the specified equipment. The response includes metadata depending on the status

Authorizations

Path parameters

idinteger · int64Required

ID of the equipment

Responses

200

Equipment status retrieved successfully

application/json

401

Unable to authenticate the token

403

Insufficient permissions to access the resource

404

Equipment not found

get

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"
  }
}

Archive an equipment

post

Marks the specified equipment as archived. Archived equipment will no longer be active, but can be restored later using the /status/active endpoint.

Authorizations

Path parameters

idinteger · int64Required

ID of the equipment

Body

commentstringRequired

Reason or note for archiving the equipment

Example: Equipment is no longer in use and has been replaced

Responses

204

Equipment archived successfully (no content)

401

Unable to authenticate the token

403

Insufficient permissions to access the resource

404

Equipment not found

409

Equipment must be active before it can be archived

post

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

Unarchive an equipment

post

Restores a previously archived equipment to active status.

Authorizations

Path parameters

idinteger · int64Required

ID of the equipment

Responses

204

Equipment unarchived successfully (no content)

401

Unable to authenticate the token

403

Insufficient permissions to access the resource

404

Equipment not found

409

Equipment must be archived before it can be unarchived

post

POST /v2/fleet/equipments/{id}/status/active HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

No content