Connect
Last updated
Last updated
Dive into the specifics of each API endpoint by checking out our complete documentation.
You will find all the methods associated with CRUDing some data sharing. Which isn't as weird as it sounds:
Returns all Sharing instances that have been created
The number of items to skip before starting to collect the result set
The number of items to return
It totally deletes a Sharing as it never existed.
The reference you defined when creating the Sharing
contract-4242-2024No body
This endpoint will allow you to create a new instance of Sharing. It can be a contract for instance.
It can be a contract reference for instance
contract-4242-2024Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). For now, only a date in the future is accepted.
Date when the sharing of data should stop serialized as an ISO8601 string with a timezone (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
An optional list of data packs to share. If not specified, all data will be shared by default. If set to an empty list, only base data will be shared. Otherwise, base data and specified optional data packs will be shared.
fault_codesAll the equipment that you wish to share, use Hiboo's ids
1, 2, 3Recipient's email address
john.doe@example.comUpdate an existing sharing by reference
The reference you defined when creating the Sharing
contract-4242-2024It can be a contract reference for instance
contract-4242-2024Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). For now, only a date in the future is accepted.
Date when the sharing of data should stop serialized as an ISO8601 string with a timezone (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
An optional list of data packs to share. If not specified, all data will be shared by default. If set to an empty list, only base data will be shared. Otherwise, base data and specified optional data packs will be shared.
fault_codes