Fleet

The following endpoints allow you to retrieve the list of all equipments and manage their identity.

Fleet

get

/v2/fleet/equipments

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

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Query parameters

limitinteger · int32 · max: 50Optional

The numbers of items to return

Default: 20

offsetinteger · int32Optional

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

Default: 0

includeCustomFieldsinteger · int32Optional

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

Default: 0

includeDataSourcesinteger · int32Optional

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

includeGroupinteger · int32Optional

By default, equipment group information is not included. If set to one, the group information will be included in the response

Default: 0

filterByInProgressSharingintegerOptional

This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.

Example: {"value":0,"summary":"Filter by not in progress sharing"}

Responses

200

List of equipment

application/json

401

Unable to authenticate the token

application/json

get/v2/fleet/equipments

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"
          }
        ],
        "group": {
          "id": 10,
          "assetIds": [
            1,
            2,
            3
          ]
        }
      }
    ]
  }
}

Archived Equipments

get

/v2/fleet/equipments/archived

Returns the list of archived equipments. This endpoint is paginated.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Query parameters

limitinteger · int32 · max: 50Optional

The numbers of items to return

Default: 20

offsetinteger · int32Optional

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

Default: 0

Responses

200

List of archived equipment

application/json

401

Unable to authenticate the token

application/json

get/v2/fleet/equipments/archived

GET /v2/fleet/equipments/archived HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 1,
    "rows": [
      {
        "id": 1,
        "archiveComment": "No longer in use",
        "archiveDate": "2025-01-01T00:00:00Z"
      }
    ]
  }
}

Equipment

get

/v2/fleet/equipments/{id}

Returns the identity of the requested equipment

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Query parameters

includeCustomFieldsinteger · int32Optional

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

application/json

get/v2/fleet/equipments/{id}

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

Delete an equipment

delete

/v2/fleet/equipments/{id}

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

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Responses

204

Equipment deleted successfully (no content)

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

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}

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

/v2/fleet/equipments/{id}/status

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

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Responses

200

Equipment status retrieved successfully

application/json

statusstring · enumRequired

Current status of the equipment

Possible values:

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

get/v2/fleet/equipments/{id}/status

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

/v2/fleet/equipments/{id}/status/archived

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

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

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)

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Equipment must be active before it can be archived

post/v2/fleet/equipments/{id}/status/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

Unarchive an equipment

post

/v2/fleet/equipments/{id}/status/active

Restores a previously archived equipment to active status.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Responses

204

Equipment unarchived successfully (no content)

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Equipment must be archived before it can be unarchived

post/v2/fleet/equipments/{id}/status/active

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

No content

PreviousFleet Identity NextWorkspaces

Last updated 27 days ago

Was this helpful?