{"type":"api","title":"Subscribe a BLE Device","meta":{"id":"/apps/pubhub/media/spaces-connect-for-iot-services/8293790500ad8451a978dbb45a557b569302cec6/fe185569-32c7-3a71-a7db-7b18e6f0f371","info":{"version":"1.1.0","title":"IoT Nova NIPC APIs"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview-control.md"}},"openapi":"3.0.0"},"spec":{"summary":"Subscribe a BLE Device","operationId":"subscribeDevice","tags":["Data APIs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"technology":{"type":"string","description":"Specifies the wireless technology used; for Sensor Connect BLE use cases, this will be `ble` indicating Bluetooth Low Energy.","example":"ble"},"id":{"type":"string","description":"A unique identifier for the device in UUID format, obtained as a response when the device is onboarded using the SCIM API.","example":"5ae0c228-24c9-433c-9001-5a23f063ffd0"},"controlApp":{"type":"string","description":"Represents the control application instance that manages the BLE device interactions through Sensor Connect. This value is specified during device onboarding using the SCIM API to indicate the application authorized to perform control operations on the device.","example":"controlApplication","$$ref":"#/components/schemas/ControlAppProperty"},"ble":{"type":"object","properties":{"serviceID":{"type":"string","description":"The unique identifier (UUID) of a specific BLE service on the device.","example":"1800","$$ref":"#/components/schemas/BleServiceID"},"characteristicID":{"type":"string","description":"The unique identifier (UUID) of a specific characteristic within a BLE service, representing a data point or control feature.","example":"2A5E","$$ref":"#/components/schemas/BleCharacteristicID"}},"required":["serviceID","characteristicID"]},"topic":{"type":"string","description":"The MQTT topic used for streaming data related to the BLE device or application.","example":"enterprise/hospital/pulse_oximeter","$$ref":"#/components/schemas/TopicString"},"dataFormat":{"type":"string","description":"Defines the data format and the supported value is “default” indicating the use of a standard or predefined data format.","example":"default","$$ref":"#/components/schemas/DataFormatString"}},"required":["technology","id","controlApp","ble","topic","dataFormat"],"$$ref":"#/components/schemas/TopicDataFormat","description":"Subscribes to notifications or streaming data from the BLE device for real-time updates."}}}},"parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"example":"8506a7e0c4242b9091bde6735dedb41f"}],"responses":{"200":{"description":"Device subscribe successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Indicates the outcome of the API operation (e.g., 'SUCCESS', 'FAILURE').","example":"SUCCESS"},"id":{"type":"string","description":"A unique identifier for the device in UUID format, obtained as a response when the device is onboarded using the SCIM API.","example":"5ae0c228-24c9-433c-9001-5a23f063ffd0"},"requestID":{"type":"string","description":"A unique identifier for the specific API request, useful for tracking and debugging.","example":"ebfd7e14-d4b7-4aa4-97f9-2dfaffed7c08"}},"$$ref":"#/components/schemas/CommonStatusResponse"}}}}},"__originalOperationId":"subscribeDevice","method":"post","path":"/control/data/subscribe"}}