Equipment Documents

Get documents for a specific equipment

get

Retrieve a list of documents for the specified equipment.

Authorizations

Path parameters

idintegerRequired

The unique identifier of the equipment.

Query parameters

offsetinteger · int64Optional

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

Default: 0

limitintegerOptional

The number of items to return

Default: 10

Responses

200

A paginated list of documents for the equipment

application/json

400

Missing parameters or invalid parameters

application/json

401

Unable to authenticate the token

application/json

404

Resource not found

application/json

get

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

{
  "total": 1,
  "offset": 1,
  "limit": 1,
  "rows": [
    {
      "id": 1,
      "name": "text",
      "shareable": true,
      "isPublic": true,
      "expirationDate": "2025-08-20",
      "fileInfos": {
        "size": 3.56,
        "contentType": "application/pdf",
        "uploadDate": "2025-08-20T06:37:56.104Z"
      }
    }
  ]
}

Upload a document for a specific equipment

post

Upload a document to be associated with the specified equipment.

Authorizations

Path parameters

idintegerRequired

The unique identifier of the equipment.

Body

namestringRequired

The name of the document.

filestring · binaryRequired

The document file to be uploaded. The document must be one of the following types PDF, JPEG, PNG, GIF, TIFF, CSV, Excel, or Word documents. File size should not exceed 10MB (10,485,760 bytes).

shareablebooleanOptional

Indicates whether the document can be shared along with the related equipment. If true, the document will be shared automatically when the equipment is shared; if false, the document remains private.

Default: false

isPublicbooleanOptional

Indicates whether the document can be publicly accessible.

Default: false

expirationDatestring · dateOptional

Date when the document becomes invalid, formatted as 'YYYY-MM-DD' in UTC.

Pattern: /^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/

Responses

201

Document successfully uploaded

application/json

400

Missing parameters or invalid parameters

application/json

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Conflict with existing document metadata (e.g., duplicate name)

413

Payload Too Large. File should not exceeds 10MB

415

Unsupported Media Type

post

POST /v2/fleet/equipments/{id}/documents HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 96

{
  "name": "text",
  "file": "binary",
  "shareable": false,
  "isPublic": false,
  "expirationDate": "2025-08-20"
}

{
  "id": 1,
  "name": "text",
  "shareable": true,
  "isPublic": true,
  "expirationDate": "2025-08-20",
  "fileInfos": {
    "size": 3.56,
    "contentType": "application/pdf",
    "uploadDate": "2025-08-20T06:37:56.104Z"
  }
}

Delete a specific document

delete

Deletes a specific document associated with the specified equipment.

Authorizations

Path parameters

idintegerRequired

The unique identifier of the equipment.

documentIdintegerRequired

The unique identifier of the document.

Responses

204

Document successfully deleted

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

delete

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

No content

Update document metadata

patch

Update the metadata (e.g., name, isPublic) of a specific document associated with the specified equipment.

Authorizations

Path parameters

idintegerRequired

The unique identifier of the equipment.

documentIdintegerRequired

The unique identifier of the document.

Body

namestringOptional

The name of the document.

expirationDatestring · dateOptional

Date when the document becomes invalid, formatted as 'YYYY-MM-DD' in UTC.

Pattern: /^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/

Responses

200

Document metadata successfully updated

application/json

400

Missing parameters or invalid parameters

application/json

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Conflict with existing document metadata (e.g., duplicate name)

patch

PATCH /v2/fleet/equipments/{id}/documents/{documentId} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "expirationDate": "2025-08-20"
}

{
  "id": 1,
  "name": "text",
  "shareable": true,
  "isPublic": true,
  "expirationDate": "2025-08-20",
  "fileInfos": {
    "size": 3.56,
    "contentType": "application/pdf",
    "uploadDate": "2025-08-20T06:37:56.104Z"
  }
}

Download a specific document

get

Allows the user to download a specific document associated with the specified equipment.

Authorizations

Path parameters

idintegerRequired

The unique identifier of the equipment.

documentIdintegerRequired

The unique identifier of the document.

Responses

200

Document successfully downloaded

application/octet-stream

Responsestring · binary

401

Unable to authenticate the token

application/json

404

Resource not found

application/json

get

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

binary