docs/_schemas.md in losant_rest-1.13.1 vs docs/_schemas.md in losant_rest-1.14.0

- old
+ new

@@ -80,10 +80,11 @@ * [Device Commands](#device-commands) * [Device Connection Status](#device-connection-status) * [Device Credentials](#device-credentials) * [Device Log](#device-log) * [Device Patch](#device-patch) +* [Device Payload Counts](#device-payload-counts) * [Device Post](#device-post) * [Device Recipe](#device-recipe) * [Device Recipe Bulk Create](#device-recipe-bulk-create) * [Device Recipe Bulk Create Enqueue](#device-recipe-bulk-create-enqueue) * [Device Recipe Bulk Create Post](#device-recipe-bulk-create-post) @@ -95,10 +96,11 @@ * [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 Payload Count Export Post](#devices-payload-count-export-post) * [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) @@ -208,23 +210,26 @@ * [Notebook Execution Options](#notebook-execution-options) * [Notebook Patch](#notebook-patch) * [Notebook Post](#notebook-post) * [Notebooks](#notebooks) * [Organization](#organization) +* [Organization Invitation](#organization-invitation) * [Organization Invitation Action](#organization-invitation-action) +* [Instance Organization Invitations](#instance-organization-invitations) * [Organization Invitation Information](#organization-invitation-information) * [Organization Invitation Post](#organization-invitation-post) * [Organization Invitation Result](#organization-invitation-result) * [Organization Invitations](#organization-invitations) * [Organization Member Patch](#organization-member-patch) * [Organization Patch](#organization-patch) * [Organization Post](#organization-post) +* [Organization Role Info](#organization-role-info) * [Organizations](#organizations) * [Password Reset Finish](#password-reset-finish) * [Password Reset Input](#password-reset-input) * [Password Reset Response](#password-reset-response) -* [Payload Counts](#payload-counts) +* [Payload Stats](#payload-stats) * [Recent Item](#recent-item) * [Recent Item List](#recent-item-list) * [Resource Transfer](#resource-transfer) * [SAML Response](#saml-response) * [SSO Request](#sso-request) @@ -6832,10 +6837,11 @@ "dataTableRows.*", "device.*", "deviceRecipe.*", "deviceRecipes.*", "devices.*", + "edgeDeployment.*", "edgeDeployments.*", "event.*", "events.*", "experience.*", "experienceDomain.*", @@ -6932,10 +6938,11 @@ "device.getCommand", "device.getCompositeState", "device.getLogEntries", "device.getState", "device.patch", + "device.payloadCounts", "device.removeData", "device.sendCommand", "device.sendState", "device.setConnectionStatus", "device.stateStream", @@ -6950,14 +6957,16 @@ "devices.delete", "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", + "devices.payloadCounts", "devices.post", "devices.sendCommand", "devices.tagKeys", "devices.tagValues", + "edgeDeployment.get", "edgeDeployments.get", "edgeDeployments.release", "edgeDeployments.remove", "edgeDeployments.replace", "event.delete", @@ -7135,10 +7144,17 @@ "instanceOrgMember.patch", "instanceOrgMember.delete", "instanceOrgMembers.*", "instanceOrgMembers.get", "instanceOrgMembers.post", + "instanceOrgInvite.*", + "instanceOrgInvite.get", + "instanceOrgInvite.delete", + "instanceOrgInvite.resendInvite", + "instanceOrgInvites.*", + "instanceOrgInvites.get", + "instanceOrgInvites.post", "instanceApiTokens.*", "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", @@ -7828,11 +7844,11 @@ ### <a name="application-apply-template-patch-schema-example"></a> Example ```json { "templateId": "575ec8687ae143cd83dc4a97", - "email": "email.example.com" + "email": "email@example.com" } ``` <br/> @@ -7985,12 +8001,12 @@ "status": "active", "description": "An example certificate description", "certificateInfo": { "serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9", "fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06", - "commonName": "myDomain.com", - "issuerName": "Network Solutions OV Server CA 2", + "commonName": "example.com", + "issuerName": "Example Issuer", "notValidBefore": "2019-04-10T00:00:00.000Z", "notValidAfter": "2020-04-10T00:00:00.000Z" }, "filterType": "all", "pubTopics": [], @@ -8151,12 +8167,12 @@ "caBundle": "MY_SSL_CERTIFICATE", "caInfo": [ { "serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9", "fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06", - "commonName": "myDomain.com", - "issuerName": "Network Solutions OV Server CA 2", + "commonName": "example.com", + "issuerName": "Example Issuer", "notValidBefore": "2019-04-10T00:00:00.000Z", "notValidAfter": "2020-04-10T00:00:00.000Z" } ] } @@ -8277,12 +8293,12 @@ "caBundle": "MY_SSL_CERTIFICATE", "caInfo": [ { "serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9", "fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06", - "commonName": "myDomain.com", - "issuerName": "Network Solutions OV Server CA 2", + "commonName": "example.com", + "issuerName": "Example Issuer", "notValidBefore": "2019-04-10T00:00:00.000Z", "notValidAfter": "2020-04-10T00:00:00.000Z" } ] } @@ -8770,12 +8786,12 @@ "status": "active", "description": "An example certificate description", "certificateInfo": { "serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9", "fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06", - "commonName": "myDomain.com", - "issuerName": "Network Solutions OV Server CA 2", + "commonName": "example.com", + "issuerName": "Example Issuer", "notValidBefore": "2019-04-10T00:00:00.000Z", "notValidAfter": "2020-04-10T00:00:00.000Z" }, "filterType": "all", "pubTopics": [], @@ -15080,11 +15096,11 @@ ```json { "includeFiles": true, "includeDevices": true, - "email": "test@losant.com" + "email": "test@example.com" } ``` <br/> @@ -15108,11 +15124,11 @@ ``` ### <a name="application-export-result-example"></a> Example ```json { - "url": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon/applicationExport.zip" + "url": "https://example.com/applicationExport.zip" } ``` <br/> @@ -16603,13 +16619,13 @@ "creationDate": "2020-01-13T04:00:00.000Z", "lastUpdated": "2020-01-13T04:00:00.000Z", "name": "smart environment", "description": "a smart env set up", "public": true, - "authorName": "Losant", - "authorUrl": "https://www.losant.com", - "templateUrl": "https://app.losant.com", + "authorName": "Example Author", + "authorUrl": "https://example.com/theAuther", + "templateUrl": "https://example.com/theTemplate", "summary": { "applicationCertificateAuthorityCount": 0, "dashboardCount": 0, "deviceCount": 1, "deviceRecipeCount": 0, @@ -16939,13 +16955,13 @@ "creationDate": "2020-01-13T04:00:00.000Z", "lastUpdated": "2020-01-13T04:00:00.000Z", "name": "smart environment", "description": "a smart env set up", "public": true, - "authorName": "Losant", - "authorUrl": "https://www.losant.com", - "templateUrl": "https://app.losant.com", + "authorName": "Example Author", + "authorUrl": "https://example.com/theAuther", + "templateUrl": "https://example.com/theTemplate", "summary": { "applicationCertificateAuthorityCount": 0, "dashboardCount": 0, "deviceCount": 1, "deviceRecipeCount": 0, @@ -17599,11 +17615,11 @@ "primaryTargetId": "575ec8687ae143cd83dc4a97", "primaryTargetType": "Application", "primaryTargetName": "My Application", "actorId": "575ed70c7ae143cd83dc4aa9", "actorType": "User", - "actorName": "example@losant.com", + "actorName": "actor@example.com", "requestResource": "application", "requestAction": "delete", "requestQueryParams": {}, "requestBody": {}, "requestPathParams": { @@ -17952,11 +17968,11 @@ "primaryTargetId": "575ec8687ae143cd83dc4a97", "primaryTargetType": "Application", "primaryTargetName": "My Application", "actorId": "575ed70c7ae143cd83dc4aa9", "actorType": "User", - "actorName": "example@losant.com", + "actorName": "actor@example.com", "requestResource": "application", "requestAction": "delete", "requestQueryParams": {}, "requestBody": {}, "requestPathParams": { @@ -24013,11 +24029,11 @@ { "id": "575ece2b7ae143cd83dc4a9b", "dashboardId": "575ece2b7ae143cd83dc4a9b", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", - "organizationName": "Losant", + "organizationName": "Example Org", "organizationIconColor": "#284fff", "ownerType": "organization", "ownerId": "58238ff2fe7b4b01009a0554", "name": "My Dashboard", "description": "The best dashboard description", @@ -24028,11 +24044,11 @@ "blocks": [], "_currentRole": "admin", "reportConfigs": [ { "toEmail": [ - "test@email.com" + "email@example.com" ], "cron": "0 0 12 * * TUE-THU", "theme": "dark", "subject": "Daily Dashboard Report" } @@ -35652,11 +35668,11 @@ ### <a name="dashboard-send-report-example"></a> Example ```json { "toEmail": [ - "test@email.com" + "email@example.com" ], "subject": "Dashboard Report", "message": "Lookit", "time": 1551887386704, "theme": "dark", @@ -41527,11 +41543,11 @@ { "id": "575ece2b7ae143cd83dc4a9b", "dashboardId": "575ece2b7ae143cd83dc4a9b", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", - "organizationName": "Losant", + "organizationName": "Example Org", "organizationIconColor": "#284fff", "ownerType": "organization", "ownerId": "58238ff2fe7b4b01009a0554", "name": "My Dashboard", "description": "The best dashboard description", @@ -41542,11 +41558,11 @@ "blocks": [], "_currentRole": "admin", "reportConfigs": [ { "toEmail": [ - "test@email.com" + "email@example.com" ], "cron": "0 0 12 * * TUE-THU", "theme": "dark", "subject": "Daily Dashboard Report" } @@ -41863,11 +41879,11 @@ ``` ### <a name="data-export-example"></a> Example ```json { - "email": "example@losant.com", + "email": "export@example.com", "deviceIds": [ "575ecf887ae143cd83dc4aa2", "575ef5c97ae143cd83dc4aac" ], "attributes": [ @@ -43991,10 +44007,55 @@ } ``` <br/> +## Device Payload Counts + +Schema for the result of a device payload count request + +### <a name="device-payload-counts-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "deviceCommand": { + "type": "number" + }, + "deviceConnect": { + "type": "number" + }, + "deviceDisconnect": { + "type": "number" + }, + "deviceState": { + "type": "number" + }, + "mqttIn": { + "type": "number" + }, + "mqttOut": { + "type": "number" + } + } +} +``` +### <a name="device-payload-counts-example"></a> Example + +```json +{ + "deviceState": 1244049, + "mqttOut": 12, + "deviceConnect": 1016, + "deviceDisconnect": 1016 +} +``` + +<br/> + ## Device Post Schema for the body of a Device creation request ### <a name="device-post-schema"></a> Schema @@ -47546,10 +47607,1383 @@ } ``` <br/> +## Devices Payload Count Export Post + +Schema for the body of a device payload count export request + +### <a name="devices-payload-count-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 + } + ] + }, + "disconnectedAt": { + "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 + } + ] + }, + "connectedAt": { + "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 + } + ] + }, + "connectionStatus": { + "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 + } + ] + } + }, + "additionalProperties": false + }, + "start": { + "type": "number" + }, + "end": { + "type": "number" + } + }, + "additionalProperties": false +} +``` +### <a name="devices-payload-count-export-post-example"></a> Example + +```json +{ + "query": { + "name": { + "$ne": "My Device" + } + }, + "email": "email@example.com" +} +``` + +<br/> + ## Devices Metadata Export Post Schema for the body of a device metadata export request ### <a name="devices-metadata-export-post-schema"></a> Schema @@ -52662,11 +54096,11 @@ ```json { "updated": 3, "failed": 0, "skipped": 2, - "logLink": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon" + "logLink": "https://example.com/log-link" } ``` <br/> @@ -52739,10 +54173,26 @@ "deviceName": { "type": "string", "minLength": 1, "maxLength": 255 }, + "deviceConnectionInfo": { + "type": "object", + "properties": { + "time": { + "type": "string", + "format": "date-time" + }, + "connected": { + "enum": [ + 1, + 0, + null + ] + } + } + }, "flowId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "flowName": { @@ -53067,10 +54517,26 @@ "deviceName": { "type": "string", "minLength": 1, "maxLength": 255 }, + "deviceConnectionInfo": { + "type": "object", + "properties": { + "time": { + "type": "string", + "format": "date-time" + }, + "connected": { + "enum": [ + 1, + 0, + null + ] + } + } + }, "flowId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "flowName": { @@ -53260,11 +54726,11 @@ ``` ### <a name="email-verification-verify-example"></a> Example ```json { - "email": "example@losant.com", + "email": "email@example.com", "token": "the email verification token" } ``` <br/> @@ -55378,11 +56844,11 @@ "id": "58c1de6c8f812590d8e82980", "experienceDomainId": "58c1de6c8f812590d8e82980", "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", - "domainName": "my.example.domain.com", + "domainName": "my.domain.example.com", "version": "develop" } ``` <br/> @@ -55457,11 +56923,11 @@ ``` ### <a name="experience-domain-patch-example"></a> Example ```json { - "domainName": "my.example.domain.com", + "domainName": "my.domain.example.com", "sslCert": "MY_SSL_CERTIFICATE", "sslKey": "MY_SSL_KEY", "version": "develop" } ``` @@ -55520,11 +56986,11 @@ ``` ### <a name="experience-domain-post-example"></a> Example ```json { - "domainName": "my.example.domain.com", + "domainName": "my.domain.example.com", "sslCert": "MY_SSL_CERTIFICATE", "sslKey": "MY_SSL_KEY", "version": "develop" } ``` @@ -55614,11 +57080,11 @@ "id": "58c1de6c8f812590d8e82980", "experienceDomainId": "58c1de6c8f812590d8e82980", "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", - "domainName": "my.example.domain.com", + "domainName": "my.domain.example.com", "version": "develop" } ], "count": 1, "totalCount": 1, @@ -57754,10 +59220,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -60002,10 +61483,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -62200,10 +63696,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -64262,11 +65773,11 @@ "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "passwordLastUpdated": "2016-06-13T04:00:00.000Z", "lastLogin": "2016-06-13T04:00:00.000Z", - "email": "example@experienceuser.com", + "email": "experienceuser@example.com", "firstName": "Example", "lastName": "Name", "avatarUrl": "https://example.avatar.url/is_here.png", "userTags": { "customKey": "customValue" @@ -64407,11 +65918,11 @@ ``` ### <a name="experience-user-post-example"></a> Example ```json { - "email": "example@experienceuser.com", + "email": "experienceuser@example.com", "firstName": "Example", "lastName": "Name", "password": "aUserPassword", "userTags": { "customKey": "customValue" @@ -64572,11 +66083,11 @@ "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "passwordLastUpdated": "2016-06-13T04:00:00.000Z", "lastLogin": "2016-06-13T04:00:00.000Z", - "email": "example@experienceuser.com", + "email": "experienceuser@example.com", "firstName": "Example", "lastName": "Name", "avatarUrl": "https://example.avatar.url/is_here.png", "userTags": { "customKey": "customValue" @@ -64706,11 +66217,11 @@ "version": "myVersionName", "endpointDefaultCors": true, "attachedDomains": [ { "id": "58c1de6c8f812590d8e82980", - "domainName": "my.example.domain.com" + "domainName": "my.domain.example.com" } ], "attachedSlugs": [ { "id": "5b995e51ea9994b50d745284", @@ -64961,11 +66472,11 @@ "version": "myVersionName", "endpointDefaultCors": true, "attachedDomains": [ { "id": "58c1de6c8f812590d8e82980", - "domainName": "my.example.domain.com" + "domainName": "my.domain.example.com" } ], "attachedSlugs": [ { "id": "5b995e51ea9994b50d745284", @@ -65789,14 +67300,14 @@ "type": "file", "parentDirectory": "/", "fileSize": 500, "contentType": "text/csv", "upload": { - "url": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon", + "url": "https://example.com/the-bucket-name", "fields": { "key": "5630dcbe1035c9d0011/file.js", - "bucket": "a-bucket-on-amazon", + "bucket": "the-bucket-name", "X-Amz-Algorithm": "AWS4-HMAC-SHA256", "X-Amz-Credential": "AKIAJPGQGBQX4PYM6FXA/20180416/us-west-1/s3/aws4_request", "X-Amz-Date": "20180416T142402Z", "Policy": "wMloiLCJjb25kaXRpb25zIjpbeyJrZXkiOiI1NjMwZGNiZTEwM2Y4ZTQ4NWM5ZDAwMTEvZmlsZS5qcyJ9LHsiYnVja2V0IjoibG9zYW50LWZpbGVzIn0seyJYLUFtei1BbGdvcml0aG0iOiJBV1M0LUhNQUMtU0hBMjU2In0seyJYLUFtei1DcmVkZW50aWFsIjoiQUtJQUpQR1FHQlFYNFBZTTZGWEEvMjAxODA0MTYvdXMtd2VzdC0xL3MzL2F3czRfcmVxdWVzdCJ9LHsiWC1BbXotRGF0ZSI6IjIwMTgwNDE2VDE0MjQwMloifV19", "X-Amz-Signature": "a4a411df572c43b4427ff08ef51763bc2d834fa399c3688f347d936370" @@ -66316,10 +67827,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -68722,10 +70248,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -70883,10 +72424,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -73299,10 +74855,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -75497,10 +77068,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -77398,10 +78984,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -79584,10 +81185,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -81782,10 +83398,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -84717,10 +86348,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -86992,10 +88638,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -89171,10 +90832,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -91397,10 +93073,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -93595,10 +95286,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -95793,10 +97499,25 @@ "pattern": "^[0-9a-zA-Z_-]{1,255}$" } }, "maxAge": { "type": "number" + }, + "triggerOn": { + "type": "string", + "enum": [ + "batch", + "individual", + "both" + ] + }, + "batchBehavior": { + "type": "string", + "enum": [ + "once", + "each" + ] } }, "additionalProperties": false }, "meta": { @@ -97457,10 +99178,11 @@ "dataTableRows.*", "device.*", "deviceRecipe.*", "deviceRecipes.*", "devices.*", + "edgeDeployment.*", "edgeDeployments.*", "event.*", "events.*", "experience.*", "experienceDomain.*", @@ -97557,10 +99279,11 @@ "device.getCommand", "device.getCompositeState", "device.getLogEntries", "device.getState", "device.patch", + "device.payloadCounts", "device.removeData", "device.sendCommand", "device.sendState", "device.setConnectionStatus", "device.stateStream", @@ -97575,14 +99298,16 @@ "devices.delete", "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", + "devices.payloadCounts", "devices.post", "devices.sendCommand", "devices.tagKeys", "devices.tagValues", + "edgeDeployment.get", "edgeDeployments.get", "edgeDeployments.release", "edgeDeployments.remove", "edgeDeployments.replace", "event.delete", @@ -97760,10 +99485,17 @@ "instanceOrgMember.patch", "instanceOrgMember.delete", "instanceOrgMembers.*", "instanceOrgMembers.get", "instanceOrgMembers.post", + "instanceOrgInvite.*", + "instanceOrgInvite.get", + "instanceOrgInvite.delete", + "instanceOrgInvite.resendInvite", + "instanceOrgInvites.*", + "instanceOrgInvites.get", + "instanceOrgInvites.post", "instanceApiTokens.*", "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", @@ -98200,228 +99932,260 @@ }, "payloadNonbillableSizeMb": { "type": "number" }, "payloadCountDetails": { - "title": "Payload Counts", - "description": "Schema for the result of a payload count request", + "title": "Payload Stats", + "description": "Schema for the result of a payload stats request", "type": "object", "properties": { - "mqttOut": { + "dataTable": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "mqttIn": { + "deviceCommand": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "dataTable": { + "deviceConnect": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, + "deviceDisconnect": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } + }, "deviceState": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceCommand": { + "endpoint": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "webhook": { + "event": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "timer": { + "flowError": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "event": { + "integration": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "virtualButton": { + "mqttIn": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceConnect": { + "mqttOut": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceDisconnect": { + "notebook": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "endpoint": { + "timer": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "integration": { + "virtualButton": { "type": "object", "patternProperties": { ".*": { "type": "number" } } + }, + "webhook": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } } } }, "payloadSizeDetails": { - "title": "Payload Counts", - "description": "Schema for the result of a payload count request", + "title": "Payload Stats", + "description": "Schema for the result of a payload stats request", "type": "object", "properties": { - "mqttOut": { + "dataTable": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "mqttIn": { + "deviceCommand": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "dataTable": { + "deviceConnect": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, + "deviceDisconnect": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } + }, "deviceState": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceCommand": { + "endpoint": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "webhook": { + "event": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "timer": { + "flowError": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "event": { + "integration": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "virtualButton": { + "mqttIn": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceConnect": { + "mqttOut": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceDisconnect": { + "notebook": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "endpoint": { + "timer": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "integration": { + "virtualButton": { "type": "object", "patternProperties": { ".*": { "type": "number" } } + }, + "webhook": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } } } } }, "additionalProperties": false @@ -98762,10 +100526,14 @@ ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, "userId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "email": { @@ -98857,22 +100625,37 @@ "properties": { "userId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, "role": { "type": "string", "enum": [ "admin", "view" ] } }, "additionalProperties": false, - "required": [ - "userId", - "role" + "anyOf": [ + { + "required": [ + "email", + "role" + ] + }, + { + "required": [ + "userId", + "role" + ] + } ] } ``` ### <a name="instance-member-post-example"></a> Example @@ -98901,10 +100684,14 @@ "items": { "title": "Instance Member", "description": "Schema for an Instance member", "type": "object", "properties": { + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, "userId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "email": { @@ -98935,10 +100722,14 @@ } }, "additionalProperties": false } }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, "count": { "type": "integer" }, "filter": { "type": "string" @@ -99146,10 +100937,18 @@ ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "orgId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, "userId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "email": { @@ -99488,10 +101287,18 @@ "type": "array", "items": { "$ref": "#/definitions/instanceOrgMembers" } }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "orgId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, "count": { "type": "integer" }, "filter": { "type": "string" @@ -100143,10 +101950,14 @@ "required": [ "name" ] } }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, "count": { "type": "integer" }, "totalCount": { "type": "integer" @@ -100287,11 +102098,11 @@ "reportConfigs": [ { "email": [ "email@example.com" ], - "callbackUrl": "https://www.example.com/callback", + "callbackUrl": "https://example.com/callback", "resourceGroupBy": "organization", "dateGroupBy": "month", "includeSandbox": false, "periods": 3 }, @@ -100362,11 +102173,11 @@ ### <a name="instance-report-options-post-example"></a> Example ```json { "email": "email@example.com", - "callbackUrl": "https://www.example.com/callback", + "callbackUrl": "https://example.com/callback", "resourceGroupBy": "organization", "dateGroupBy": "month", "includeSandbox": false, "start": "2020-01-01T00:00:00.000Z", "end": "2020-01-31T11:59:59.999Z" @@ -101983,117 +103794,133 @@ }, "orgCount": { "type": "number" }, "payloadCount": { - "title": "Payload Counts", - "description": "Schema for the result of a payload count request", + "title": "Payload Stats", + "description": "Schema for the result of a payload stats request", "type": "object", "properties": { - "mqttOut": { + "dataTable": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "mqttIn": { + "deviceCommand": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "dataTable": { + "deviceConnect": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, + "deviceDisconnect": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } + }, "deviceState": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceCommand": { + "endpoint": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "webhook": { + "event": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "timer": { + "flowError": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "event": { + "integration": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "virtualButton": { + "mqttIn": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceConnect": { + "mqttOut": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceDisconnect": { + "notebook": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "endpoint": { + "timer": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "integration": { + "virtualButton": { "type": "object", "patternProperties": { ".*": { "type": "number" } } + }, + "webhook": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } } } }, "storageStats": { "type": "object", @@ -102132,15 +103959,15 @@ "id": "575ed70c7ae143cd83dc4aa9", "userId": "575ed70c7ae143cd83dc4aa9", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "passwordLastUpdated": "2016-06-13T04:00:00.000Z", - "email": "example@losant.com", + "email": "email@example.com", "firstName": "Example", "lastName": "Name", - "companyName": "Losant IoT, Inc.", - "url": "https://www.losant.com", + "companyName": "Example, Inc.", + "url": "https://example.com", "emailVerified": true, "needsToVerifyEmail": false, "twoFactorAuthEnabled": false, "fullName": "Example Name", "summary": { @@ -102221,15 +104048,15 @@ ``` ### <a name="me-patch-example"></a> Example ```json { - "email": "example@losant.com", + "email": "email@example.com", "firstName": "Example", "lastName": "Name", - "companyName": "Losant IoT, Inc.", - "url": "https://www.losant.com", + "companyName": "Example, Inc.", + "url": "https://example.com", "password": "my new password" } ``` <br/> @@ -104313,10 +106140,40 @@ "required": [ "fileName", "outputType" ], "additionalProperties": false + }, + { + "type": "object", + "properties": { + "outputType": { + "type": "string", + "enum": [ + "temporaryUrl" + ] + }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } + }, + "required": [ + "fileName", + "outputType" + ], + "additionalProperties": false } ] } }, "stats": { @@ -104346,11 +106203,11 @@ "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "name": "Example Notebook", "jupyterFileName": "myNotebook.ipynb", - "jupyterFileUrl": "https://mystoragedomain.com/myNotebook.ipynb", + "jupyterFileUrl": "https:/storage.example.com/myNotebook.ipynb", "inputs": [ { "fileName": "deviceDataWithAttributes", "inputType": "deviceData", "attributes": [ @@ -104396,11 +106253,11 @@ "end": 0 }, { "fileName": "anExternalUrl", "inputType": "externalUrl", - "sourceUrl": "https://foo.com" + "sourceUrl": "https://example.com/external" } ], "outputs": [ { "fileName": "result.html", @@ -105323,10 +107180,40 @@ "required": [ "fileName", "outputType" ], "additionalProperties": false + }, + { + "type": "object", + "properties": { + "outputType": { + "type": "string", + "enum": [ + "temporaryUrl" + ] + }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } + }, + "required": [ + "fileName", + "outputType" + ], + "additionalProperties": false } ] } }, "imageVersion": { @@ -105937,10 +107824,40 @@ "required": [ "fileName", "outputType" ], "additionalProperties": false + }, + { + "type": "object", + "properties": { + "outputType": { + "type": "string", + "enum": [ + "temporaryUrl" + ] + }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } + }, + "required": [ + "fileName", + "outputType" + ], + "additionalProperties": false } ] } } }, @@ -106582,10 +108499,40 @@ "required": [ "fileName", "outputType" ], "additionalProperties": false + }, + { + "type": "object", + "properties": { + "outputType": { + "type": "string", + "enum": [ + "temporaryUrl" + ] + }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } + }, + "required": [ + "fileName", + "outputType" + ], + "additionalProperties": false } ] } }, "stats": { @@ -106655,11 +108602,11 @@ "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "name": "Example Notebook", "jupyterFileName": "myNotebook.ipynb", - "jupyterFileUrl": "https://mystoragedomain.com/myNotebook.ipynb", + "jupyterFileUrl": "https:/storage.example.com/myNotebook.ipynb", "inputs": [ { "fileName": "deviceDataWithAttributes", "inputType": "deviceData", "attributes": [ @@ -106705,11 +108652,11 @@ "end": 0 }, { "fileName": "anExternalUrl", "inputType": "externalUrl", - "sourceUrl": "https://foo.com" + "sourceUrl": "https://example.com/external" } ], "outputs": [ { "fileName": "result.html", @@ -107048,117 +108995,133 @@ }, "memberCount": { "type": "number" }, "payloadCount": { - "title": "Payload Counts", - "description": "Schema for the result of a payload count request", + "title": "Payload Stats", + "description": "Schema for the result of a payload stats request", "type": "object", "properties": { - "mqttOut": { + "dataTable": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "mqttIn": { + "deviceCommand": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "dataTable": { + "deviceConnect": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, + "deviceDisconnect": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } + }, "deviceState": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceCommand": { + "endpoint": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "webhook": { + "event": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "timer": { + "flowError": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "event": { + "integration": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "virtualButton": { + "mqttIn": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceConnect": { + "mqttOut": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceDisconnect": { + "notebook": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "endpoint": { + "timer": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "integration": { + "virtualButton": { "type": "object", "patternProperties": { ".*": { "type": "number" } } + }, + "webhook": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } } } }, "pendingInviteCount": { "type": "number" @@ -107237,18 +109200,18 @@ "members": [ { "userId": "575ed70c7ae143cd83dc4aa9", "firstName": "Example", "lastName": "Name", - "email": "example@losant.com", + "email": "email@example.com", "role": "admin" }, { "userId": "575ef90f7ae143cd83dc4aad", "firstName": "Other View", "lastName": "Only User", - "email": "viewer@losant.com", + "email": "viewer@example.com", "role": "view" } ], "summary": { "appCount": 2, @@ -107262,10 +109225,136 @@ } ``` <br/> +## Organization Invitation + +Schema for a pending invitation to an Organization + +### <a name="organization-invitation-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, + "role": { + "type": "string", + "enum": [ + "admin", + "edit", + "collaborate", + "view", + "none" + ] + }, + "applicationRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } + }, + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false + }, + "maxItems": 1000 + }, + "dashboardRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } + }, + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false + }, + "maxItems": 1000 + }, + "inviteDate": { + "type": "string", + "format": "date-time" + }, + "ttl": { + "type": "number" + }, + "hasExpired": { + "type": "boolean" + }, + "disallowTransfer": { + "type": "boolean" + } + } +} +``` +### <a name="organization-invitation-example"></a> Example + +```json +{ + "id": "575ed71e7ae143cd83dc4aaa", + "email": "invitedUser@example.com", + "role": "edit", + "applicationRoles": [ + { + "resourceId": "575ec8687ae143cd83dc4a97", + "role": "view" + } + ], + "dashboardRoles": [ + { + "resourceId": "575ece2b7ae143cd83dc4a9b", + "role": "none" + } + ], + "inviteDate": "2016-05-13T04:00:00.000Z", + "ttl": 4233600000, + "hasExpired": true, + "disallowTransfer": false +} +``` + +<br/> + ## Organization Invitation Action Schema for the body of a request to accept or reject an invitation ### <a name="organization-invitation-action-schema"></a> Schema @@ -107298,18 +109387,191 @@ ``` ### <a name="organization-invitation-action-example"></a> Example ```json { - "email": "invitedUser@losant.com", + "email": "invitedUser@example.com", "token": "the_invitation_token", "accept": true } ``` <br/> +## Instance Organization Invitations + +Schema for an collection of pending invitations to an Instance Organization + +### <a name="instance-organization-invitations-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Schema for a pending invitation to an Organization", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, + "role": { + "type": "string", + "enum": [ + "admin", + "edit", + "collaborate", + "view", + "none" + ] + }, + "applicationRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } + }, + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false + }, + "maxItems": 1000 + }, + "dashboardRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } + }, + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false + }, + "maxItems": 1000 + }, + "inviteDate": { + "type": "string", + "format": "date-time" + }, + "ttl": { + "type": "number" + }, + "hasExpired": { + "type": "boolean" + }, + "disallowTransfer": { + "type": "boolean" + } + } + } + }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "orgId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "count": { + "type": "integer" + }, + "filter": { + "type": "string" + }, + "filterField": { + "type": "string" + }, + "sortField": { + "type": "string" + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + } + } +} +``` +### <a name="instance-organization-invitations-example"></a> Example + +```json +{ + "items": [ + { + "id": "575ed71e7ae143cd83dc4aaa", + "email": "invitedUser@example.com", + "role": "edit", + "applicationRoles": [ + { + "resourceId": "575ec8687ae143cd83dc4a97", + "role": "view" + } + ], + "dashboardRoles": [ + { + "resourceId": "575ece2b7ae143cd83dc4a9b", + "role": "none" + } + ], + "inviteDate": "2016-05-13T04:00:00.000Z", + "ttl": 4233600000, + "hasExpired": true, + "disallowTransfer": false + } + ], + "count": 8, + "sortField": "role", + "sortDirection": "asc" +} +``` + +<br/> + ## Organization Invitation Information Schema for information about an invitation ### <a name="organization-invitation-information-schema"></a> Schema @@ -107355,11 +109617,11 @@ ### <a name="organization-invitation-information-example"></a> Example ```json { "orgName": "My Organization", - "email": "invitedUser@losant.com", + "email": "invitedUser@example.com", "role": "edit", "inviteDate": "2016-05-13T04:00:00.000Z", "ttl": 4233600000, "disallowTransfer": true } @@ -107458,11 +109720,11 @@ ``` ### <a name="organization-invitation-post-example"></a> Example ```json { - "email": "invitedUser@losant.com", + "email": "invitedUser@example.com", "role": "edit" } ``` <br/> @@ -107510,93 +109772,98 @@ "$schema": "http://json-schema.org/draft-04/schema#", "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "email": { - "type": "string", - "format": "email", - "maxLength": 1024 - }, - "role": { - "type": "string", - "enum": [ - "admin", - "edit", - "collaborate", - "view", - "none" - ] - }, - "applicationRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "title": "Organization Invitation", + "description": "Schema for a pending invitation to an Organization", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, + "role": { + "type": "string", + "enum": [ + "admin", + "edit", + "collaborate", + "view", + "none" + ] + }, + "applicationRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } }, - "role": { - "type": "string", - "enum": [ - "collaborate", - "view", - "none" - ] - } + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false }, - "required": [ - "resourceId", - "role" - ], - "additionalProperties": false + "maxItems": 1000 }, - "maxItems": 1000 - }, - "dashboardRoles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "dashboardRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } }, - "role": { - "type": "string", - "enum": [ - "collaborate", - "view", - "none" - ] - } + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false }, - "required": [ - "resourceId", - "role" - ], - "additionalProperties": false + "maxItems": 1000 }, - "maxItems": 1000 - }, - "inviteDate": { - "type": "string", - "format": "date-time" - }, - "ttl": { - "type": "number" - }, - "hasExpired": { - "type": "boolean" - }, - "disallowTransfer": { - "type": "boolean" + "inviteDate": { + "type": "string", + "format": "date-time" + }, + "ttl": { + "type": "number" + }, + "hasExpired": { + "type": "boolean" + }, + "disallowTransfer": { + "type": "boolean" + } } } } } ``` @@ -107604,11 +109871,11 @@ ```json [ { "id": "575ed71e7ae143cd83dc4aaa", - "email": "invitedUser@losant.com", + "email": "invitedUser@example.com", "role": "edit", "applicationRoles": [ { "resourceId": "575ec8687ae143cd83dc4a97", "role": "view" @@ -107830,10 +110097,97 @@ } ``` <br/> +## Organization Role Info + +Schema for an Organization member&#x27;s role info + +### <a name="organization-role-info-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "role": { + "type": "string", + "enum": [ + "admin", + "edit", + "collaborate", + "view", + "none" + ] + }, + "applicationRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } + }, + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false + }, + "maxItems": 1000 + }, + "dashboardRoles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "role": { + "type": "string", + "enum": [ + "collaborate", + "view", + "none" + ] + } + }, + "required": [ + "resourceId", + "role" + ], + "additionalProperties": false + }, + "maxItems": 1000 + } + }, + "additionalProperties": false +} +``` +### <a name="organization-role-info-example"></a> Example + +```json +{ + "role": "view" +} +``` + +<br/> + ## Organizations Schema for a collection of Organizations ### <a name="organizations-schema"></a> Schema @@ -108101,117 +110455,133 @@ }, "memberCount": { "type": "number" }, "payloadCount": { - "title": "Payload Counts", - "description": "Schema for the result of a payload count request", + "title": "Payload Stats", + "description": "Schema for the result of a payload stats request", "type": "object", "properties": { - "mqttOut": { + "dataTable": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "mqttIn": { + "deviceCommand": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "dataTable": { + "deviceConnect": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, + "deviceDisconnect": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } + }, "deviceState": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceCommand": { + "endpoint": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "webhook": { + "event": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "timer": { + "flowError": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "event": { + "integration": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "virtualButton": { + "mqttIn": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceConnect": { + "mqttOut": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceDisconnect": { + "notebook": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "endpoint": { + "timer": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "integration": { + "virtualButton": { "type": "object", "patternProperties": { ".*": { "type": "number" } } + }, + "webhook": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } } } }, "pendingInviteCount": { "type": "number" @@ -108326,18 +110696,18 @@ "members": [ { "userId": "575ed70c7ae143cd83dc4aa9", "firstName": "Example", "lastName": "Name", - "email": "example@losant.com", + "email": "email@example.com", "role": "admin" }, { "userId": "575ef90f7ae143cd83dc4aad", "firstName": "Other View", "lastName": "Only User", - "email": "viewer@losant.com", + "email": "viewer@example.com", "role": "view" } ], "summary": { "appCount": 2, @@ -108399,11 +110769,11 @@ ### <a name="password-reset-finish-example"></a> Example ```json { "token": "the_password_reset_token", - "email": "example@losant.com", + "email": "email@example.com", "password": "the new password" } ``` <br/> @@ -108433,11 +110803,11 @@ ``` ### <a name="password-reset-input-example"></a> Example ```json { - "email": "example@losant.com" + "email": "email@example.com" } ``` <br/> @@ -108477,129 +110847,145 @@ } ``` <br/> -## Payload Counts +## Payload Stats -Schema for the result of a payload count request +Schema for the result of a payload stats request -### <a name="payload-counts-schema"></a> Schema +### <a name="payload-stats-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "mqttOut": { + "dataTable": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "mqttIn": { + "deviceCommand": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "dataTable": { + "deviceConnect": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, + "deviceDisconnect": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } + }, "deviceState": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceCommand": { + "endpoint": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "webhook": { + "event": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "timer": { + "flowError": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "event": { + "integration": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "virtualButton": { + "mqttIn": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceConnect": { + "mqttOut": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "deviceDisconnect": { + "notebook": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "endpoint": { + "timer": { "type": "object", "patternProperties": { ".*": { "type": "number" } } }, - "integration": { + "virtualButton": { "type": "object", "patternProperties": { ".*": { "type": "number" } } + }, + "webhook": { + "type": "object", + "patternProperties": { + ".*": { + "type": "number" + } + } } } } ``` -### <a name="payload-counts-example"></a> Example +### <a name="payload-stats-example"></a> Example ```json { "timer": { "timer.flow": 19772 @@ -108833,11 +111219,11 @@ ### <a name="saml-response-example"></a> Example ```json { "SAMLResponse": "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoy...", - "SAMLDomain": "losant.com" + "SAMLDomain": "example.com" } ``` <br/> @@ -109516,10 +111902,11 @@ "dataTableRows.*", "device.*", "deviceRecipe.*", "deviceRecipes.*", "devices.*", + "edgeDeployment.*", "edgeDeployments.*", "event.*", "events.*", "experience.*", "experienceDomain.*", @@ -109616,10 +112003,11 @@ "device.getCommand", "device.getCompositeState", "device.getLogEntries", "device.getState", "device.patch", + "device.payloadCounts", "device.removeData", "device.sendCommand", "device.sendState", "device.setConnectionStatus", "device.stateStream", @@ -109634,14 +112022,16 @@ "devices.delete", "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", + "devices.payloadCounts", "devices.post", "devices.sendCommand", "devices.tagKeys", "devices.tagValues", + "edgeDeployment.get", "edgeDeployments.get", "edgeDeployments.release", "edgeDeployments.remove", "edgeDeployments.replace", "event.delete", @@ -109819,10 +112209,17 @@ "instanceOrgMember.patch", "instanceOrgMember.delete", "instanceOrgMembers.*", "instanceOrgMembers.get", "instanceOrgMembers.post", + "instanceOrgInvite.*", + "instanceOrgInvite.get", + "instanceOrgInvite.delete", + "instanceOrgInvite.resendInvite", + "instanceOrgInvites.*", + "instanceOrgInvites.get", + "instanceOrgInvites.post", "instanceApiTokens.*", "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", @@ -109887,11 +112284,11 @@ ``` ### <a name="user-credentials-example"></a> Example ```json { - "email": "example@losant.com", + "email": "email@example.com", "password": "this is the password" } ``` <br/> @@ -110013,10 +112410,11 @@ "dataTableRows.*", "device.*", "deviceRecipe.*", "deviceRecipes.*", "devices.*", + "edgeDeployment.*", "edgeDeployments.*", "event.*", "events.*", "experience.*", "experienceDomain.*", @@ -110113,10 +112511,11 @@ "device.getCommand", "device.getCompositeState", "device.getLogEntries", "device.getState", "device.patch", + "device.payloadCounts", "device.removeData", "device.sendCommand", "device.sendState", "device.setConnectionStatus", "device.stateStream", @@ -110131,14 +112530,16 @@ "devices.delete", "devices.removeData", "devices.detailedSummary", "devices.export", "devices.get", + "devices.payloadCounts", "devices.post", "devices.sendCommand", "devices.tagKeys", "devices.tagValues", + "edgeDeployment.get", "edgeDeployments.get", "edgeDeployments.release", "edgeDeployments.remove", "edgeDeployments.replace", "event.delete", @@ -110316,10 +112717,17 @@ "instanceOrgMember.patch", "instanceOrgMember.delete", "instanceOrgMembers.*", "instanceOrgMembers.get", "instanceOrgMembers.post", + "instanceOrgInvite.*", + "instanceOrgInvite.get", + "instanceOrgInvite.delete", + "instanceOrgInvite.resendInvite", + "instanceOrgInvites.*", + "instanceOrgInvites.get", + "instanceOrgInvites.post", "instanceApiTokens.*", "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", @@ -110399,15 +112807,15 @@ ``` ### <a name="user-post-example"></a> Example ```json { - "email": "example@losant.com", + "email": "email@example.com", "firstName": "Example", "lastName": "Name", - "companyName": "Losant IoT, Inc.", - "url": "https://www.losant.com", + "companyName": "Example, Inc.", + "url": "https://example.com", "password": "the new password", "acceptTerms": "on" } ``` @@ -110839,9 +113247,13 @@ "type": "string", "minLength": 1, "maxLength": 255 }, "deviceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "deploymentId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" } }, "required": [