Hiboo Connect
The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process.
Returns all Sharing instances that have been created
Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here
The number of items to skip before starting to collect the result set
The number of items to return
successful operation
Invalid input or missing parameters
Unable to authenticate the token
This endpoint will allow you to create a new instance of Sharing. It can be a contract for instance.
Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here
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). The date must not be before one rolling year.
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, set it to null if the end date is unsure
All the equipment that you wish to share, use Hiboo's ids
1If false, the recipient will not be notified when the sharing is created or started
Successful operation
Invalid input or missing parameters
Unable to authenticate the token
Insufficient permissions to access the resource
It totally deletes a Sharing as it never existed.
Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here
The reference you defined when creating the Sharing
contract-4242-2024Sharing was successfully deleted
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Sharing cannot be deleted because it has already started or ended
No content
Update an existing sharing by reference
Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here
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). The date must not be before one rolling year.
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
Successful operation
Missing parameters or invalid parameters
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Sharing has already started
This endpoint will stop the sharing of data for the specified reference. It will not delete the sharing, but it will stop the data sharing process.
Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here
The reference you defined when creating the Sharing
contract-4242-2024successful operation
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
if the Sharing is not in progress
No content
Last updated
Was this helpful?