Hiboo Connect
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
10The number of items to return
10Filter by sharing status
in_progressPossible values: Filter by asset ID
1successful operation
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).
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
Current status of the sharing:
- pending: The beneficiary user has not yet created an organization in Hiboo
- planned: The sharing will be active ("in progress" status) as soon as the start date is reached
- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream
- stopped: The sharing has been stopped before the initially scheduled end date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
- completed: The sharing has ended on the scheduled date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
All the equipment that you wish to share, use Hiboo's ids
[1,2,3]Recipient's email address
john.doe@example.comDefines if the notification is enabled on the sharing creation/start actions
Invalid input or missing parameters
Unable to authenticate the token
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
1Recipient's email address. The local part of the email address can only contain alphanumeric characters and the characters _ ' + - and .
john.doe@example.comIf false, the recipient will not be notified when the sharing is created or started
Successful operation
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).
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
Current status of the sharing:
- pending: The beneficiary user has not yet created an organization in Hiboo
- planned: The sharing will be active ("in progress" status) as soon as the start date is reached
- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream
- stopped: The sharing has been stopped before the initially scheduled end date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
- completed: The sharing has ended on the scheduled date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
All the equipment that you wish to share, use Hiboo's ids
[1,2,3]Recipient's email address
john.doe@example.comDefines if the notification is enabled on the sharing creation/start actions
Invalid input or missing parameters
Unable to authenticate the token
Insufficient permissions to access the resource
Unique reference is already used by another sharing
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
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).
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
Current status of the sharing:
- pending: The beneficiary user has not yet created an organization in Hiboo
- planned: The sharing will be active ("in progress" status) as soon as the start date is reached
- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream
- stopped: The sharing has been stopped before the initially scheduled end date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
- completed: The sharing has ended on the scheduled date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
All the equipment that you wish to share, use Hiboo's ids
[1,2,3]Recipient's email address
john.doe@example.comDefines if the notification is enabled on the sharing creation/start actions
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
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
No content
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
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
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).
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
Current status of the sharing:
- pending: The beneficiary user has not yet created an organization in Hiboo
- planned: The sharing will be active ("in progress" status) as soon as the start date is reached
- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream
- stopped: The sharing has been stopped before the initially scheduled end date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
- completed: The sharing has ended on the scheduled date. Beneficiary users don't have access to the assets current data stream anymore, but can still access the data history
All the equipment that you wish to share, use Hiboo's ids
[1,2,3]Recipient's email address
john.doe@example.comDefines if the notification is enabled on the sharing creation/start actions
Missing parameters or invalid parameters
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Sharing has already started
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
No content
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?