api.sensors.v1 package¶
Submodules¶
api.sensors.v1.sensor module¶
Autogenerated API
-
api.sensors.v1.sensor.
find_sensors
(limit: int = None, offset: int = None, customerID: list = None, keywords: list = None, sortBy: list = None, startTimestamp: int = None, endTimestamp: int = None, includeFlags: list = None, excludeFlags: list = None, sensorID: list = None, locationName: list = None, applicationName: list = None, subCriteria: list = None, includeDeleted: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Search sensors (PUBLIC)
Return type: dict
Parameters: - limit (int) – Limit results
- offset (int) – Offset results
- customerID (list) – Limit result to objects belonging to these customers
- keywords (list) – Search for sensors matching this hostname or IP-address
- sortBy (list) – Order results by these properties (prefix with - to sort descending)
- startTimestamp (int) – Search objects from this timestamp
- endTimestamp (int) – Search objects until this timestamp
- includeFlags (list) – Search objects with these flags set
- excludeFlags (list) – Exclude objects with these flags set
- sensorID (list) – Search for specific sensors by ID
- locationName (list) – Search for sensors bound to any of these locations
- applicationName (list) – Search for sensors by application type
- subCriteria (list) –
- includeDeleted (bool) – Also include deleted objects (where implemented)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 814, “limit”: 620, “responseCode”: 200, “count”: 771, “data”: [{“id”: 557, “expectedUpdateTime”: 889, “scheduledDowntimeFromTime”: 27, “scheduledDowntimeUntilTime”: 565, “information”: “Sort degree finally address happy source play.”, “hostname”: “Tough hot who American as.”, “additionalData”: “Business tonight join treatment avoid.”, “flags”: [“MONITORED”], “lastUpdatedByUser”: {“id”: 47, “customerID”: 84, “userName”: “erindoyle”, “name”: “Sierra Torres”}, “lastUpdatedTimestamp”: 394559952, “lastAcknowledgedTimestamp”: 206154138, “inScheduledDowntime”: true}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Beat just national must not.”, “messageTemplate”: “Ready fund yet way.”, “field”: “Stage plan hour today.”, “parameter”: {}, “timestamp”: 1290204947}], “currentPage”: 233, “size”: 225}
-
api.sensors.v1.sensor.
get_sensor
(id: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch sensor by ID (PUBLIC)
Return type: dict
Parameters: id (int) – ID of sensor to fetch
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 852, “limit”: 838, “responseCode”: 200, “count”: 727, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Run cold street.”, “messageTemplate”: “Finish within method teacher build.”, “field”: “Specific onto student into everything low or.”, “parameter”: {}, “timestamp”: 1091517871}], “currentPage”: 154, “size”: 991}
-
api.sensors.v1.sensor.
get_sensor_comments
(sensorID: int, limit: int = 25, offset: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch sensor comments by sensor ID (PUBLIC)
Return type: dict
Parameters: - sensorID (int) – ID of sensor to fetch comments for
- limit (int) – Limit results
- offset (int) – Offset results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 492, “limit”: 500, “responseCode”: 200, “count”: 446, “data”: [{“timestamp”: 650524006, “user”: {“id”: 273, “customerID”: 672, “userName”: “spenceadam”, “name”: “Cynthia Young”}, “comment”: “Pattern form last there.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Democratic difficult score yourself close in.”, “messageTemplate”: “Eat child produce technology very.”, “field”: “Adult clearly home support window wait year.”, “parameter”: {}, “timestamp”: 95204308}], “currentPage”: 56, “size”: 841}
-
api.sensors.v1.sensor.
list_sensors
(customerID: list = None, applicationName: list = None, keywords: list = None, limit: int = 25, offset: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List sensors (PUBLIC)
Return type: dict
Parameters: Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 453, “limit”: 701, “responseCode”: 200, “count”: 959, “data”: [{“id”: 230, “expectedUpdateTime”: 183, “scheduledDowntimeFromTime”: 892, “scheduledDowntimeUntilTime”: 480, “information”: “Visit big phone to away fine those none.”, “hostname”: “Total center huge edge.”, “additionalData”: “Car great win.”, “flags”: [“SHARED_CUSTOMER_DATA”], “lastUpdatedByUser”: {“id”: 672, “customerID”: 601, “userName”: “megan27”, “name”: “Devin Jackson”}, “lastUpdatedTimestamp”: 1403180108, “lastAcknowledgedTimestamp”: 578620743, “inScheduledDowntime”: false}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Know fact fire.”, “messageTemplate”: “Professor bad during.”, “field”: “Drug since should across federal official.”, “parameter”: {}, “timestamp”: 379274416}], “currentPage”: 953, “size”: 916}
api.sensors.v1.status module¶
Autogenerated API
-
api.sensors.v1.status.
find_sensors
(limit: int = None, offset: int = None, customerID: list = None, keywords: list = None, sortBy: list = None, startTimestamp: int = None, endTimestamp: int = None, includeFlags: list = None, excludeFlags: list = None, sensorID: list = None, locationName: list = None, applicationName: list = None, subCriteria: list = None, includeDeleted: bool = 'False', excludeReportingSensors: bool = 'False', excludeSensorsInScheduledDowntime: bool = 'False', excludeSensorsInReportingCluster: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Search sensor status (PUBLIC)
Return type: dict
Parameters: - limit (int) – Limit results
- offset (int) – Offset results
- customerID (list) – Limit result to objects belonging to these customers
- keywords (list) – Search for sensors matching this hostname or IP-address
- sortBy (list) – Order results by these properties (prefix with - to sort descending)
- startTimestamp (int) – Search objects from this timestamp
- endTimestamp (int) – Search objects until this timestamp
- includeFlags (list) – Search objects with these flags set
- excludeFlags (list) – Exclude objects with these flags set
- sensorID (list) – Search for specific sensors by ID
- locationName (list) – Search for sensors bound to any of these locations
- applicationName (list) – Search for sensors by application type
- subCriteria (list) –
- includeDeleted (bool) – Also include deleted objects (where implemented)
- excludeReportingSensors (bool) – Exclude sensors which are reporting
- excludeSensorsInScheduledDowntime (bool) – Exclude sensors which are in scheduled downtime
- excludeSensorsInReportingCluster (bool) – Exclude sensors which are member of a cluster where any member is reporting
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 834, “limit”: 955, “responseCode”: 200, “count”: 806, “data”: [{“lastEventTimestamp”: 222599881, “lastUpdateTimestamp”: 1156699226, “messageRate”: 354, “lastAgentHost”: “Mouth business try foot forget we catch.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Size something employee stage anything themselves put.”, “messageTemplate”: “Only cold garden word best office.”, “field”: “Win best run important happen.”, “parameter”: {}, “timestamp”: 603506808}], “currentPage”: 866, “size”: 750}
-
api.sensors.v1.status.
get_sensor
(id: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch sensor status by ID (PUBLIC)
Return type: dict
Parameters: id (int) – ID of sensor to fetch status for
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 276, “limit”: 897, “responseCode”: 200, “count”: 79, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Production we task continue parent.”, “messageTemplate”: “Ok southern fire me itself point despite.”, “field”: “Mean hold new term.”, “parameter”: {}, “timestamp”: 777992535}], “currentPage”: 306, “size”: 662}
-
api.sensors.v1.status.
list_sensors
(customerID: list = None, applicationName: list = None, keywords: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List sensor status (PUBLIC)
Return type: dict
Parameters: Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 216, “limit”: 327, “responseCode”: 200, “count”: 250, “data”: [{“lastEventTimestamp”: 1380534508, “lastUpdateTimestamp”: 422236541, “messageRate”: 282, “lastAgentHost”: “Own not feeling clearly.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Woman pay radio finish.”, “messageTemplate”: “Gun everything trial billion property civil with measure.”, “field”: “Woman rise hard fire.”, “parameter”: {}, “timestamp”: 80486462}], “currentPage”: 583, “size”: 840}