# Hiboo Connect

The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process.

## List Sharing

> Returns all Sharing instances that have been created

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Hiboo Connect","description":"The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"schemas":{"Sharing":{"required":["reference","startDate","dataPacksCodes","assetIds","recipient","notificationEnabled","properties"],"type":"object","properties":{"reference":{"type":"string","description":"It can be a contract reference for instance"},"startDate":{"description":"Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ).","type":"string","format":"date-time"},"endDate":{"description":"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","type":"string","format":"date-time"},"status":{"description":"Current status of the sharing:\n- pending: The beneficiary user has not yet created an organization in Hiboo\n- planned: The sharing will be active (\"in progress\" status) as soon as the start date is reached\n- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream\n- 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\n- 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\n","type":"string","enum":["pending","planned","in_progress","stopped","completed"]},"dataPacksCodes":{"description":"List of data packs shared","type":"array","minItems":0,"items":{"type":"string","enum":["essential","vehicle_conditions","energy_and_fuel","activity","others","usage_hours","fault_codes"]}},"assetIds":{"description":"All the equipment that you wish to share, use Hiboo's ids","type":"array","minItems":1,"items":{"type":"number","format":"int64"}},"recipient":{"description":"Recipient's email address","type":"string","format":"email"},"notificationEnabled":{"description":"Defines if the notification is enabled on the sharing creation/start actions","type":"boolean"},"properties":{"type":"object","description":"Additional properties of the sharing","properties":{"customer":{"type":"string","description":"Customer name"},"site":{"type":"string","description":"Site name"},"contract":{"type":"string","description":"Contract reference"},"purchaseOrder":{"type":"string","description":"Purchase order reference"},"project":{"type":"string","description":"Project reference"},"accountNumber":{"type":"string","description":"Account number"}}}}},"Error":{"required":["message","details"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"},"details":{"type":"object","description":"Additional information about the Error"}}},"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}}},"paths":{"/v2/fleet/sharings":{"get":{"tags":["Hiboo Connect"],"summary":"List Sharing","description":"Returns all Sharing instances that have been created","operationId":"listSharing","parameters":[{"name":"offset","in":"query","required":true,"schema":{"type":"integer","description":"The number of items to skip before starting to collect the result set"}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","description":"The number of items to return"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["pending","planned","in_progress","stopped","completed"]},"description":"Filter by sharing status"},{"name":"assetId","in":"query","required":false,"schema":{"type":"integer","description":"Filter by asset ID"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sharing"}}}},"400":{"description":"Invalid input or missing parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```

## Create a new Sharing

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

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Hiboo Connect","description":"The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"schemas":{"CreateSharingBody":{"required":["reference","startDate","endDate","assetIds","recipient"],"type":"object","properties":{"reference":{"type":"string","description":"It can be a contract reference for instance"},"startDate":{"description":"Date 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.","type":"string","format":"date-time"},"endDate":{"description":"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","type":"string","format":"date-time"},"optionalDataPackCodes":{"deprecated":true,"description":"**Deprecated.** Use `excludedDataPackCodes` instead. 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. If both `optionalDataPackCodes` and `excludedDataPackCodes` are provided, `excludedDataPackCodes` will take precedence and `optionalDataPackCodes` will be ignored. idle data pack is always provided when passing optionalDataPackCodes, even if not specified, to avoid retrocompability issues. To exclude it, use excludedDataPackCodes parameter instead.","type":"array","minItems":0,"items":{"type":"string","enum":["fault_codes"]}},"excludedDataPackCodes":{"description":"An optional list of data packs to exclude from sharing. If not specified, all data will be shared by default. If set to an empty list, no data pack will be excluded. Otherwise, specified data packs will be excluded from sharing.","type":"array","minItems":0,"items":{"type":"string","enum":["fault_codes","idle"]}},"assetIds":{"description":"All the equipment that you wish to share, use Hiboo's ids","type":"array","minItems":1,"items":{"type":"number","format":"int64"}},"recipient":{"description":"Recipient's email address. The local part of the email address can only contain alphanumeric characters and the characters _ ' + - and .","type":"string","format":"email"},"notificationEnabled":{"description":"If false, the recipient will not be notified when the sharing is created or started","type":"boolean"},"properties":{"type":"object","description":"Additional properties to be added to the sharing","properties":{"customer":{"type":"string","description":"Customer name"},"site":{"type":"string","description":"Site name"},"contract":{"type":"string","description":"Contract reference"},"purchaseOrder":{"type":"string","description":"Purchase order reference"},"project":{"type":"string","description":"Project reference"},"accountNumber":{"type":"string","description":"Account number"}}}}},"Sharing":{"required":["reference","startDate","dataPacksCodes","assetIds","recipient","notificationEnabled","properties"],"type":"object","properties":{"reference":{"type":"string","description":"It can be a contract reference for instance"},"startDate":{"description":"Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ).","type":"string","format":"date-time"},"endDate":{"description":"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","type":"string","format":"date-time"},"status":{"description":"Current status of the sharing:\n- pending: The beneficiary user has not yet created an organization in Hiboo\n- planned: The sharing will be active (\"in progress\" status) as soon as the start date is reached\n- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream\n- 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\n- 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\n","type":"string","enum":["pending","planned","in_progress","stopped","completed"]},"dataPacksCodes":{"description":"List of data packs shared","type":"array","minItems":0,"items":{"type":"string","enum":["essential","vehicle_conditions","energy_and_fuel","activity","others","usage_hours","fault_codes"]}},"assetIds":{"description":"All the equipment that you wish to share, use Hiboo's ids","type":"array","minItems":1,"items":{"type":"number","format":"int64"}},"recipient":{"description":"Recipient's email address","type":"string","format":"email"},"notificationEnabled":{"description":"Defines if the notification is enabled on the sharing creation/start actions","type":"boolean"},"properties":{"type":"object","description":"Additional properties of the sharing","properties":{"customer":{"type":"string","description":"Customer name"},"site":{"type":"string","description":"Site name"},"contract":{"type":"string","description":"Contract reference"},"purchaseOrder":{"type":"string","description":"Purchase order reference"},"project":{"type":"string","description":"Project reference"},"accountNumber":{"type":"string","description":"Account number"}}}}},"Error":{"required":["message","details"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"},"details":{"type":"object","description":"Additional information about the Error"}}},"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}}},"paths":{"/v2/fleet/sharings":{"post":{"tags":["Hiboo Connect"],"summary":"Create a new Sharing","description":"This endpoint will allow you to create a new instance of Sharing. It can be a contract for instance.","operationId":"addSharing","requestBody":{"description":"More information about the required payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSharingBody"}}},"required":true},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sharing"}}}},"400":{"description":"Invalid input or missing parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"409":{"description":"Unique reference is already used by another sharing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}}}}}}
```

## Get a sharing

> Returns a single sharing by reference

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Hiboo Connect","description":"The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"schemas":{"Sharing":{"required":["reference","startDate","dataPacksCodes","assetIds","recipient","notificationEnabled","properties"],"type":"object","properties":{"reference":{"type":"string","description":"It can be a contract reference for instance"},"startDate":{"description":"Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ).","type":"string","format":"date-time"},"endDate":{"description":"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","type":"string","format":"date-time"},"status":{"description":"Current status of the sharing:\n- pending: The beneficiary user has not yet created an organization in Hiboo\n- planned: The sharing will be active (\"in progress\" status) as soon as the start date is reached\n- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream\n- 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\n- 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\n","type":"string","enum":["pending","planned","in_progress","stopped","completed"]},"dataPacksCodes":{"description":"List of data packs shared","type":"array","minItems":0,"items":{"type":"string","enum":["essential","vehicle_conditions","energy_and_fuel","activity","others","usage_hours","fault_codes"]}},"assetIds":{"description":"All the equipment that you wish to share, use Hiboo's ids","type":"array","minItems":1,"items":{"type":"number","format":"int64"}},"recipient":{"description":"Recipient's email address","type":"string","format":"email"},"notificationEnabled":{"description":"Defines if the notification is enabled on the sharing creation/start actions","type":"boolean"},"properties":{"type":"object","description":"Additional properties of the sharing","properties":{"customer":{"type":"string","description":"Customer name"},"site":{"type":"string","description":"Site name"},"contract":{"type":"string","description":"Contract reference"},"purchaseOrder":{"type":"string","description":"Purchase order reference"},"project":{"type":"string","description":"Project reference"},"accountNumber":{"type":"string","description":"Account number"}}}}},"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}}},"paths":{"/v2/fleet/sharings/{reference}":{"get":{"tags":["Hiboo Connect"],"summary":"Get a sharing","description":"Returns a single sharing by reference","operationId":"getSharing","parameters":[{"name":"reference","in":"path","description":"The reference you defined when creating the sharing","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sharing"}}}},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"}}}}}}
```

## Delete a Sharing

> It totally deletes a Sharing as it never existed. This will only work if the Sharing has not started yet.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Hiboo Connect","description":"The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}},"Error":{"required":["message","details"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"},"details":{"type":"object","description":"Additional information about the Error"}}}}},"paths":{"/v2/fleet/sharings/{reference}":{"delete":{"tags":["Hiboo Connect"],"summary":"Delete a Sharing","description":"It totally deletes a Sharing as it never existed. This will only work if the Sharing has not started yet.","operationId":"deleteSharing","parameters":[{"name":"reference","in":"path","description":"The reference you defined when creating the Sharing","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Sharing was successfully deleted"},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"},"409":{"description":"Sharing cannot be deleted because it has already started or ended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Update an existing sharing

> Update an existing sharing by reference

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Hiboo Connect","description":"The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"schemas":{"PatchSharingBody":{"type":"object","properties":{"reference":{"type":"string","description":"It can be a contract reference for instance"},"startDate":{"description":"Date 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.","type":"string","format":"date-time"},"endDate":{"description":"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","type":"string","format":"date-time"},"optionalDataPackCodes":{"deprecated":true,"description":"**Deprecated.** Use `excludedDataPackCodes` instead. 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. If both `optionalDataPackCodes` and `excludedDataPackCodes` are provided, `excludedDataPackCodes` will take precedence and `optionalDataPackCodes` will be ignored. idle data pack is always provided when passing optionalDataPackCodes, even if not specified, to avoid retrocompability issues. To exclude it, use excludedDataPackCodes parameter instead.","type":"array","minItems":0,"items":{"type":"string","enum":["fault_codes"]}},"excludedDataPackCodes":{"description":"An optional list of data packs to exclude from sharing. If not specified, all data will be shared by default. If set to an empty list, no data pack will be excluded. Otherwise, specified data packs will be excluded from sharing.","type":"array","minItems":0,"items":{"type":"string","enum":["fault_codes","idle"]}},"properties":{"type":"object","description":"Additional properties about the sharing","properties":{"customer":{"type":"string","description":"Customer name"},"site":{"type":"string","description":"Site name"},"contract":{"type":"string","description":"Contract reference"},"purchaseOrder":{"type":"string","description":"Purchase order reference"},"project":{"type":"string","description":"Project reference"},"accountNumber":{"type":"string","description":"Account number"}}}}},"Sharing":{"required":["reference","startDate","dataPacksCodes","assetIds","recipient","notificationEnabled","properties"],"type":"object","properties":{"reference":{"type":"string","description":"It can be a contract reference for instance"},"startDate":{"description":"Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ).","type":"string","format":"date-time"},"endDate":{"description":"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","type":"string","format":"date-time"},"status":{"description":"Current status of the sharing:\n- pending: The beneficiary user has not yet created an organization in Hiboo\n- planned: The sharing will be active (\"in progress\" status) as soon as the start date is reached\n- in_progress: The sharing is in progress and the beneficiary users have access to the assets data stream\n- 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\n- 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\n","type":"string","enum":["pending","planned","in_progress","stopped","completed"]},"dataPacksCodes":{"description":"List of data packs shared","type":"array","minItems":0,"items":{"type":"string","enum":["essential","vehicle_conditions","energy_and_fuel","activity","others","usage_hours","fault_codes"]}},"assetIds":{"description":"All the equipment that you wish to share, use Hiboo's ids","type":"array","minItems":1,"items":{"type":"number","format":"int64"}},"recipient":{"description":"Recipient's email address","type":"string","format":"email"},"notificationEnabled":{"description":"Defines if the notification is enabled on the sharing creation/start actions","type":"boolean"},"properties":{"type":"object","description":"Additional properties of the sharing","properties":{"customer":{"type":"string","description":"Customer name"},"site":{"type":"string","description":"Site name"},"contract":{"type":"string","description":"Contract reference"},"purchaseOrder":{"type":"string","description":"Purchase order reference"},"project":{"type":"string","description":"Project reference"},"accountNumber":{"type":"string","description":"Account number"}}}}},"Error":{"required":["message","details"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"},"details":{"type":"object","description":"Additional information about the Error"}}},"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}}},"paths":{"/v2/fleet/sharings/{reference}":{"patch":{"tags":["Hiboo Connect"],"summary":"Update an existing sharing","description":"Update an existing sharing by reference","operationId":"updateSharing","parameters":[{"name":"reference","in":"path","description":"The reference you defined when creating the Sharing","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Partial update of an existing sharing resource. Only the provided fields will be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSharingBody"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sharing"}}}},"400":{"description":"Missing parameters or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"},"409":{"description":"Sharing has already started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}}}}}}
```

## Stop the sharing

> 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.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Hiboo Connect","description":"The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}},"Error":{"required":["message","details"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"},"details":{"type":"object","description":"Additional information about the Error"}}}}},"paths":{"/v2/fleet/sharings/{reference}/in-progress":{"delete":{"tags":["Hiboo Connect"],"summary":"Stop the sharing","description":"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.","operationId":"stopSharing","parameters":[{"name":"reference","in":"path","description":"The reference you defined when creating the Sharing","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"successful operation"},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"},"409":{"description":"if the Sharing is not in progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hiboo.io/rest-api-reference/hiboo-connect.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.