Sharing

Dive into the specifics of each API endpoint by checking out our complete documentation.

You will find all the methods associated with CRUDing some sharing. Which isn't as weird as it sounds:

Create a new Sharing

This endpoint will allow you to create a new instance of Sharing. It can be a contract for instance.

POSThttps://api.hiboo.io/v2/fleet/sharings

Authorization

api_key

Body

application/json

More information about the required payload

reference*string

It can be a contract reference for instance

Example: "contract-4242-2024"

startDate*string (date-time)

Date from which the sharing of data should start (YYYY-MM-DDTHH:mm:ssZ)

endDatestring (date-time)

Date when the sharing of data should stop (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

assetIds*array of number (int64)

All the equipment that you wish to share, use Hiboo's ids

recipient*string (email)

Recipient's email address

Example: "[e-mail]"

Response

201400401403

Successful operation

Body

application/json

reference*string

It can be a contract reference for instance

Example: "contract-4242-2024"

startDate*string (date-time)

Date from which the sharing of data should start (YYYY-MM-DDTHH:mm:ssZ)

endDatestring (date-time)

Date when the sharing of data should stop (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

assetIds*array of number (int64)

All the equipment that you wish to share, use Hiboo's ids

recipient*string (email)

Recipient's email address

Example: "[e-mail]"

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/sharings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reference": "contract-4242-2024",
      "startDate": "2024-10-22T00:26:38.658Z",
      "assetIds": [
        [
          1,
          2,
          3
        ]
      ],
      "recipient": "[e-mail]"
    }),
});
const data = await response.json();

Response

201400401403

{
  "reference": "contract-4242-2024",
  "startDate": "2024-10-22T00:26:38.658Z",
  "endDate": "2024-10-22T00:26:38.658Z",
  "assetIds": [
    [
      1,
      2,
      3
    ]
  ],
  "recipient": "[e-mail]"
}

Update an existing sharing

Update an existing sharing by reference

PATCHhttps://api.hiboo.io/v2/fleet/sharings/{reference}

Authorization

api_key

Path parameters

reference*string

The reference you defined when creating the Sharing

Example: "contract-4242-2024"

Body

application/json

Update an existent sharing

referencestring

It can be a contract reference for instance

Example: "contract-4242-2024"

startDatestring (date-time)

Date from which the sharing of data should start (YYYY-MM-DDTHH:mm:ssZ)

endDatestring (date-time)

Date when the sharing of data should stop (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

Response

200400401403404409

Successful operation

Body

application/json

reference*string

It can be a contract reference for instance

Example: "contract-4242-2024"

startDate*string (date-time)

Date from which the sharing of data should start (YYYY-MM-DDTHH:mm:ssZ)

endDatestring (date-time)

Date when the sharing of data should stop (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

assetIds*array of number (int64)

All the equipment that you wish to share, use Hiboo's ids

recipient*string (email)

Recipient's email address

Example: "[e-mail]"

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/sharings/{reference}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409

{
  "reference": "contract-4242-2024",
  "startDate": "2024-10-22T00:26:38.658Z",
  "endDate": "2024-10-22T00:26:38.658Z",
  "assetIds": [
    [
      1,
      2,
      3
    ]
  ],
  "recipient": "[e-mail]"
}

List Sharing

Returns all Sharing instances that have been created

GEThttps://api.hiboo.io/v2/fleet/sharings

Authorization

api_key

Response

200401

successful operation

Body

application/json

reference*string

It can be a contract reference for instance

Example: "contract-4242-2024"

startDate*string (date-time)

Date from which the sharing of data should start (YYYY-MM-DDTHH:mm:ssZ)

endDatestring (date-time)

Date when the sharing of data should stop (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure

assetIds*array of number (int64)

All the equipment that you wish to share, use Hiboo's ids

recipient*string (email)

Recipient's email address

Example: "[e-mail]"

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/sharings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "reference": "contract-4242-2024",
  "startDate": "2024-10-22T00:26:38.658Z",
  "endDate": "2024-10-22T00:26:38.658Z",
  "assetIds": [
    [
      1,
      2,
      3
    ]
  ],
  "recipient": "[e-mail]"
}

Delete a Sharing

It totally deletes a Sharing as it never existed.

DELETEhttps://api.hiboo.io/v2/fleet/sharings/{reference}

Authorization

api_key

Path parameters

reference*string

The reference you defined when creating the Sharing

Example: "contract-4242-2024"

Response

204401403404409

Sharing was successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/sharings/{reference}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401403404409

{
  "message": "text"
}

Stop the sharing

DELETEhttps://api.hiboo.io/v2/fleet/sharings/{reference}/in-progress

Authorization

api_key

Path parameters

reference*string

The reference you defined when creating the Sharing

Example: "contract-4242-2024"

Response

204401403404409

successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/sharings/{reference}/in-progress', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401403404409

{
  "message": "text"
}