docs/_schemas.md in losant_rest-1.10.1 vs docs/_schemas.md in losant_rest-1.10.2

- old
+ new

@@ -81,11 +81,17 @@ * [Device State](#device-state) * [Device State or States](#device-state-or-states) * [Device States](#device-states) * [Device Tag Filter](#device-tag-filter) * [Devices](#devices) +* [Devices Data Removed](#devices-data-removed) +* [Devices Delete Post](#devices-delete-post) +* [Devices Deleted](#devices-deleted) +* [Devices Metadata Export Post](#devices-metadata-export-post) * [Devices Patch](#devices-patch) +* [Devices Remove Data Post](#devices-remove-data-post) +* [Devices Updated](#devices-updated) * [Disable Two Factor Auth](#disable-two-factor-auth) * [Edge Deployment](#edge-deployment) * [Edge Deployment Release](#edge-deployment-release) * [Edge Deployment Remove](#edge-deployment-remove) * [Edge Deployment Replace](#edge-deployment-replace) @@ -369,10 +375,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -450,10 +478,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -531,10 +581,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -612,10 +684,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -876,10 +970,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1243,10 +1359,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1324,10 +1462,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1405,10 +1565,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1486,10 +1668,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1567,10 +1771,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1648,10 +1874,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1729,10 +1977,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1810,10 +2080,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -1891,10 +2183,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -2260,10 +2574,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -3171,10 +3507,12 @@ "deviceRecipe.get", "deviceRecipe.patch", "deviceRecipes.get", "deviceRecipes.post", "devices.patch", + "devices.delete", + "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", "devices.post", "devices.sendCommand", @@ -10021,10 +10359,14 @@ "type": "string", "enum": [ "normal", "satellite" ] + }, + "query": { + "type": "string", + "maxLength": 32767 } }, "additionalProperties": false } }, @@ -12250,10 +12592,14 @@ }, "popupTemplate": { "type": "string", "maxLength": 32767 }, + "query": { + "type": "string", + "maxLength": 32767 + }, "resizedPins": { "type": "boolean" }, "resolution": { "oneOf": [ @@ -15606,10 +15952,14 @@ "type": "string", "enum": [ "normal", "satellite" ] + }, + "query": { + "type": "string", + "maxLength": 32767 } }, "additionalProperties": false } }, @@ -17835,10 +18185,14 @@ }, "popupTemplate": { "type": "string", "maxLength": 32767 }, + "query": { + "type": "string", + "maxLength": 32767 + }, "resizedPins": { "type": "boolean" }, "resolution": { "oneOf": [ @@ -21120,10 +21474,14 @@ "type": "string", "enum": [ "normal", "satellite" ] + }, + "query": { + "type": "string", + "maxLength": 32767 } }, "additionalProperties": false } }, @@ -23349,10 +23707,14 @@ }, "popupTemplate": { "type": "string", "maxLength": 32767 }, + "query": { + "type": "string", + "maxLength": 32767 + }, "resizedPins": { "type": "boolean" }, "resolution": { "oneOf": [ @@ -26889,10 +27251,14 @@ "type": "string", "enum": [ "normal", "satellite" ] + }, + "query": { + "type": "string", + "maxLength": 32767 } }, "additionalProperties": false } }, @@ -29118,10 +29484,14 @@ }, "popupTemplate": { "type": "string", "maxLength": 32767 }, + "query": { + "type": "string", + "maxLength": 32767 + }, "resizedPins": { "type": "boolean" }, "resolution": { "oneOf": [ @@ -30294,10 +30664,14 @@ "email": { "type": "string", "format": "email", "maxLength": 1024 }, + "callbackUrl": { + "type": "string", + "maxLength": 1024 + }, "deviceIds": { "type": "array", "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" @@ -30321,10 +30695,13 @@ }, "additionalProperties": false }, "maxItems": 100 }, + "deviceQuery": { + "ref": "#/definitions/advancedQuery" + }, "attributes": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-zA-Z_-]{1,255}$" @@ -30344,10 +30721,14 @@ "default": true }, "includeID": { "type": "boolean", "default": true + }, + "includeBlobData": { + "type": "boolean", + "default": false } } } }, "additionalProperties": false @@ -31190,10 +31571,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -34572,10 +34975,2186 @@ } ``` <br/> +## Devices Data Removed + +Schema for response to bulk device data removal + +### <a name="devices-data-removed-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "completed": { + "type": "number" + }, + "notApplicable": { + "type": "number" + } + } +} +``` +### <a name="devices-data-removed-example"></a> Example + +```json +{ + "completed": 3, + "skipped": 0 +} +``` + +<br/> + +## Devices Delete Post + +Schema for the body of a bulk device delete request + +### <a name="devices-delete-post-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, + "query": { + "title": "Advanced Device Query", + "description": "Schema for advanced device queries", + "type": "object", + "properties": { + "$and": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$or": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$nor": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "id": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "creationDate": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "lastUpdated": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "name": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "deviceClass": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "gatewayId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "parentId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "ancestorId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "attributeName": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "experienceUserId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "experienceGroupId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "tags": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$eq" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "$ne": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$ne" + ], + "additionalProperties": false + } + ] + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "query" + ] +} +``` +### <a name="devices-delete-post-example"></a> Example + +```json +{ + "query": { + "name": { + "$ne": "My Device" + } + }, + "email": "email@example.com" +} +``` + +<br/> + +## Devices Deleted + +Schema for response to devices removal + +### <a name="devices-deleted-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "removed": { + "type": "number" + }, + "failed": { + "type": "number" + } + } +} +``` +### <a name="devices-deleted-example"></a> Example + +```json +{ + "removed": 3 +} +``` + +<br/> + +## Devices Metadata Export Post + +Schema for the body of a device metadata export request + +### <a name="devices-metadata-export-post-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, + "callbackUrl": { + "type": "string", + "maxLength": 1024 + }, + "query": { + "title": "Advanced Device Query", + "description": "Schema for advanced device queries", + "type": "object", + "properties": { + "$and": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$or": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$nor": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "id": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "creationDate": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "lastUpdated": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "name": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "deviceClass": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "gatewayId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "parentId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "ancestorId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "attributeName": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "experienceUserId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "experienceGroupId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "tags": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$eq" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "$ne": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$ne" + ], + "additionalProperties": false + } + ] + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false +} +``` +### <a name="devices-metadata-export-post-example"></a> Example + +```json +{ + "query": { + "name": { + "$ne": "My Device" + } + }, + "email": "email@example.com" +} +``` + +<br/> + ## Devices Patch Schema for the body of a Devices modification request ### <a name="devices-patch-schema"></a> Schema @@ -34793,17 +37372,1770 @@ "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "maxItems": 1000 + }, + "query": { + "title": "Advanced Device Query", + "description": "Schema for advanced device queries", + "type": "object", + "properties": { + "$and": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$or": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$nor": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "id": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "creationDate": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "lastUpdated": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "name": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "deviceClass": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "gatewayId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "parentId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "ancestorId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "attributeName": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "experienceUserId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "experienceGroupId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "tags": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$eq" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "$ne": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$ne" + ], + "additionalProperties": false + } + ] + } + }, + "additionalProperties": false + }, + "updateOperations": { + "type": "array", + "maxItems": 25, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "name" + ] + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "deviceClass" + ] + }, + "value": { + "type": "string", + "enum": [ + "standalone", + "gateway", + "peripheral", + "floating", + "edgeCompute", + "system" + ] + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "description" + ] + }, + "value": { + "type": "string", + "maxLength": 32767 + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "gatewayId", + "parentId" + ] + }, + "value": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "systemInterval" + ] + }, + "value": { + "type": "integer", + "minimum": 5, + "maximum": 3600 + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "keepDuplicates" + ] + }, + "value": { + "type": "boolean" + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "tag" + ] + }, + "value": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "required": [ + "key", + "value" + ], + "additionalProperties": false + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "attributeTag" + ] + }, + "attributeName": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "value": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "required": [ + "key", + "value" + ], + "additionalProperties": false + } + }, + "required": [ + "operation", + "target", + "attributeName", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "set" + ] + }, + "target": { + "type": "string", + "enum": [ + "attributeDescription" + ] + }, + "attributeName": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "value": { + "type": "string", + "maxLength": 32767 + } + }, + "required": [ + "operation", + "target", + "attributeName", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "remove" + ] + }, + "target": { + "type": "string", + "enum": [ + "description", + "parentId" + ] + } + }, + "required": [ + "operation", + "target" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "remove" + ] + }, + "target": { + "type": "string", + "enum": [ + "tag" + ] + }, + "tagKey": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "required": [ + "operation", + "target", + "tagKey" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "remove" + ] + }, + "target": { + "type": "string", + "enum": [ + "attribute" + ] + }, + "attributeName": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "required": [ + "operation", + "target", + "attributeName" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "remove" + ] + }, + "target": { + "type": "string", + "enum": [ + "attributeTag" + ] + }, + "attributeName": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "tagKey": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "required": [ + "operation", + "target", + "attributeName", + "tagKey" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "remove" + ] + }, + "target": { + "type": "string", + "enum": [ + "attributeDescription" + ] + }, + "attributeName": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "required": [ + "operation", + "target", + "attributeName" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "add" + ] + }, + "target": { + "type": "string", + "enum": [ + "attribute" + ] + }, + "value": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "dataType": { + "type": "string", + "enum": [ + "string", + "number", + "gps", + "boolean", + "blob" + ] + }, + "contentType": { + "type": "string", + "maxLength": 64 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "attributeTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "system": { + "type": "object", + "properties": { + "aggregation": { + "type": "string", + "enum": [ + "FIRST", + "LAST", + "COUNT", + "MAX", + "MIN", + "MEDIAN", + "MEAN", + "SUM", + "STD_DEV" + ] + }, + "aggregationOptions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "additionalProperties": false, + "maxItems": 0 + }, + "childAttributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "mode": { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + "deviceIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "maxItems": 1000 + }, + "deviceTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "maxItems": 100 + } + }, + "required": [ + "name", + "mode" + ], + "additionalProperties": false + }, + "maxItems": 256 + } + }, + "additionalProperties": false + } + }, + "required": [ + "name", + "dataType" + ], + "additionalProperties": false + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "operation": { + "type": "string", + "enum": [ + "add" + ] + }, + "target": { + "type": "string", + "enum": [ + "attributeSystem" + ] + }, + "value": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "dataType": { + "type": "string", + "enum": [ + "string", + "number", + "gps", + "boolean", + "blob" + ] + }, + "contentType": { + "type": "string", + "maxLength": 64 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "attributeTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "system": { + "type": "object", + "properties": { + "aggregation": { + "type": "string", + "enum": [ + "FIRST", + "LAST", + "COUNT", + "MAX", + "MIN", + "MEDIAN", + "MEAN", + "SUM", + "STD_DEV" + ] + }, + "aggregationOptions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "additionalProperties": false, + "maxItems": 0 + }, + "childAttributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "mode": { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + "deviceIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "maxItems": 1000 + }, + "deviceTags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "maxItems": 100 + } + }, + "required": [ + "name", + "mode" + ], + "additionalProperties": false + }, + "maxItems": 256 + } + }, + "additionalProperties": false + } + }, + "required": [ + "name", + "dataType" + ], + "additionalProperties": false + } + }, + "required": [ + "operation", + "target", + "value" + ], + "additionalProperties": false + } + ] + } + }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 } }, "additionalProperties": false, - "required": [ - "updateFields", - "deviceIds" - ] + "required": [] } ``` ### <a name="devices-patch-example"></a> Example ```json @@ -34833,10 +39165,1133 @@ } ``` <br/> +## Devices Remove Data Post + +Schema for the body of a bulk data removal request + +### <a name="devices-remove-data-post-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "query": { + "title": "Advanced Device Query", + "description": "Schema for advanced device queries", + "type": "object", + "properties": { + "$and": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$or": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$nor": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "id": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "creationDate": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "lastUpdated": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "name": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "deviceClass": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "gatewayId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "parentId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "ancestorId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "attributeName": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "experienceUserId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "experienceGroupId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "tags": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$eq" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "$ne": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$ne" + ], + "additionalProperties": false + } + ] + } + }, + "additionalProperties": false + }, + "start": { + "type": "number" + }, + "end": { + "type": "number" + }, + "attributes": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + ] + }, + "keepConnectionHistory": { + "type": "boolean" + }, + "keepCommandHistory": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "query" + ] +} +``` +### <a name="devices-remove-data-post-example"></a> Example + +```json +{ + "query": { + "name": { + "$ne": "My Device" + } + }, + "start": 1, + "end": 0, + "attributes": [ + "deleteMyData", + "mineToo" + ] +} +``` + +<br/> + +## Devices Updated + +Schema for response of devices updated if under 100 devices queried + +### <a name="devices-updated-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "updated": { + "type": "number" + }, + "failed": { + "type": "number" + }, + "skipped": { + "type": "number" + }, + "logLink": { + "type": "string" + } + } +} +``` +### <a name="devices-updated-example"></a> Example + +```json +{ + "updated": 3, + "failed": 0, + "skipped": 2, + "logLink": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon" +} +``` + +<br/> + ## Disable Two Factor Auth Schema for the body of a request to disable two factor auth ### <a name="disable-two-factor-auth-schema"></a> Schema @@ -36267,10 +41722,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36348,10 +41825,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36429,10 +41928,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36510,10 +42031,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36591,10 +42134,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36672,10 +42237,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36753,10 +42340,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36834,10 +42443,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -36915,10 +42546,32 @@ "type": "string", "minLength": 1 }, "$ci": { "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } } }, "additionalProperties": false } ] @@ -77715,10 +83368,12 @@ "deviceRecipe.get", "deviceRecipe.patch", "deviceRecipes.get", "deviceRecipes.post", "devices.patch", + "devices.delete", + "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", "devices.post", "devices.sendCommand", @@ -79744,10 +85399,1029 @@ "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "maxItems": 1000 + }, + "deviceQuery": { + "title": "Advanced Device Query", + "description": "Schema for advanced device queries", + "type": "object", + "properties": { + "$and": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$or": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "$nor": { + "type": "array", + "items": { + "$ref": "#/definitions/advancedDeviceQuery" + }, + "maxItems": 100 + }, + "id": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "creationDate": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "lastUpdated": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "name": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "deviceClass": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "gatewayId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "parentId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "ancestorId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "attributeName": { + "oneOf": [ + { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$ne": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lt": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$gte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$lte": { + "type": [ + "string", + "number", + "boolean", + "null" + ] + }, + "$startsWith": { + "type": "string", + "minLength": 1 + }, + "$endsWith": { + "type": "string", + "minLength": 1 + }, + "$contains": { + "type": "string", + "minLength": 1 + }, + "$ci": { + "type": "boolean" + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": [ + "string", + "number", + "boolean" + ] + } + } + }, + "additionalProperties": false + } + ] + }, + "experienceUserId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "experienceGroupId": { + "oneOf": [ + { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$ne": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "null" + } + ] + }, + "$in": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + }, + "$nin": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + }, + "additionalProperties": false, + "minProperties": 1, + "maxProperties": 1 + } + ] + }, + "tags": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + }, + { + "type": "object", + "properties": { + "$eq": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$eq" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "$ne": { + "oneOf": [ + { + "type": "object", + "properties": { + "$tagKey": { + "type": "string", + "maxLength": 255 + }, + "$tagValue": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false, + "minProperties": 1 + }, + { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "$ne" + ], + "additionalProperties": false + } + ] + } + }, + "additionalProperties": false } }, "required": [ "name" ], @@ -85051,10 +91725,12 @@ "deviceRecipe.get", "deviceRecipe.patch", "deviceRecipes.get", "deviceRecipes.post", "devices.patch", + "devices.delete", + "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", "devices.post", "devices.sendCommand", @@ -85472,9 +92148,11 @@ "deviceRecipe.get", "deviceRecipe.patch", "deviceRecipes.get", "deviceRecipes.post", "devices.patch", + "devices.delete", + "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", "devices.post", "devices.sendCommand",