Equipment Document

Explore the full details of each API endpoint in our comprehensive documentation.

Here, you will find all the methods for performing Upload, Download, Update, Delete operations on documents. It's not as complicated as it sounds—whether you're creating new content, retrieving existing data, making updates, or removing documents, this API provides everything you need to manage your documents seamlessly.

Note

Please note that this API is still under active development and is not yet 100% ready.

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.

isPublicbooleanOptional

Indicates whether the document can be publicly accessible.

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

The user is not authenticated

application/json

403

The user does not have the right to upload a document

application/json

404

Equipment 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

HTTPcURLJavaScriptPython

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: 94

{
  "name": "text",
  "file": "binary",
  "shareable": true,
  "isPublic": true,
  "expirationDate": "2025-06-03"
}

{
  "id": 1,
  "name": "text",
  "shareable": true,
  "isPublic": true,
  "expirationDate": "2025-06-03",
  "fileInfos": {
    "size": 3.56,
    "contentType": "application/pdf",
    "uploadDate": "2025-06-03T21:56:09.229Z"
  }
}

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

The user is not authenticated

application/json

403

The user does not have the right to update a document

application/json

404

Equipment or document not found

application/json

409

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

patch

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "name": "text",
  "shareable": true,
  "isPublic": true,
  "expirationDate": "2025-06-03",
  "fileInfos": {
    "size": 3.56,
    "contentType": "application/pdf",
    "uploadDate": "2025-06-03T21:56:09.229Z"
  }
}

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

offsetintegerOptional

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

The user is not authenticated

application/json

404

Equipment not found

application/json

get

HTTPcURLJavaScriptPython

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-06-03",
      "fileInfos": {
        "size": 3.56,
        "contentType": "application/pdf",
        "uploadDate": "2025-06-03T21:56:09.229Z"
      }
    }
  ]
}

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

The user is not authenticated

application/json

404

Equipment or document not found

application/json

get

HTTPcURLJavaScriptPython

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

binary

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

The user is not authenticated

application/json

403

The user does not have the right to delete a document

application/json

404

Equipment or document not found

application/json

delete

HTTPcURLJavaScriptPython

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

No content