","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"{{baseUrl}}/devices/:deviceId","host":["{{baseUrl}}"],"path":["devices",":deviceId"],"variable":[{"key":"deviceId","value":"mollit","description":"(Required) The ID of the device as returned by `/devices`"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5f1d2f64-6de7-48e4-8333-624392c0b834"},{"name":"Get business partners","id":"07ac22b4-5092-4585-a196-efc4cd0e1142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-SYSTEM-DISTRIBUTOR","value":"65490af0-ef62-11e9-847a-a58a2ea33526","type":"text"}],"url":"https://core.sensaru.net/api/v1/business_partners","description":"Returns a list of all assets, i. e. portfolios, economic units, properties and administration units.
\nResponse JSON
\nSuccess response
\nCode: 200
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result | \narray | \n | \nSee description below. | \n
\n\n
\n
Asset object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nnumber | \n1300 | \nThe ID of the category. | \n
\n\n| label | \nstring | \n\"Wohngebäude < 1000 m²\" | \nA descriptive label of the category. | \n
\n\n| level | \ninteger | \n2 | \n1 => asset is a portfolio
2 => asset is an economic unit
3 => asset is a property
4 => asset is an administration unit | \n
\n\n| locationId | \nstring | \n\"1240.2.4\" | \nThis is the economic unit ID, property ID and administration unit ID separated by dots.
For example
- Economic unit ID: `1000`
- Property ID: `105`
- Administration unit ID: `8`
becomes `1000.105.8`.
When the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: `1000.105`.
When the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: `1000`.
If the economic unit is part of a portfolio, the location ID is prefixed with the portfolio ID and a colon as separator. E. g.: 22:1000.105.8 for portfolio 22. | \n
\n\n| portfolioId | \nstring | \n\"22\" | \n(optional) The portfolio ID part of the location ID. | \n
\n\n| economicUnitId | \nstring | \n\"1240\" | \nThe economic unit ID part of the location ID. | \n
\n\n| propertyId | \nstring | \n\"2\" | \nThe property ID part of the location ID. | \n
\n\n| administrationUnitId | \nstring | \n\"4\" | \nThe administration unit ID part of the location ID. | \n
\n\n| addresses | \narray | \n[ { \"city\": \"The City\", \"country\": \"My Country\", \"street\": \"Main Street\", \"streetNumber\": \"2\", \"zip\": \"783928\" } ] | \n(optional) An optional array of addresses. The array is only returned if it was created previously. | \n
\n\n
\n
API key for authentication.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/building_categories","description":"Returns a list of all assets, i. e. portfolios, economic units, properties and administration units.
\nResponse JSON
\nSuccess response
\nCode: 200
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result | \narray | \n | \nSee description below. | \n
\n\n
\n
Asset object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nnumber | \n1300 | \nThe ID of the category. | \n
\n\n| label | \nstring | \n\"Wohngebäude < 1000 m²\" | \nA descriptive label of the category. | \n
\n\n| level | \ninteger | \n2 | \n1 => asset is a portfolio
2 => asset is an economic unit
3 => asset is a property
4 => asset is an administration unit | \n
\n\n| locationId | \nstring | \n\"1240.2.4\" | \nThis is the economic unit ID, property ID and administration unit ID separated by dots.
For example
- Economic unit ID: `1000`
- Property ID: `105`
- Administration unit ID: `8`
becomes `1000.105.8`.
When the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: `1000.105`.
When the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: `1000`.
If the economic unit is part of a portfolio, the location ID is prefixed with the portfolio ID and a colon as separator. E. g.: 22:1000.105.8 for portfolio 22. | \n
\n\n| portfolioId | \nstring | \n\"22\" | \n(optional) The portfolio ID part of the location ID. | \n
\n\n| economicUnitId | \nstring | \n\"1240\" | \nThe economic unit ID part of the location ID. | \n
\n\n| propertyId | \nstring | \n\"2\" | \nThe property ID part of the location ID. | \n
\n\n| administrationUnitId | \nstring | \n\"4\" | \nThe administration unit ID part of the location ID. | \n
\n\n| addresses | \narray | \n[ { \"city\": \"The City\", \"country\": \"My Country\", \"street\": \"Main Street\", \"streetNumber\": \"2\", \"zip\": \"783928\" } ] | \n(optional) An optional array of addresses. The array is only returned if it was created previously. | \n
\n\n
\n
API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner ID to send the request for.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/edge_client_groups/:edgeClientGroupId","description":"Deletes an asset.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["edge_client_groups",":edgeClientGroupId"],"host":["https://core.sensaru.net/api/v1"],"query":[],"variable":[{"id":"f923c14b-70f8-4fd9-b118-bd5fb6385ade","type":"any","value":"2644c9e2-f6b5-451e-a190-c3802722303b","key":"edgeClientGroupId"}]}},"response":[],"_postman_id":"a3399c5e-ddb2-4421-89ec-445286cf67f8"},{"name":"Get edge client group","id":"097d2131-987c-4948-819a-5263c6ccc278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner ID to send the request for.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/edge_client_groups/:edgeClientGroupId","description":"Returns a single asset. See Get assets for a description of the returned JSON.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["edge_client_groups",":edgeClientGroupId"],"host":["https://core.sensaru.net/api/v1"],"query":[],"variable":[{"id":"62f962e9-d14f-4b67-ab08-270c4847e58c","type":"any","value":"f6643497-69b1-4789-a1e2-dd688c2a1c39","key":"edgeClientGroupId"}]}},"response":[],"_postman_id":"097d2131-987c-4948-819a-5263c6ccc278"},{"name":"Update edge client group","id":"ef4e433b-7f66-4a29-8fde-71acdc4f0d7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner ID to send the request for.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My edge client group\",\r\n \"acl\": {\"moduleAccess\": {\"*\": {\"global\": {\"event\": true, \"isAdmin\": true, \"read\": true, \"write\": true}}}, \"version\": 1}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/edge_client_groups/:edgeClientGroupId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["edge_client_groups",":edgeClientGroupId"],"host":["https://core.sensaru.net/api/v1"],"query":[],"variable":[{"id":"1ed94fef-e88d-4618-9510-0d4e0b0acbcc","type":"any","value":"","key":"edgeClientGroupId"}]}},"response":[],"_postman_id":"ef4e433b-7f66-4a29-8fde-71acdc4f0d7c"}],"id":"c3b3cbc9-9424-4b71-9417-7c0bb274215a","_postman_id":"c3b3cbc9-9424-4b71-9417-7c0bb274215a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get edge client groups","id":"69310a81-46e3-4c3a-a0b0-4bce523ad183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner ID to send the request for.
\n"}],"url":"https://core.sensaru.net/api/v1/edge_client_groups","description":"Returns a list of all assets, i. e. portfolios, economic units, properties and administration units.
\nResponse JSON
\nSuccess response
\nCode: 200
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.assets | \narray | \n | \nSee description below. | \n
\n\n| result.responseMetadata | \nobject | \n | \n | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"1270.2.4\" | \nThe key to pass to the query parameter offset to get the next page. nextKey is set to an empty string when there is no more data. | \n
\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n
\n
Asset object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n | \nThe ID of the asset. Use this ID whereever an asset ID is required as part of the path. | \n
\n\n| name | \nstring | \n\"Kiel, Goethestraße 12\" | \nThe user-set name of the asset. | \n
\n\n| level | \ninteger | \n2 | \n1 => asset is a portfolio
2 => asset is an economic unit
3 => asset is a property
4 => asset is an administration unit | \n
\n\n| locationId | \nstring | \n\"1240.2.4\" | \nThis is the economic unit ID, property ID and administration unit ID separated by dots.
For example
- Economic unit ID: `1000`
- Property ID: `105`
- Administration unit ID: `8`
becomes `1000.105.8`.
When the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: `1000.105`.
When the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: `1000`.
If the economic unit is part of a portfolio, the location ID is prefixed with the portfolio ID and a colon as separator. E. g.: 22:1000.105.8 for portfolio 22. | \n
\n\n| portfolioId | \nstring | \n\"22\" | \n(optional) The portfolio ID part of the location ID. | \n
\n\n| economicUnitId | \nstring | \n\"1240\" | \nThe economic unit ID part of the location ID. | \n
\n\n| propertyId | \nstring | \n\"2\" | \nThe property ID part of the location ID. | \n
\n\n| administrationUnitId | \nstring | \n\"4\" | \nThe administration unit ID part of the location ID. | \n
\n\n| addresses | \narray
| \n[ { \"city\": \"The City\", \"country\": \"My Country\", \"street\": \"Main Street\", \"streetNumber\": \"2\", \"zip\": \"783928\" } ] | \n(optional) An optional array of addresses. The array is only returned if it was created previously. | \n
\n\n
\n
API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner ID to send the request for.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My edge client group\",\r\n \"acl\": {\"moduleAccess\": {\"*\": {\"global\": {\"event\": true, \"isAdmin\": true, \"read\": true, \"write\": true}}}, \"version\": 1}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/edge_client_groups","description":"Creates a new asset, i. e. a new portfolio, economic unit, property or administration unit.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| name | \nstring | \n\"Kiel, Goethestraße 12\" | \n\"\" | \nSee description below. | \n
\n\n| locationId | \nstring | \n\"1240.2.4\" | \n\"\" | \nThis is the economic unit ID, property ID and administration unit ID separated by dots.
For example
- Economic unit ID: `1000`
- Property ID: `105`
- Administration unit ID: `8`
becomes `1000.105.8`.
When the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: `1000.105`.
When the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: `1000`.
If the economic unit is part of a portfolio, the location ID is prefixed with the portfolio ID and a colon as separator. E. g.: 22:1000.105.8 for portfolio 22.
To create a portfolio, set the portfolio ID followed by a colon, e.g. `22:`. | \n
\n\n| addresses | \narray | \n[ { \"city\": \"The City\", \"country\": \"My Country\", \"street\": \"Main Street\", \"streetNumber\": \"2\", \"zip\": \"783928\" } ] | \n[] | \n(optional) An array of addresses. | \n
\n\n| customParameter | \nvariant | \n\"My custom parameter\" | \n | \n(optional) Any other property is stored as is in database. | \n
\n\n
\n
API key for authentication.
\n"}],"url":"https://core.sensaru.net/api/v1/modules","description":"Returns a list of all assets, i. e. portfolios, economic units, properties and administration units.
\nResponse JSON
\nSuccess response
\nCode: 200
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.assets | \narray | \n | \nSee description below. | \n
\n\n| result.responseMetadata | \nobject | \n | \n | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"1270.2.4\" | \nThe key to pass to the query parameter offset to get the next page. nextKey is set to an empty string when there is no more data. | \n
\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n
\n
Asset object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n | \nThe ID of the asset. Use this ID whereever an asset ID is required as part of the path. | \n
\n\n| name | \nstring | \n\"Kiel, Goethestraße 12\" | \nThe user-set name of the asset. | \n
\n\n| level | \ninteger | \n2 | \n1 => asset is a portfolio
2 => asset is an economic unit
3 => asset is a property
4 => asset is an administration unit | \n
\n\n| locationId | \nstring | \n\"1240.2.4\" | \nThis is the economic unit ID, property ID and administration unit ID separated by dots.
For example
- Economic unit ID: `1000`
- Property ID: `105`
- Administration unit ID: `8`
becomes `1000.105.8`.
When the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: `1000.105`.
When the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: `1000`.
If the economic unit is part of a portfolio, the location ID is prefixed with the portfolio ID and a colon as separator. E. g.: 22:1000.105.8 for portfolio 22. | \n
\n\n| portfolioId | \nstring | \n\"22\" | \n(optional) The portfolio ID part of the location ID. | \n
\n\n| economicUnitId | \nstring | \n\"1240\" | \nThe economic unit ID part of the location ID. | \n
\n\n| propertyId | \nstring | \n\"2\" | \nThe property ID part of the location ID. | \n
\n\n| administrationUnitId | \nstring | \n\"4\" | \nThe administration unit ID part of the location ID. | \n
\n\n| addresses | \narray
| \n[ { \"city\": \"The City\", \"country\": \"My Country\", \"street\": \"Main Street\", \"streetNumber\": \"2\", \"zip\": \"783928\" } ] | \n(optional) An optional array of addresses. The array is only returned if it was created previously. | \n
\n\n
\n
API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log?timeFormat=iso-8601&convertToNumber=true&aggregate=15m&dateFrom=1682892000&dateTo=1685570400&limit=1000","description":"Returns the data point log (time series) for a specific data point.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.log | \narray | \n[[1700000000, 22.5], ...] | \nArray of [timestamp, value] pairs. Timestamp format depends on timeFormat query parameter. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
(optional) unix-timestamp-seconds (default), unix-timestamp-milliseconds, or iso-8601.
\n","type":"text/plain"},"key":"timeFormat","value":"iso-8601"},{"disabled":true,"description":{"content":"(optional) raw (default) or localized (formatted with units).
\n","type":"text/plain"},"key":"dataPointFormat","value":"raw"},{"description":{"content":"(optional) Convert boolean/array values to numbers.
\n","type":"text/plain"},"key":"convertToNumber","value":"true"},{"description":{"content":"(optional) Aggregation: none (default), 15m, hour, day, all.
\n","type":"text/plain"},"key":"aggregate","value":"15m"},{"description":{"content":"(optional) Start time as Unix timestamp in seconds.
\n","type":"text/plain"},"key":"dateFrom","value":"1682892000"},{"description":{"content":"(optional) End time as Unix timestamp in seconds.
\n","type":"text/plain"},"key":"dateTo","value":"1685570400"},{"disabled":true,"description":{"content":"(optional) Sort direction. Default: true.
\n","type":"text/plain"},"key":"ascending","value":"true"},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–10000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"1000"},{"disabled":true,"description":{"content":"(optional) Language code for localized formatting.
\n","type":"text/plain"},"key":"lang","value":"de"}],"variable":[{"id":"3dac6cbd-12ca-4673-b92b-bbd57ccd924f","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"},{"id":"8e9dfb8d-64c8-4a37-87d3-ecde7eb3b71f","description":{"content":"(required) The data point UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"dataPointId"}]}},"response":[{"id":"e6ea977f-1edd-4f15-99d4-11132df6c895","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log?timeFormat=iso-8601&convertToNumber=true&aggregate=15m&dateFrom=1682892000&dateTo=1685570400&limit=1000","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId","log"],"query":[{"key":"timeFormat","value":"iso-8601","description":"(optional) `unix-timestamp-seconds` (default), `unix-timestamp-milliseconds`, or `iso-8601`."},{"key":"dataPointFormat","value":"raw","description":"(optional) `raw` (default) or `localized` (formatted with units).","disabled":true},{"key":"convertToNumber","value":"true","description":"(optional) Convert boolean/array values to numbers."},{"key":"aggregate","value":"15m","description":"(optional) Aggregation: `none` (default), `15m`, `hour`, `day`, `all`."},{"key":"dateFrom","value":"1682892000","description":"(optional) Start time as Unix timestamp in seconds."},{"key":"dateTo","value":"1685570400","description":"(optional) End time as Unix timestamp in seconds."},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"1000","description":"(optional) Page size (1–10000). Default: `100`."},{"key":"lang","value":"de","description":"(optional) Language code for localized formatting.","disabled":true}],"variable":[{"id":"3dac6cbd-12ca-4673-b92b-bbd57ccd924f","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"8e9dfb8d-64c8-4a37-87d3-ecde7eb3b71f","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Returns the data point log (time series) for a specific data point.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.log** | array | `[[1700000000, 22.5], ...]` | Array of `[timestamp, value]` pairs. Timestamp format depends on `timeFormat` query parameter. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"log\": [\n [\n 1700000000,\n 22.5\n ],\n [\n 1700003600,\n 23.1\n ],\n [\n 1700007200,\n 24.2\n ]\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"},{"id":"544ed9de-bf58-4baf-baa9-ad708fa27a6f","name":"Success (timeFormat=iso-8601)","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log?timeFormat=iso-8601&convertToNumber=true&aggregate=15m&dateFrom=1682892000&dateTo=1685570400&limit=1000","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId","log"],"query":[{"key":"timeFormat","value":"iso-8601","description":"(optional) `unix-timestamp-seconds` (default), `unix-timestamp-milliseconds`, or `iso-8601`."},{"key":"dataPointFormat","value":"raw","description":"(optional) `raw` (default) or `localized` (formatted with units).","disabled":true},{"key":"convertToNumber","value":"true","description":"(optional) Convert boolean/array values to numbers."},{"key":"aggregate","value":"15m","description":"(optional) Aggregation: `none` (default), `15m`, `hour`, `day`, `all`."},{"key":"dateFrom","value":"1682892000","description":"(optional) Start time as Unix timestamp in seconds."},{"key":"dateTo","value":"1685570400","description":"(optional) End time as Unix timestamp in seconds."},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"1000","description":"(optional) Page size (1–10000). Default: `100`."},{"key":"lang","value":"de","description":"(optional) Language code for localized formatting.","disabled":true}],"variable":[{"id":"3dac6cbd-12ca-4673-b92b-bbd57ccd924f","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"8e9dfb8d-64c8-4a37-87d3-ecde7eb3b71f","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Returns the data point log (time series) for a specific data point.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.log** | array | `[[1700000000, 22.5], ...]` | Array of `[timestamp, value]` pairs. Timestamp format depends on `timeFormat` query parameter. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"log\": [\n [\n \"2024-11-15T10:00:00.000\",\n 22.5\n ],\n [\n \"2024-11-15T11:00:00.000\",\n 23.1\n ]\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"99350c4c-a6c7-43c3-ac38-c9e6654310ce"},{"name":"Add log entries","id":"1dde3a00-e35d-41a8-bee8-c63538e7e60b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entries\": [\n [\n 1682892000,\n 21.5\n ],\n [\n 1682892120,\n 21.6\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log?timeZone=Europe/Berlin&publishLast=true","description":"Creates one or more data point log entries.
\nRequest body JSON
\nThe body accepts an object with an entries array, or a flat array directly.
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| entries | \narray | \n[[1682892000, 21.5], [1682892120, 21.6]] | \n | \n(required) Array of [utcTimestamp, value] pairs. utcTimestamp is a Unix timestamp in seconds (UTC). value can be any type (number, boolean, string). | \n
\n\n
\n
Alternatively, the array can be passed directly without the entries wrapper:
\n[[1682892000, 21.5], [1682892120, 21.6]]\n
\nA legacy single-entry object format is also supported:
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| dateUtc | \ninteger | \n1682892000 | \n | \n(required) Unix timestamp in seconds (UTC). | \n
\n\n| dateLocal | \ninteger | \n1682899200 | \n | \n(required) Unix timestamp in seconds (local time). | \n
\n\n| value | \nvariant | \n21.5 | \n | \n(required) The data point value. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId","data-points",":dataPointId","log"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[{"description":{"content":"(optional) Timezone for local time calculation. Default: UTC.
\n","type":"text/plain"},"key":"timeZone","value":"Europe/Berlin"},{"description":{"content":"(optional) Publish the last entry as current value. Default: false.
\n","type":"text/plain"},"key":"publishLast","value":"true"}],"variable":[{"id":"87367cb2-4929-4ded-8e3c-20091e00f819","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"},{"id":"e209a147-e053-4f98-9778-2988c43a7ee7","description":{"content":"(required) The data point UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"dataPointId"}]}},"response":[{"id":"1f185038-f39a-49c5-bf1f-92831b00608e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"entries\": [\n [\n 1682892000,\n 21.5\n ],\n [\n 1682892120,\n 21.6\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log?timeZone=Europe/Berlin&publishLast=true","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId","log"],"query":[{"key":"timeZone","value":"Europe/Berlin","description":"(optional) Timezone for local time calculation. Default: `UTC`."},{"key":"publishLast","value":"true","description":"(optional) Publish the last entry as current value. Default: `false`."}],"variable":[{"id":"87367cb2-4929-4ded-8e3c-20091e00f819","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"e209a147-e053-4f98-9778-2988c43a7ee7","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Creates one or more data point log entries.\n\n#### Request body JSON\n\nThe body accepts an object with an `entries` array, or a flat array directly.\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **entries** | array | `[[1682892000, 21.5], [1682892120, 21.6]]` | | (required) Array of `[utcTimestamp, value]` pairs. `utcTimestamp` is a Unix timestamp in seconds (UTC). `value` can be any type (number, boolean, string). |\n\nAlternatively, the array can be passed directly without the `entries` wrapper:\n```json\n[[1682892000, 21.5], [1682892120, 21.6]]\n```\n\nA legacy single-entry object format is also supported:\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **dateUtc** | integer | `1682892000` | | (required) Unix timestamp in seconds (UTC). |\n| **dateLocal** | integer | `1682899200` | | (required) Unix timestamp in seconds (local time). |\n| **value** | variant | `21.5` | | (required) The data point value. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"1dde3a00-e35d-41a8-bee8-c63538e7e60b"},{"name":"Delete log entry","id":"1d2d381e-1242-4746-bf74-410c3ce816eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log/:logEntryId","description":"Deletes a single data point log entry identified by its local and UTC timestamps in milliseconds. The path format is {localTimeMs}_{utcTimeMs}.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId","data-points",":dataPointId","log",":logEntryId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"fa83f6d2-aff8-48e2-b7ef-ad6f824bc061","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"},{"id":"231e98fe-0f2c-47fe-a5e3-606623025c66","description":{"content":"(required) The data point UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"dataPointId"},{"id":"40b08555-7d08-4654-a8f4-465fa6e988b8","description":{"content":"(required) Format: {localTimeMs}_{utcTimeMs}. Both values in milliseconds.
\n","type":"text/plain"},"type":"any","value":"1682895600000_1682888400000","key":"logEntryId"}]}},"response":[{"id":"c2f02c40-c28b-4ce2-9df3-9ceaab5e8c1f","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId/log/:logEntryId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId","log",":logEntryId"],"variable":[{"id":"fa83f6d2-aff8-48e2-b7ef-ad6f824bc061","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"231e98fe-0f2c-47fe-a5e3-606623025c66","key":"dataPointId","value":"","description":"(required) The data point UUID."},{"id":"40b08555-7d08-4654-a8f4-465fa6e988b8","key":"logEntryId","value":"1682895600000_1682888400000","description":"(required) Format: `{localTimeMs}_{utcTimeMs}`. Both values in milliseconds."}]},"description":"Deletes a single data point log entry identified by its local and UTC timestamps in milliseconds. The path format is `{localTimeMs}_{utcTimeMs}`.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"1d2d381e-1242-4746-bf74-410c3ce816eb"}],"id":"de37f21d-54c0-4118-a917-0ae6b01a02c8","_postman_id":"de37f21d-54c0-4118-a917-0ae6b01a02c8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get data point","id":"d6e7cb11-0d8d-4002-94f2-1d38d5396834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId?lang=en-US","description":"Returns a single data point by ID.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is a single data point object.
\nData point object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"dp-uuid\" | \nData point UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nOwning business partner. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical location. | \n
\n\n| disabled | \nboolean | \nfalse | \nWhether data point is disabled. | \n
\n\n| label | \nstring | \n\"Supply Temperature\" | \nLocalized display name. | \n
\n\n| nativeId | \nstring | \n\"S108AABB.supplyTemperature\" | \nInternal native identifier (serial.name). | \n
\n\n| parentId | \nUUID | \n\"device-uuid\" | \nParent device UUID. | \n
\n\n| type | \nstring | \n\"double\" | \nValue type (double, boolean, string, array). | \n
\n\n| aggregation | \nstring | \n\"average\" | \nAggregation method (average, last, sum). | \n
\n\n| role | \ninteger | \n201014 | \nNumeric role ID. | \n
\n\n| roleName | \nstring | \n\"Supply Temperature\" | \nLocalized role name. | \n
\n\n| tags | \narray | \n[\"heating\"] | \nUser-defined tags. | \n
\n\n| unit | \nstring | \n\"°C\" | \nDisplay unit. | \n
\n\n| unitCode | \ninteger | \n2 | \nNumeric unit code. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nParent device serial number. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether parent is a Sensaru device. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| value | \nvariant | \n45.3 | \n(optional) Last known value. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"}],"variable":[{"id":"eaa037b0-2832-4d1a-b527-9f105c2fbac8","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"},{"id":"072712ab-b456-45ec-9a1b-30fd9ca63bb3","description":{"content":"(required) The data point UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"dataPointId"}]}},"response":[{"id":"bb248ecc-b05f-4178-b31c-b2d27a202bdd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."}],"variable":[{"id":"eaa037b0-2832-4d1a-b527-9f105c2fbac8","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"072712ab-b456-45ec-9a1b-30fd9ca63bb3","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Returns a single data point by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single data point object.\n\n\n##### Data point object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"dp-uuid\"` | Data point UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Owning business partner. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical location. |\n| **disabled** | boolean | `false` | Whether data point is disabled. |\n| **label** | string | `\"Supply Temperature\"` | Localized display name. |\n| **nativeId** | string | `\"S108AABB.supplyTemperature\"` | Internal native identifier (`serial.name`). |\n| **parentId** | UUID | `\"device-uuid\"` | Parent device UUID. |\n| **type** | string | `\"double\"` | Value type (`double`, `boolean`, `string`, `array`). |\n| **aggregation** | string | `\"average\"` | Aggregation method (`average`, `last`, `sum`). |\n| **role** | integer | `201014` | Numeric role ID. |\n| **roleName** | string | `\"Supply Temperature\"` | Localized role name. |\n| **tags** | array | `[\"heating\"]` | User-defined tags. |\n| **unit** | string | `\"°C\"` | Display unit. |\n| **unitCode** | integer | `2` | Numeric unit code. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Parent device serial number. |\n| **isSensaruDevice** | boolean | `true` | Whether parent is a Sensaru device. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **value** | variant | `45.3` | (optional) Last known value. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": \"dp-uuid-1\",\n \"businessPartnerId\": \"bp-uuid\",\n \"locationId\": \"1:WE-01.100\",\n \"disabled\": false,\n \"label\": \"Supply Temperature\",\n \"nativeId\": \"S108AABB.smoothedSupplyTemperature\",\n \"parentId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"double\",\n \"aggregation\": \"average\",\n \"role\": 201014,\n \"roleName\": \"Supply Temperature\",\n \"tags\": [],\n \"unit\": \"\\u00b0C\",\n \"unitCode\": 2,\n \"metadata\": {},\n \"serialNumber\": \"S108AABBCCDD\",\n \"isSensaruDevice\": true,\n \"updatedAt\": 1700000000,\n \"value\": 45.3\n }\n}"},{"id":"5f488e72-a6a7-4103-933e-8a8b0fa38507","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."}],"variable":[{"id":"eaa037b0-2832-4d1a-b527-9f105c2fbac8","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"072712ab-b456-45ec-9a1b-30fd9ca63bb3","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Returns a single data point by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single data point object.\n\n\n##### Data point object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"dp-uuid\"` | Data point UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Owning business partner. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical location. |\n| **disabled** | boolean | `false` | Whether data point is disabled. |\n| **label** | string | `\"Supply Temperature\"` | Localized display name. |\n| **nativeId** | string | `\"S108AABB.supplyTemperature\"` | Internal native identifier (`serial.name`). |\n| **parentId** | UUID | `\"device-uuid\"` | Parent device UUID. |\n| **type** | string | `\"double\"` | Value type (`double`, `boolean`, `string`, `array`). |\n| **aggregation** | string | `\"average\"` | Aggregation method (`average`, `last`, `sum`). |\n| **role** | integer | `201014` | Numeric role ID. |\n| **roleName** | string | `\"Supply Temperature\"` | Localized role name. |\n| **tags** | array | `[\"heating\"]` | User-defined tags. |\n| **unit** | string | `\"°C\"` | Display unit. |\n| **unitCode** | integer | `2` | Numeric unit code. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Parent device serial number. |\n| **isSensaruDevice** | boolean | `true` | Whether parent is a Sensaru device. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **value** | variant | `45.3` | (optional) Last known value. |"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"d6e7cb11-0d8d-4002-94f2-1d38d5396834"},{"name":"Replace data point metadata","id":"8d065a73-f1ea-4bf8-8ed0-e015dd2c1bfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"energy\",\n \"heating\"\n ],\n \"customField\": \"value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId","description":"Replaces the data point's metadata and tags entirely. Tags are cleared first, then set from the tags array in the body. All other body fields become the new metadata object.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| tags | \narray | \n[\"energy\", \"heating\"] | \n[] | \n(optional) Replaces all existing tags. Existing tags are cleared first. Non-empty strings only. | \n
\n\n| customProperty | \nvariant | \n\"My custom value\" | \n | \n(optional) Any other property is stored as metadata. The entire object (minus tags) becomes the new metadata, replacing any previous metadata. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId","data-points",":dataPointId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"d2e05de7-918c-41a9-811c-9e57a1f63f24","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"},{"id":"19cebbc5-c80a-4d96-9241-c332a0725bb4","description":{"content":"(required) The data point UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"dataPointId"}]}},"response":[{"id":"5fd66525-ea8a-46bd-a712-371831c74021","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"energy\",\n \"heating\"\n ],\n \"customField\": \"value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId"],"variable":[{"id":"d2e05de7-918c-41a9-811c-9e57a1f63f24","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"19cebbc5-c80a-4d96-9241-c332a0725bb4","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Replaces the data point's metadata and tags entirely. Tags are cleared first, then set from the `tags` array in the body. All other body fields become the new metadata object.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **tags** | array | `[\"energy\", \"heating\"]` | `[]` | (optional) Replaces all existing tags. Existing tags are cleared first. Non-empty strings only. |\n| **customProperty** | variant | `\"My custom value\"` | | (optional) Any other property is stored as metadata. The entire object (minus `tags`) becomes the new metadata, replacing any previous metadata. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"8d065a73-f1ea-4bf8-8ed0-e015dd2c1bfa"},{"name":"Update data point metadata","id":"768c9578-71a5-4f8d-b85a-9da71c0f3ba4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"newTag\"\n ],\n \"customField\": \"value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId","description":"Partially updates data point metadata. Tags are added to the existing set (additive). Other fields are merged into existing metadata.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| tags | \narray | \n[\"newTag\"] | \n[] | \n(optional) Tags to add to the existing tag set (additive, does not remove existing tags). Non-empty strings only. | \n
\n\n| customProperty | \nvariant | \n\"My custom value\" | \n | \n(optional) Any other property is merged into existing metadata. Only provided fields are updated; unmentioned fields are preserved. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId","data-points",":dataPointId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"975ac05c-559f-4275-9ff0-c3ba02fcc5ed","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"},{"id":"8acd57b8-1abc-45c1-9b37-64e2b1b8fdca","description":{"content":"(required) The data point UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"dataPointId"}]}},"response":[{"id":"95a32bdf-75fb-460d-9a22-ada0d35c390e","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"newTag\"\n ],\n \"customField\": \"value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points/:dataPointId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points",":dataPointId"],"variable":[{"id":"975ac05c-559f-4275-9ff0-c3ba02fcc5ed","key":"deviceId","value":"","description":"(required) The device UUID."},{"id":"8acd57b8-1abc-45c1-9b37-64e2b1b8fdca","key":"dataPointId","value":"","description":"(required) The data point UUID."}]},"description":"Partially updates data point metadata. Tags are added to the existing set (additive). Other fields are merged into existing metadata.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **tags** | array | `[\"newTag\"]` | `[]` | (optional) Tags to add to the existing tag set (additive, does not remove existing tags). Non-empty strings only. |\n| **customProperty** | variant | `\"My custom value\"` | | (optional) Any other property is merged into existing metadata. Only provided fields are updated; unmentioned fields are preserved. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"768c9578-71a5-4f8d-b85a-9da71c0f3ba4"}],"id":"c7f30fcf-6ea3-403d-b5b0-fbd7c78dffdc","_postman_id":"c7f30fcf-6ea3-403d-b5b0-fbd7c78dffdc","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get device data points","id":"c62c9888-1d66-419f-95a4-d9204a6e1ce5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points?lang=en-US&limit=100","description":"Returns data points for a specific device.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result | \narray | \n | \nArray of data point objects. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Data point object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"dp-uuid\" | \nData point UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nOwning business partner. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical location. | \n
\n\n| disabled | \nboolean | \nfalse | \nWhether data point is disabled. | \n
\n\n| label | \nstring | \n\"Supply Temperature\" | \nLocalized display name. | \n
\n\n| nativeId | \nstring | \n\"S108AABB.supplyTemperature\" | \nInternal native identifier (serial.name). | \n
\n\n| parentId | \nUUID | \n\"device-uuid\" | \nParent device UUID. | \n
\n\n| type | \nstring | \n\"double\" | \nValue type (double, boolean, string, array). | \n
\n\n| aggregation | \nstring | \n\"average\" | \nAggregation method (average, last, sum). | \n
\n\n| role | \ninteger | \n201014 | \nNumeric role ID. | \n
\n\n| roleName | \nstring | \n\"Supply Temperature\" | \nLocalized role name. | \n
\n\n| tags | \narray | \n[\"heating\"] | \nUser-defined tags. | \n
\n\n| unit | \nstring | \n\"°C\" | \nDisplay unit. | \n
\n\n| unitCode | \ninteger | \n2 | \nNumeric unit code. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nParent device serial number. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether parent is a Sensaru device. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| value | \nvariant | \n45.3 | \n(optional) Last known value. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Sort field. Default: id.
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"(optional) Sort direction. Default: true.
\n","type":"text/plain"},"key":"ascending","value":"true"},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–1000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[{"id":"c26c1f51-5e5e-4b19-9070-eaed2afa107f","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"8a4314e7-7318-4140-a059-1aaaa3cb2700","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/data-points?lang=en-US&limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","data-points"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."},{"key":"orderBy","value":"id","description":"(optional) Sort field. Default: `id`.","disabled":true},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–1000). Default: `100`."}],"variable":[{"id":"c26c1f51-5e5e-4b19-9070-eaed2afa107f","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Returns data points for a specific device.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result** | array | | Array of data point objects. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Data point object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"dp-uuid\"` | Data point UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Owning business partner. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical location. |\n| **disabled** | boolean | `false` | Whether data point is disabled. |\n| **label** | string | `\"Supply Temperature\"` | Localized display name. |\n| **nativeId** | string | `\"S108AABB.supplyTemperature\"` | Internal native identifier (`serial.name`). |\n| **parentId** | UUID | `\"device-uuid\"` | Parent device UUID. |\n| **type** | string | `\"double\"` | Value type (`double`, `boolean`, `string`, `array`). |\n| **aggregation** | string | `\"average\"` | Aggregation method (`average`, `last`, `sum`). |\n| **role** | integer | `201014` | Numeric role ID. |\n| **roleName** | string | `\"Supply Temperature\"` | Localized role name. |\n| **tags** | array | `[\"heating\"]` | User-defined tags. |\n| **unit** | string | `\"°C\"` | Display unit. |\n| **unitCode** | integer | `2` | Numeric unit code. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Parent device serial number. |\n| **isSensaruDevice** | boolean | `true` | Whether parent is a Sensaru device. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **value** | variant | `45.3` | (optional) Last known value. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": \"dp-uuid-1\",\n \"businessPartnerId\": \"bp-uuid\",\n \"locationId\": \"1:WE-01.100\",\n \"disabled\": false,\n \"label\": \"Supply Temperature\",\n \"nativeId\": \"S108AABB.smoothedSupplyTemperature\",\n \"parentId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"double\",\n \"aggregation\": \"average\",\n \"role\": 201014,\n \"roleName\": \"Supply Temperature\",\n \"tags\": [],\n \"unit\": \"\\u00b0C\",\n \"unitCode\": 2,\n \"metadata\": {},\n \"serialNumber\": \"S108AABBCCDD\",\n \"isSensaruDevice\": true,\n \"updatedAt\": 1700000000,\n \"value\": 45.3\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n}"}],"_postman_id":"c62c9888-1d66-419f-95a4-d9204a6e1ce5"}],"id":"5878b182-16e3-4d6d-ac0a-e1fad4d53133","_postman_id":"5878b182-16e3-4d6d-ac0a-e1fad4d53133","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get device","id":"dcecc749-c199-410f-9067-490df0c322d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId?lang=en-US","description":"Returns a single device by ID.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is a single device object.
\nDevice object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"d23d6fd0-...\" | \nThe device UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nBusiness partner that owns this device. | \n
\n\n| type | \nstring | \n\"S1\" | \nDevice family (G1, S1, V1). | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nDevice serial number. | \n
\n\n| deviceTypeId | \nstring | \n\"s1-08-01\" | \n(Sensaru devices only) Device type identifier. | \n
\n\n| deviceType | \ninteger | \n8 | \n(Sensaru devices only) Numeric device type from serial. | \n
\n\n| operationMode | \ninteger | \n1 | \n(Sensaru devices only) Current operation mode. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \nDisplay name. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n(optional) Free-text notes. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether this is a Sensaru device. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical asset location. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \nLocation display name. | \n
\n\n| roles | \narray | \n[201014] | \nNumeric role IDs. | \n
\n\n| tags | \narray | \n[\"energy\"] | \nUser-defined tags. | \n
\n\n| status | \nstring | \n\"online\" | \n\"online\" or \"offline\". | \n
\n\n| geoCoordinates | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from asset. | \n
\n\n| geoCoordinatesZip | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from ZIP geocoding. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nAddress objects. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| settings | \nobject | \n{} | \n(optional) Device-specific settings. | \n
\n\n| unconfigured | \nboolean | \ntrue | \n(optional) Only present if true. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastPacket | \ninteger | \n1700000000 | \nUnix epoch seconds of last received packet. | \n
\n\n| dataPoints | \narray | \n[\"dp-uuid-1\"] | \nData point UUIDs belonging to this device. | \n
\n\n| configurationFields | \narray | \n | \n(optional) Only when configFields=true. Array of field descriptors with id, type, label, required, enum. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Include configuration fields. Default: false.
\n","type":"text/plain"},"key":"configFields","value":"true"}],"variable":[{"id":"b873ebed-3cb2-4d02-a2d9-066ce8e02060","description":{"content":"(required) The device UUID as returned by GET /devices.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"a53f703b-66c8-4c13-b8ed-a9e61f58ea6c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."},{"key":"configFields","value":"true","description":"(optional) Include configuration fields. Default: `false`.","disabled":true}],"variable":[{"id":"b873ebed-3cb2-4d02-a2d9-066ce8e02060","key":"deviceId","value":"","description":"(required) The device UUID as returned by `GET /devices`."}]},"description":"Returns a single device by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"businessPartnerId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"type\": \"S1\",\n \"serialNumber\": \"S108AABBCCDD\",\n \"deviceTypeId\": \"s1-08-01\",\n \"deviceType\": 8,\n \"operationMode\": 1,\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"isSensaruDevice\": true,\n \"locationId\": \"1:WE-01.100\",\n \"roles\": [\n 201014\n ],\n \"tags\": [],\n \"status\": \"online\",\n \"settings\": {\n \"heatingCircuit\": \"HC-1\"\n },\n \"updatedAt\": 1700000000,\n \"createdAt\": 1699000000,\n \"lastPacket\": 1700000000,\n \"dataPoints\": [\n \"dp-uuid-1\",\n \"dp-uuid-2\"\n ],\n \"configurationFields\": [\n {\n \"id\": \"heatingCircuit\",\n \"type\": \"heatingCircuitSelector\",\n \"label\": \"Heating Circuit\",\n \"required\": true\n }\n ]\n }\n}"},{"id":"48984d7b-bbfe-4900-8fb8-c7cfede0af6d","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."},{"key":"configFields","value":"true","description":"(optional) Include configuration fields. Default: `false`.","disabled":true}],"variable":[{"id":"b873ebed-3cb2-4d02-a2d9-066ce8e02060","key":"deviceId","value":"","description":"(required) The device UUID as returned by `GET /devices`."}]},"description":"Returns a single device by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"dcecc749-c199-410f-9067-490df0c322d6"},{"name":"Update device","id":"2c084635-3901-4c57-91c6-b7f56081361a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\",\n \"settings\": {},\n \"metadata\": {},\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId","description":"Updates a device (full replacement). Also used for moving or merging devices.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| name | \nstring | \n\"Optimizer 1\" | \n | \n(optional) Display name of the device. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n | \n(optional) Free-text notes. | \n
\n\n| operationMode | \ninteger | \n1 | \n | \n(optional) New operation mode ID. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \n | \n(optional) Hierarchical asset location ID. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \n | \n(optional) Location display name. | \n
\n\n| businessPartnerId | \nstring | \n\"uuid\" | \n | \n(optional) Move device to a different business partner (requires move=1 query param). Only for superuser/systemProvider/systemDistributor. | \n
\n\n| settings | \nobject | \n{\"heatingCircuit\": \"HC-1\"} | \n | \n(optional) Device-specific settings. Heating circuit assignment is validated for uniqueness within the economic unit. | \n
\n\n| metadata | \nobject | \n{\"custom\": \"value\"} | \n | \n(optional) Custom metadata object. | \n
\n\n| tags | \narray | \n[\"energy\", \"heating\"] | \n | \n(optional) Device tags. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is the updated device object.
\nDevice object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"d23d6fd0-...\" | \nThe device UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nBusiness partner that owns this device. | \n
\n\n| type | \nstring | \n\"S1\" | \nDevice family (G1, S1, V1). | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nDevice serial number. | \n
\n\n| deviceTypeId | \nstring | \n\"s1-08-01\" | \n(Sensaru devices only) Device type identifier. | \n
\n\n| deviceType | \ninteger | \n8 | \n(Sensaru devices only) Numeric device type from serial. | \n
\n\n| operationMode | \ninteger | \n1 | \n(Sensaru devices only) Current operation mode. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \nDisplay name. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n(optional) Free-text notes. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether this is a Sensaru device. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical asset location. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \nLocation display name. | \n
\n\n| roles | \narray | \n[201014] | \nNumeric role IDs. | \n
\n\n| tags | \narray | \n[\"energy\"] | \nUser-defined tags. | \n
\n\n| status | \nstring | \n\"online\" | \n\"online\" or \"offline\". | \n
\n\n| geoCoordinates | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from asset. | \n
\n\n| geoCoordinatesZip | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from ZIP geocoding. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nAddress objects. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| settings | \nobject | \n{} | \n(optional) Device-specific settings. | \n
\n\n| unconfigured | \nboolean | \ntrue | \n(optional) Only present if true. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastPacket | \ninteger | \n1700000000 | \nUnix epoch seconds of last received packet. | \n
\n\n| dataPoints | \narray | \n[\"dp-uuid-1\"] | \nData point UUIDs belonging to this device. | \n
\n\n| configurationFields | \narray | \n | \n(optional) Only when configFields=true. Array of field descriptors with id, type, label, required, enum. | \n
\n\n
\n
(optional) Set to 1 to move device to a different business partner.
\n","type":"text/plain"},"key":"move","value":"1"},{"disabled":true,"description":{"content":"(optional) UUID of device to merge with.
\n","type":"text/plain"},"key":"merge","value":""},{"disabled":true,"description":{"content":"(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"}],"variable":[{"id":"13c0c3f1-de6f-4b8c-89bf-d5a999cd37b8","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"c536512a-71a0-4b7c-bff9-89a29d50d7e7","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\",\n \"settings\": {},\n \"metadata\": {},\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"move","value":"1","description":"(optional) Set to `1` to move device to a different business partner.","disabled":true},{"key":"merge","value":"","description":"(optional) UUID of device to merge with.","disabled":true},{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true}],"variable":[{"id":"13c0c3f1-de6f-4b8c-89bf-d5a999cd37b8","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Updates a device (full replacement). Also used for moving or merging devices.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **name** | string | `\"Optimizer 1\"` | | (optional) Display name of the device. |\n| **notes** | string | `\"Floor 2\"` | | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (optional) New operation mode ID. |\n| **locationId** | string | `\"1:WE-01.100\"` | | (optional) Hierarchical asset location ID. |\n| **locationName** | string | `\"Building A\"` | | (optional) Location display name. |\n| **businessPartnerId** | string | `\"uuid\"` | | (optional) Move device to a different business partner (requires `move=1` query param). Only for superuser/systemProvider/systemDistributor. |\n| **settings** | object | `{\"heatingCircuit\": \"HC-1\"}` | | (optional) Device-specific settings. Heating circuit assignment is validated for uniqueness within the economic unit. |\n| **metadata** | object | `{\"custom\": \"value\"}` | | (optional) Custom metadata object. |\n| **tags** | array | `[\"energy\", \"heating\"]` | | (optional) Device tags. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the updated device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"S1\",\n \"serialNumber\": \"S108AABBCCDD\",\n \"name\": \"Optimizer 1 (updated)\",\n \"isSensaruDevice\": true,\n \"locationId\": \"1:WE-01.100\",\n \"updatedAt\": 1700003600,\n \"createdAt\": 1699000000,\n \"lastPacket\": 1700000000\n }\n}"},{"id":"4e8561c7-3fc4-40af-86cd-52bbf5846df5","name":"Not found","originalRequest":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\",\n \"settings\": {},\n \"metadata\": {},\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"move","value":"1","description":"(optional) Set to `1` to move device to a different business partner.","disabled":true},{"key":"merge","value":"","description":"(optional) UUID of device to merge with.","disabled":true},{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true}],"variable":[{"id":"13c0c3f1-de6f-4b8c-89bf-d5a999cd37b8","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Updates a device (full replacement). Also used for moving or merging devices.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **name** | string | `\"Optimizer 1\"` | | (optional) Display name of the device. |\n| **notes** | string | `\"Floor 2\"` | | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (optional) New operation mode ID. |\n| **locationId** | string | `\"1:WE-01.100\"` | | (optional) Hierarchical asset location ID. |\n| **locationName** | string | `\"Building A\"` | | (optional) Location display name. |\n| **businessPartnerId** | string | `\"uuid\"` | | (optional) Move device to a different business partner (requires `move=1` query param). Only for superuser/systemProvider/systemDistributor. |\n| **settings** | object | `{\"heatingCircuit\": \"HC-1\"}` | | (optional) Device-specific settings. Heating circuit assignment is validated for uniqueness within the economic unit. |\n| **metadata** | object | `{\"custom\": \"value\"}` | | (optional) Custom metadata object. |\n| **tags** | array | `[\"energy\", \"heating\"]` | | (optional) Device tags. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the updated device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"2c084635-3901-4c57-91c6-b7f56081361a"},{"name":"Update device (partial)","id":"141c6a4d-5578-4708-874d-06f21e9bfd2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Optimizer 1\",\n \"settings\": {\n \"heatingCircuit\": \"HC-1\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId","description":"Partially updates a device. Only provided fields are changed.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| name | \nstring | \n\"Optimizer 1\" | \n | \n(optional) Display name of the device. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n | \n(optional) Free-text notes. | \n
\n\n| operationMode | \ninteger | \n1 | \n | \n(optional) New operation mode ID. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \n | \n(optional) Hierarchical asset location ID. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \n | \n(optional) Location display name. | \n
\n\n| businessPartnerId | \nstring | \n\"uuid\" | \n | \n(optional) Move device to a different business partner (requires move=1 query param). Only for superuser/systemProvider/systemDistributor. | \n
\n\n| settings | \nobject | \n{\"heatingCircuit\": \"HC-1\"} | \n | \n(optional) Device-specific settings. Heating circuit assignment is validated for uniqueness within the economic unit. | \n
\n\n| metadata | \nobject | \n{\"custom\": \"value\"} | \n | \n(optional) Custom metadata object. | \n
\n\n| tags | \narray | \n[\"energy\", \"heating\"] | \n | \n(optional) Device tags. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is the updated device object.
\nDevice object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"d23d6fd0-...\" | \nThe device UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nBusiness partner that owns this device. | \n
\n\n| type | \nstring | \n\"S1\" | \nDevice family (G1, S1, V1). | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nDevice serial number. | \n
\n\n| deviceTypeId | \nstring | \n\"s1-08-01\" | \n(Sensaru devices only) Device type identifier. | \n
\n\n| deviceType | \ninteger | \n8 | \n(Sensaru devices only) Numeric device type from serial. | \n
\n\n| operationMode | \ninteger | \n1 | \n(Sensaru devices only) Current operation mode. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \nDisplay name. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n(optional) Free-text notes. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether this is a Sensaru device. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical asset location. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \nLocation display name. | \n
\n\n| roles | \narray | \n[201014] | \nNumeric role IDs. | \n
\n\n| tags | \narray | \n[\"energy\"] | \nUser-defined tags. | \n
\n\n| status | \nstring | \n\"online\" | \n\"online\" or \"offline\". | \n
\n\n| geoCoordinates | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from asset. | \n
\n\n| geoCoordinatesZip | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from ZIP geocoding. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nAddress objects. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| settings | \nobject | \n{} | \n(optional) Device-specific settings. | \n
\n\n| unconfigured | \nboolean | \ntrue | \n(optional) Only present if true. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastPacket | \ninteger | \n1700000000 | \nUnix epoch seconds of last received packet. | \n
\n\n| dataPoints | \narray | \n[\"dp-uuid-1\"] | \nData point UUIDs belonging to this device. | \n
\n\n| configurationFields | \narray | \n | \n(optional) Only when configFields=true. Array of field descriptors with id, type, label, required, enum. | \n
\n\n
\n
(optional) Set to 1 to move device to a different business partner.
\n","type":"text/plain"},"key":"move","value":"1"},{"disabled":true,"description":{"content":"(optional) UUID of device to merge with.
\n","type":"text/plain"},"key":"merge","value":""},{"disabled":true,"description":{"content":"(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"}],"variable":[{"id":"5ea9b0ba-32ba-4073-bb2a-0b76fd243443","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"150c93c8-d819-4fda-9e85-c1ad2fbd7d2b","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Optimizer 1\",\n \"settings\": {\n \"heatingCircuit\": \"HC-1\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"move","value":"1","description":"(optional) Set to `1` to move device to a different business partner.","disabled":true},{"key":"merge","value":"","description":"(optional) UUID of device to merge with.","disabled":true},{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true}],"variable":[{"id":"5ea9b0ba-32ba-4073-bb2a-0b76fd243443","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Partially updates a device. Only provided fields are changed.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **name** | string | `\"Optimizer 1\"` | | (optional) Display name of the device. |\n| **notes** | string | `\"Floor 2\"` | | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (optional) New operation mode ID. |\n| **locationId** | string | `\"1:WE-01.100\"` | | (optional) Hierarchical asset location ID. |\n| **locationName** | string | `\"Building A\"` | | (optional) Location display name. |\n| **businessPartnerId** | string | `\"uuid\"` | | (optional) Move device to a different business partner (requires `move=1` query param). Only for superuser/systemProvider/systemDistributor. |\n| **settings** | object | `{\"heatingCircuit\": \"HC-1\"}` | | (optional) Device-specific settings. Heating circuit assignment is validated for uniqueness within the economic unit. |\n| **metadata** | object | `{\"custom\": \"value\"}` | | (optional) Custom metadata object. |\n| **tags** | array | `[\"energy\", \"heating\"]` | | (optional) Device tags. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the updated device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"S1\",\n \"serialNumber\": \"S108AABBCCDD\",\n \"name\": \"Optimizer 1 (updated)\",\n \"isSensaruDevice\": true,\n \"locationId\": \"1:WE-01.100\",\n \"updatedAt\": 1700003600,\n \"createdAt\": 1699000000,\n \"lastPacket\": 1700000000\n }\n}"},{"id":"c5e4a22c-5be5-45a4-b534-d8c31be569df","name":"Not found","originalRequest":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Optimizer 1\",\n \"settings\": {\n \"heatingCircuit\": \"HC-1\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"move","value":"1","description":"(optional) Set to `1` to move device to a different business partner.","disabled":true},{"key":"merge","value":"","description":"(optional) UUID of device to merge with.","disabled":true},{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true}],"variable":[{"id":"5ea9b0ba-32ba-4073-bb2a-0b76fd243443","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Partially updates a device. Only provided fields are changed.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **name** | string | `\"Optimizer 1\"` | | (optional) Display name of the device. |\n| **notes** | string | `\"Floor 2\"` | | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (optional) New operation mode ID. |\n| **locationId** | string | `\"1:WE-01.100\"` | | (optional) Hierarchical asset location ID. |\n| **locationName** | string | `\"Building A\"` | | (optional) Location display name. |\n| **businessPartnerId** | string | `\"uuid\"` | | (optional) Move device to a different business partner (requires `move=1` query param). Only for superuser/systemProvider/systemDistributor. |\n| **settings** | object | `{\"heatingCircuit\": \"HC-1\"}` | | (optional) Device-specific settings. Heating circuit assignment is validated for uniqueness within the economic unit. |\n| **metadata** | object | `{\"custom\": \"value\"}` | | (optional) Custom metadata object. |\n| **tags** | array | `[\"energy\", \"heating\"]` | | (optional) Device tags. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the updated device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"141c6a4d-5578-4708-874d-06f21e9bfd2d"},{"name":"Delete device","id":"bab49450-1bfb-4ede-8bac-6d3df2adeede","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId?factoryReset=1","description":"Deletes a device. Soft delete by default. Set factoryReset=1 for hard delete (gateway: also deletes all child sensors).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[{"description":{"content":"(optional) Set to 1 for factory reset / hard delete. Default: 0 (soft delete).
\n","type":"text/plain"},"key":"factoryReset","value":"1"}],"variable":[{"id":"2dbbe088-6580-4045-abe4-7f6633fb87fd","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"bc7618ea-ac10-49c7-939a-aec3004b1b39","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId?factoryReset=1","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"factoryReset","value":"1","description":"(optional) Set to `1` for factory reset / hard delete. Default: `0` (soft delete)."}],"variable":[{"id":"2dbbe088-6580-4045-abe4-7f6633fb87fd","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Deletes a device. Soft delete by default. Set `factoryReset=1` for hard delete (gateway: also deletes all child sensors).\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"},{"id":"2fe78b24-cb36-4cf7-823d-adc3051ba991","name":"Not found","originalRequest":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId?factoryReset=1","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId"],"query":[{"key":"factoryReset","value":"1","description":"(optional) Set to `1` for factory reset / hard delete. Default: `0` (soft delete)."}],"variable":[{"id":"2dbbe088-6580-4045-abe4-7f6633fb87fd","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Deletes a device. Soft delete by default. Set `factoryReset=1` for hard delete (gateway: also deletes all child sensors).\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"bab49450-1bfb-4ede-8bac-6d3df2adeede"},{"name":"Requeue gateway packets","id":"d1ff70d8-c6dc-41e9-ac1b-8a46145e9ac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/requeue-packets?dateFrom=1751846400&dateTo=1751932800","description":"Re-injects raw gateway packets into the processing pipeline for the given time range. Device must be a Sensaru gateway (role 20300).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId","requeue-packets"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[{"description":{"content":"(optional) Unix timestamp in seconds — start of date range.
\n","type":"text/plain"},"key":"dateFrom","value":"1751846400"},{"description":{"content":"(optional) Unix timestamp in seconds — end of date range.
\n","type":"text/plain"},"key":"dateTo","value":"1751932800"}],"variable":[{"id":"ae22f072-27c5-4b61-9491-1f7d1acc435c","description":{"content":"(required) The gateway device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"306bbf0e-b0a5-4fb8-b417-0b37d0274e40","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/requeue-packets?dateFrom=1751846400&dateTo=1751932800","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","requeue-packets"],"query":[{"key":"dateFrom","value":"1751846400","description":"(optional) Unix timestamp in seconds — start of date range."},{"key":"dateTo","value":"1751932800","description":"(optional) Unix timestamp in seconds — end of date range."}],"variable":[{"id":"ae22f072-27c5-4b61-9491-1f7d1acc435c","key":"deviceId","value":"","description":"(required) The gateway device UUID."}]},"description":"Re-injects raw gateway packets into the processing pipeline for the given time range. Device must be a Sensaru gateway (role 20300).\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"d1ff70d8-c6dc-41e9-ac1b-8a46145e9ac5"},{"name":"Set gateway data","id":"53633ab8-6252-4ba6-95dd-6ae37ef89ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataType\": \"s1\",\n \"data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/gateway-data","description":"Manually injects sensor data into a gateway for testing or correction. Device must be a Sensaru gateway (role 20300).
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| dataType | \nstring | \n\"s1\" | \n | \n(required) Type of sensor data to inject. | \n
\n\n| data | \nvariant | \n{} | \n | \n(required) The sensor data payload. Structure depends on dataType. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":deviceId","gateway-data"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"32808ac5-e15c-4ae5-b84c-12d7cca5321a","description":{"content":"(required) The gateway device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"59ee8398-e6ae-4dd7-9bf5-2e73eeea71ff","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataType\": \"s1\",\n \"data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/gateway-data","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","gateway-data"],"variable":[{"id":"32808ac5-e15c-4ae5-b84c-12d7cca5321a","key":"deviceId","value":"","description":"(required) The gateway device UUID."}]},"description":"Manually injects sensor data into a gateway for testing or correction. Device must be a Sensaru gateway (role 20300).\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **dataType** | string | `\"s1\"` | | (required) Type of sensor data to inject. |\n| **data** | variant | `{}` | | (required) The sensor data payload. Structure depends on `dataType`. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"53633ab8-6252-4ba6-95dd-6ae37ef89ac9"},{"name":"Get device service messages","id":"848b6149-fa02-4f7d-b8ae-d948a496d825","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/service-messages?limit=100","description":"Returns service messages for a specific device.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.serviceMessages | \narray | \n | \nArray of service message objects. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Service message object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"msg-uuid\" | \nService message ID. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastUpdate | \ninteger | \n1700003600 | \nUnix epoch seconds. | \n
\n\n| deviceId | \nUUID | \n\"device-uuid\" | \nDevice that triggered the message. | \n
\n\n| dataPointId | \nUUID | \n\"dp-uuid\" | \nRelated data point. | \n
\n\n| roles | \narray | \n[201014, 800001] | \nAssociated role IDs. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nLocation of the device. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nDevice addresses. | \n
\n\n| priority | \nstring | \n\"error\" | \nSeverity: \"critical\", \"error\", \"warning\", \"info\". | \n
\n\n| isSticky | \nboolean | \nfalse | \nWhether the message persists after resolution. | \n
\n\n| message | \nstring | \n\"Sensor offline\" | \nLocalized message text. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Filter by location ID.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent or exact.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"disabled":true,"description":{"content":"(optional) Comma-separated role IDs.
\n","type":"text/plain"},"key":"roles","value":""},{"disabled":true,"description":{"content":"(optional) Comma-separated status filters.
\n","type":"text/plain"},"key":"filter","value":""},{"disabled":true,"description":{"content":"(optional) Full-text search.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–1000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[{"id":"f515fed9-d26f-466e-a19f-1adbb3518ab6","description":{"content":"(required) The device UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"deviceId"}]}},"response":[{"id":"f219b5f7-56f9-423c-974a-6f8c36f60601","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/:deviceId/service-messages?limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices",":deviceId","service-messages"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true},{"key":"locationId","value":"","description":"(optional) Filter by location ID.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` or `exact`.","disabled":true},{"key":"roles","value":"","description":"(optional) Comma-separated role IDs.","disabled":true},{"key":"filter","value":"","description":"(optional) Comma-separated status filters.","disabled":true},{"key":"search","value":"","description":"(optional) Full-text search.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–1000). Default: `100`."}],"variable":[{"id":"f515fed9-d26f-466e-a19f-1adbb3518ab6","key":"deviceId","value":"","description":"(required) The device UUID."}]},"description":"Returns service messages for a specific device.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.serviceMessages** | array | | Array of service message objects. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Service message object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"msg-uuid\"` | Service message ID. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastUpdate** | integer | `1700003600` | Unix epoch seconds. |\n| **deviceId** | UUID | `\"device-uuid\"` | Device that triggered the message. |\n| **dataPointId** | UUID | `\"dp-uuid\"` | Related data point. |\n| **roles** | array | `[201014, 800001]` | Associated role IDs. |\n| **locationId** | string | `\"1:WE-01.100\"` | Location of the device. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Device addresses. |\n| **priority** | string | `\"error\"` | Severity: `\"critical\"`, `\"error\"`, `\"warning\"`, `\"info\"`. |\n| **isSticky** | boolean | `false` | Whether the message persists after resolution. |\n| **message** | string | `\"Sensor offline\"` | Localized message text. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"serviceMessages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-000000000001\",\n \"createdAt\": 1700000000,\n \"lastUpdate\": 1700003600,\n \"deviceId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"dataPointId\": \"dp-uuid-1\",\n \"roles\": [\n 201014\n ],\n \"locationId\": \"1:WE-01.100\",\n \"priority\": \"error\",\n \"isSticky\": false,\n \"message\": \"Supply temperature sensor offline\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"848b6149-fa02-4f7d-b8ae-d948a496d825"}],"id":"b32238e9-7b0e-4e08-8d58-26e00a6426c5","_postman_id":"b32238e9-7b0e-4e08-8d58-26e00a6426c5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get data points (global)","id":"3b1366da-5c13-44ea-9d58-e09bf1a92456","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/data-points?roles=900101,900201&lang=en-US&limit=100","description":"Returns data points across all devices, filtered by roles. The roles parameter is required.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result | \narray | \n | \nArray of data point objects. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Data point object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"dp-uuid\" | \nData point UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nOwning business partner. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical location. | \n
\n\n| disabled | \nboolean | \nfalse | \nWhether data point is disabled. | \n
\n\n| label | \nstring | \n\"Supply Temperature\" | \nLocalized display name. | \n
\n\n| nativeId | \nstring | \n\"S108AABB.supplyTemperature\" | \nInternal native identifier (serial.name). | \n
\n\n| parentId | \nUUID | \n\"device-uuid\" | \nParent device UUID. | \n
\n\n| type | \nstring | \n\"double\" | \nValue type (double, boolean, string, array). | \n
\n\n| aggregation | \nstring | \n\"average\" | \nAggregation method (average, last, sum). | \n
\n\n| role | \ninteger | \n201014 | \nNumeric role ID. | \n
\n\n| roleName | \nstring | \n\"Supply Temperature\" | \nLocalized role name. | \n
\n\n| tags | \narray | \n[\"heating\"] | \nUser-defined tags. | \n
\n\n| unit | \nstring | \n\"°C\" | \nDisplay unit. | \n
\n\n| unitCode | \ninteger | \n2 | \nNumeric unit code. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nParent device serial number. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether parent is a Sensaru device. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| value | \nvariant | \n45.3 | \n(optional) Last known value. | \n
\n\n
\n
(required) Comma-separated numeric role IDs.
\n","type":"text/plain"},"key":"roles","value":"900101,900201"},{"disabled":true,"description":{"content":"(optional) Hierarchical location ID filter.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent or exact. Default: exact.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"disabled":true,"description":{"content":"(optional) Include virtual devices. Default: false.
\n","type":"text/plain"},"key":"virtualDevices","value":"true"},{"description":{"content":"(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Sort field. Default: id.
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"(optional) Sort direction. Default: true.
\n","type":"text/plain"},"key":"ascending","value":"true"},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–1000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"914b2053-968c-4534-84ad-2fb076c370b4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/data-points?roles=900101,900201&lang=en-US&limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","data-points"],"query":[{"key":"roles","value":"900101,900201","description":"(required) Comma-separated numeric role IDs."},{"key":"locationId","value":"","description":"(optional) Hierarchical location ID filter.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` or `exact`. Default: `exact`.","disabled":true},{"key":"virtualDevices","value":"true","description":"(optional) Include virtual devices. Default: `false`.","disabled":true},{"key":"lang","value":"en-US","description":"(optional) Language code."},{"key":"orderBy","value":"id","description":"(optional) Sort field. Default: `id`.","disabled":true},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–1000). Default: `100`."}]},"description":"Returns data points across all devices, filtered by roles. The `roles` parameter is required.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result** | array | | Array of data point objects. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Data point object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"dp-uuid\"` | Data point UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Owning business partner. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical location. |\n| **disabled** | boolean | `false` | Whether data point is disabled. |\n| **label** | string | `\"Supply Temperature\"` | Localized display name. |\n| **nativeId** | string | `\"S108AABB.supplyTemperature\"` | Internal native identifier (`serial.name`). |\n| **parentId** | UUID | `\"device-uuid\"` | Parent device UUID. |\n| **type** | string | `\"double\"` | Value type (`double`, `boolean`, `string`, `array`). |\n| **aggregation** | string | `\"average\"` | Aggregation method (`average`, `last`, `sum`). |\n| **role** | integer | `201014` | Numeric role ID. |\n| **roleName** | string | `\"Supply Temperature\"` | Localized role name. |\n| **tags** | array | `[\"heating\"]` | User-defined tags. |\n| **unit** | string | `\"°C\"` | Display unit. |\n| **unitCode** | integer | `2` | Numeric unit code. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Parent device serial number. |\n| **isSensaruDevice** | boolean | `true` | Whether parent is a Sensaru device. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **value** | variant | `45.3` | (optional) Last known value. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": \"dp-uuid-1\",\n \"businessPartnerId\": \"bp-uuid\",\n \"locationId\": \"1:WE-01.100\",\n \"disabled\": false,\n \"label\": \"Supply Temperature\",\n \"nativeId\": \"S108AABB.smoothedSupplyTemperature\",\n \"parentId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"double\",\n \"aggregation\": \"average\",\n \"role\": 201014,\n \"roleName\": \"Supply Temperature\",\n \"tags\": [],\n \"unit\": \"\\u00b0C\",\n \"unitCode\": 2,\n \"metadata\": {},\n \"serialNumber\": \"S108AABBCCDD\",\n \"isSensaruDevice\": true,\n \"updatedAt\": 1700000000,\n \"value\": 45.3\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n}"}],"_postman_id":"3b1366da-5c13-44ea-9d58-e09bf1a92456"},{"name":"Get energy data","id":"c94fceac-37cf-4549-a9aa-5c42fc0aeb68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/energy-data?lang=de&dataPointFormat=localized&limit=100","description":"Returns aggregated energy data (heating, electricity, water) per location and year.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an object keyed by location ID. Each location contains years as keys, each year contains energy data.
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.{locationId}.{year}.heatingEnergySource | \nstring | \n\"gas\" | \nEnergy source: gas, oil, power, district, pellets, other, unknown. | \n
\n\n| result.{locationId}.{year}.heatingEnergy | \nnumber | \n15240 | \nHeating energy in kWh. | \n
\n\n| result.{locationId}.{year}.electricalEnergyConsumption | \nnumber | \n3400 | \nElectrical energy consumption in kWh. | \n
\n\n| result.{locationId}.{year}.electricalEnergyProduction | \nnumber | \n1250 | \nElectrical energy production in kWh (e.g., PV). | \n
\n\n| result.{locationId}.{year}.waterVolume | \nnumber | \n450 | \nWater volume in m³. | \n
\n\n| result.{locationId}.{year}.heatingSensorData | \nboolean | \ntrue | \nWhether heating sensor data exists. | \n
\n\n| result.{locationId}.{year}.heatingEnergyDataMissing | \nboolean | \nfalse | \nWhether heating data is incomplete. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"de"},{"disabled":true,"description":{"content":"(optional) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent or exact. Default: exact.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"description":{"content":"(optional) raw (default) or localized.
\n","type":"text/plain"},"key":"dataPointFormat","value":"localized"},{"disabled":true,"description":{"content":"(optional) Unix timestamp in seconds.
\n","type":"text/plain"},"key":"dateFrom","value":""},{"disabled":true,"description":{"content":"(optional) Unix timestamp in seconds.
\n","type":"text/plain"},"key":"dateTo","value":""},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–10000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"a9b1699f-4233-4337-a952-687507c5797c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/energy-data?lang=de&dataPointFormat=localized&limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","energy-data"],"query":[{"key":"lang","value":"de","description":"(optional) Language code."},{"key":"locationId","value":"","description":"(optional) Hierarchical location ID.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` or `exact`. Default: `exact`.","disabled":true},{"key":"dataPointFormat","value":"localized","description":"(optional) `raw` (default) or `localized`."},{"key":"dateFrom","value":"","description":"(optional) Unix timestamp in seconds.","disabled":true},{"key":"dateTo","value":"","description":"(optional) Unix timestamp in seconds.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–10000). Default: `100`."}]},"description":"Returns aggregated energy data (heating, electricity, water) per location and year.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an object keyed by location ID. Each location contains years as keys, each year contains energy data.\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.{locationId}.{year}.heatingEnergySource** | string | `\"gas\"` | Energy source: `gas`, `oil`, `power`, `district`, `pellets`, `other`, `unknown`. |\n| **result.{locationId}.{year}.heatingEnergy** | number | `15240` | Heating energy in kWh. |\n| **result.{locationId}.{year}.electricalEnergyConsumption** | number | `3400` | Electrical energy consumption in kWh. |\n| **result.{locationId}.{year}.electricalEnergyProduction** | number | `1250` | Electrical energy production in kWh (e.g., PV). |\n| **result.{locationId}.{year}.waterVolume** | number | `450` | Water volume in m³. |\n| **result.{locationId}.{year}.heatingSensorData** | boolean | `true` | Whether heating sensor data exists. |\n| **result.{locationId}.{year}.heatingEnergyDataMissing** | boolean | `false` | Whether heating data is incomplete. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"1:WE-01.100\": {\n \"2024\": {\n \"heatingEnergySource\": \"gas\",\n \"heatingSensorData\": true,\n \"heatingEnergy\": 15240,\n \"electricalEnergyConsumption\": 3400,\n \"electricalEnergyProduction\": 1250,\n \"waterVolume\": 450,\n \"heatingEnergyDataMissing\": false,\n \"electricalEnergyConsumptionDataMissing\": false,\n \"electricalEnergyProductionDataMissing\": true,\n \"waterVolumeDataMissing\": true\n }\n }\n }\n}"}],"_postman_id":"c94fceac-37cf-4549-a9aa-5c42fc0aeb68"},{"name":"Get logs (global)","id":"dc997f93-0ef1-4441-b5b9-927b1097c8ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/logs?roles=900102,900202&lang=de&timeFormat=iso-8601&convertToNumber=true&aggregate=year&limit=1000","description":"Returns data point logs across multiple devices, filtered by roles. The roles parameter is required.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.dataPoints | \nobject | \n | \nObject keyed by data point UUID, each value is a data point metadata object. | \n
\n\n| result.logs | \nobject | \n | \nObject keyed by data point UUID, each value is an array of [timestamp, value] pairs. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
(required) Comma-separated numeric role IDs.
\n","type":"text/plain"},"key":"roles","value":"900102,900202"},{"description":{"content":"(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"de"},{"disabled":true,"description":{"content":"(optional) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent or exact. Default: exact.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"description":{"content":"(optional) unix-timestamp-seconds (default), unix-timestamp-milliseconds, or iso-8601.
\n","type":"text/plain"},"key":"timeFormat","value":"iso-8601"},{"disabled":true,"description":{"content":"(optional) raw (default) or localized.
\n","type":"text/plain"},"key":"dataPointFormat","value":"raw"},{"description":{"content":"(optional) Convert values to numbers.
\n","type":"text/plain"},"key":"convertToNumber","value":"true"},{"description":{"content":"(optional) hour, day, year, or all. Note: none and 15m are not available here.
\n","type":"text/plain"},"key":"aggregate","value":"year"},{"disabled":true,"description":{"content":"(optional) Unix timestamp in seconds.
\n","type":"text/plain"},"key":"dateFrom","value":""},{"disabled":true,"description":{"content":"(optional) Unix timestamp in seconds.
\n","type":"text/plain"},"key":"dateTo","value":""},{"disabled":true,"description":{"content":"(optional) Include virtual devices. Default: false.
\n","type":"text/plain"},"key":"virtualDevices","value":"true"},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–10000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"c8d7e85f-39e3-4dff-a010-16fcb44daddd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/logs?roles=900102,900202&lang=de&timeFormat=iso-8601&convertToNumber=true&aggregate=year&limit=1000","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","logs"],"query":[{"key":"roles","value":"900102,900202","description":"(required) Comma-separated numeric role IDs."},{"key":"lang","value":"de","description":"(optional) Language code."},{"key":"locationId","value":"","description":"(optional) Hierarchical location ID.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` or `exact`. Default: `exact`.","disabled":true},{"key":"timeFormat","value":"iso-8601","description":"(optional) `unix-timestamp-seconds` (default), `unix-timestamp-milliseconds`, or `iso-8601`."},{"key":"dataPointFormat","value":"raw","description":"(optional) `raw` (default) or `localized`.","disabled":true},{"key":"convertToNumber","value":"true","description":"(optional) Convert values to numbers."},{"key":"aggregate","value":"year","description":"(optional) `hour`, `day`, `year`, or `all`. Note: `none` and `15m` are not available here."},{"key":"dateFrom","value":"","description":"(optional) Unix timestamp in seconds.","disabled":true},{"key":"dateTo","value":"","description":"(optional) Unix timestamp in seconds.","disabled":true},{"key":"virtualDevices","value":"true","description":"(optional) Include virtual devices. Default: `false`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"1000","description":"(optional) Page size (1–10000). Default: `100`."}]},"description":"Returns data point logs across multiple devices, filtered by roles. The `roles` parameter is required.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.dataPoints** | object | | Object keyed by data point UUID, each value is a data point metadata object. |\n| **result.logs** | object | | Object keyed by data point UUID, each value is an array of `[timestamp, value]` pairs. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"dataPoints\": {\n \"dp-uuid-1\": {\n \"label\": \"Supply Temperature\",\n \"unit\": \"\\u00b0C\",\n \"role\": 201014\n }\n },\n \"logs\": {\n \"dp-uuid-1\": [\n [\n 1700000000,\n 45.3\n ],\n [\n 1700003600,\n 44.8\n ]\n ]\n },\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"dc997f93-0ef1-4441-b5b9-927b1097c8ff"},{"name":"Get statistics","id":"a9c88d68-e992-4178-bcc3-23639a21c3f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/statistics","description":"Returns aggregate device statistics (counts by severity/type).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.count | \ninteger | \n150 | \nTotal device count. | \n
\n\n| result.criticalCount | \ninteger | \n2 | \nDevices with critical status. | \n
\n\n| result.errorCount | \ninteger | \n5 | \nDevices with error status. | \n
\n\n| result.warningCount | \ninteger | \n3 | \nDevices with warnings. | \n
\n\n| result.offlineCount | \ninteger | \n8 | \nOffline devices. | \n
\n\n| result.unconfiguredCount | \ninteger | \n4 | \nUnconfigured devices. | \n
\n\n| result.groups | \nobject | \n | \n(optional) Present when groupBy is set. Keyed by group value, each with same count fields. | \n
\n\n| result.healthCheck | \nobject | \n | \n(optional) Present when includeHealthCheck=true. See Get health check. | \n
\n\n| result.unassignedGateways | \narray | \n | \n(optional) Present when unassignedGateways=true. Array of gateway objects with nested devices count map. | \n
\n\n
\n
(optional) Comma-separated location IDs.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent or exact.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"disabled":true,"description":{"content":"(optional) Comma-separated numeric role IDs.
\n","type":"text/plain"},"key":"roles","value":""},{"disabled":true,"description":{"content":"(optional) Group results by field.
\n","type":"text/plain"},"key":"groupBy","value":""},{"disabled":true,"description":{"content":"(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Include unassigned gateways. Default: 0.
\n","type":"text/plain"},"key":"unassignedGateways","value":"1"},{"disabled":true,"description":{"content":"(optional) Include health check diagnostics. Default: 0.
\n","type":"text/plain"},"key":"includeHealthCheck","value":"1"}],"variable":[]}},"response":[{"id":"474924f1-61ee-4141-ae14-3409da940f77","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/statistics","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","statistics"],"query":[{"key":"locationId","value":"","description":"(optional) Comma-separated location IDs.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` or `exact`.","disabled":true},{"key":"roles","value":"","description":"(optional) Comma-separated numeric role IDs.","disabled":true},{"key":"groupBy","value":"","description":"(optional) Group results by field.","disabled":true},{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true},{"key":"unassignedGateways","value":"1","description":"(optional) Include unassigned gateways. Default: `0`.","disabled":true},{"key":"includeHealthCheck","value":"1","description":"(optional) Include health check diagnostics. Default: `0`.","disabled":true}]},"description":"Returns aggregate device statistics (counts by severity/type).\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.count** | integer | `150` | Total device count. |\n| **result.criticalCount** | integer | `2` | Devices with critical status. |\n| **result.errorCount** | integer | `5` | Devices with error status. |\n| **result.warningCount** | integer | `3` | Devices with warnings. |\n| **result.offlineCount** | integer | `8` | Offline devices. |\n| **result.unconfiguredCount** | integer | `4` | Unconfigured devices. |\n| **result.groups** | object | | (optional) Present when `groupBy` is set. Keyed by group value, each with same count fields. |\n| **result.healthCheck** | object | | (optional) Present when `includeHealthCheck=true`. See `Get health check`. |\n| **result.unassignedGateways** | array | | (optional) Present when `unassignedGateways=true`. Array of gateway objects with nested `devices` count map. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"count\": 150,\n \"criticalCount\": 2,\n \"errorCount\": 5,\n \"warningCount\": 3,\n \"offlineCount\": 8,\n \"unconfiguredCount\": 4\n }\n}"}],"_postman_id":"a9c88d68-e992-4178-bcc3-23639a21c3f3"},{"name":"Get health check","id":"a606b76b-3741-42d6-860a-4736c38c2be6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/health-check?lang=de-DE","description":"Runs comprehensive per-device diagnostics and returns issues grouped by location. Required for >10000 devices: provide a locationId filter.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.totalDevices | \ninteger | \n150 | \nTotal devices checked. | \n
\n\n| result.totalErrors | \ninteger | \n12 | \nTotal devices with issues. | \n
\n\n| result.totalUnconfigured | \ninteger | \n3 | \nTotal unconfigured devices. | \n
\n\n| result.locations | \nobject | \n | \nObject keyed by location ID. | \n
\n\n
\n
Location object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| totalDevices | \ninteger | \n50 | \nDevices at this location. | \n
\n\n| totalErrors | \ninteger | \n5 | \nDevices with issues. | \n
\n\n| totalUnconfigured | \ninteger | \n1 | \nUnconfigured devices. | \n
\n\n| ok | \nboolean | \nfalse | \ntrue if no issues found. | \n
\n\n| fullyConfigured | \nboolean | \nfalse | \ntrue if all devices configured. | \n
\n\n| devices | \narray | \n | \nArray of device health entries (only devices with issues, or all if includeOk=true). | \n
\n\n
\n
Device health entry
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| deviceId | \nUUID | \n\"device-uuid\" | \nDevice UUID. | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nSerial number. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \nDisplay name. | \n
\n\n| deviceType | \nstring | \n\"S1\" | \nDevice family. | \n
\n\n| deviceTypeId | \nstring | \n\"s1-08-01\" | \nDevice type identifier. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nLocation. | \n
\n\n| offline | \nboolean | \nfalse | \nOffline flag. | \n
\n\n| unconfigured | \nboolean | \nfalse | \nUnconfigured flag. | \n
\n\n| lastPacket | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| issues | \narray | \n | \nArray of issue objects. | \n
\n\n
\n
Issue object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| code | \nstring | \n\"noRecentPacket\" | \nIssue code: offline, noRecentPacket, lowRssi, unconfigured, highTelegramLoss, highTelegramRepetitions, dataGaps, lowRsrp, lowRsrq, highCoverageEnhancement, highNbiotResets, highPacketGaps, pressureOutOfRange, dualtempNotMounted, highOutsideTemp. | \n
\n\n| severity | \nstring | \n\"error\" | \n\"error\" or \"info\". | \n
\n\n| message | \nstring | \n\"Kein aktuelles Paket\" | \nLocalized issue description. | \n
\n\n| value | \nvariant | \n-92 | \n(optional) Measured value that triggered the issue. | \n
\n\n
\n
\nWorkflow: Health check for a gateway by serial number
\nIf you only have the gateway serial number and a system provider API key, follow these steps:
\nStep 1 — Find the business partner
\nGET /modules/c1-device-management/gateways?search=G100AABBCCDD\nC1-BUSINESS-PARTNER: 0\n
The response contains businessPartnerId (the BP that owns the gateway) and assigned: true/false.
\nStep 2 — Find the gateway's location
\nGET /modules/c1-device-management/devices?search=G100AABBCCDD\nC1-BUSINESS-PARTNER: <businessPartnerId from step 1>\n
The gateway device object contains locationId (e.g., 1:WE-01).
\nStep 3 — Run the health check
\nGET /modules/c1-device-management/devices/health-check?locationId=1:WE-01\nC1-BUSINESS-PARTNER: <businessPartnerId from step 1>\n
This returns diagnostics for all devices at the gateway's location. Omit locationId to check all devices of the business partner.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices","health-check"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[{"disabled":true,"description":{"content":"(optional) Hierarchical location ID. Required when >10000 devices exist.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) Include devices without issues. Default: false.
\n","type":"text/plain"},"key":"includeOk","value":"true"},{"description":{"content":"(optional) Language for issue messages. Default: de-DE.
\n","type":"text/plain"},"key":"lang","value":"de-DE"}],"variable":[]}},"response":[{"id":"199b410a-c961-4278-809d-c8ab63ad436c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/health-check?lang=de-DE","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","health-check"],"query":[{"key":"locationId","value":"","description":"(optional) Hierarchical location ID. Required when >10000 devices exist.","disabled":true},{"key":"includeOk","value":"true","description":"(optional) Include devices without issues. Default: `false`.","disabled":true},{"key":"lang","value":"de-DE","description":"(optional) Language for issue messages. Default: `de-DE`."}]},"description":"Runs comprehensive per-device diagnostics and returns issues grouped by location. Required for >10000 devices: provide a `locationId` filter.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.totalDevices** | integer | `150` | Total devices checked. |\n| **result.totalErrors** | integer | `12` | Total devices with issues. |\n| **result.totalUnconfigured** | integer | `3` | Total unconfigured devices. |\n| **result.locations** | object | | Object keyed by location ID. |\n\n##### Location object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **totalDevices** | integer | `50` | Devices at this location. |\n| **totalErrors** | integer | `5` | Devices with issues. |\n| **totalUnconfigured** | integer | `1` | Unconfigured devices. |\n| **ok** | boolean | `false` | `true` if no issues found. |\n| **fullyConfigured** | boolean | `false` | `true` if all devices configured. |\n| **devices** | array | | Array of device health entries (only devices with issues, or all if `includeOk=true`). |\n\n##### Device health entry\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **deviceId** | UUID | `\"device-uuid\"` | Device UUID. |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Serial number. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **deviceType** | string | `\"S1\"` | Device family. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | Device type identifier. |\n| **locationId** | string | `\"1:WE-01.100\"` | Location. |\n| **offline** | boolean | `false` | Offline flag. |\n| **unconfigured** | boolean | `false` | Unconfigured flag. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds. |\n| **issues** | array | | Array of issue objects. |\n\n##### Issue object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **code** | string | `\"noRecentPacket\"` | Issue code: `offline`, `noRecentPacket`, `lowRssi`, `unconfigured`, `highTelegramLoss`, `highTelegramRepetitions`, `dataGaps`, `lowRsrp`, `lowRsrq`, `highCoverageEnhancement`, `highNbiotResets`, `highPacketGaps`, `pressureOutOfRange`, `dualtempNotMounted`, `highOutsideTemp`. |\n| **severity** | string | `\"error\"` | `\"error\"` or `\"info\"`. |\n| **message** | string | `\"Kein aktuelles Paket\"` | Localized issue description. |\n| **value** | variant | `-92` | (optional) Measured value that triggered the issue. |\n\n---\n\n#### Workflow: Health check for a gateway by serial number\n\nIf you only have the gateway serial number and a **system provider** API key, follow these steps:\n\n**Step 1 — Find the business partner**\n\n```\nGET /modules/c1-device-management/gateways?search=G100AABBCCDD\nC1-BUSINESS-PARTNER: 0\n```\n\nThe response contains `businessPartnerId` (the BP that owns the gateway) and `assigned: true/false`.\n\n**Step 2 — Find the gateway's location**\n\n```\nGET /modules/c1-device-management/devices?search=G100AABBCCDD\nC1-BUSINESS-PARTNER: \n```\n\nThe gateway device object contains `locationId` (e.g., `1:WE-01`).\n\n**Step 3 — Run the health check**\n\n```\nGET /modules/c1-device-management/devices/health-check?locationId=1:WE-01\nC1-BUSINESS-PARTNER: \n```\n\nThis returns diagnostics for all devices at the gateway's location. Omit `locationId` to check all devices of the business partner."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"totalDevices\": 150,\n \"totalErrors\": 12,\n \"totalUnconfigured\": 3,\n \"locations\": {\n \"1:WE-01.100\": {\n \"totalDevices\": 5,\n \"totalErrors\": 2,\n \"totalUnconfigured\": 0,\n \"ok\": false,\n \"fullyConfigured\": true,\n \"devices\": [\n {\n \"deviceId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"serialNumber\": \"S108AABBCCDD\",\n \"name\": \"Optimizer 1\",\n \"deviceType\": \"S1\",\n \"deviceTypeId\": \"s1-08-01\",\n \"locationId\": \"1:WE-01.100\",\n \"offline\": false,\n \"unconfigured\": false,\n \"lastPacket\": 1700000000,\n \"issues\": [\n {\n \"code\": \"noRecentPacket\",\n \"severity\": \"error\",\n \"message\": \"Kein aktuelles Paket\"\n },\n {\n \"code\": \"lowRssi\",\n \"severity\": \"error\",\n \"message\": \"Niedriger RSSI\",\n \"value\": -92\n }\n ]\n }\n ]\n }\n }\n }\n}"},{"id":"fbfee999-7389-4d8a-a065-fc9267199f34","name":"Too many devices","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/health-check?lang=de-DE","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","health-check"],"query":[{"key":"locationId","value":"","description":"(optional) Hierarchical location ID. Required when >10000 devices exist.","disabled":true},{"key":"includeOk","value":"true","description":"(optional) Include devices without issues. Default: `false`.","disabled":true},{"key":"lang","value":"de-DE","description":"(optional) Language for issue messages. Default: `de-DE`."}]},"description":"Runs comprehensive per-device diagnostics and returns issues grouped by location. Required for >10000 devices: provide a `locationId` filter.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.totalDevices** | integer | `150` | Total devices checked. |\n| **result.totalErrors** | integer | `12` | Total devices with issues. |\n| **result.totalUnconfigured** | integer | `3` | Total unconfigured devices. |\n| **result.locations** | object | | Object keyed by location ID. |\n\n##### Location object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **totalDevices** | integer | `50` | Devices at this location. |\n| **totalErrors** | integer | `5` | Devices with issues. |\n| **totalUnconfigured** | integer | `1` | Unconfigured devices. |\n| **ok** | boolean | `false` | `true` if no issues found. |\n| **fullyConfigured** | boolean | `false` | `true` if all devices configured. |\n| **devices** | array | | Array of device health entries (only devices with issues, or all if `includeOk=true`). |\n\n##### Device health entry\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **deviceId** | UUID | `\"device-uuid\"` | Device UUID. |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Serial number. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **deviceType** | string | `\"S1\"` | Device family. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | Device type identifier. |\n| **locationId** | string | `\"1:WE-01.100\"` | Location. |\n| **offline** | boolean | `false` | Offline flag. |\n| **unconfigured** | boolean | `false` | Unconfigured flag. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds. |\n| **issues** | array | | Array of issue objects. |\n\n##### Issue object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **code** | string | `\"noRecentPacket\"` | Issue code: `offline`, `noRecentPacket`, `lowRssi`, `unconfigured`, `highTelegramLoss`, `highTelegramRepetitions`, `dataGaps`, `lowRsrp`, `lowRsrq`, `highCoverageEnhancement`, `highNbiotResets`, `highPacketGaps`, `pressureOutOfRange`, `dualtempNotMounted`, `highOutsideTemp`. |\n| **severity** | string | `\"error\"` | `\"error\"` or `\"info\"`. |\n| **message** | string | `\"Kein aktuelles Paket\"` | Localized issue description. |\n| **value** | variant | `-92` | (optional) Measured value that triggered the issue. |\n\n---\n\n#### Workflow: Health check for a gateway by serial number\n\nIf you only have the gateway serial number and a **system provider** API key, follow these steps:\n\n**Step 1 — Find the business partner**\n\n```\nGET /modules/c1-device-management/gateways?search=G100AABBCCDD\nC1-BUSINESS-PARTNER: 0\n```\n\nThe response contains `businessPartnerId` (the BP that owns the gateway) and `assigned: true/false`.\n\n**Step 2 — Find the gateway's location**\n\n```\nGET /modules/c1-device-management/devices?search=G100AABBCCDD\nC1-BUSINESS-PARTNER: \n```\n\nThe gateway device object contains `locationId` (e.g., `1:WE-01`).\n\n**Step 3 — Run the health check**\n\n```\nGET /modules/c1-device-management/devices/health-check?locationId=1:WE-01\nC1-BUSINESS-PARTNER: \n```\n\nThis returns diagnostics for all devices at the gateway's location. Omit `locationId` to check all devices of the business partner."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"too_many_devices\",\n \"description\": \"More than 10000 devices found. Please provide a locationId filter.\"\n}"}],"_postman_id":"a606b76b-3741-42d6-860a-4736c38c2be6"},{"name":"Get devices","id":"2e71da01-85cb-4ba7-9ed6-1d2c3ad815e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices?lang=en-US&orderBy=id&ascending=true&limit=100","description":"Returns a paginated list of devices for the current business partner.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.devices | \narray | \n | \nArray of device objects. When groupBy=locationId, this is an object keyed by location ID instead. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Device object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"d23d6fd0-...\" | \nThe device UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nBusiness partner that owns this device. | \n
\n\n| type | \nstring | \n\"S1\" | \nDevice family (G1, S1, V1). | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nDevice serial number. | \n
\n\n| deviceTypeId | \nstring | \n\"s1-08-01\" | \n(Sensaru devices only) Device type identifier. | \n
\n\n| deviceType | \ninteger | \n8 | \n(Sensaru devices only) Numeric device type from serial. | \n
\n\n| operationMode | \ninteger | \n1 | \n(Sensaru devices only) Current operation mode. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \nDisplay name. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n(optional) Free-text notes. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether this is a Sensaru device. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical asset location. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \nLocation display name. | \n
\n\n| roles | \narray | \n[201014] | \nNumeric role IDs. | \n
\n\n| tags | \narray | \n[\"energy\"] | \nUser-defined tags. | \n
\n\n| status | \nstring | \n\"online\" | \n\"online\" or \"offline\". | \n
\n\n| geoCoordinates | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from asset. | \n
\n\n| geoCoordinatesZip | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from ZIP geocoding. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nAddress objects. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| settings | \nobject | \n{} | \n(optional) Device-specific settings. | \n
\n\n| unconfigured | \nboolean | \ntrue | \n(optional) Only present if true. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastPacket | \ninteger | \n1700000000 | \nUnix epoch seconds of last received packet. | \n
\n\n| dataPoints | \narray | \n[\"dp-uuid-1\"] | \nData point UUIDs belonging to this device. | \n
\n\n| configurationFields | \narray | \n | \n(optional) Only when configFields=true. Array of field descriptors with id, type, label, required, enum. | \n
\n\n
\n
(optional) Language code for localized names.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Filter by hierarchical asset location ID.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent (include children) or exact. Default: inherits from locationId level.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"disabled":true,"description":{"content":"(optional) Comma-separated numeric role IDs to filter by.
\n","type":"text/plain"},"key":"roles","value":""},{"disabled":true,"description":{"content":"(optional) Comma-separated tags to filter by.
\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"(optional) Numeric device type code.
\n","type":"text/plain"},"key":"deviceType","value":""},{"disabled":true,"description":{"content":"(optional) Comma-separated operation mode IDs.
\n","type":"text/plain"},"key":"operationMode","value":""},{"disabled":true,"description":{"content":"(optional) Comma-separated status filters, e.g. unconfigured.
\n","type":"text/plain"},"key":"filter","value":""},{"disabled":true,"description":{"content":"(optional) Include virtual devices. Default: false.
\n","type":"text/plain"},"key":"virtualDevices","value":"true"},{"disabled":true,"description":{"content":"(optional) Full-text search across serial number and name.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"(optional) Include configuration fields in response. Default: false.
\n","type":"text/plain"},"key":"configFields","value":"true"},{"description":{"content":"(optional) Sort field. Default: id.
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"description":{"content":"(optional) Sort direction. Default: true.
\n","type":"text/plain"},"key":"ascending","value":"true"},{"disabled":true,"description":{"content":"(optional) Group results by field, e.g. locationId.
\n","type":"text/plain"},"key":"groupBy","value":"locationId"},{"disabled":true,"description":{"content":"(optional) Include unassigned gateways. Default: 0.
\n","type":"text/plain"},"key":"unassignedGateways","value":"1"},{"disabled":true,"description":{"content":"(optional) Pagination cursor returned in responseMetadata.nextKey.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–10000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"0304cbc5-99b6-4c4d-8126-0d478d206451","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices?lang=en-US&orderBy=id&ascending=true&limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code for localized names."},{"key":"locationId","value":"","description":"(optional) Filter by hierarchical asset location ID.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` (include children) or `exact`. Default: inherits from locationId level.","disabled":true},{"key":"roles","value":"","description":"(optional) Comma-separated numeric role IDs to filter by.","disabled":true},{"key":"tags","value":"","description":"(optional) Comma-separated tags to filter by.","disabled":true},{"key":"deviceType","value":"","description":"(optional) Numeric device type code.","disabled":true},{"key":"operationMode","value":"","description":"(optional) Comma-separated operation mode IDs.","disabled":true},{"key":"filter","value":"","description":"(optional) Comma-separated status filters, e.g. `unconfigured`.","disabled":true},{"key":"virtualDevices","value":"true","description":"(optional) Include virtual devices. Default: `false`.","disabled":true},{"key":"search","value":"","description":"(optional) Full-text search across serial number and name.","disabled":true},{"key":"configFields","value":"true","description":"(optional) Include configuration fields in response. Default: `false`.","disabled":true},{"key":"orderBy","value":"id","description":"(optional) Sort field. Default: `id`."},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`."},{"key":"groupBy","value":"locationId","description":"(optional) Group results by field, e.g. `locationId`.","disabled":true},{"key":"unassignedGateways","value":"1","description":"(optional) Include unassigned gateways. Default: `0`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor returned in `responseMetadata.nextKey`.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–10000). Default: `100`."}]},"description":"Returns a paginated list of devices for the current business partner.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.devices** | array | | Array of device objects. When `groupBy=locationId`, this is an object keyed by location ID instead. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"devices\": [\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"businessPartnerId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"type\": \"S1\",\n \"serialNumber\": \"S108AABBCCDD\",\n \"deviceTypeId\": \"s1-08-01\",\n \"deviceType\": 8,\n \"operationMode\": 1,\n \"name\": \"Optimizer 1\",\n \"isSensaruDevice\": true,\n \"locationId\": \"1:WE-01.100\",\n \"locationName\": \"Musterstr. 1\",\n \"roles\": [\n 201014\n ],\n \"tags\": [],\n \"status\": \"online\",\n \"geoCoordinates\": [\n 9.99,\n 53.55\n ],\n \"updatedAt\": 1700000000,\n \"createdAt\": 1699000000,\n \"lastPacket\": 1700000000,\n \"dataPoints\": [\n \"dp-uuid-1\",\n \"dp-uuid-2\"\n ]\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"},{"id":"bacd1676-b8ac-489a-a9f4-f568c290cb90","name":"No business partner context","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices?lang=en-US&orderBy=id&ascending=true&limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code for localized names."},{"key":"locationId","value":"","description":"(optional) Filter by hierarchical asset location ID.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` (include children) or `exact`. Default: inherits from locationId level.","disabled":true},{"key":"roles","value":"","description":"(optional) Comma-separated numeric role IDs to filter by.","disabled":true},{"key":"tags","value":"","description":"(optional) Comma-separated tags to filter by.","disabled":true},{"key":"deviceType","value":"","description":"(optional) Numeric device type code.","disabled":true},{"key":"operationMode","value":"","description":"(optional) Comma-separated operation mode IDs.","disabled":true},{"key":"filter","value":"","description":"(optional) Comma-separated status filters, e.g. `unconfigured`.","disabled":true},{"key":"virtualDevices","value":"true","description":"(optional) Include virtual devices. Default: `false`.","disabled":true},{"key":"search","value":"","description":"(optional) Full-text search across serial number and name.","disabled":true},{"key":"configFields","value":"true","description":"(optional) Include configuration fields in response. Default: `false`.","disabled":true},{"key":"orderBy","value":"id","description":"(optional) Sort field. Default: `id`."},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`."},{"key":"groupBy","value":"locationId","description":"(optional) Group results by field, e.g. `locationId`.","disabled":true},{"key":"unassignedGateways","value":"1","description":"(optional) Include unassigned gateways. Default: `0`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor returned in `responseMetadata.nextKey`.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–10000). Default: `100`."}]},"description":"Returns a paginated list of devices for the current business partner.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.devices** | array | | Array of device objects. When `groupBy=locationId`, this is an object keyed by location ID instead. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"request_error\",\n \"description\": \"No business partner specified.\"\n}"}],"_postman_id":"2e71da01-85cb-4ba7-9ed6-1d2c3ad815e6"},{"name":"Create device","id":"6e26388e-5ad4-43ad-94b1-64c54ac5d1ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"S108AABBCCDD\",\n \"homeClient\": \"G100AABBCCDD\",\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices","description":"Creates a new device (gateway or sensor).
\nGateway (G1): Requires serialNumber and publicCertificate. Only system providers can create gateways (except virtual G1FF).
\nSensor (S1/V1): Requires serialNumber, homeClient (gateway serial), name, and operationMode.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \n | \n(required) The device serial number. Converted to uppercase. | \n
\n\n| homeClient | \nstring | \n\"G100AABBCCDD\" | \n | \n(required for sensors) Serial number of the gateway this sensor connects to. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \n\"\" | \n(required for sensors) Display name of the device. | \n
\n\n| notes | \nstring | \n\"Installed in basement\" | \n\"\" | \n(optional) Free-text notes. | \n
\n\n| operationMode | \ninteger | \n1 | \n | \n(required for sensors) The operation mode ID. Can also be passed as measurement. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \n\"\" | \n(optional) Hierarchical asset location ID to assign the device to. | \n
\n\n| publicCertificate | \nstring | \n\"-----BEGIN CERTIFICATE-----\\n...\" | \n | \n(required for gateways) PEM-encoded public certificate. | \n
\n\n| setupKey | \nstring | \n\"ABCD-1234\" | \n(auto-generated) | \n(optional, gateways only) Setup key. Auto-generated if omitted. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nFor sensors (S1/V1): the result is the new device UUID as a string.
\nFor gateways (G1): the result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[]}},"response":[{"id":"b7c6f9fe-24a1-4ea2-8d2c-b6d696c60e1c","name":"Success (sensor)","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"S108AABBCCDD\",\n \"homeClient\": \"G100AABBCCDD\",\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices","description":"Creates a new device (gateway or sensor).\n\n**Gateway (G1):** Requires `serialNumber` and `publicCertificate`. Only system providers can create gateways (except virtual G1FF).\n\n**Sensor (S1/V1):** Requires `serialNumber`, `homeClient` (gateway serial), `name`, and `operationMode`.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | | (required) The device serial number. Converted to uppercase. |\n| **homeClient** | string | `\"G100AABBCCDD\"` | | (required for sensors) Serial number of the gateway this sensor connects to. |\n| **name** | string | `\"Optimizer 1\"` | `\"\"` | (required for sensors) Display name of the device. |\n| **notes** | string | `\"Installed in basement\"` | `\"\"` | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (required for sensors) The operation mode ID. Can also be passed as `measurement`. |\n| **locationId** | string | `\"1:WE-01.100\"` | `\"\"` | (optional) Hierarchical asset location ID to assign the device to. |\n| **publicCertificate** | string | `\"-----BEGIN CERTIFICATE-----\\n...\"` | | (required for gateways) PEM-encoded public certificate. |\n| **setupKey** | string | `\"ABCD-1234\"` | *(auto-generated)* | (optional, gateways only) Setup key. Auto-generated if omitted. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nFor **sensors** (S1/V1): the result is the new device UUID as a string.\n\nFor **gateways** (G1): the result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\"\n}"},{"id":"4b8afad8-5374-4583-a5fb-d74a5c235e52","name":"Success (gateway)","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"S108AABBCCDD\",\n \"homeClient\": \"G100AABBCCDD\",\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices","description":"Creates a new device (gateway or sensor).\n\n**Gateway (G1):** Requires `serialNumber` and `publicCertificate`. Only system providers can create gateways (except virtual G1FF).\n\n**Sensor (S1/V1):** Requires `serialNumber`, `homeClient` (gateway serial), `name`, and `operationMode`.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | | (required) The device serial number. Converted to uppercase. |\n| **homeClient** | string | `\"G100AABBCCDD\"` | | (required for sensors) Serial number of the gateway this sensor connects to. |\n| **name** | string | `\"Optimizer 1\"` | `\"\"` | (required for sensors) Display name of the device. |\n| **notes** | string | `\"Installed in basement\"` | `\"\"` | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (required for sensors) The operation mode ID. Can also be passed as `measurement`. |\n| **locationId** | string | `\"1:WE-01.100\"` | `\"\"` | (optional) Hierarchical asset location ID to assign the device to. |\n| **publicCertificate** | string | `\"-----BEGIN CERTIFICATE-----\\n...\"` | | (required for gateways) PEM-encoded public certificate. |\n| **setupKey** | string | `\"ABCD-1234\"` | *(auto-generated)* | (optional, gateways only) Setup key. Auto-generated if omitted. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nFor **sensors** (S1/V1): the result is the new device UUID as a string.\n\nFor **gateways** (G1): the result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"},{"id":"06824863-8cf3-4ba9-951e-a879d136d609","name":"Duplicate serial number","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"S108AABBCCDD\",\n \"homeClient\": \"G100AABBCCDD\",\n \"name\": \"Optimizer 1\",\n \"notes\": \"\",\n \"operationMode\": 1,\n \"locationId\": \"1:WE-01.100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices","description":"Creates a new device (gateway or sensor).\n\n**Gateway (G1):** Requires `serialNumber` and `publicCertificate`. Only system providers can create gateways (except virtual G1FF).\n\n**Sensor (S1/V1):** Requires `serialNumber`, `homeClient` (gateway serial), `name`, and `operationMode`.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | | (required) The device serial number. Converted to uppercase. |\n| **homeClient** | string | `\"G100AABBCCDD\"` | | (required for sensors) Serial number of the gateway this sensor connects to. |\n| **name** | string | `\"Optimizer 1\"` | `\"\"` | (required for sensors) Display name of the device. |\n| **notes** | string | `\"Installed in basement\"` | `\"\"` | (optional) Free-text notes. |\n| **operationMode** | integer | `1` | | (required for sensors) The operation mode ID. Can also be passed as `measurement`. |\n| **locationId** | string | `\"1:WE-01.100\"` | `\"\"` | (optional) Hierarchical asset location ID to assign the device to. |\n| **publicCertificate** | string | `\"-----BEGIN CERTIFICATE-----\\n...\"` | | (required for gateways) PEM-encoded public certificate. |\n| **setupKey** | string | `\"ABCD-1234\"` | *(auto-generated)* | (optional, gateways only) Setup key. Auto-generated if omitted. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nFor **sensors** (S1/V1): the result is the new device UUID as a string.\n\nFor **gateways** (G1): the result is an empty object `{}`."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"request_error\",\n \"description\": \"A device with this serial number already exists.\"\n}"}],"_postman_id":"6e26388e-5ad4-43ad-94b1-64c54ac5d1ba"},{"name":"Assign device","id":"70a532c8-8a7b-42f2-8512-5d1745fcaa70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"G100AABBCCDD\",\n \"setupKey\": \"ABCD-1234\",\n \"name\": \"Gateway Keller\",\n \"notes\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/assign?lang=en-US","description":"Assigns a gateway to the current business partner. The gateway must exist and not be assigned yet.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| serialNumber | \nstring | \n\"G100AABBCCDD\" | \n | \n(required) Gateway serial number. Converted to uppercase. Must start with G1. | \n
\n\n| setupKey | \nstring | \n\"ABCD-1234\" | \n | \n(required for non-system-provider users) The setup key of the gateway. | \n
\n\n| name | \nstring | \n\"Gateway Keller\" | \n | \n(required) Display name of the gateway. | \n
\n\n| notes | \nstring | \n\"Installed 2024-01\" | \n\"\" | \n(optional) Free-text notes. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is the assigned gateway as a device object.
\nDevice object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"d23d6fd0-...\" | \nThe device UUID. | \n
\n\n| businessPartnerId | \nstring | \n\"bp-uuid\" | \nBusiness partner that owns this device. | \n
\n\n| type | \nstring | \n\"S1\" | \nDevice family (G1, S1, V1). | \n
\n\n| serialNumber | \nstring | \n\"S108AABBCCDD\" | \nDevice serial number. | \n
\n\n| deviceTypeId | \nstring | \n\"s1-08-01\" | \n(Sensaru devices only) Device type identifier. | \n
\n\n| deviceType | \ninteger | \n8 | \n(Sensaru devices only) Numeric device type from serial. | \n
\n\n| operationMode | \ninteger | \n1 | \n(Sensaru devices only) Current operation mode. | \n
\n\n| name | \nstring | \n\"Optimizer 1\" | \nDisplay name. | \n
\n\n| notes | \nstring | \n\"Floor 2\" | \n(optional) Free-text notes. | \n
\n\n| isSensaruDevice | \nboolean | \ntrue | \nWhether this is a Sensaru device. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nHierarchical asset location. | \n
\n\n| locationName | \nstring | \n\"Building A\" | \nLocation display name. | \n
\n\n| roles | \narray | \n[201014] | \nNumeric role IDs. | \n
\n\n| tags | \narray | \n[\"energy\"] | \nUser-defined tags. | \n
\n\n| status | \nstring | \n\"online\" | \n\"online\" or \"offline\". | \n
\n\n| geoCoordinates | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from asset. | \n
\n\n| geoCoordinatesZip | \narray | \n[9.99, 53.55] | \n[longitude, latitude] from ZIP geocoding. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nAddress objects. | \n
\n\n| metadata | \nobject | \n{} | \n(optional) Custom metadata. | \n
\n\n| settings | \nobject | \n{} | \n(optional) Device-specific settings. | \n
\n\n| unconfigured | \nboolean | \ntrue | \n(optional) Only present if true. | \n
\n\n| updatedAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastPacket | \ninteger | \n1700000000 | \nUnix epoch seconds of last received packet. | \n
\n\n| dataPoints | \narray | \n[\"dp-uuid-1\"] | \nData point UUIDs belonging to this device. | \n
\n\n| configurationFields | \narray | \n | \n(optional) Only when configFields=true. Array of field descriptors with id, type, label, required, enum. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"}],"variable":[]}},"response":[{"id":"de840099-c759-40af-9842-423537cacb55","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"G100AABBCCDD\",\n \"setupKey\": \"ABCD-1234\",\n \"name\": \"Gateway Keller\",\n \"notes\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/assign?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","assign"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."}]},"description":"Assigns a gateway to the current business partner. The gateway must exist and not be assigned yet.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **serialNumber** | string | `\"G100AABBCCDD\"` | | (required) Gateway serial number. Converted to uppercase. Must start with `G1`. |\n| **setupKey** | string | `\"ABCD-1234\"` | | (required for non-system-provider users) The setup key of the gateway. |\n| **name** | string | `\"Gateway Keller\"` | | (required) Display name of the gateway. |\n| **notes** | string | `\"Installed 2024-01\"` | `\"\"` | (optional) Free-text notes. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the assigned gateway as a device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"G1\",\n \"serialNumber\": \"G100AABBCCDD\",\n \"name\": \"Gateway Keller\",\n \"isSensaruDevice\": true,\n \"locationId\": \"\",\n \"roles\": [\n 20300\n ],\n \"status\": \"online\",\n \"updatedAt\": 1700000000,\n \"createdAt\": 1699000000,\n \"lastPacket\": 1700000000\n }\n}"},{"id":"26cd3ee4-97a6-4edb-8de8-399bea1624e6","name":"Invalid setup key","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"G100AABBCCDD\",\n \"setupKey\": \"ABCD-1234\",\n \"name\": \"Gateway Keller\",\n \"notes\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/devices/assign?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["devices","assign"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."}]},"description":"Assigns a gateway to the current business partner. The gateway must exist and not be assigned yet.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **serialNumber** | string | `\"G100AABBCCDD\"` | | (required) Gateway serial number. Converted to uppercase. Must start with `G1`. |\n| **setupKey** | string | `\"ABCD-1234\"` | | (required for non-system-provider users) The setup key of the gateway. |\n| **name** | string | `\"Gateway Keller\"` | | (required) Display name of the gateway. |\n| **notes** | string | `\"Installed 2024-01\"` | `\"\"` | (optional) Free-text notes. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the assigned gateway as a device object.\n\n\n##### Device object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"d23d6fd0-...\"` | The device UUID. |\n| **businessPartnerId** | string | `\"bp-uuid\"` | Business partner that owns this device. |\n| **type** | string | `\"S1\"` | Device family (`G1`, `S1`, `V1`). |\n| **serialNumber** | string | `\"S108AABBCCDD\"` | Device serial number. |\n| **deviceTypeId** | string | `\"s1-08-01\"` | (Sensaru devices only) Device type identifier. |\n| **deviceType** | integer | `8` | (Sensaru devices only) Numeric device type from serial. |\n| **operationMode** | integer | `1` | (Sensaru devices only) Current operation mode. |\n| **name** | string | `\"Optimizer 1\"` | Display name. |\n| **notes** | string | `\"Floor 2\"` | (optional) Free-text notes. |\n| **isSensaruDevice** | boolean | `true` | Whether this is a Sensaru device. |\n| **locationId** | string | `\"1:WE-01.100\"` | Hierarchical asset location. |\n| **locationName** | string | `\"Building A\"` | Location display name. |\n| **roles** | array | `[201014]` | Numeric role IDs. |\n| **tags** | array | `[\"energy\"]` | User-defined tags. |\n| **status** | string | `\"online\"` | `\"online\"` or `\"offline\"`. |\n| **geoCoordinates** | array | `[9.99, 53.55]` | `[longitude, latitude]` from asset. |\n| **geoCoordinatesZip** | array | `[9.99, 53.55]` | `[longitude, latitude]` from ZIP geocoding. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Address objects. |\n| **metadata** | object | `{}` | (optional) Custom metadata. |\n| **settings** | object | `{}` | (optional) Device-specific settings. |\n| **unconfigured** | boolean | `true` | (optional) Only present if `true`. |\n| **updatedAt** | integer | `1700000000` | Unix epoch seconds. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastPacket** | integer | `1700000000` | Unix epoch seconds of last received packet. |\n| **dataPoints** | array | `[\"dp-uuid-1\"]` | Data point UUIDs belonging to this device. |\n| **configurationFields** | array | | (optional) Only when `configFields=true`. Array of field descriptors with `id`, `type`, `label`, `required`, `enum`. |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"request_error\",\n \"description\": \"Setup key is invalid.\"\n}"}],"_postman_id":"70a532c8-8a7b-42f2-8512-5d1745fcaa70"}],"id":"7fd79249-e72e-4940-b046-5523807b0fae","_postman_id":"7fd79249-e72e-4940-b046-5523807b0fae","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"service-messages","item":[{"name":"{messageId}","item":[{"name":"Get service message","id":"ee3d59c9-6250-4a07-9cdc-5316c8f6096f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/service-messages/:messageId?lang=en-US","description":"Returns a single service message by ID.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is a single service message object (see Get service messages for field descriptions).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["service-messages",":messageId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[{"description":{"content":"(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"}],"variable":[{"id":"8a468d1d-276c-4cf7-a087-c41298dff5c2","description":{"content":"(required) The service message UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"messageId"}]}},"response":[{"id":"772f16a2-4d99-484e-a2f4-55bf816331b5","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/service-messages/:messageId?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["service-messages",":messageId"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."}],"variable":[{"id":"8a468d1d-276c-4cf7-a087-c41298dff5c2","key":"messageId","value":"","description":"(required) The service message UUID."}]},"description":"Returns a single service message by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single service message object (see `Get service messages` for field descriptions)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-000000000001\",\n \"createdAt\": 1700000000,\n \"lastUpdate\": 1700003600,\n \"deviceId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"dataPointId\": \"dp-uuid-1\",\n \"roles\": [\n 201014\n ],\n \"locationId\": \"1:WE-01.100\",\n \"priority\": \"error\",\n \"isSticky\": false,\n \"message\": \"Supply temperature sensor offline\"\n }\n}"},{"id":"8d26f5f8-18ef-492e-a3c9-56b8a10f8111","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/service-messages/:messageId?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["service-messages",":messageId"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."}],"variable":[{"id":"8a468d1d-276c-4cf7-a087-c41298dff5c2","key":"messageId","value":"","description":"(required) The service message UUID."}]},"description":"Returns a single service message by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single service message object (see `Get service messages` for field descriptions)."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"ee3d59c9-6250-4a07-9cdc-5316c8f6096f"}],"id":"6c8c7e7b-ee31-48fa-a0b0-bc1384d30404","_postman_id":"6c8c7e7b-ee31-48fa-a0b0-bc1384d30404","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get service messages","id":"e24b9bd0-d503-43ff-8b04-598d592308af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/service-messages?limit=100","description":"Returns service messages across all devices for the current business partner.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.serviceMessages | \narray | \n | \nArray of service message objects. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Service message object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"msg-uuid\" | \nService message ID. | \n
\n\n| createdAt | \ninteger | \n1700000000 | \nUnix epoch seconds. | \n
\n\n| lastUpdate | \ninteger | \n1700003600 | \nUnix epoch seconds. | \n
\n\n| deviceId | \nUUID | \n\"device-uuid\" | \nDevice that triggered the message. | \n
\n\n| dataPointId | \nUUID | \n\"dp-uuid\" | \nRelated data point. | \n
\n\n| roles | \narray | \n[201014, 800001] | \nAssociated role IDs. | \n
\n\n| locationId | \nstring | \n\"1:WE-01.100\" | \nLocation of the device. | \n
\n\n| addresses | \narray | \n[{\"street\": \"...\", ...}] | \nDevice addresses. | \n
\n\n| priority | \nstring | \n\"error\" | \nSeverity: \"critical\", \"error\", \"warning\", \"info\". | \n
\n\n| isSticky | \nboolean | \nfalse | \nWhether the message persists after resolution. | \n
\n\n| message | \nstring | \n\"Sensor offline\" | \nLocalized message text. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) parent or exact.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"},{"disabled":true,"description":{"content":"(optional) Comma-separated role IDs.
\n","type":"text/plain"},"key":"roles","value":""},{"disabled":true,"description":{"content":"(optional) Comma-separated status filters.
\n","type":"text/plain"},"key":"filter","value":""},{"disabled":true,"description":{"content":"(optional) Full-text search.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–1000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"0621598e-0f6d-418b-81ad-ee845a434638","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/service-messages?limit=100","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["service-messages"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code.","disabled":true},{"key":"locationId","value":"","description":"(optional) Hierarchical location ID.","disabled":true},{"key":"locationIdFilterType","value":"parent","description":"(optional) `parent` or `exact`.","disabled":true},{"key":"roles","value":"","description":"(optional) Comma-separated role IDs.","disabled":true},{"key":"filter","value":"","description":"(optional) Comma-separated status filters.","disabled":true},{"key":"search","value":"","description":"(optional) Full-text search.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"100","description":"(optional) Page size (1–1000). Default: `100`."}]},"description":"Returns service messages across all devices for the current business partner.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.serviceMessages** | array | | Array of service message objects. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Service message object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"msg-uuid\"` | Service message ID. |\n| **createdAt** | integer | `1700000000` | Unix epoch seconds. |\n| **lastUpdate** | integer | `1700003600` | Unix epoch seconds. |\n| **deviceId** | UUID | `\"device-uuid\"` | Device that triggered the message. |\n| **dataPointId** | UUID | `\"dp-uuid\"` | Related data point. |\n| **roles** | array | `[201014, 800001]` | Associated role IDs. |\n| **locationId** | string | `\"1:WE-01.100\"` | Location of the device. |\n| **addresses** | array | `[{\"street\": \"...\", ...}]` | Device addresses. |\n| **priority** | string | `\"error\"` | Severity: `\"critical\"`, `\"error\"`, `\"warning\"`, `\"info\"`. |\n| **isSticky** | boolean | `false` | Whether the message persists after resolution. |\n| **message** | string | `\"Sensor offline\"` | Localized message text. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"serviceMessages\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-000000000001\",\n \"createdAt\": 1700000000,\n \"lastUpdate\": 1700003600,\n \"deviceId\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"dataPointId\": \"dp-uuid-1\",\n \"roles\": [\n 201014\n ],\n \"locationId\": \"1:WE-01.100\",\n \"priority\": \"error\",\n \"isSticky\": false,\n \"message\": \"Supply temperature sensor offline\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"e24b9bd0-d503-43ff-8b04-598d592308af"}],"id":"ac087b7f-71c6-4386-81ba-a270fbc436ef","_postman_id":"ac087b7f-71c6-4386-81ba-a270fbc436ef","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"commissioning-cards","item":[{"name":"{cardId}","item":[{"name":"Get commissioning card","id":"feff2741-af06-4aba-ad1f-59881d7a36a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","description":"Returns a single commissioning card by ID.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is a single commissioning card object.
\nCommissioning card object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| serialNumber | \nstring | \n\"04A3B2C1D2E3F4\" | \nNFC card serial number. | \n
\n\n| name | \nstring | \n\"Site Office\" | \nDisplay name. | \n
\n\n
\n
(required) The commissioning card UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"cardId"}]}},"response":[{"id":"1b846ecc-8fbb-4183-9290-e41258e846cb","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["commissioning-cards",":cardId"],"variable":[{"id":"cb644568-4783-42a7-9faa-f2dd84861f80","key":"cardId","value":"","description":"(required) The commissioning card UUID."}]},"description":"Returns a single commissioning card by ID.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is a single commissioning card object.\n\n\n##### Commissioning card object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **serialNumber** | string | `\"04A3B2C1D2E3F4\"` | NFC card serial number. |\n| **name** | string | `\"Site Office\"` | Display name. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"serialNumber\": \"04A3B2C1D2E3F4\",\n \"name\": \"Site Office\"\n }\n}"}],"_postman_id":"feff2741-af06-4aba-ad1f-59881d7a36a8"},{"name":"Replace commissioning card","id":"1e18e282-c7d5-453e-9ceb-54d3dc9c1165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","description":"Replaces a commissioning card (full update).
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| name | \nstring | \n\"Updated name\" | \n | \n(required) New display name. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["commissioning-cards",":cardId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"6cace7bb-8b79-4b62-92b7-66ecc656a822","description":{"content":"(required) The commissioning card UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"cardId"}]}},"response":[{"id":"555d77ef-4f7b-4dc1-947d-4eeb2c031769","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["commissioning-cards",":cardId"],"variable":[{"id":"6cace7bb-8b79-4b62-92b7-66ecc656a822","key":"cardId","value":"","description":"(required) The commissioning card UUID."}]},"description":"Replaces a commissioning card (full update).\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **name** | string | `\"Updated name\"` | | (required) New display name. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"1e18e282-c7d5-453e-9ceb-54d3dc9c1165"},{"name":"Update commissioning card","id":"db3c6dbb-39fe-49bc-88b3-40f29e27ce08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","description":"Partially updates a commissioning card.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| name | \nstring | \n\"Updated name\" | \n | \n(optional) New display name. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["commissioning-cards",":cardId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"6afa6ee3-9b9a-4986-9b8c-7d0e696e6189","description":{"content":"(required) The commissioning card UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"cardId"}]}},"response":[{"id":"1d8b566a-1b3f-4050-b4f3-ecf74f2b6d58","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["commissioning-cards",":cardId"],"variable":[{"id":"6afa6ee3-9b9a-4986-9b8c-7d0e696e6189","key":"cardId","value":"","description":"(required) The commissioning card UUID."}]},"description":"Partially updates a commissioning card.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **name** | string | `\"Updated name\"` | | (optional) New display name. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"db3c6dbb-39fe-49bc-88b3-40f29e27ce08"},{"name":"Delete commissioning card","id":"9adc9729-94f8-4880-8c72-8cab1c0ea770","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","description":"Deletes a commissioning card.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["commissioning-cards",":cardId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"41ab66ff-c8b0-43f3-b8a3-23d57f6f5110","description":{"content":"(required) The commissioning card UUID.
\n","type":"text/plain"},"type":"any","value":"","key":"cardId"}]}},"response":[{"id":"d536b98b-1eaf-4424-8794-f2e2a8b9859e","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards/:cardId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["commissioning-cards",":cardId"],"variable":[{"id":"41ab66ff-c8b0-43f3-b8a3-23d57f6f5110","key":"cardId","value":"","description":"(required) The commissioning card UUID."}]},"description":"Deletes a commissioning card.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"9adc9729-94f8-4880-8c72-8cab1c0ea770"}],"id":"a63e47c5-f335-44c0-8edf-f499e8376b67","_postman_id":"a63e47c5-f335-44c0-8edf-f499e8376b67","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get commissioning cards","id":"6446869c-6533-4e10-8d21-b7cd574dbb3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards?limit=1000","description":"Returns a paginated list of commissioning cards.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.commissioningCards | \narray | \n | \nArray of commissioning card objects. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Commissioning card object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| serialNumber | \nstring | \n\"04A3B2C1D2E3F4\" | \nNFC card serial number. | \n
\n\n| name | \nstring | \n\"Site Office\" | \nDisplay name. | \n
\n\n
\n
(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–1000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"c4e9b349-5464-422a-b741-a5f45b5a497a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards?limit=1000","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["commissioning-cards"],"query":[{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"1000","description":"(optional) Page size (1–1000). Default: `100`."}]},"description":"Returns a paginated list of commissioning cards.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.commissioningCards** | array | | Array of commissioning card objects. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Commissioning card object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **serialNumber** | string | `\"04A3B2C1D2E3F4\"` | NFC card serial number. |\n| **name** | string | `\"Site Office\"` | Display name. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"commissioningCards\": [\n {\n \"serialNumber\": \"04A3B2C1D2E3F4\",\n \"name\": \"Site Office\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"6446869c-6533-4e10-8d21-b7cd574dbb3a"},{"name":"Create commissioning card","id":"c2ac451d-a039-465e-bdbd-aa392834e7f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"G100AABBCCDD\",\n \"name\": \"Inbetriebnahme Geb\\u00e4ude A\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards","description":"Creates a new commissioning card.
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| serialNumber | \nstring | \n\"G100AABBCCDD\" | \n | \n(required) Gateway serial number to associate with the card. | \n
\n\n| name | \nstring | \n\"Inbetriebnahme Gebäude A\" | \n\"\" | \n(required) Display name of the commissioning card. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["commissioning-cards"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[]}},"response":[{"id":"417b4f92-c697-40f8-a50f-c919e7a55593","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"G100AABBCCDD\",\n \"name\": \"Inbetriebnahme Geb\\u00e4ude A\"\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/commissioning-cards","description":"Creates a new commissioning card.\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **serialNumber** | string | `\"G100AABBCCDD\"` | | (required) Gateway serial number to associate with the card. |\n| **name** | string | `\"Inbetriebnahme Gebäude A\"` | `\"\"` | (required) Display name of the commissioning card. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"c2ac451d-a039-465e-bdbd-aa392834e7f7"}],"id":"648e2503-5902-4810-a444-36c5388fcd84","_postman_id":"648e2503-5902-4810-a444-36c5388fcd84","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"dashboards","item":[{"name":"Get app dashboard","id":"26c8310d-ebdb-4790-ad01-f3bc6c2f28eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/app?locationId=1:WE-01&lang=en-US","description":"Returns the app dashboard data for a location.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.metrics | \narray | \n | \nArray of metric widgets with deviceId, value, label, unit, icon. | \n
\n\n| result.diagram | \nobject | \n | \nSankey-style diagram data with state, left, right, center, top sections. | \n
\n\n
\n
(required) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":"1:WE-01"},{"description":{"content":"(optional) Language code. Default: en-US.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Year filter.
\n","type":"text/plain"},"key":"year","value":""},{"disabled":true,"description":{"content":"(optional) Month filter (0-11).
\n","type":"text/plain"},"key":"month","value":""},{"disabled":true,"description":{"content":"(optional) Day filter.
\n","type":"text/plain"},"key":"day","value":""}],"variable":[]}},"response":[{"id":"a910fbc5-bdeb-495f-aa21-f9623154191a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/app?locationId=1:WE-01&lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["dashboards","app"],"query":[{"key":"locationId","value":"1:WE-01","description":"(required) Hierarchical location ID."},{"key":"lang","value":"en-US","description":"(optional) Language code. Default: `en-US`."},{"key":"year","value":"","description":"(optional) Year filter.","disabled":true},{"key":"month","value":"","description":"(optional) Month filter (0-11).","disabled":true},{"key":"day","value":"","description":"(optional) Day filter.","disabled":true}]},"description":"Returns the app dashboard data for a location.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.metrics** | array | | Array of metric widgets with `deviceId`, `value`, `label`, `unit`, `icon`. |\n| **result.diagram** | object | | Sankey-style diagram data with `state`, `left`, `right`, `center`, `top` sections. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"metrics\": [\n {\n \"deviceId\": \"dev-uuid\",\n \"value\": \"22.5 \\u00b0C\",\n \"label\": \"S1 DualTemp\",\n \"unit\": \"\\u00b0C\",\n \"icon\": \"thermometer\"\n }\n ],\n \"diagram\": {\n \"state\": \"ok\",\n \"left\": [],\n \"right\": [],\n \"center\": [],\n \"top\": {}\n }\n }\n}"}],"_postman_id":"26c8310d-ebdb-4790-ad01-f3bc6c2f28eb"},{"name":"Get business UI dashboard","id":"07c522c7-87cf-4f25-b9f7-228614edbc25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/business-ui?locationId=1:WE-01&lang=en-US","description":"Returns the business UI dashboard data for a location.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.diagram | \nobject | \n | \nDiagram with left, right, center, top sections showing energy, CO2, efficiency. | \n
\n\n| result.powerConsumption | \nnumber | \n2150 | \nTotal power consumption in kWh. | \n
\n\n| result.waterConsumption | \nnumber | \n450 | \nTotal water consumption in m³. | \n
\n\n| result.heatConsumption | \nnumber | \n8500 | \nTotal heat consumption in kWh. | \n
\n\n
\n
(required) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":"1:WE-01"},{"description":{"content":"(optional) Language code. Default: en-US.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Year filter.
\n","type":"text/plain"},"key":"year","value":""},{"disabled":true,"description":{"content":"(optional) Month filter (0-11).
\n","type":"text/plain"},"key":"month","value":""},{"disabled":true,"description":{"content":"(optional) Day filter.
\n","type":"text/plain"},"key":"day","value":""}],"variable":[]}},"response":[{"id":"b7f317c3-d748-48c6-85a7-aa802a113147","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/business-ui?locationId=1:WE-01&lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["dashboards","business-ui"],"query":[{"key":"locationId","value":"1:WE-01","description":"(required) Hierarchical location ID."},{"key":"lang","value":"en-US","description":"(optional) Language code. Default: `en-US`."},{"key":"year","value":"","description":"(optional) Year filter.","disabled":true},{"key":"month","value":"","description":"(optional) Month filter (0-11).","disabled":true},{"key":"day","value":"","description":"(optional) Day filter.","disabled":true}]},"description":"Returns the business UI dashboard data for a location.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.diagram** | object | | Diagram with `left`, `right`, `center`, `top` sections showing energy, CO2, efficiency. |\n| **result.powerConsumption** | number | `2150` | Total power consumption in kWh. |\n| **result.waterConsumption** | number | `450` | Total water consumption in m³. |\n| **result.heatConsumption** | number | `8500` | Total heat consumption in kWh. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"diagram\": {\n \"left\": [],\n \"right\": [],\n \"center\": [],\n \"top\": {}\n },\n \"powerConsumption\": 2150,\n \"waterConsumption\": 450,\n \"heatConsumption\": 8500\n }\n}"}],"_postman_id":"07c522c7-87cf-4f25-b9f7-228614edbc25"},{"name":"Get energy dashboard","id":"9b81bdf7-860f-4473-8e2f-017a3c014a30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/energy?locationId=1:WE-01&lang=en-US","description":"Returns the energy dashboard data for a location.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.power | \nobject | \n | \nPower data with sources and consumers arrays. | \n
\n\n| result.heating | \nobject | \n | \nHeating data with sources and consumers arrays. | \n
\n\n
\n
(required) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":"1:WE-01"},{"description":{"content":"(optional) Language code. Default: en-US.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Year filter.
\n","type":"text/plain"},"key":"year","value":""},{"disabled":true,"description":{"content":"(optional) Month filter (0-11).
\n","type":"text/plain"},"key":"month","value":""},{"disabled":true,"description":{"content":"(optional) Day filter.
\n","type":"text/plain"},"key":"day","value":""}],"variable":[]}},"response":[{"id":"4e64c9b0-ea2c-4e45-87da-6af5ff1f0e53","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/energy?locationId=1:WE-01&lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["dashboards","energy"],"query":[{"key":"locationId","value":"1:WE-01","description":"(required) Hierarchical location ID."},{"key":"lang","value":"en-US","description":"(optional) Language code. Default: `en-US`."},{"key":"year","value":"","description":"(optional) Year filter.","disabled":true},{"key":"month","value":"","description":"(optional) Month filter (0-11).","disabled":true},{"key":"day","value":"","description":"(optional) Day filter.","disabled":true}]},"description":"Returns the energy dashboard data for a location.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.power** | object | | Power data with `sources` and `consumers` arrays. |\n| **result.heating** | object | | Heating data with `sources` and `consumers` arrays. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"power\": {\n \"sources\": [],\n \"consumers\": []\n },\n \"heating\": {\n \"sources\": [],\n \"consumers\": []\n }\n }\n}"}],"_postman_id":"9b81bdf7-860f-4473-8e2f-017a3c014a30"},{"name":"Get main dashboard","id":"fad27cde-131b-44e8-8753-ed4093674de0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/main?lang=en-US","description":"Returns the main dashboard overview.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.statistics | \narray | \n | \nArray of {statisticName, statisticValue} objects. | \n
\n\n| result.energyClasses | \nobject | \n | \nEnergy class comparisons with myBuildings, avgGermany, avgSensaru. | \n
\n\n| result.consumptionData | \nobject | \n | \nEnergy class, consumption per m², total consumption. | \n
\n\n| result.emissionData | \nobject | \n | \nCO₂ equivalent per m², total CO₂. | \n
\n\n| result.mapMarkerLocations | \narray | \n | \nArray of [longitude, latitude, rating] for map display. | \n
\n\n| result.savings | \nobject | \n | \nPotential and actual savings with amounts and percentages. | \n
\n\n| result.topObjects | \narray | \n | \nBest-performing buildings. | \n
\n\n| result.worstObjects | \narray | \n | \nWorst-performing buildings. | \n
\n\n
\n
(optional) Language code. Default: en-US.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":""}],"variable":[]}},"response":[{"id":"6ea6436a-a3be-4e97-a508-326592109a33","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/main?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["dashboards","main"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code. Default: `en-US`."},{"key":"locationId","value":"","description":"(optional) Hierarchical location ID.","disabled":true}]},"description":"Returns the main dashboard overview.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.statistics** | array | | Array of `{statisticName, statisticValue}` objects. |\n| **result.energyClasses** | object | | Energy class comparisons with `myBuildings`, `avgGermany`, `avgSensaru`. |\n| **result.consumptionData** | object | | Energy class, consumption per m², total consumption. |\n| **result.emissionData** | object | | CO₂ equivalent per m², total CO₂. |\n| **result.mapMarkerLocations** | array | | Array of `[longitude, latitude, rating]` for map display. |\n| **result.savings** | object | | Potential and actual savings with amounts and percentages. |\n| **result.topObjects** | array | | Best-performing buildings. |\n| **result.worstObjects** | array | | Worst-performing buildings. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"statistics\": [\n {\n \"statisticName\": \"administrationUnits\",\n \"statisticValue\": 45\n }\n ],\n \"energyClasses\": {},\n \"consumptionData\": {},\n \"emissionData\": {},\n \"mapMarkerLocations\": [],\n \"savings\": {},\n \"topObjects\": [],\n \"worstObjects\": []\n }\n}"}],"_postman_id":"fad27cde-131b-44e8-8753-ed4093674de0"},{"name":"Get optimizer dashboard","id":"c27ca179-f74e-4923-ac4c-4a4d387519e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/optimizer?lang=en-US","description":"Returns the optimizer dashboard data.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.temperatureAdjustmentCurve | \narray | \n[[-20, 0.0], [-19, 1.2]] | \nAggregated static heating table as [outsideTemp, offsetKelvin] pairs. | \n
\n\n| result.temperatureAdjustmentCurves | \nobject | \n | \nPer heating circuit curves, keyed by circuit ID. | \n
\n\n| result.outdoorTemperatureRangeMin | \nnumber | \n-5.3 | \nMinimum observed outdoor temperature. | \n
\n\n| result.outdoorTemperatureRangeMax | \nnumber | \n8.2 | \nMaximum observed outdoor temperature. | \n
\n\n
\n
(optional) Language code. Default: en-US.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":""},{"disabled":true,"description":{"content":"(optional) Filter by heating system source location.
\n","type":"text/plain"},"key":"heatingSystemSourceLocationId","value":""}],"variable":[]}},"response":[{"id":"4f74547e-0c18-487e-af71-3d22b4ae7abf","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/dashboards/optimizer?lang=en-US","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["dashboards","optimizer"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code. Default: `en-US`."},{"key":"locationId","value":"","description":"(optional) Hierarchical location ID.","disabled":true},{"key":"heatingSystemSourceLocationId","value":"","description":"(optional) Filter by heating system source location.","disabled":true}]},"description":"Returns the optimizer dashboard data.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.temperatureAdjustmentCurve** | array | `[[-20, 0.0], [-19, 1.2]]` | Aggregated static heating table as `[outsideTemp, offsetKelvin]` pairs. |\n| **result.temperatureAdjustmentCurves** | object | | Per heating circuit curves, keyed by circuit ID. |\n| **result.outdoorTemperatureRangeMin** | number | `-5.3` | Minimum observed outdoor temperature. |\n| **result.outdoorTemperatureRangeMax** | number | `8.2` | Maximum observed outdoor temperature. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"temperatureAdjustmentCurve\": [\n [\n -20,\n 0.0\n ],\n [\n -19,\n 1.2\n ],\n [\n -18,\n 2.5\n ]\n ],\n \"temperatureAdjustmentCurves\": {},\n \"outdoorTemperatureRangeMin\": -5.3,\n \"outdoorTemperatureRangeMax\": 8.2\n }\n}"}],"_postman_id":"c27ca179-f74e-4923-ac4c-4a4d387519e4"}],"id":"9e8e5719-a890-4c0d-86a8-25294ea25c9d","_postman_id":"9e8e5719-a890-4c0d-86a8-25294ea25c9d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"reference-data (public)","item":[{"name":"Get all roles","id":"2beee94b-c5e4-4d25-9542-775fb866829d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/roles","description":"Returns all available device roles. No business partner context required.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an array of role objects.
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nstring | \n\"20.10.14\" | \nDot-separated role ID. | \n
\n\n| numericId | \ninteger | \n201014 | \nNumeric role ID (used in query parameters). | \n
\n\n| name | \nstring | \n\"Supply Temperature\" | \nLocalized role name. | \n
\n\n| aggregation | \nstring | \n\"average\" | \n(optional) Default aggregation method. | \n
\n\n
\n
(optional) Language code for localized role names.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Full-text search filter.
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"e9ec1fed-6477-4d38-98b4-2071c511ecc6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/roles","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["roles"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code for localized role names.","disabled":true},{"key":"search","value":"","description":"(optional) Full-text search filter.","disabled":true}]},"description":"Returns all available device roles. No business partner context required.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an array of role objects.\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | string | `\"20.10.14\"` | Dot-separated role ID. |\n| **numericId** | integer | `201014` | Numeric role ID (used in query parameters). |\n| **name** | string | `\"Supply Temperature\"` | Localized role name. |\n| **aggregation** | string | `\"average\"` | (optional) Default aggregation method. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": \"20.10.14\",\n \"numericId\": 201014,\n \"name\": \"Supply Temperature\",\n \"aggregation\": \"average\"\n },\n {\n \"id\": \"90.04.02\",\n \"numericId\": 900402,\n \"name\": \"Heat Meter - Heating\"\n }\n ]\n}"}],"_postman_id":"2beee94b-c5e4-4d25-9542-775fb866829d"},{"name":"Get all device types","id":"ae40f0e4-4cd2-404e-af18-7b198e5de230","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-types","description":"Returns all device type descriptions (device description JSON). No business partner context required.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an object keyed by device type ID, each containing the device description JSON (configuration fields, data points, roles).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["device-types"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[]}},"response":[{"id":"6e5f5b00-0bf5-47b8-be83-0b5f80c2a06c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-types","description":"Returns all device type descriptions (device description JSON). No business partner context required.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an object keyed by device type ID, each containing the device description JSON (configuration fields, data points, roles)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"s1-08-01\": {\n \"name\": \"S1 Optimizer\",\n \"fields\": [\n \"...\"\n ]\n },\n \"s1-04-01\": {\n \"name\": \"S1 DualTemp\",\n \"fields\": [\n \"...\"\n ]\n }\n }\n}"}],"_postman_id":"ae40f0e4-4cd2-404e-af18-7b198e5de230"},{"name":"Get device type","id":"29dfc6d6-2cea-461d-b156-458930f00f76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-types/:typeId","description":"Returns the device description JSON for a specific device type. No business partner context required.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is the device description JSON for the requested type, containing configuration fields, data point definitions, and roles.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["device-types",":typeId"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"54471232-2485-493f-a393-0af5782769c9","description":{"content":"(required) Device type ID, e.g. s1-08-01.
\n","type":"text/plain"},"type":"any","value":"s1-08-01","key":"typeId"}]}},"response":[{"id":"ed124eb7-9c2a-4792-b6bd-d4e964e9615f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-types/:typeId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["device-types",":typeId"],"variable":[{"id":"54471232-2485-493f-a393-0af5782769c9","key":"typeId","value":"s1-08-01","description":"(required) Device type ID, e.g. `s1-08-01`."}]},"description":"Returns the device description JSON for a specific device type. No business partner context required.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the device description JSON for the requested type, containing configuration fields, data point definitions, and roles."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"name\": \"S1 Optimizer\",\n \"fields\": [\n \"...\"\n ],\n \"dataPoints\": {}\n }\n}"},{"id":"394199cf-4fa7-4e04-93ef-f4e08983036e","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-types/:typeId","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["device-types",":typeId"],"variable":[{"id":"54471232-2485-493f-a393-0af5782769c9","key":"typeId","value":"s1-08-01","description":"(required) Device type ID, e.g. `s1-08-01`."}]},"description":"Returns the device description JSON for a specific device type. No business partner context required.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is the device description JSON for the requested type, containing configuration fields, data point definitions, and roles."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"not_found\",\n \"description\": \"The requested resource was not found.\"\n}"}],"_postman_id":"29dfc6d6-2cea-461d-b156-458930f00f76"}],"id":"540b6252-7922-4b08-993c-332b40e71847","_postman_id":"540b6252-7922-4b08-993c-332b40e71847","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"system-provider (bp=0)","item":[{"name":"gateways","item":[{"name":"{serialNumber}","item":[{"name":"Update firmware","id":"4ae3c2cb-a421-4d7f-94c7-b109343447ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancel\": false,\n \"revision\": -1\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/:serialNumber/update-firmware","description":"Triggers a firmware update for a gateway. Set cancel: true to cancel a pending update. System provider only (bp=0).
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| cancel | \nboolean | \ntrue | \nfalse | \n(optional) Set to true to cancel a pending firmware update. | \n
\n\n| revision | \ninteger | \n42 | \n-1 | \n(optional) Target firmware revision. -1 for latest available. | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["gateways",":serialNumber","update-firmware"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"919710f1-183a-4fb4-bf22-5ab56dc8521a","description":{"content":"(required) Gateway serial number.
\n","type":"text/plain"},"type":"any","value":"G100AABBCCDD","key":"serialNumber"}]}},"response":[{"id":"3add21d6-dcc1-4fab-8f5b-be89a62b3108","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancel\": false,\n \"revision\": -1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/:serialNumber/update-firmware","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["gateways",":serialNumber","update-firmware"],"variable":[{"id":"919710f1-183a-4fb4-bf22-5ab56dc8521a","key":"serialNumber","value":"G100AABBCCDD","description":"(required) Gateway serial number."}]},"description":"Triggers a firmware update for a gateway. Set `cancel: true` to cancel a pending update. **System provider only (bp=0).**\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **cancel** | boolean | `true` | `false` | (optional) Set to `true` to cancel a pending firmware update. |\n| **revision** | integer | `42` | `-1` | (optional) Target firmware revision. `-1` for latest available. |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"4ae3c2cb-a421-4d7f-94c7-b109343447ea"},{"name":"Set fast mode","id":"97871fdd-c6b5-44be-9912-5a8b3b217a9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/:serialNumber/fast-mode","description":"Enables or disables fast mode (shorter reporting interval) for a gateway. System provider only (bp=0).
\nRequest body JSON
\n\n\n\n| Property | \nType | \nExample value | \nDefault | \nDescription | \n
\n\n\n\n| enabled | \nboolean | \nfalse | \ntrue | \n(optional) Set to false to disable fast mode. Default: true (enable). | \n
\n\n
\n
Response JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["gateways",":serialNumber","fast-mode"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"262be96a-4e00-43ab-99e0-11a1d52d70f9","description":{"content":"(required) Gateway serial number.
\n","type":"text/plain"},"type":"any","value":"G100AABBCCDD","key":"serialNumber"}]}},"response":[{"id":"b9e6c1c4-b419-42ff-ac1e-067ec87e28a6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/:serialNumber/fast-mode","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["gateways",":serialNumber","fast-mode"],"variable":[{"id":"262be96a-4e00-43ab-99e0-11a1d52d70f9","key":"serialNumber","value":"G100AABBCCDD","description":"(required) Gateway serial number."}]},"description":"Enables or disables fast mode (shorter reporting interval) for a gateway. **System provider only (bp=0).**\n\n#### Request body JSON\n\n| **Property** | **Type** | **Example value** | **Default** | **Description** |\n| --- | --- | --- | --- | --- |\n| **enabled** | boolean | `false` | `true` | (optional) Set to `false` to disable fast mode. Default: `true` (enable). |\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"97871fdd-c6b5-44be-9912-5a8b3b217a9d"},{"name":"Factory reset","id":"cafed62b-db62-41c6-95c7-50598577ee76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/:serialNumber/factory-reset","description":"Triggers a factory reset for a gateway. System provider only (bp=0).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an empty object {}.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["gateways",":serialNumber","factory-reset"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[{"id":"024f952c-e541-41b6-a3d6-404cccc5534e","description":{"content":"(required) Gateway serial number.
\n","type":"text/plain"},"type":"any","value":"G100AABBCCDD","key":"serialNumber"}]}},"response":[{"id":"ffb5814d-0ca6-43c8-a0d4-78512ecefd66","name":"Success","originalRequest":{"method":"POST","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/:serialNumber/factory-reset","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["gateways",":serialNumber","factory-reset"],"variable":[{"id":"024f952c-e541-41b6-a3d6-404cccc5534e","key":"serialNumber","value":"G100AABBCCDD","description":"(required) Gateway serial number."}]},"description":"Triggers a factory reset for a gateway. **System provider only (bp=0).**\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an empty object `{}`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {}\n}"}],"_postman_id":"cafed62b-db62-41c6-95c7-50598577ee76"}],"id":"324e3e8a-6bf7-45dd-8bbe-6bcdd2fbd6e2","_postman_id":"324e3e8a-6bf7-45dd-8bbe-6bcdd2fbd6e2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get gateways","id":"54d593ec-f98c-4c43-8c97-d400ce8efd38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways?filter=all&limit=50","description":"Returns a list of gateways with filtering. System provider only (bp=0).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.gateways | \narray | \n | \nArray of gateway objects. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
Gateway object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| id | \nUUID | \n\"gw-uuid\" | \nGateway UUID. | \n
\n\n| serialNumber | \nstring | \n\"G100AABBCCDD\" | \nGateway serial number. | \n
\n\n| businessPartnerId | \nUUID | \n\"bp-uuid\" | \nAssigned business partner (empty if unassigned). | \n
\n\n| assigned | \nboolean | \ntrue | \nWhether gateway is assigned to a BP. | \n
\n\n| status | \nstring | \n\"active\" | \n\"inbox\", \"active\", or \"inactive\" (inactive = no packet for >130 min). | \n
\n\n| lastUpdate | \ninteger | \n1700000000 | \nUnix epoch seconds of last proxy update. | \n
\n\n| firmwareRevision | \ninteger | \n12345 | \nCurrent firmware revision number. | \n
\n\n| firmwareVersion | \nstring | \n\"2.3.4\" | \nFirmware version string. | \n
\n\n| systemControllerRevision | \ninteger | \n5678 | \nSystem controller revision. | \n
\n\n| updating | \nboolean | \nfalse | \nWhether firmware update is in progress. | \n
\n\n| updateProgress | \ninteger | \n0 | \nUpdate progress percentage (0-100). | \n
\n\n| blockUpdate | \nboolean | \ntrue | \nWhether updates are blocked. | \n
\n\n| targetRevision | \ninteger | \n0 | \nTarget firmware revision for pending update. | \n
\n\n| fastCycle | \nboolean | \nfalse | \nWhether fast mode is configured. | \n
\n\n| fastCycleActive | \nboolean | \nfalse | \nWhether fast mode is currently active. | \n
\n\n| nextResponseTime | \ninteger | \n0 | \nUnix epoch seconds of expected next response. | \n
\n\n| factoryReset | \nboolean | \nfalse | \nWhether factory reset is pending. | \n
\n\n
\n
\nTip: Use the businessPartnerId from the response to query BP-specific endpoints like devices/health-check. See the workflow section in Get health check for a step-by-step guide.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["gateways"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[{"disabled":true,"description":{"content":"(optional) Search by serial number or name.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"(optional) Comma-separated business partner IDs.
\n","type":"text/plain"},"key":"bp_ids","value":""},{"description":{"content":"(optional) all (default), inbox, active, inactive, updateAvailable.
\n","type":"text/plain"},"key":"filter","value":"all"},{"disabled":true,"description":{"content":"(optional) Numeric offset. Default: 0.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"(optional) Page size (1–1000). Default: 50.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"157415e8-7414-4f9e-b9a8-1f9e79f96762","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways?filter=all&limit=50","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["gateways"],"query":[{"key":"search","value":"","description":"(optional) Search by serial number or name.","disabled":true},{"key":"bp_ids","value":"","description":"(optional) Comma-separated business partner IDs.","disabled":true},{"key":"filter","value":"all","description":"(optional) `all` (default), `inbox`, `active`, `inactive`, `updateAvailable`."},{"key":"offset","value":"0","description":"(optional) Numeric offset. Default: `0`.","disabled":true},{"key":"limit","value":"50","description":"(optional) Page size (1–1000). Default: `50`."}]},"description":"Returns a list of gateways with filtering. **System provider only (bp=0).**\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.gateways** | array | | Array of gateway objects. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |\n\n##### Gateway object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **id** | UUID | `\"gw-uuid\"` | Gateway UUID. |\n| **serialNumber** | string | `\"G100AABBCCDD\"` | Gateway serial number. |\n| **businessPartnerId** | UUID | `\"bp-uuid\"` | Assigned business partner (empty if unassigned). |\n| **assigned** | boolean | `true` | Whether gateway is assigned to a BP. |\n| **status** | string | `\"active\"` | `\"inbox\"`, `\"active\"`, or `\"inactive\"` (inactive = no packet for >130 min). |\n| **lastUpdate** | integer | `1700000000` | Unix epoch seconds of last proxy update. |\n| **firmwareRevision** | integer | `12345` | Current firmware revision number. |\n| **firmwareVersion** | string | `\"2.3.4\"` | Firmware version string. |\n| **systemControllerRevision** | integer | `5678` | System controller revision. |\n| **updating** | boolean | `false` | Whether firmware update is in progress. |\n| **updateProgress** | integer | `0` | Update progress percentage (0-100). |\n| **blockUpdate** | boolean | `true` | Whether updates are blocked. |\n| **targetRevision** | integer | `0` | Target firmware revision for pending update. |\n| **fastCycle** | boolean | `false` | Whether fast mode is configured. |\n| **fastCycleActive** | boolean | `false` | Whether fast mode is currently active. |\n| **nextResponseTime** | integer | `0` | Unix epoch seconds of expected next response. |\n| **factoryReset** | boolean | `false` | Whether factory reset is pending. |\n\n---\n\n**Tip:** Use the `businessPartnerId` from the response to query BP-specific endpoints like `devices/health-check`. See the workflow section in `Get health check` for a step-by-step guide."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"gateways\": [\n {\n \"id\": \"gw-uuid\",\n \"serialNumber\": \"G100AABBCCDD\",\n \"businessPartnerId\": \"bp-uuid\",\n \"assigned\": true,\n \"status\": \"active\",\n \"lastUpdate\": 1700000000,\n \"firmwareRevision\": 12345,\n \"firmwareVersion\": \"2.3.4\",\n \"systemControllerRevision\": 5678,\n \"updating\": false,\n \"updateProgress\": 0,\n \"blockUpdate\": true,\n \"targetRevision\": 0,\n \"fastCycle\": false,\n \"fastCycleActive\": false,\n \"nextResponseTime\": 0,\n \"factoryReset\": false\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"54d593ec-f98c-4c43-8c97-d400ce8efd38"},{"name":"Get available firmwares","id":"4b3aeed0-92ad-4f1c-bbbc-35a331164a6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/available-firmwares","description":"Returns available firmware versions for gateways. System provider only (bp=0).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\nThe result is an array of available firmware revision numbers (integers).
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["gateways","available-firmwares"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[]}},"response":[{"id":"f32eb2e9-ad6d-407b-8148-347206289702","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateways/available-firmwares","description":"Returns available firmware versions for gateways. **System provider only (bp=0).**\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\nThe result is an array of available firmware revision numbers (integers)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n 12345,\n 12346,\n 12400\n ]\n}"}],"_postman_id":"4b3aeed0-92ad-4f1c-bbbc-35a331164a6c"}],"id":"88383b1c-d8cd-46ba-b8be-04e02182150e","_postman_id":"88383b1c-d8cd-46ba-b8be-04e02182150e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get offline devices","id":"d661e16e-cc5f-4fe4-a31d-e6c6ec6a7450","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/offline-devices?lang=en-US&limit=10000","description":"Returns offline Sensaru gateways and sensors. System provider only (bp=0).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.devices | \narray | \n | \nArray of offline device objects (same structure as device object). | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
(optional) Language code.
\n","type":"text/plain"},"key":"lang","value":"en-US"},{"disabled":true,"description":{"content":"(optional) Sort field. Default: id.
\n","type":"text/plain"},"key":"orderBy","value":"id"},{"disabled":true,"description":{"content":"(optional) Sort direction. Default: true.
\n","type":"text/plain"},"key":"ascending","value":"true"},{"disabled":true,"description":{"content":"(optional) Pagination cursor.
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"(optional) Page size (1–10000). Default: 100.
\n","type":"text/plain"},"key":"limit","value":"10000"}],"variable":[]}},"response":[{"id":"4022173c-71db-4fd4-931f-090679a2c4a0","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/offline-devices?lang=en-US&limit=10000","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["offline-devices"],"query":[{"key":"lang","value":"en-US","description":"(optional) Language code."},{"key":"orderBy","value":"id","description":"(optional) Sort field. Default: `id`.","disabled":true},{"key":"ascending","value":"true","description":"(optional) Sort direction. Default: `true`.","disabled":true},{"key":"offset","value":"","description":"(optional) Pagination cursor.","disabled":true},{"key":"limit","value":"10000","description":"(optional) Page size (1–10000). Default: `100`."}]},"description":"Returns offline Sensaru gateways and sensors. **System provider only (bp=0).**\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.devices** | array | | Array of offline device objects (same structure as device object). |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"devices\": [\n {\n \"id\": \"dev-uuid\",\n \"serialNumber\": \"G100AABB\",\n \"type\": \"G1\",\n \"status\": \"offline\",\n \"lastPacket\": 1699000000\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"d661e16e-cc5f-4fe4-a31d-e6c6ec6a7450"},{"name":"Get gateway statistics","id":"979edeb3-fa07-453f-9c8f-53f51746079e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/gateway-statistics","description":"Returns gateway statistics. System provider only (bp=0). (Stub — not yet implemented.)
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n(Stub endpoint — not yet implemented.)
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["gateway-statistics"],"host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"query":[],"variable":[]}},"response":[],"_postman_id":"979edeb3-fa07-453f-9c8f-53f51746079e"},{"name":"Get device inbox","id":"6a16b454-12b7-4c28-a1d6-14bbcf26ac19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-inbox?limit=50","description":"Returns device inbox entries (unassigned devices). System provider only (bp=0).
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.devices | \narray | \n | \nArray of unassigned device entries with id and serialNumber. | \n
\n\n| result.responseMetadata | \nobject | \n | \nPagination metadata. | \n
\n\n| result.responseMetadata.nextKey | \nstring | \n\"cursor-value\" | \nPass to offset query parameter for next page. Empty string when no more data. | \n
\n\n
\n
(optional) Full-text search.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"(optional) Numeric offset. Default: 0.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"(optional) Page size (1–1000). Default: 50.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"496fa60b-6178-4075-a2c1-29c6bb095605","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/device-inbox?limit=50","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["device-inbox"],"query":[{"key":"search","value":"","description":"(optional) Full-text search.","disabled":true},{"key":"offset","value":"0","description":"(optional) Numeric offset. Default: `0`.","disabled":true},{"key":"limit","value":"50","description":"(optional) Page size (1–1000). Default: `50`."}]},"description":"Returns device inbox entries (unassigned devices). **System provider only (bp=0).**\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.devices** | array | | Array of unassigned device entries with `id` and `serialNumber`. |\n| **result.responseMetadata** | object | | Pagination metadata. |\n| **result.responseMetadata.nextKey** | string | `\"cursor-value\"` | Pass to `offset` query parameter for next page. Empty string when no more data. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"devices\": [\n {\n \"id\": \"dev-uuid\",\n \"serialNumber\": \"G1FF789012\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"\"\n }\n }\n}"}],"_postman_id":"6a16b454-12b7-4c28-a1d6-14bbcf26ac19"}],"id":"2751fe88-d2fa-469b-9a13-95aa708ffd08","_postman_id":"2751fe88-d2fa-469b-9a13-95aa708ffd08","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get optimizer status","id":"862a3c14-7de2-4ba2-a65a-7a28d066b5d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/optimizer-status","description":"Returns optimizer status overview for the business partner.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.locationId | \nstring | \n\"1:WE-01\" | \n(single location mode) Location ID. | \n
\n\n| result.ready | \nboolean | \ntrue | \nWhether optimizers are fully configured and operational. | \n
\n\n| result.optimizerDevices | \nobject | \n | \nOptimizer device status: found, count, allConfigured, unconfiguredDevices. | \n
\n\n| result.propertyData | \nobject | \n | \nProperty data completeness: complete, incompleteProperties. | \n
\n\n| result.consumptionSettings | \narray | \n | \nPYC settings per heating system config. | \n
\n\n
\n
(optional) Filter by location ID (asset ID or UUID).
\n","type":"text/plain"},"key":"locationId","value":""}],"variable":[]}},"response":[{"id":"36a4d53e-cd64-4ab5-b0a9-7a8d7ffa03de","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/optimizer-status","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["optimizer-status"],"query":[{"key":"locationId","value":"","description":"(optional) Filter by location ID (asset ID or UUID).","disabled":true}]},"description":"Returns optimizer status overview for the business partner.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.locationId** | string | `\"1:WE-01\"` | (single location mode) Location ID. |\n| **result.ready** | boolean | `true` | Whether optimizers are fully configured and operational. |\n| **result.optimizerDevices** | object | | Optimizer device status: `found`, `count`, `allConfigured`, `unconfiguredDevices`. |\n| **result.propertyData** | object | | Property data completeness: `complete`, `incompleteProperties`. |\n| **result.consumptionSettings** | array | | PYC settings per heating system config. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"locationId\": \"1:WE-01\",\n \"ready\": true,\n \"optimizerDevices\": {\n \"found\": true,\n \"count\": 1,\n \"allConfigured\": true,\n \"unconfiguredDevices\": []\n },\n \"propertyData\": {\n \"complete\": true,\n \"incompleteProperties\": []\n },\n \"consumptionSettings\": [\n {\n \"assetId\": \"asset-uuid\",\n \"previousYearConsumption\": 15000,\n \"set\": true\n }\n ]\n }\n}"}],"_postman_id":"862a3c14-7de2-4ba2-a65a-7a28d066b5d8"},{"name":"Get reception status","id":"0538f231-181f-405b-aef5-3455d33fde91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.
\n","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-device-management/reception-status","description":"Returns reception/signal quality status for devices.
\nResponse JSON
\nSuccess response
\nCode: 200
\nAll successful responses are wrapped in:
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \ntrue | \nAlways true for the success response. | \n
\n\n| result | \nobject | \n | \nThe endpoint-specific result object. See below. | \n
\n\n
\n
Error response
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| success | \nboolean | \nfalse | \nAlways false for the error response. | \n
\n\n| error | \nstring | \n\"request_error\" | \nMachine-readable error code. | \n
\n\n| description | \nstring | \n\"No business partner specified.\" | \nHuman-readable error description. | \n
\n\n
\n
result object
\n\n\n\n| Property | \nType | \nExample value | \nDescription | \n
\n\n\n\n| result.totalDevices | \ninteger | \n180 | \nTotal devices checked. | \n
\n\n| result.issueCount | \ninteger | \n8 | \nTotal devices with reception issues. | \n
\n\n| result.sensors | \nobject | \n | \nSensor signal issues: total, issues array. | \n
\n\n| result.gateways | \nobject | \n | \nGateway connectivity issues: total, issues array with rsrp, rsrq, coverageEnhancementAverage. | \n
\n\n
\n
(optional) Hierarchical location ID.
\n","type":"text/plain"},"key":"locationId","value":""}],"variable":[]}},"response":[{"id":"90b7b030-f132-432d-9a41-f5a37ff7b604","name":"Success","originalRequest":{"method":"GET","header":[{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","description":"Only required when logged in as a system provider or system distributor. Sets the business partner context.","type":"text"}],"url":{"raw":"https://core.sensaru.net/api/v1/modules/c1-device-management/reception-status","host":["https://core.sensaru.net/api/v1/modules/c1-device-management"],"path":["reception-status"],"query":[{"key":"locationId","value":"","description":"(optional) Hierarchical location ID.","disabled":true}]},"description":"Returns reception/signal quality status for devices.\n\n#### Response JSON\n\n##### Success response\n\n**Code:** 200\n\nAll successful responses are wrapped in:\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `true` | Always `true` for the success response. |\n| **result** | object | | The endpoint-specific result object. See below. |\n\n##### Error response\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **success** | boolean | `false` | Always `false` for the error response. |\n| **error** | string | `\"request_error\"` | Machine-readable error code. |\n| **description** | string | `\"No business partner specified.\"` | Human-readable error description. |\n\n##### result object\n\n| **Property** | **Type** | **Example value** | **Description** |\n| --- | --- | --- | --- |\n| **result.totalDevices** | integer | `180` | Total devices checked. |\n| **result.issueCount** | integer | `8` | Total devices with reception issues. |\n| **result.sensors** | object | | Sensor signal issues: `total`, `issues` array. |\n| **result.gateways** | object | | Gateway connectivity issues: `total`, `issues` array with `rsrp`, `rsrq`, `coverageEnhancementAverage`. |"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"totalDevices\": 180,\n \"issueCount\": 2,\n \"sensors\": {\n \"total\": 150,\n \"issues\": [\n {\n \"deviceId\": \"dev-uuid\",\n \"serialNumber\": \"S104AABB\",\n \"rssi\": -92,\n \"problems\": [\n \"lowRssi\"\n ]\n }\n ]\n },\n \"gateways\": {\n \"total\": 30,\n \"issues\": []\n }\n }\n}"}],"_postman_id":"0538f231-181f-405b-aef5-3455d33fde91"}],"id":"80f6394d-1a0b-4f49-8f7e-8184407321cf","_postman_id":"80f6394d-1a0b-4f49-8f7e-8184407321cf","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"c1-reporting","item":[{"name":"esg/meters","item":[{"name":"{meterId}","item":[{"name":"data-points","item":[{"name":"{dataPointId}","item":[{"name":"Get data point","id":"18e215df-1a67-4615-9c3e-975693b8dd05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-reporting/esg/meters/:meterId/data-points/:dataPointId","description":"Returns information about a single data point of a meter.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["esg","meters",":meterId","data-points",":dataPointId"],"host":["https://core.sensaru.net/api/v1/modules/c1-reporting"],"query":[],"variable":[{"id":"a1f25dd8-5941-4998-9248-a2038ff65feb","description":{"content":"(Required) The ID of the meter as returned by /esg/meters.
\n","type":"text/plain"},"type":"any","value":"fe8367c6-0923-4a2e-8cba-ceab583b089a","key":"meterId"},{"id":"83fea163-bbf1-4a88-bc0e-39b33a0723a6","description":{"content":"(Required) The ID of the data point as returned by /esg/meters/{meterId}/data-points. Currently can be meter-reading or consumption.
\n","type":"text/plain"},"type":"any","value":"meter-reading","key":"dataPointId"}]}},"response":[{"id":"8dde77a2-0008-4427-96bb-92e27668c9c3","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/esg/meters/:meterId/data-points/:dataPointId","host":["{{baseUrl}}"],"path":["esg","meters",":meterId","data-points",":dataPointId"],"variable":[{"key":"meterId","value":"tempor adipisicing","description":"(Required) The ID of the meter as returned by `/esg/meters`."},{"key":"dataPointId","value":"-2048178","description":"(Required) The ID of the data point as returned by `/esg/meters/{meterId}/data-points`. Currently can be `meter-reading` or `consumption`."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"meter-reading\",\n \"value\": 5917030.738307178,\n \"updatedAt\": 1631388075,\n \"unit\": \"l\"\n}"}],"_postman_id":"18e215df-1a67-4615-9c3e-975693b8dd05"},{"name":"Get log","id":"93faab53-c8ff-4638-9531-d996599c4a2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-reporting/esg/meters/:meterId/data-points/:dataPointId/log","description":"Returns the logged data for the specified data point within the specified date range. Data can be returned aggregated.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["esg","meters",":meterId","data-points",":dataPointId","log"],"host":["https://core.sensaru.net/api/v1/modules/c1-reporting"],"query":[{"disabled":true,"description":{"content":"Returns data for the specified 4-digit year range (e. g. 2020-2025, inclusive) or 4-digit year (e. g. 2025). Cannot be used together with dateFrom and dateTo.
\n","type":"text/plain"},"key":"years","value":"2023"},{"disabled":true,"description":{"content":"Returns data for the specified month (1 to 12) or months (e. g. 10-12, inclusive). Requires years to be set to a single year. Cannot be used together with dateFrom and dateTo.
\n","type":"text/plain"},"key":"months","value":"1"},{"disabled":true,"description":{"content":"Returns data for the specified day (1 to 31) or days (e. g. 12-21, inclusive). Requires years and months to be single values. Cannot be used together with dateFrom and dateTo.
\n","type":"text/plain"},"key":"days","value":"12"},{"disabled":true,"description":{"content":"Returns data for the specified hour of the day (0 to 23) or hours (e. g. 6-18, inclusive). Requires years, months and days to be set to be single values. Cannot be used together with dateFrom and dateTo.
\n","type":"text/plain"},"key":"hours","value":"13"},{"disabled":true,"description":{"content":"Start date as a Unix timestamp (in seconds, local time). Cannot be used together with years, months, days or hours. For example September 10, 2022 11 pm has the timestamp 1662850800. This is regardless of the time zone. So 11 pm with GMT+2 or GMT+10 both have the same value.
\n","type":"text/plain"},"key":"dateFrom","value":"1662850800"},{"disabled":true,"description":{"content":"End date as a Unix timestamp (in seconds, local time). Cannot be used together with years, months, days or hours.
\n","type":"text/plain"},"key":"dateTo","value":"1662850800"},{"disabled":true,"description":{"content":"Possible values:
\n\nnone15mhourdayall
\nAggregate the data. none returns the data in the highest resolution stored. all aggregates all values in the time frame, i. e. only one value is returned.
\n","type":"text/plain"},"key":"aggregate","value":"hour"},{"disabled":true,"description":{"content":"Specify nextKey from the last result to get the next page.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"The number of log entries to return. The maximum value is 1000. Defaults to 100.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[{"id":"e19c9964-16f8-4b42-8e82-50e4b29d2e20","description":{"content":"(Required) Meter ID
\n","type":"text/plain"},"type":"any","value":"fe8367c6-0923-4a2e-8cba-ceab583b089a","key":"meterId"},{"id":"a0b0737b-95e0-45cb-808a-5c8696fa0c81","description":{"content":"(Required) The ID of the data point as returned by /esg/meters/{meterId}/data-points.
\n","type":"text/plain"},"type":"any","value":"consumption","key":"dataPointId"}]}},"response":[{"id":"20a3dfd8-cf9f-4322-a3a5-68160127a016","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/esg/meters/:meterId/data-points/:dataPointId/log?years=-2048178&months=-2048178&days=-2048178&hours=-2048178&dateFrom=-2048178&dateTo=-2048178&aggregate=hour&offset=-2048178&limit=-2048178","host":["{{baseUrl}}"],"path":["esg","meters",":meterId","data-points",":dataPointId","log"],"query":[{"key":"years","value":"-2048178"},{"key":"months","value":"-2048178"},{"key":"days","value":"-2048178"},{"key":"hours","value":"-2048178"},{"key":"dateFrom","value":"-2048178"},{"key":"dateTo","value":"-2048178"},{"key":"aggregate","value":"hour"},{"key":"offset","value":"-2048178"},{"key":"limit","value":"-2048178"}],"variable":[{"key":"meterId","value":"tempor adipisicing","description":"(Required) Meter ID"},{"key":"dataPointId","value":"tempor adipisicing","description":"(Required) The ID of the data point as returned by `/esg/meters/{meterId}/data-points`."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"log\": [\n [\n 1631389792,\n 74828\n ],\n [\n 1631389792,\n 74828\n ]\n ],\n \"responseMetadata\": {\n \"nextKey\": \"mollit exercitation occaecat in E\"\n }\n}"}],"_postman_id":"93faab53-c8ff-4638-9531-d996599c4a2c"}],"id":"461ea4b0-96c8-465f-a65a-a64d46499cca","_postman_id":"461ea4b0-96c8-465f-a65a-a64d46499cca","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get data points","id":"b70143b2-d603-44eb-ba2f-3da389f51d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-reporting/esg/meters/:meterId/data-points","description":"Returns a list of all data points of a meter. Every meter currently has two data points: meter-reading and consumption.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["esg","meters",":meterId","data-points"],"host":["https://core.sensaru.net/api/v1/modules/c1-reporting"],"query":[],"variable":[{"id":"83bc6086-2b31-4d93-8cf5-4acd46b08da9","description":{"content":"(Required) The ID of the meter as returned by /esg/meters.
\n","type":"text/plain"},"type":"any","value":"fe8367c6-0923-4a2e-8cba-ceab583b089a","key":"meterId"}]}},"response":[{"id":"3cf99dc1-c3ce-46d1-b61f-0162fc736a26","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/esg/meters/:meterId/data-points","host":["{{baseUrl}}"],"path":["esg","meters",":meterId","data-points"],"variable":[{"key":"meterId","value":"tempor adipisicing","description":"(Required) The ID of the meter as returned by `/esg/meters`."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"meter-reading\",\n \"value\": -61456852.81375943,\n \"updatedAt\": 1631388075,\n \"unit\": \"l\"\n },\n {\n \"id\": \"meter-reading\",\n \"value\": 39697991.07832408,\n \"updatedAt\": 1631388075,\n \"unit\": \"l\"\n }\n]"}],"_postman_id":"b70143b2-d603-44eb-ba2f-3da389f51d40"}],"id":"b7beedb5-010f-45a5-83ec-f639ea8223a6","_postman_id":"b7beedb5-010f-45a5-83ec-f639ea8223a6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get meter","id":"f63ab401-7008-40d5-a5f5-b39e7a5aa44b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-reporting/esg/meters/:meterId?lang=en","description":"Returns information about a single meter.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["esg","meters",":meterId"],"host":["https://core.sensaru.net/api/v1/modules/c1-reporting"],"query":[{"description":{"content":"The language to return localized strings for. The language code can be either only the ISO 639 language code or the ISO 639 language code and the ISO 3166 country code separated by a dash (-). The language defaults do en.
\n","type":"text/plain"},"key":"lang","value":"en"}],"variable":[{"id":"21e47967-f145-4480-98fc-161110dfcf2b","description":{"content":"(Required) The ID of the meter as returned by /esg/meters.
\n","type":"text/plain"},"type":"any","value":"fe8367c6-0923-4a2e-8cba-ceab583b089a","key":"meterId"}]}},"response":[{"id":"d274b674-9037-4e77-916c-ae65b2cbd1b1","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/esg/meters/:meterId?lang=en","host":["{{baseUrl}}"],"path":["esg","meters",":meterId"],"query":[{"key":"lang","value":"en"}],"variable":[{"key":"meterId","value":"tempor adipisicing","description":"(Required) The ID of the meter as returned by `/esg/meters`."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"Homegear HG-16A-EO\",\n \"serialNumber\": \"EOD0412EBCB\",\n \"locationId\": \"1000.105.8\",\n \"role\": \"gas-meter\",\n \"name\": \"Heating living room\",\n \"parent\": \"21:15211.2_23\",\n \"parentDirection\": 1,\n \"description\": \"1-channel switching actuator.\",\n \"longDescription\": \"The Homegear HG-16A-EO is a wireless 1-channel 230V/16A switching actuator. EnOcean is used as communication protocol. It features:\\n- bidirectional communication with resends\\n- encryption\\n- remote management\\n- meshing\\n- local control when the gateway is not available\",\n \"tags\": [\n \"ut pariatur fugiat dolore\",\n \"elit ullamco dolore\"\n ]\n}"}],"_postman_id":"f63ab401-7008-40d5-a5f5-b39e7a5aa44b"}],"id":"68c25b91-7c5b-4e64-9b0b-3b80ceb825d8","_postman_id":"68c25b91-7c5b-4e64-9b0b-3b80ceb825d8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get meters","id":"cc36722f-b28c-441f-a2fe-c88f1084d5e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-reporting/esg/meters?locationId=21:03150&locationIdFilterType=exact","description":"Get all or a list of filtered meters. The list can be filtered by location, role or tag. With more information we can add more filters to this list.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["esg","meters"],"host":["https://core.sensaru.net/api/v1/modules/c1-reporting"],"query":[{"description":{"content":"Filters by location, i. e. where the meter is located. This is the economic unit ID, property ID and administration unit ID separated by dots.
\nFor example
\n\n- Economic unit ID:
1000 \n- Property ID:
105 \n- Administration unit ID:
8 \n
\nbecomes 1000.105.8.
\nWhen the meter is associated with the property and not an administration unit, the administration unit part including the dot is omitted: 1000.105.
\nWhen the meter is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: 1000.
\n","type":"text/plain"},"key":"locationId","value":"21:03150"},{"description":{"content":"Specifies how the location ID filter is applied. Valid options are:
\n\nexact (default): Only devices that have the exact location ID are returned.parent: All devices that have a location ID that begins with the specified one are returned. Like this for example all devices of the building (property) or apartment (administration unit ID) are returned when the filter is set to the economic unit ID.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"exact"},{"disabled":true,"description":{"content":"Filters meters by their role.
\n","type":"text/plain"},"key":"role","value":"water-meter"},{"disabled":true,"description":{"content":"Filters meters by tag. Tag examples are heat-pump or elevator. One or more tags (seperated by comma) can be provided. Tags are used to further specify what a meter is used for. A tag is just a string defined on the home client. So a tag can be arbitralily chosen. For automatisms it makes sense to stick to a predefined list though. Predifined tag values are (this list can be extended):
\n\n- building
\n- apartment
\n- warm-water
\n- cold-water
\n- elevator
\n- heat-pump
\n- photo-voltaic
\n
\n","type":"text/plain"},"key":"tags","value":"heat-pump,building"},{"disabled":true,"description":{"content":"Specify nextKey from the last result to get the next page.
\n","type":"text/plain"},"key":"offset","value":"-2048178"},{"disabled":true,"description":{"content":"The number of meters to return. The maximum value is 1000. Defaults to 100.
\n","type":"text/plain"},"key":"limit","value":"-2048178"},{"disabled":true,"description":{"content":"The language to return localized strings for. The language code can be either only the ISO 639 language code or the ISO 639 language code and the ISO 3166 country code separated by a dash (-). The language defaults do en.
\n","type":"text/plain"},"key":"lang","value":"en"}],"variable":[]}},"response":[{"id":"580c9086-0688-4230-b536-88aa972c9ce5","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/esg/meters?locationId=pariatur quis occaecat qui enim&role=water-meter&tags=heat-pump,building&offset=-2048178&limit=-2048178&lang=en","host":["{{baseUrl}}"],"path":["esg","meters"],"query":[{"key":"locationId","value":"pariatur quis occaecat qui enim"},{"key":"role","value":"water-meter"},{"key":"tags","value":"heat-pump,building"},{"key":"offset","value":"-2048178"},{"key":"limit","value":"-2048178"},{"key":"lang","value":"en"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meters\": [\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"Homegear HG-16A-EO\",\n \"serialNumber\": \"EOD0412EBCB\",\n \"locationId\": \"1000.105.8\",\n \"role\": \"power-meter\",\n \"name\": \"Heating living room\",\n \"parent\": \"21:15211.2_23\",\n \"parentDirection\": 1,\n \"description\": \"1-channel switching actuator.\",\n \"longDescription\": \"The Homegear HG-16A-EO is a wireless 1-channel 230V/16A switching actuator. EnOcean is used as communication protocol. It features:\\n- bidirectional communication with resends\\n- encryption\\n- remote management\\n- meshing\\n- local control when the gateway is not available\",\n \"tags\": [\n \"sit laboris laborum pariatur\",\n \"veniam ad do dolore Lorem\"\n ]\n },\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"type\": \"Homegear HG-16A-EO\",\n \"serialNumber\": \"EOD0412EBCB\",\n \"locationId\": \"1000.105.8\",\n \"role\": \"water-meter\",\n \"name\": \"Heating living room\",\n \"parent\": \"21:15211.2_23\",\n \"parentDirection\": 1,\n \"description\": \"1-channel switching actuator.\",\n \"longDescription\": \"The Homegear HG-16A-EO is a wireless 1-channel 230V/16A switching actuator. EnOcean is used as communication protocol. It features:\\n- bidirectional communication with resends\\n- encryption\\n- remote management\\n- meshing\\n- local control when the gateway is not available\",\n \"tags\": [\n \"aliqua non\",\n \"veniam in deserunt Lorem Excepteur\"\n ]\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"ad ipsum proident\"\n }\n}"},{"id":"9ce0e6b0-6475-44a1-a1d4-369464959278","name":"Invalid filter.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/esg/meters?locationId=pariatur quis occaecat qui enim&role=water-meter&tags=heat-pump,building&offset=-2048178&limit=-2048178&lang=en","host":["{{baseUrl}}"],"path":["esg","meters"],"query":[{"key":"locationId","value":"pariatur quis occaecat qui enim"},{"key":"role","value":"water-meter"},{"key":"tags","value":"heat-pump,building"},{"key":"offset","value":"-2048178"},{"key":"limit","value":"-2048178"},{"key":"lang","value":"en"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cc36722f-b28c-441f-a2fe-c88f1084d5e5"}],"id":"4390affb-220b-4f99-a9e4-c31e74b4b3f2","_postman_id":"4390affb-220b-4f99-a9e4-c31e74b4b3f2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}}],"id":"98224faa-d669-43ca-a457-acdc1f091b26","_postman_id":"98224faa-d669-43ca-a457-acdc1f091b26","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"c1-service-messages","item":[{"name":"service-messages","item":[{"name":"report","item":[{"name":"Get alarm report","id":"7cd03893-51e1-40a2-8de3-cd1eb3281e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/service-messages/report?locationId=60:01082&dateFrom=1682892000&dateTo=1685570400","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["service-messages","report"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[{"description":{"content":"Filters by location, i. e. where the device is located. For devices associated with real estate properties this is the economic unit ID, property ID and administration unit ID separated by dots.\nFor example
\n\n- Economic unit ID:
1000 \n- Property ID:
105 \n- Administration unit ID:
8\nbecomes 1000.105.8.\nWhen the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: 1000.105.\nWhen the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: 1000. \n
\n","type":"text/plain"},"key":"locationId","value":"60:01082"},{"description":{"content":"Start date as a Unix timestamp (in seconds, UTC).
\n","type":"text/plain"},"key":"dateFrom","value":"1682892000"},{"description":{"content":"End date as a Unix timestamp (in seconds, UTC).
\n","type":"text/plain"},"key":"dateTo","value":"1685570400"}],"variable":[]}},"response":[],"_postman_id":"7cd03893-51e1-40a2-8de3-cd1eb3281e8d"}],"id":"0269d4ef-8d2c-47ea-b0f8-52641dd8060b","_postman_id":"0269d4ef-8d2c-47ea-b0f8-52641dd8060b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get service messages","id":"ac7b9791-c3b0-4c91-b996-a5f9b5779883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/service-messages","description":"Returns all active device service messages. The service messages can be filtered.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["service-messages"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[{"disabled":true,"key":"dateFrom","value":"61510809"},{"disabled":true,"key":"dateTo","value":"61510809"},{"disabled":true,"key":"locationId","value":"tempor"},{"disabled":true,"key":"filter","value":"critical"},{"disabled":true,"key":"offset","value":"61510809"},{"disabled":true,"key":"limit","value":"61510809"}],"variable":[]}},"response":[{"id":"dc7374cb-17fd-4184-ba47-55bbed899976","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/service-messages?dateFrom=61510809&dateTo=61510809&locationId=tempor&filter=critical&offset=61510809&limit=61510809","host":["{{baseUrl}}"],"path":["service-messages"],"query":[{"key":"dateFrom","value":"61510809"},{"key":"dateTo","value":"61510809"},{"key":"locationId","value":"tempor"},{"key":"filter","value":"critical"},{"key":"offset","value":"61510809"},{"key":"limit","value":"61510809"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceMessages\": [\n {\n \"id\": \"bcf13894-9e1a-0506-b994-7e434693bd4d\",\n \"createdAt\": 1631388075,\n \"locationId\": \"1000.105.8\",\n \"priority\": \"warning\",\n \"message\": \"The device is offline.\",\n \"header\": \"Water meter\",\n \"footer\": \"Demo city, demo street 23\",\n \"url\": \"https://device-management.sensaru.cloud/service-message/e05fd897-ef91-0f20-be49-058ca498ba04\"\n },\n {\n \"id\": \"bcf13894-9e1a-0506-b994-7e434693bd4d\",\n \"createdAt\": 1631388075,\n \"locationId\": \"1000.105.8\",\n \"priority\": \"warning\",\n \"message\": \"The device is offline.\",\n \"header\": \"Water meter\",\n \"footer\": \"Demo city, demo street 23\",\n \"url\": \"https://device-management.sensaru.cloud/service-message/e05fd897-ef91-0f20-be49-058ca498ba04\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"sint labore laboris deserunt in\"\n }\n}"}],"_postman_id":"ac7b9791-c3b0-4c91-b996-a5f9b5779883"}],"id":"5d0a547c-3459-48d2-bfb2-19fb09dd78a5","_postman_id":"5d0a547c-3459-48d2-bfb2-19fb09dd78a5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"devices","item":[{"name":"{typeId}","item":[{"name":"Get alarm rule templates","id":"60e562a8-5516-4c07-9d97-96d25642e217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/devices/:typeId/alarm-rule-templates","description":"Returns all active device service messages. The service messages can be filtered.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["devices",":typeId","alarm-rule-templates"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[],"variable":[{"id":"ec5dc386-36b3-417f-9bdd-8b47fc9a1eb2","type":"any","value":"s1-02-01","key":"typeId"}]}},"response":[{"id":"487bafac-38fc-449f-98e7-9c6b4529ba29","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/service-messages?dateFrom=61510809&dateTo=61510809&locationId=tempor&filter=critical&offset=61510809&limit=61510809","host":["{{baseUrl}}"],"path":["service-messages"],"query":[{"key":"dateFrom","value":"61510809"},{"key":"dateTo","value":"61510809"},{"key":"locationId","value":"tempor"},{"key":"filter","value":"critical"},{"key":"offset","value":"61510809"},{"key":"limit","value":"61510809"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceMessages\": [\n {\n \"id\": \"bcf13894-9e1a-0506-b994-7e434693bd4d\",\n \"createdAt\": 1631388075,\n \"locationId\": \"1000.105.8\",\n \"priority\": \"warning\",\n \"message\": \"The device is offline.\",\n \"header\": \"Water meter\",\n \"footer\": \"Demo city, demo street 23\",\n \"url\": \"https://device-management.sensaru.cloud/service-message/e05fd897-ef91-0f20-be49-058ca498ba04\"\n },\n {\n \"id\": \"bcf13894-9e1a-0506-b994-7e434693bd4d\",\n \"createdAt\": 1631388075,\n \"locationId\": \"1000.105.8\",\n \"priority\": \"warning\",\n \"message\": \"The device is offline.\",\n \"header\": \"Water meter\",\n \"footer\": \"Demo city, demo street 23\",\n \"url\": \"https://device-management.sensaru.cloud/service-message/e05fd897-ef91-0f20-be49-058ca498ba04\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"sint labore laboris deserunt in\"\n }\n}"}],"_postman_id":"60e562a8-5516-4c07-9d97-96d25642e217"}],"id":"4ea13df6-bdf9-446e-9c33-dd25f56c31af","_postman_id":"4ea13df6-bdf9-446e-9c33-dd25f56c31af","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}}],"id":"36cde1ce-8643-4c05-a074-a699ec555e0c","_postman_id":"36cde1ce-8643-4c05-a074-a699ec555e0c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"alarm-definitions","item":[{"name":"{alarmDefinitionId}","item":[{"name":"Delete alarm definition","id":"3c85c561-d4a4-42fe-ad7b-98a1371dab44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"PRIVATE-TOKEN","value":"","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/admin/alarm-definitions/:alarmDefinitionId","description":"Creates a device within Sensaru Cloud. You can only (pre-)create actual devices. This does not work for edge clients or communication modules.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["admin","alarm-definitions",":alarmDefinitionId"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[],"variable":[{"id":"fe405692-2018-4d00-877e-c6783811364d","type":"any","value":"a4241de8-ada1-459f-9f6d-974e9e2c1acc","key":"alarmDefinitionId"}]}},"response":[{"id":"144b02a0-44de-4359-b6b9-0230169a2ce4","name":"Returns success when the device was successfully created.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"id\",\n \"homeClient\": \"occaecat\",\n \"name\": \"ut\",\n \"operationMode\": -38921153,\n \"notes\": \"mollit eiusmod\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/devices"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a8b898db-0572-4898-87eb-b42ae08a4323","name":"Returns one of the Sensaru Cloud REST error codes on error.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"id\",\n \"homeClient\": \"occaecat\",\n \"name\": \"ut\",\n \"operationMode\": -38921153,\n \"notes\": \"mollit eiusmod\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/devices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3c85c561-d4a4-42fe-ad7b-98a1371dab44"},{"name":"Update alarm definition","id":"6aaf1d10-e8fb-43b9-b720-d2ecea336735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"PRIVATE-TOKEN","value":"","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"locationId\": \"1:545\",\r\n \"deviceId\": \"07967581-dcdb-47f0-8384-c3c7d056c544\",\r\n \"alarmDefinitionTemplateId\": \"heating-check\",\r\n \"values\": [0.9],\r\n \"priority\": 3\r\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/admin/alarm-definitions/:alarmDefinitionId","description":"Creates a device within Sensaru Cloud. You can only (pre-)create actual devices. This does not work for edge clients or communication modules.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["admin","alarm-definitions",":alarmDefinitionId"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[],"variable":[{"id":"b2ecef2f-8c55-43f4-b59b-f01b07a4f555","type":"any","value":"a4241de8-ada1-459f-9f6d-974e9e2c1acc","key":"alarmDefinitionId"}]}},"response":[{"id":"64519355-d70f-4ebf-be14-1006d3b44d10","name":"Returns success when the device was successfully created.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"id\",\n \"homeClient\": \"occaecat\",\n \"name\": \"ut\",\n \"operationMode\": -38921153,\n \"notes\": \"mollit eiusmod\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/devices"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"f376f0f8-2d9a-4268-864d-fcb44f336b2b","name":"Returns one of the Sensaru Cloud REST error codes on error.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"id\",\n \"homeClient\": \"occaecat\",\n \"name\": \"ut\",\n \"operationMode\": -38921153,\n \"notes\": \"mollit eiusmod\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/devices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6aaf1d10-e8fb-43b9-b720-d2ecea336735"}],"id":"b4a9be71-be54-4279-a100-cf79c77c3c88","_postman_id":"b4a9be71-be54-4279-a100-cf79c77c3c88","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}},{"name":"Get alarm definitions","id":"a8848352-1798-4272-85f9-c5dc21efd645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"PRIVATE-TOKEN","value":"","description":"API key for authentication.
\n"},{"key":"C1-BUSINESS-PARTNER","value":""}],"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/alarm-definitions","description":"Get all or a list of filtered devices. The list can be filtered by location, role or service message level.
\nWhen an ERP system is used and connected to Sensaru Cloud, these IDs are the same as defined there.\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["alarm-definitions"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[{"disabled":true,"description":{"content":"Filters by location, i. e. where the device is located. For devices associated with real estate properties this is the economic unit ID, property ID and administration unit ID separated by dots.
\nFor example
\n\n- Economic unit ID:
1000 \n- Property ID:
105 \n- Administration unit ID:
8 \n
\nbecomes 1000.105.8.
\nWhen the device is associated with the property and not an administration unit, the administration unit part including the dot is omitted: 1000.105.
\nWhen the device is associated with the economic unit and neither a property nor an administration unit, omit both parts including the dot: 1000.
\n","type":"text/plain"},"key":"locationId","value":"70:18960"},{"disabled":true,"description":{"content":"Specifies how the location ID filter is applied. Valid options are:
\n\nexact (default): Only devices that have the exact location ID are returned.parent: All devices that have a location ID that begins with the specified one are returned. Like this for example all devices of the building (property) or apartment (administration unit ID) are returned when the filter is set to the economic unit ID.
\n","type":"text/plain"},"key":"locationIdFilterType","value":"parent"}],"variable":[]}},"response":[{"id":"637ea1f3-ebe3-43ad-b72b-64ad03685c7d","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/devices?locationId=aliquip&locationIdFilterType=exact&roles=90.01.00&filter=critical&offset=98378940&limit=98378940&lang=en-US&orderBy=locationId&groupBy=locationId","host":["{{baseUrl}}"],"path":["devices"],"query":[{"key":"locationId","value":"aliquip"},{"key":"locationIdFilterType","value":"exact"},{"key":"roles","value":"90.01.00"},{"key":"filter","value":"critical"},{"key":"offset","value":"98378940"},{"key":"limit","value":"98378940"},{"key":"lang","value":"en-US"},{"key":"orderBy","value":"locationId"},{"key":"groupBy","value":"locationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"devices\": [\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"nativeId\": 107,\n \"type\": \"Homegear HG-16A-EO\",\n \"serialNumber\": \"EOD0412EBCB\",\n \"softwareVersion\": \"esse culpa eiusmod\",\n \"interface\": \"ENO14260490011\",\n \"locationId\": \"60:1000.105.8\",\n \"status\": \"critical\",\n \"operationMode\": 1,\n \"name\": \"Heating living room\",\n \"notes\": \"Next to the electic cabinet\",\n \"equipmentId\": \"AMW44_01_00_91_BWM01\",\n \"parent\": \"21:15211.2_23\",\n \"parentDirection\": 1,\n \"description\": \"1-channel switching actuator.\",\n \"longDescription\": \"The Homegear HG-16A-EO is a wireless 1-channel 230V/16A switching actuator. EnOcean is used as communication protocol. It features:\\n- bidirectional communication with resends\\n- encryption\\n- remote management\\n- meshing\\n- local control when the gateway is not available\",\n \"roles\": [\n 900100,\n 900100\n ],\n \"sections\": [\n \"primary-facilities\",\n \"primary-facilities\"\n ],\n \"tags\": [\n \"heat-pump\",\n \"heat-pump\"\n ],\n \"addresses\": [\n {\n \"street\": \"Main street\",\n \"streetNumber\": \"21a\",\n \"zip\": \"32144\",\n \"city\": \"Hamburg\",\n \"country\": \"Germany\"\n },\n {\n \"street\": \"Main street\",\n \"streetNumber\": \"21a\",\n \"zip\": \"32144\",\n \"city\": \"Hamburg\",\n \"country\": \"Germany\"\n }\n ],\n \"locationName\": \"Hauptstraße 22-30, 12345 Stadt\",\n \"predecessors\": [\n {\n \"serialNumber\": \"BB53998983\",\n \"type\": \"Kamstrup flowIQ 2200\",\n \"activeUntil\": 1660221715657\n },\n {\n \"serialNumber\": \"BB53998983\",\n \"type\": \"Kamstrup flowIQ 2200\",\n \"activeUntil\": 1660221715657\n }\n ],\n \"dataPoints\": [\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"nativeId\": \"1.TOTAL_VOLUME\",\n \"service\": false,\n \"value\": {\n \"value\": \"\"\n },\n \"updatedAt\": 1631388075,\n \"parentId\": \"aac90cc6-b84c-0f04-8e7f-9310465e4feb\",\n \"priority\": \"error\",\n \"role\": \"90.01.00\",\n \"localizedValue\": \"21,3 °C\",\n \"label\": \"Total volume\",\n \"icon\": \"icon-pressure\",\n \"unit\": \"l\",\n \"unitCode\": 62\n },\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"nativeId\": \"1.TOTAL_VOLUME\",\n \"service\": false,\n \"value\": {\n \"value\": \"\"\n },\n \"updatedAt\": 1631388075,\n \"parentId\": \"aac90cc6-b84c-0f04-8e7f-9310465e4feb\",\n \"priority\": \"error\",\n \"role\": \"90.01.00\",\n \"localizedValue\": \"21,3 °C\",\n \"label\": \"Total volume\",\n \"icon\": \"icon-pressure\",\n \"unit\": \"l\",\n \"unitCode\": 62\n }\n ],\n \"homeClientId\": \"60:1000.105.8\"\n },\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"nativeId\": 107,\n \"type\": \"Homegear HG-16A-EO\",\n \"serialNumber\": \"EOD0412EBCB\",\n \"softwareVersion\": \"consequat eius\",\n \"interface\": \"ENO14260490011\",\n \"locationId\": \"60:1000.105.8\",\n \"status\": \"warning\",\n \"operationMode\": 1,\n \"name\": \"Heating living room\",\n \"notes\": \"Next to the electic cabinet\",\n \"equipmentId\": \"AMW44_01_00_91_BWM01\",\n \"parent\": \"21:15211.2_23\",\n \"parentDirection\": 1,\n \"description\": \"1-channel switching actuator.\",\n \"longDescription\": \"The Homegear HG-16A-EO is a wireless 1-channel 230V/16A switching actuator. EnOcean is used as communication protocol. It features:\\n- bidirectional communication with resends\\n- encryption\\n- remote management\\n- meshing\\n- local control when the gateway is not available\",\n \"roles\": [\n 900100,\n 900100\n ],\n \"sections\": [\n \"primary-facilities\",\n \"primary-facilities\"\n ],\n \"tags\": [\n \"heat-pump\",\n \"heat-pump\"\n ],\n \"addresses\": [\n {\n \"street\": \"Main street\",\n \"streetNumber\": \"21a\",\n \"zip\": \"32144\",\n \"city\": \"Hamburg\",\n \"country\": \"Germany\"\n },\n {\n \"street\": \"Main street\",\n \"streetNumber\": \"21a\",\n \"zip\": \"32144\",\n \"city\": \"Hamburg\",\n \"country\": \"Germany\"\n }\n ],\n \"locationName\": \"Hauptstraße 22-30, 12345 Stadt\",\n \"predecessors\": [\n {\n \"serialNumber\": \"BB53998983\",\n \"type\": \"Kamstrup flowIQ 2200\",\n \"activeUntil\": 1660221715657\n },\n {\n \"serialNumber\": \"BB53998983\",\n \"type\": \"Kamstrup flowIQ 2200\",\n \"activeUntil\": 1660221715657\n }\n ],\n \"dataPoints\": [\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"nativeId\": \"1.TOTAL_VOLUME\",\n \"service\": true,\n \"value\": {\n \"value\": \"\"\n },\n \"updatedAt\": 1631388075,\n \"parentId\": \"aac90cc6-b84c-0f04-8e7f-9310465e4feb\",\n \"priority\": \"warning\",\n \"role\": \"90.01.00\",\n \"localizedValue\": \"21,3 °C\",\n \"label\": \"Total volume\",\n \"icon\": \"icon-pressure\",\n \"unit\": \"l\",\n \"unitCode\": 62\n },\n {\n \"id\": \"d23d6fd0-116a-11ec-9437-7760f7e49837\",\n \"nativeId\": \"1.TOTAL_VOLUME\",\n \"service\": true,\n \"value\": {\n \"value\": \"\"\n },\n \"updatedAt\": 1631388075,\n \"parentId\": \"aac90cc6-b84c-0f04-8e7f-9310465e4feb\",\n \"priority\": \"critical\",\n \"role\": \"90.01.00\",\n \"localizedValue\": \"21,3 °C\",\n \"label\": \"Total volume\",\n \"icon\": \"icon-pressure\",\n \"unit\": \"l\",\n \"unitCode\": 62\n }\n ],\n \"homeClientId\": \"60:1000.105.8\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"ipsum occaecat exercitation ea in\"\n }\n}"},{"id":"25f41cbf-42c3-42d3-b132-4ce3af626592","name":"Invalid filter.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/devices?locationId=aliquip&locationIdFilterType=exact&roles=90.01.00&filter=critical&offset=98378940&limit=98378940&lang=en-US&orderBy=locationId&groupBy=locationId","host":["{{baseUrl}}"],"path":["devices"],"query":[{"key":"locationId","value":"aliquip"},{"key":"locationIdFilterType","value":"exact"},{"key":"roles","value":"90.01.00"},{"key":"filter","value":"critical"},{"key":"offset","value":"98378940"},{"key":"limit","value":"98378940"},{"key":"lang","value":"en-US"},{"key":"orderBy","value":"locationId"},{"key":"groupBy","value":"locationId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a8848352-1798-4272-85f9-c5dc21efd645"},{"name":"Create alarm definition","id":"4a0579d4-cc86-4268-8a00-20179131c80f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"PRIVATE-TOKEN","value":"","type":"text"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"locationId\": \"1:545\",\n \"deviceId\": \"07967581-dcdb-47f0-8384-c3c7d056c544\",\n \"alarmDefinitionTemplateId\": \"pressure-loss\",\n \"values\": [0.8],\n \"priority\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/admin/alarm-definitions","description":"Creates a device within Sensaru Cloud. You can only (pre-)create actual devices. This does not work for edge clients or communication modules.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["admin","alarm-definitions"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[],"variable":[]}},"response":[{"id":"f6971ad5-6534-4900-a080-f9e7a12c9a5b","name":"Returns success when the device was successfully created.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"id\",\n \"homeClient\": \"occaecat\",\n \"name\": \"ut\",\n \"operationMode\": -38921153,\n \"notes\": \"mollit eiusmod\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/devices"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"02482357-7cda-4751-9bfa-258aee228fd6","name":"Returns one of the Sensaru Cloud REST error codes on error.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"body":{"mode":"raw","raw":"{\n \"serialNumber\": \"id\",\n \"homeClient\": \"occaecat\",\n \"name\": \"ut\",\n \"operationMode\": -38921153,\n \"notes\": \"mollit eiusmod\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/devices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4a0579d4-cc86-4268-8a00-20179131c80f"},{"name":"Get alarm definition templates","id":"27874668-3209-436f-b285-22527859ce3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"C1-BUSINESS-PARTNER","value":"","type":"text"}],"url":"https://core.sensaru.net/api/v1/modules/c1-service-messages/alarm-definitions/templates?lang=en-US","description":"Returns all active device service messages. The service messages can be filtered.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}},"urlObject":{"path":["alarm-definitions","templates"],"host":["https://core.sensaru.net/api/v1/modules/c1-service-messages"],"query":[{"description":{"content":"The language to return localized strings for. The language code is the ISO 639 language code and the ISO 3166 country code separated by a dash (-). The language defaults to en-US.
\n","type":"text/plain"},"key":"lang","value":"en-US"}],"variable":[]}},"response":[{"id":"131ca619-b572-446a-a37c-8ae84b8196e9","name":"Success response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"PRIVATE-TOKEN","value":""}],"url":{"raw":"{{baseUrl}}/service-messages?dateFrom=61510809&dateTo=61510809&locationId=tempor&filter=critical&offset=61510809&limit=61510809","host":["{{baseUrl}}"],"path":["service-messages"],"query":[{"key":"dateFrom","value":"61510809"},{"key":"dateTo","value":"61510809"},{"key":"locationId","value":"tempor"},{"key":"filter","value":"critical"},{"key":"offset","value":"61510809"},{"key":"limit","value":"61510809"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceMessages\": [\n {\n \"id\": \"bcf13894-9e1a-0506-b994-7e434693bd4d\",\n \"createdAt\": 1631388075,\n \"locationId\": \"1000.105.8\",\n \"priority\": \"warning\",\n \"message\": \"The device is offline.\",\n \"header\": \"Water meter\",\n \"footer\": \"Demo city, demo street 23\",\n \"url\": \"https://device-management.sensaru.cloud/service-message/e05fd897-ef91-0f20-be49-058ca498ba04\"\n },\n {\n \"id\": \"bcf13894-9e1a-0506-b994-7e434693bd4d\",\n \"createdAt\": 1631388075,\n \"locationId\": \"1000.105.8\",\n \"priority\": \"warning\",\n \"message\": \"The device is offline.\",\n \"header\": \"Water meter\",\n \"footer\": \"Demo city, demo street 23\",\n \"url\": \"https://device-management.sensaru.cloud/service-message/e05fd897-ef91-0f20-be49-058ca498ba04\"\n }\n ],\n \"responseMetadata\": {\n \"nextKey\": \"sint labore laboris deserunt in\"\n }\n}"}],"_postman_id":"27874668-3209-436f-b285-22527859ce3d"}],"id":"4884c820-827f-4c09-bb50-f63881b1c5d1","_postman_id":"4884c820-827f-4c09-bb50-f63881b1c5d1","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}}],"id":"ff326a95-7347-497f-b394-ea92333cde21","_postman_id":"ff326a95-7347-497f-b394-ea92333cde21","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5c7d1043-3f47-4af9-b170-e2019402f726","id":"5c7d1043-3f47-4af9-b170-e2019402f726","name":"Sensaru Cloud","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"PRIVATE-TOKEN"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3cdd1089-f493-4674-94d1-5e661eb8055e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"bd15a3c8-e0ff-49ff-b0ce-bcb5a9511777"}}],"variable":[{"key":"apiKey","value":""},{"key":"bp","value":""},{"key":"sd","value":"65490af0-ef62-11e9-847a-a58a2ea33526"},{"key":"coreBaseUrl","value":"https://core.sensaru.net/api/v1"},{"key":"reportingBaseUrl","value":"https://core.sensaru.net/api/v1/modules/c1-reporting"},{"key":"serviceMessagesBaseUrl","value":"https://core.sensaru.net/api/v1/modules/c1-service-messages"},{"key":"deviceManagementBaseUrl","value":"https://core.sensaru.net/api/v1/modules/c1-device-management"}]}