docs/_schemas.md in losant_rest-1.3.3 vs docs/_schemas.md in losant_rest-1.4.0

- old
+ new

@@ -16,10 +16,11 @@ * [Audit Log Filter](#audit-log-filter) * [Audit Logs](#audit-logs) * [Authenticated Device](#authenticated-device) * [Authenticated Solution User](#authenticated-solution-user) * [Authenticated User](#authenticated-user) +* [Change Password](#change-password) * [Composite Device State](#composite-device-state) * [Dashboard](#dashboard) * [Dashboard Context Instance](#dashboard-context-instance) * [Dashboard Patch](#dashboard-patch) * [Dashboard Post](#dashboard-post) @@ -30,20 +31,22 @@ * [Data Table Post](#data-table-post) * [Data Table Query](#data-table-query) * [Data Table Row](#data-table-row) * [Data Table Row Insert/Update](#data-table-row-insert/update) * [Data Table Rows](#data-table-rows) +* [Data Table Export](#data-table-export) * [Data Tables](#data-tables) * [Device](#device) * [Device Command](#device-command) * [Device Commands](#device-commands) * [Device Credentials](#device-credentials) * [Device Log](#device-log) * [Device Patch](#device-patch) * [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) * [Device Recipe Patch](#device-recipe-patch) * [Device Recipe Post](#device-recipe-post) * [Device Recipes](#device-recipes) * [Single or Multiple Device States](#single-or-multiple-device-states) @@ -55,27 +58,31 @@ * [Error](#error) * [Event](#event) * [Event Patch](#event-patch) * [Event Post](#event-post) * [Events](#events) +* [Experience Domain](#experience-domain) +* [Experience Domain Patch](#experience-domain-patch) +* [Experience Domain Post](#experience-domain-post) +* [Experience Domains](#experience-domains) * [Experience Endpoint](#experience-endpoint) * [Experience Endpoint Patch](#experience-endpoint-patch) * [Experience Endpoint Post](#experience-endpoint-post) * [Experience Endpoint Stats](#experience-endpoint-stats) * [Experience Endpoints](#experience-endpoints) * [Experience Group](#experience-group) * [Experience Group Patch](#experience-group-patch) * [Experience Group Post](#experience-group-post) * [Experience Groups](#experience-groups) -* [Experience Template](#experience-template) -* [Experience Template Patch](#experience-template-patch) -* [Experience Template Post](#experience-template-post) -* [Experience Templates](#experience-templates) * [Experience User](#experience-user) * [Experience User Patch](#experience-user-patch) * [Experience User Post](#experience-user-post) * [Experience Users](#experience-users) +* [Experience View](#experience-view) +* [Experience View Patch](#experience-view-patch) +* [Experience View Post](#experience-view-post) +* [Experience Views](#experience-views) * [Workflow](#workflow) * [Workflow Log](#workflow-log) * [Workflow Patch](#workflow-patch) * [Workflow Post](#workflow-post) * [Workflow Storage Entries](#workflow-storage-entries) @@ -385,20 +392,23 @@ "type": "number" }, "eventCount": { "type": "number" }, + "experienceDomainCount": { + "type": "number" + }, "experienceEndpointCount": { "type": "number" }, "experienceGroupCount": { "type": "number" }, - "experienceTemplateCount": { + "experienceUserCount": { "type": "number" }, - "experienceUserCount": { + "experienceViewCount": { "type": "number" }, "flowCount": { "type": "number" }, @@ -407,10 +417,39 @@ }, "webhookCount": { "type": "number" } } + }, + "ftueTracking": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "version": { + "type": "number" + }, + "status": { + "type": "string", + "enum": [ + "skipped", + "completed" + ] + } + }, + "required": [ + "name", + "version", + "status" + ], + "additionalProperties": false + }, + "maxItems": 100 } } } ``` ### <a name="application-example"></a> Example @@ -483,18 +522,20 @@ "deviceRecipe.*", "deviceRecipes.*", "devices.*", "event.*", "events.*", + "experienceDomain.*", + "experienceDomains.*", "experienceEndpoint.*", "experienceEndpoints.*", "experienceGroup.*", "experienceGroups.*", - "experienceTemplate.*", - "experienceTemplates.*", "experienceUser.*", "experienceUsers.*", + "experienceView.*", + "experienceViews.*", "integration.*", "integrations.*", "flow.*", "flows.*", "flowVersion.*", @@ -556,10 +597,15 @@ "event.patch", "events.get", "events.mostRecentBySeverity", "events.patch", "events.post", + "experienceDomain.delete", + "experienceDomain.get", + "experienceDomain.patch", + "experienceDomains.get", + "experienceDomains.post", "experienceEndpoint.delete", "experienceEndpoint.get", "experienceEndpoint.patch", "experienceEndpoints.get", "experienceEndpoints.post", @@ -567,20 +613,20 @@ "experienceGroup.delete", "experienceGroup.get", "experienceGroup.patch", "experienceGroups.get", "experienceGroups.post", - "experienceTemplate.delete", - "experienceTemplate.get", - "experienceTemplate.patch", - "experienceTemplates.get", - "experienceTemplates.post", "experienceUser.delete", "experienceUser.get", "experienceUser.patch", "experienceUsers.get", "experienceUsers.post", + "experienceView.delete", + "experienceView.get", + "experienceView.patch", + "experienceViews.get", + "experienceViews.post", "flow.delete", "flow.clearStorageEntries", "flow.get", "flow.getStorageEntries", "flow.log", @@ -1116,10 +1162,39 @@ "required": [ "key", "json" ] } + }, + "ftueTracking": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "version": { + "type": "number" + }, + "status": { + "type": "string", + "enum": [ + "skipped", + "completed" + ] + } + }, + "required": [ + "name", + "version", + "status" + ], + "additionalProperties": false + }, + "maxItems": 100 } }, "additionalProperties": false } ``` @@ -1321,20 +1396,23 @@ "type": "number" }, "eventCount": { "type": "number" }, + "experienceDomainCount": { + "type": "number" + }, "experienceEndpointCount": { "type": "number" }, "experienceGroupCount": { "type": "number" }, - "experienceTemplateCount": { + "experienceUserCount": { "type": "number" }, - "experienceUserCount": { + "experienceViewCount": { "type": "number" }, "flowCount": { "type": "number" }, @@ -1343,10 +1421,39 @@ }, "webhookCount": { "type": "number" } } + }, + "ftueTracking": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "version": { + "type": "number" + }, + "status": { + "type": "string", + "enum": [ + "skipped", + "completed" + ] + } + }, + "required": [ + "name", + "version", + "status" + ], + "additionalProperties": false + }, + "maxItems": 100 } } } }, "count": { @@ -1470,13 +1577,14 @@ "ApplicationKey", "DataTable", "Device", "DeviceRecipe", "Event", + "ExperienceDomain", "ExperienceEndpoint", "ExperienceGroup", - "ExperienceTemplate", + "ExperienceView", "ExperienceUser", "Flow", "SolutionUser", "Integration", "Webhook" @@ -1616,13 +1724,14 @@ "ApplicationKey", "DataTable", "Device", "DeviceRecipe", "Event", + "ExperienceDomain", "ExperienceEndpoint", "ExperienceGroup", - "ExperienceTemplate", + "ExperienceView", "ExperienceUser", "Flow", "SolutionUser", "Integration", "Webhook" @@ -1779,13 +1888,14 @@ "ApplicationKey", "DataTable", "Device", "DeviceRecipe", "Event", + "ExperienceDomain", "ExperienceEndpoint", "ExperienceGroup", - "ExperienceTemplate", + "ExperienceView", "ExperienceUser", "Flow", "SolutionUser", "Integration", "Webhook" @@ -2038,10 +2148,58 @@ } ``` <br/> +## Change Password + +Schema for the body of a request to change the current user&#x27;s password + +### <a name="change-password-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "twoFactorCode": { + "type": "string", + "maxLength": 2048 + }, + "password": { + "type": "string", + "minLength": 8, + "maxLength": 2048 + }, + "newPassword": { + "type": "string", + "minLength": 8, + "maxLength": 2048 + }, + "invalidateExistingTokens": { + "type": "boolean" + } + }, + "required": [ + "password", + "newPassword" + ], + "additionalProperties": false +} +``` +### <a name="change-password-example"></a> Example + +```json +{ + "newPassword": "yourNewPassword", + "password": "yourCurrentPassword", + "invalidateExistingTokens": true +} +``` + +<br/> + ## Composite Device State Schema for a composite Device state ### <a name="composite-device-state-schema"></a> Schema @@ -3803,10 +3961,79 @@ } ``` <br/> +## Data Table Export + +Schema for the body of a data table export + +### <a name="data-table-export-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + }, + "query": { + "$ref": "#/definitions/dataTableQuery" + }, + "queryOptions": { + "type": "object", + "properties": { + "sortDirection": { + "type": "string", + "enum": [ + "desc", + "asc" + ] + }, + "limit": { + "type": "number" + }, + "sortColumn": { + "type": "string" + }, + "offset": { + "type": "number" + } + } + } + }, + "additionalProperties": false +} +``` +### <a name="data-table-export-example"></a> Example + +```json +{ + "email": "email@example.com", + "query": { + "$or": [ + { + "myCol1": { + "$ne": 0 + } + }, + { + "myCol2": 5 + } + ] + }, + "queryOptions": { + "limit": 10000 + } +} +``` + +<br/> + ## Data Tables Schema for a collection of Data Tables ### <a name="data-tables-schema"></a> Schema @@ -4789,10 +5016,37 @@ } ``` <br/> +## Device Recipe Bulk Create Enqueue + +Schema for the result of a bulk Device creation request when creating more than 750 devices + +### <a name="device-recipe-bulk-create-enqueue-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "jobQueued": { + "type": "boolean" + } + } +} +``` +### <a name="device-recipe-bulk-create-enqueue-example"></a> Example + +```json +{ + "jobQueued": true +} +``` + +<br/> + ## Device Recipe Bulk Create Post Schema for the body of a bulk Device creation request ### <a name="device-recipe-bulk-create-post-schema"></a> Schema @@ -4811,10 +5065,15 @@ "csv": { "type": "string" }, "makeUniqueKeySecret": { "type": "boolean" + }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 } }, "additionalProperties": false, "required": [ "csv" @@ -6325,10 +6584,262 @@ } ``` <br/> +## Experience Domain + +Schema for a single Experience Domain + +### <a name="experience-domain-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "experienceDomainId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "sslCert": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "sslBundle": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "domainName": { + "type": "string", + "maxLength": 1024, + "minLength": 3 + } + } +} +``` +### <a name="experience-domain-example"></a> Example + +```json +{ + "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" +} +``` + +<br/> + +## Experience Domain Patch + +Schema for the body of an Experience Domain modification request + +### <a name="experience-domain-patch-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "sslKey": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "sslCert": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "sslBundle": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "domainName": { + "type": "string", + "maxLength": 1024, + "minLength": 3 + } + }, + "additionalProperties": false +} +``` +### <a name="experience-domain-patch-example"></a> Example + +```json +{ + "domainName": "my.example.domain.com", + "sslCert": "MY_SSL_CERTIFICATE", + "sslKey": "MY_SSL_KEY" +} +``` + +<br/> + +## Experience Domain Post + +Schema for the body of an Experience Domain creation request + +### <a name="experience-domain-post-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "sslKey": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "sslCert": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "sslBundle": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "domainName": { + "type": "string", + "maxLength": 1024, + "minLength": 3 + } + }, + "additionalProperties": false, + "required": [ + "domainName" + ] +} +``` +### <a name="experience-domain-post-example"></a> Example + +```json +{ + "domainName": "my.example.domain.com", + "sslCert": "MY_SSL_CERTIFICATE", + "sslKey": "MY_SSL_KEY" +} +``` + +<br/> + +## Experience Domains + +Schema for a collection of Experience Domains + +### <a name="experience-domains-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Experience Domain", + "description": "Schema for a single Experience Domain", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "experienceDomainId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "sslCert": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "sslBundle": { + "type": "string", + "maxLength": 32767, + "minLength": 50 + }, + "domainName": { + "type": "string", + "maxLength": 1024, + "minLength": 3 + } + } + } + }, + "count": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } +} +``` +### <a name="experience-domains-example"></a> Example + +```json +{ + "items": [ + { + "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" + } + ], + "count": 1, + "totalCount": 1, + "applicationId": "575ec8687ae143cd83dc4a97" +} +``` + +<br/> + ## Experience Endpoint Schema for a single Experience Endpoint ### <a name="experience-endpoint-schema"></a> Schema @@ -6387,10 +6898,21 @@ "public", "authenticated", "group" ] }, + "endpointTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, "experienceGroups": { "type": "array", "items": { "type": "object", "properties": { @@ -6473,10 +6995,21 @@ "public", "authenticated", "group" ] }, + "endpointTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, "experienceGroupIds": { "type": "array", "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" @@ -6540,10 +7073,21 @@ "public", "authenticated", "group" ] }, + "endpointTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, "experienceGroupIds": { "type": "array", "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" @@ -6695,10 +7239,21 @@ "public", "authenticated", "group" ] }, + "endpointTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, "experienceGroups": { "type": "array", "items": { "type": "object", "properties": { @@ -6841,10 +7396,21 @@ "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "maxItems": 1000 + }, + "groupTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false } } } ``` ### <a name="experience-group-example"></a> Example @@ -6903,10 +7469,21 @@ "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "maxItems": 1000 + }, + "groupTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false } }, "additionalProperties": false } ``` @@ -6961,10 +7538,21 @@ "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "maxItems": 1000 + }, + "groupTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false } }, "additionalProperties": false, "required": [ "name" @@ -7049,10 +7637,21 @@ "items": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "maxItems": 1000 + }, + "groupTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false } } } }, "count": { @@ -7122,26 +7721,26 @@ } ``` <br/> -## Experience Template +## Experience User -Schema for a single Experience Template +Schema for a single Experience User -### <a name="experience-template-schema"></a> Schema +### <a name="experience-user-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, - "experienceTemplateId": { + "experienceUserId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "applicationId": { "type": "string", @@ -7153,233 +7752,261 @@ }, "lastUpdated": { "type": "string", "format": "date-time" }, - "name": { + "passwordLastUpdated": { "type": "string", - "minLength": 1, - "maxLength": 255 + "format": "date-time" }, - "description": { + "lastLogin": { "type": "string", - "maxLength": 32767 + "format": "date-time" }, - "templateType": { + "email": { "type": "string", - "enum": [ - "layout", - "page", - "component" - ] + "format": "email", + "maxLength": 1024 }, - "layoutId": { - "type": [ - "string", - "null" - ], - "pattern": "^[A-Fa-f\\d]{24}$" + "firstName": { + "type": "string", + "maxLength": 1024 }, - "body": { + "lastName": { "type": "string", - "maxLength": 131072, - "minLength": 1 + "maxLength": 1024 }, - "templateTags": { + "avatarUrl": { + "type": "string", + "format": "url" + }, + "tokenCutoff": { + "type": "string", + "format": "date-time" + }, + "userTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false + }, + "experienceGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + } } } } ``` -### <a name="experience-template-example"></a> Example +### <a name="experience-user-example"></a> Example ```json { - "id": "59cc5c628246c6caed4b16c1", - "experienceTemplateId": "59cc5c628246c6caed4b16c1", + "id": "58b9d782cbfafe1be675744d", + "experienceUserId": "58b9d782cbfafe1be675744d", "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", - "name": "My Page Template", - "templateType": "page", - "body": "<p>{{data}}</p>", - "layoutId": "59cc5cad8246c6caed4b16c2", - "templateTags": { + "passwordLastUpdated": "2016-06-13T04:00:00.000Z", + "lastLogin": "2016-06-13T04:00:00.000Z", + "email": "example@experienceuser.com", + "firstName": "Example", + "lastName": "Name", + "avatarUrl": "https://example.avatar.url/is_here.png", + "userTags": { "customKey": "customValue" } } ``` <br/> -## Experience Template Patch +## Experience User Patch -Schema for the body of an Experience Template modification request +Schema for the body of an Experience User modification request -### <a name="experience-template-patch-schema"></a> Schema +### <a name="experience-user-patch-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "name": { + "email": { "type": "string", - "minLength": 1, - "maxLength": 255 + "format": "email", + "maxLength": 1024 }, - "description": { + "firstName": { "type": "string", - "maxLength": 32767 + "maxLength": 1024 }, - "layoutId": { - "type": [ - "string", - "null" - ], - "pattern": "^[A-Fa-f\\d]{24}$" + "lastName": { + "type": "string", + "maxLength": 1024 }, - "body": { + "password": { "type": "string", - "maxLength": 131072, - "minLength": 1 + "minLength": 8, + "maxLength": 2048 }, - "templateTags": { + "tokenCutoff": { + "type": "string", + "format": "date-time" + }, + "userTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false + }, + "experienceGroupIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "maxItems": 1000 } }, "additionalProperties": false } ``` -### <a name="experience-template-patch-example"></a> Example +### <a name="experience-user-patch-example"></a> Example ```json { - "body": "New Content! <p>{{newData}}</p>", - "templateTags": { + "password": "aNewPassword", + "userTags": { "customKey": "newCustomValue" } } ``` <br/> -## Experience Template Post +## Experience User Post -Schema for the body of an Experience Template creation request +Schema for the body of an Experience User creation request -### <a name="experience-template-post-schema"></a> Schema +### <a name="experience-user-post-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "name": { + "email": { "type": "string", - "minLength": 1, - "maxLength": 255 + "format": "email", + "maxLength": 1024 }, - "description": { + "firstName": { "type": "string", - "maxLength": 32767 + "maxLength": 1024 }, - "templateType": { + "lastName": { "type": "string", - "enum": [ - "layout", - "page", - "component" - ] + "maxLength": 1024 }, - "layoutId": { - "type": [ - "string", - "null" - ], - "pattern": "^[A-Fa-f\\d]{24}$" + "password": { + "type": "string", + "minLength": 8, + "maxLength": 2048 }, - "body": { + "tokenCutoff": { "type": "string", - "maxLength": 131072, - "minLength": 1 + "format": "date-time" }, - "templateTags": { + "userTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false + }, + "experienceGroupIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "maxItems": 1000 } }, "additionalProperties": false, "required": [ - "name", - "templateType", - "body" + "email", + "password" ] } ``` -### <a name="experience-template-post-example"></a> Example +### <a name="experience-user-post-example"></a> Example ```json { - "name": "My Page Template", - "templateType": "page", - "body": "<p>{{data}}</p>", - "layoutId": "59cc5cad8246c6caed4b16c2", - "templateTags": { + "email": "example@experienceuser.com", + "firstName": "Example", + "lastName": "Name", + "password": "aUserPassword", + "userTags": { "customKey": "customValue" } } ``` <br/> -## Experience Templates +## Experience Users -Schema for a collection of Experience Templates +Schema for a collection of Experience Users -### <a name="experience-templates-schema"></a> Schema +### <a name="experience-users-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "items": { "type": "array", "items": { - "title": "Experience Template", - "description": "Schema for a single Experience Template", + "title": "Experience User", + "description": "Schema for a single Experience User", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, - "experienceTemplateId": { + "experienceUserId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "applicationId": { "type": "string", @@ -7391,49 +8018,66 @@ }, "lastUpdated": { "type": "string", "format": "date-time" }, - "name": { + "passwordLastUpdated": { "type": "string", - "minLength": 1, - "maxLength": 255 + "format": "date-time" }, - "description": { + "lastLogin": { "type": "string", - "maxLength": 32767 + "format": "date-time" }, - "templateType": { + "email": { "type": "string", - "enum": [ - "layout", - "page", - "component" - ] + "format": "email", + "maxLength": 1024 }, - "layoutId": { - "type": [ - "string", - "null" - ], - "pattern": "^[A-Fa-f\\d]{24}$" + "firstName": { + "type": "string", + "maxLength": 1024 }, - "body": { + "lastName": { "type": "string", - "maxLength": 131072, - "minLength": 1 + "maxLength": 1024 }, - "templateTags": { + "avatarUrl": { + "type": "string", + "format": "url" + }, + "tokenCutoff": { + "type": "string", + "format": "date-time" + }, + "userTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false + }, + "experienceGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + } } } } }, "count": { @@ -7466,37 +8110,35 @@ }, "applicationId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, - "templateType": { + "experienceGroupId": { "type": "string", - "enum": [ - "layout", - "page", - "component" - ] + "pattern": "^[A-Fa-f\\d]{24}$" } } } ``` -### <a name="experience-templates-example"></a> Example +### <a name="experience-users-example"></a> Example ```json { "items": [ { - "id": "59cc5c628246c6caed4b16c1", - "experienceTemplateId": "59cc5c628246c6caed4b16c1", + "id": "58b9d782cbfafe1be675744d", + "experienceUserId": "58b9d782cbfafe1be675744d", "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", - "name": "My Page Template", - "templateType": "page", - "body": "<p>{{data}}</p>", - "layoutId": "59cc5cad8246c6caed4b16c2", - "templateTags": { + "passwordLastUpdated": "2016-06-13T04:00:00.000Z", + "lastLogin": "2016-06-13T04:00:00.000Z", + "email": "example@experienceuser.com", + "firstName": "Example", + "lastName": "Name", + "avatarUrl": "https://example.avatar.url/is_here.png", + "userTags": { "customKey": "customValue" } } ], "count": 1, @@ -7509,26 +8151,26 @@ } ``` <br/> -## Experience User +## Experience View -Schema for a single Experience User +Schema for a single Experience View -### <a name="experience-user-schema"></a> Schema +### <a name="experience-view-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, - "experienceUserId": { + "experienceViewId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "applicationId": { "type": "string", @@ -7540,261 +8182,238 @@ }, "lastUpdated": { "type": "string", "format": "date-time" }, - "passwordLastUpdated": { + "name": { "type": "string", - "format": "date-time" + "minLength": 1, + "maxLength": 255 }, - "lastLogin": { + "description": { "type": "string", - "format": "date-time" + "maxLength": 32767 }, - "email": { + "viewType": { "type": "string", - "format": "email", - "maxLength": 1024 + "enum": [ + "layout", + "page", + "component" + ] }, - "firstName": { - "type": "string", - "maxLength": 1024 + "layoutId": { + "type": [ + "string", + "null" + ], + "pattern": "^[A-Fa-f\\d]{24}$" }, - "lastName": { + "layoutName": { "type": "string", - "maxLength": 1024 + "minLength": 1, + "maxLength": 255 }, - "avatarUrl": { + "body": { "type": "string", - "format": "url" + "maxLength": 131072, + "minLength": 1 }, - "tokenCutoff": { - "type": "string", - "format": "date-time" - }, - "userTags": { + "viewTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "experienceGroups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "id": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - } - } - } } } } ``` -### <a name="experience-user-example"></a> Example +### <a name="experience-view-example"></a> Example ```json { - "id": "58b9d782cbfafe1be675744d", - "experienceUserId": "58b9d782cbfafe1be675744d", + "id": "59cc5c628246c6caed4b16c1", + "experienceViewId": "59cc5c628246c6caed4b16c1", "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", - "firstName": "Example", - "lastName": "Name", - "avatarUrl": "https://example.avatar.url/is_here.png", - "userTags": { + "name": "My Page View", + "viewType": "page", + "body": "<p>{{data}}</p>", + "layoutId": "59cc5cad8246c6caed4b16c2", + "viewTags": { "customKey": "customValue" } } ``` <br/> -## Experience User Patch +## Experience View Patch -Schema for the body of an Experience User modification request +Schema for the body of an Experience View modification request -### <a name="experience-user-patch-schema"></a> Schema +### <a name="experience-view-patch-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "email": { + "name": { "type": "string", - "format": "email", - "maxLength": 1024 + "minLength": 1, + "maxLength": 255 }, - "firstName": { + "description": { "type": "string", - "maxLength": 1024 + "maxLength": 32767 }, - "lastName": { - "type": "string", - "maxLength": 1024 + "layoutId": { + "type": [ + "string", + "null" + ], + "pattern": "^[A-Fa-f\\d]{24}$" }, - "password": { + "body": { "type": "string", - "minLength": 8, - "maxLength": 2048 + "maxLength": 131072, + "minLength": 1 }, - "tokenCutoff": { - "type": "string", - "format": "date-time" - }, - "userTags": { + "viewTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "experienceGroupIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 } }, "additionalProperties": false } ``` -### <a name="experience-user-patch-example"></a> Example +### <a name="experience-view-patch-example"></a> Example ```json { - "password": "aNewPassword", - "userTags": { + "body": "New Content! <p>{{newData}}</p>", + "viewTags": { "customKey": "newCustomValue" } } ``` <br/> -## Experience User Post +## Experience View Post -Schema for the body of an Experience User creation request +Schema for the body of an Experience View creation request -### <a name="experience-user-post-schema"></a> Schema +### <a name="experience-view-post-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "email": { + "name": { "type": "string", - "format": "email", - "maxLength": 1024 + "minLength": 1, + "maxLength": 255 }, - "firstName": { + "description": { "type": "string", - "maxLength": 1024 + "maxLength": 32767 }, - "lastName": { + "viewType": { "type": "string", - "maxLength": 1024 + "enum": [ + "layout", + "page", + "component" + ] }, - "password": { - "type": "string", - "minLength": 8, - "maxLength": 2048 + "layoutId": { + "type": [ + "string", + "null" + ], + "pattern": "^[A-Fa-f\\d]{24}$" }, - "tokenCutoff": { + "body": { "type": "string", - "format": "date-time" + "maxLength": 131072, + "minLength": 1 }, - "userTags": { + "viewTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "experienceGroupIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 } }, "additionalProperties": false, "required": [ - "email", - "password" + "name", + "viewType", + "body" ] } ``` -### <a name="experience-user-post-example"></a> Example +### <a name="experience-view-post-example"></a> Example ```json { - "email": "example@experienceuser.com", - "firstName": "Example", - "lastName": "Name", - "password": "aUserPassword", - "userTags": { + "name": "My Page View", + "viewType": "page", + "body": "<p>{{data}}</p>", + "layoutId": "59cc5cad8246c6caed4b16c2", + "viewTags": { "customKey": "customValue" } } ``` <br/> -## Experience Users +## Experience Views -Schema for a collection of Experience Users +Schema for a collection of Experience Views -### <a name="experience-users-schema"></a> Schema +### <a name="experience-views-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "items": { "type": "array", "items": { - "title": "Experience User", - "description": "Schema for a single Experience User", + "title": "Experience View", + "description": "Schema for a single Experience View", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, - "experienceUserId": { + "experienceViewId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, "applicationId": { "type": "string", @@ -7806,66 +8425,54 @@ }, "lastUpdated": { "type": "string", "format": "date-time" }, - "passwordLastUpdated": { + "name": { "type": "string", - "format": "date-time" + "minLength": 1, + "maxLength": 255 }, - "lastLogin": { + "description": { "type": "string", - "format": "date-time" + "maxLength": 32767 }, - "email": { + "viewType": { "type": "string", - "format": "email", - "maxLength": 1024 + "enum": [ + "layout", + "page", + "component" + ] }, - "firstName": { - "type": "string", - "maxLength": 1024 + "layoutId": { + "type": [ + "string", + "null" + ], + "pattern": "^[A-Fa-f\\d]{24}$" }, - "lastName": { + "layoutName": { "type": "string", - "maxLength": 1024 + "minLength": 1, + "maxLength": 255 }, - "avatarUrl": { + "body": { "type": "string", - "format": "url" + "maxLength": 131072, + "minLength": 1 }, - "tokenCutoff": { - "type": "string", - "format": "date-time" - }, - "userTags": { + "viewTags": { "type": "object", "patternProperties": { "^[0-9a-zA-Z_-]{1,255}$": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "experienceGroups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "id": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - } - } - } } } } }, "count": { @@ -7898,35 +8505,37 @@ }, "applicationId": { "type": "string", "pattern": "^[A-Fa-f\\d]{24}$" }, - "experienceGroupId": { + "viewType": { "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "enum": [ + "layout", + "page", + "component" + ] } } } ``` -### <a name="experience-users-example"></a> Example +### <a name="experience-views-example"></a> Example ```json { "items": [ { - "id": "58b9d782cbfafe1be675744d", - "experienceUserId": "58b9d782cbfafe1be675744d", + "id": "59cc5c628246c6caed4b16c1", + "experienceViewId": "59cc5c628246c6caed4b16c1", "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", - "firstName": "Example", - "lastName": "Name", - "avatarUrl": "https://example.avatar.url/is_here.png", - "userTags": { + "name": "My Page View", + "viewType": "page", + "body": "<p>{{data}}</p>", + "layoutId": "59cc5cad8246c6caed4b16c2", + "viewTags": { "customKey": "customValue" } } ], "count": 1, @@ -10680,20 +11289,23 @@ "type": "number" }, "devicerecipe": { "type": "number" }, + "experiencedomain": { + "type": "number" + }, "experienceendpoint": { "type": "number" }, "experiencegroup": { "type": "number" }, - "experiencetemplate": { + "experienceuser": { "type": "number" }, - "experienceuser": { + "experienceview": { "type": "number" }, "flow": { "type": "number" }, @@ -10846,20 +11458,23 @@ "type": "number" }, "deviceRecipeCount": { "type": "number" }, + "experienceDomainCount": { + "type": "number" + }, "experienceEndpointCount": { "type": "number" }, "experienceGroupCount": { "type": "number" }, - "experienceTemplateCount": { + "experienceUserCount": { "type": "number" }, - "experienceUserCount": { + "experienceViewCount": { "type": "number" }, "flowCount": { "type": "number" }, @@ -11293,20 +11908,23 @@ "type": "number" }, "devicerecipe": { "type": "number" }, + "experiencedomain": { + "type": "number" + }, "experienceendpoint": { "type": "number" }, "experiencegroup": { "type": "number" }, - "experiencetemplate": { + "experienceuser": { "type": "number" }, - "experienceuser": { + "experienceview": { "type": "number" }, "flow": { "type": "number" }, @@ -11351,20 +11969,23 @@ "type": "number" }, "deviceRecipeCount": { "type": "number" }, + "experienceDomainCount": { + "type": "number" + }, "experienceEndpointCount": { "type": "number" }, "experienceGroupCount": { "type": "number" }, - "experienceTemplateCount": { + "experienceUserCount": { "type": "number" }, - "experienceUserCount": { + "experienceViewCount": { "type": "number" }, "flowCount": { "type": "number" }, @@ -12058,20 +12679,23 @@ "type": "number" }, "devicerecipe": { "type": "number" }, + "experiencedomain": { + "type": "number" + }, "experienceendpoint": { "type": "number" }, "experiencegroup": { "type": "number" }, - "experiencetemplate": { + "experienceuser": { "type": "number" }, - "experienceuser": { + "experienceview": { "type": "number" }, "flow": { "type": "number" }, @@ -12116,20 +12740,23 @@ "type": "number" }, "deviceRecipeCount": { "type": "number" }, + "experienceDomainCount": { + "type": "number" + }, "experienceEndpointCount": { "type": "number" }, "experienceGroupCount": { "type": "number" }, - "experienceTemplateCount": { + "experienceUserCount": { "type": "number" }, - "experienceUserCount": { + "experienceViewCount": { "type": "number" }, "flowCount": { "type": "number" }, @@ -13037,10 +13664,14 @@ }, "avatarUrl": { "type": "string", "format": "url" }, + "tokenCutoff": { + "type": "string", + "format": "date-time" + }, "accessRestrictions": { "type": "object", "properties": { "dashboardIds": { "type": "array", @@ -13188,10 +13819,14 @@ "twoFactorAuthKey": { "type": "string", "minLength": 52, "maxLength": 52 }, + "tokenCutoff": { + "type": "string", + "format": "date-time" + }, "accessRestrictions": { "type": "object", "properties": { "dashboardIds": { "type": "array", @@ -13272,10 +13907,14 @@ "twoFactorAuthKey": { "type": "string", "minLength": 52, "maxLength": 52 }, + "tokenCutoff": { + "type": "string", + "format": "date-time" + }, "accessRestrictions": { "type": "object", "properties": { "dashboardIds": { "type": "array", @@ -13408,9 +14047,13 @@ "type": "boolean" }, "avatarUrl": { "type": "string", "format": "url" + }, + "tokenCutoff": { + "type": "string", + "format": "date-time" }, "accessRestrictions": { "type": "object", "properties": { "dashboardIds": {