Equipment Groups

The following endpoints allow you to manage equipment groups, enabling you to link multiple equipments together.

Create a new equipment group

post

https://api.hiboo.iohttps://api-sandbox.hiboo.io

/v2/fleet/groups

Create a new group by linking multiple equipments together. At least 2 equipment IDs are required.

Authorizations

JWT

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

Body

application/json

assetIdsinteger[] · min: 2Required

List of equipment IDs to group together. At least 2 equipment IDs are required.

Example: [1,2,3]

Responses

201

Group successfully created

application/json

idintegerRequired

The unique identifier of the group

Example: 42

assetIdsinteger[]Required

List of equipment IDs in the group

Example: [1,2,3]

400

Cannot create a group with less than two equipments

application/json

401

Unable to authenticate the token

application/json

403

Insufficient permissions to create a group with these equipments

application/json

409

One or more equipments are already part of a group

application/json

post/v2/fleet/groups

HTTPcURLJavaScriptPython

POST /v2/fleet/groups HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "assetIds": [
    1,
    2,
    3
  ]
}

{
  "id": 42,
  "assetIds": [
    1,
    2,
    3
  ]
}

Update an equipment group

put

https://api.hiboo.iohttps://api-sandbox.hiboo.io

/v2/fleet/groups/{id}

Update an existing equipment group by replacing the list of equipments. At least 2 equipment IDs are required.

Authorizations

JWT

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

idintegerRequired

The unique identifier of the group to update.

Body

application/json

assetIdsinteger[] · min: 2Required

List of equipment IDs to group together. At least 2 equipment IDs are required.

Example: [1,2,3]

Responses

200

Group successfully updated

application/json

idintegerRequired

The unique identifier of the group

Example: 42

assetIdsinteger[]Required

List of equipment IDs in the group

Example: [1,2,3]

400

Insufficient equipments to form a group (at least 2 required)

application/json

401

Unable to authenticate the token

application/json

403

Insufficient permissions to edit this group

application/json

404

Group not found

application/json

409

One or more equipments are already part of another group

application/json

put/v2/fleet/groups/{id}

HTTPcURLJavaScriptPython

PUT /v2/fleet/groups/{id} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "assetIds": [
    1,
    2,
    3
  ]
}

{
  "id": 42,
  "assetIds": [
    1,
    2,
    3
  ]
}

Delete an equipment group

delete

https://api.hiboo.iohttps://api-sandbox.hiboo.io

/v2/fleet/groups/{id}

Delete an existing equipment group. This will unlink all equipments from the group.

Authorizations

JWT

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

idintegerRequired

The unique identifier of the group to delete.

Responses

204

Group successfully deleted

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to delete this group

application/json

delete/v2/fleet/groups/{id}

HTTPcURLJavaScriptPython

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

No content