losant_rest 1.3.3 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.markdownlint.json +11 -0
- data/README.md +139 -231
- data/docs/_schemas.md +1036 -393
- data/docs/dataTableRows.md +41 -0
- data/docs/deviceRecipe.md +1 -0
- data/docs/{experienceTemplate.md → experienceDomain.md} +25 -25
- data/docs/experienceDomains.md +85 -0
- data/docs/experienceView.md +130 -0
- data/docs/{experienceTemplates.md → experienceViews.md} +15 -15
- data/docs/me.md +36 -0
- data/lib/losant_rest.rb +4 -2
- data/lib/losant_rest/client.rb +18 -10
- data/lib/losant_rest/data_table_rows.rb +48 -0
- data/lib/losant_rest/device_recipe.rb +1 -0
- data/lib/losant_rest/{experience_template.rb → experience_domain.rb} +26 -26
- data/lib/losant_rest/experience_domains.rb +124 -0
- data/lib/losant_rest/experience_view.rb +174 -0
- data/lib/losant_rest/{experience_templates.rb → experience_views.rb} +16 -16
- data/lib/losant_rest/me.rb +44 -0
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/application.json +34 -2
- data/schemas/applicationApiTokenPost.json +14 -7
- data/schemas/applicationPatch.json +29 -0
- data/schemas/applications.json +34 -2
- data/schemas/auditLog.json +2 -1
- data/schemas/auditLogFilter.json +2 -1
- data/schemas/auditLogs.json +2 -1
- data/schemas/changePassword.json +28 -0
- data/schemas/dataTableRowsExport.json +36 -0
- data/schemas/deviceRecipeBulkCreateEnqueued.json +9 -0
- data/schemas/deviceRecipeBulkCreatePost.json +5 -0
- data/schemas/experienceDomain.json +41 -0
- data/schemas/experienceDomainPatch.json +27 -0
- data/schemas/experienceDomainPost.json +30 -0
- data/schemas/experienceDomains.json +61 -0
- data/schemas/experienceEndpoint.json +11 -0
- data/schemas/experienceEndpointPatch.json +11 -0
- data/schemas/experienceEndpointPost.json +11 -0
- data/schemas/experienceEndpoints.json +11 -0
- data/schemas/experienceGroup.json +11 -0
- data/schemas/experienceGroupPatch.json +11 -0
- data/schemas/experienceGroupPost.json +11 -0
- data/schemas/experienceGroups.json +11 -0
- data/schemas/{experienceTemplate.json → experienceView.json} +8 -3
- data/schemas/{experienceTemplatePatch.json → experienceViewPatch.json} +1 -1
- data/schemas/{experienceTemplatePost.json → experienceViewPost.json} +3 -3
- data/schemas/{experienceTemplates.json → experienceViews.json} +11 -6
- data/schemas/me.json +10 -4
- data/schemas/org.json +10 -4
- data/schemas/orgs.json +10 -4
- data/schemas/solutionUser.json +4 -0
- data/schemas/solutionUserPatch.json +4 -0
- data/schemas/solutionUserPost.json +4 -0
- data/schemas/solutionUsers.json +4 -0
- metadata +22 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f694a4207f01979eccdf4a9efc3fd8716295957f
|
4
|
+
data.tar.gz: 9d4dfc759fbc43209d77e4b4657241823b172c55
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 93b7bdb6c393c2afc90e5dc95e858d34967ab3574621976c0b06358616a203e8a2e607237e0ca63883e5f87f3cecad292d22f7bbc40f8bf3776e83c3229b0989
|
7
|
+
data.tar.gz: ce6904bb8ac7ce290289ae512a93400f584df880a6384b21ed13323f016f693c7281814daec4f3101f9f2c51336e59f4a8132a400b23424518061bcc40e6f54d
|
data/.markdownlint.json
ADDED
data/README.md
CHANGED
@@ -2,14 +2,9 @@
|
|
2
2
|
|
3
3
|
[![Build Status](https://travis-ci.org/Losant/losant-rest-ruby.svg?branch=master)](https://travis-ci.org/Losant/losant-rest-ruby) [![Gem Version](https://badge.fury.io/rb/losant_rest.svg)](https://badge.fury.io/rb/losant_rest)
|
4
4
|
|
5
|
-
The [Losant](https://www.losant.com) REST API client provides a simple way to
|
6
|
-
use the comprehensive Losant API. You can authenticate either as a Losant
|
7
|
-
device or with your user account, and have access to all the functionality
|
8
|
-
of the Losant platform.
|
5
|
+
The [Losant](https://www.losant.com) REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.
|
9
6
|
|
10
|
-
This client works with Ruby 2.1 and higher. It uses
|
11
|
-
[HTTParty](https://github.com/jnunemaker/httparty) under the
|
12
|
-
covers for the actual HTTP communication.
|
7
|
+
This client works with Ruby 2.1 and higher. It uses [HTTParty](https://github.com/jnunemaker/httparty) under the covers for the actual HTTP communication.
|
13
8
|
|
14
9
|
<br/>
|
15
10
|
|
@@ -25,8 +20,7 @@ gem install losant_rest
|
|
25
20
|
|
26
21
|
## Example
|
27
22
|
|
28
|
-
Below is a high-level example of using the Losant Ruby REST API client to
|
29
|
-
authenticate against the Losant Platform and report state for a device.
|
23
|
+
Below is a high-level example of using the Losant Ruby REST API client to authenticate against the Losant Platform and report state for a device.
|
30
24
|
|
31
25
|
```ruby
|
32
26
|
require "losant_rest"
|
@@ -54,10 +48,7 @@ puts response
|
|
54
48
|
|
55
49
|
### LosantRest
|
56
50
|
|
57
|
-
LosantRest is the wrapping module, but it also acts as a singleton [Client](#losantrestclient)
|
58
|
-
instance. So if you only need a single client instance, you do not need to
|
59
|
-
instantiate one yourself - the LosantRest module will act exactly like an
|
60
|
-
instance of LosantRest::Client.
|
51
|
+
LosantRest is the wrapping module, but it also acts as a singleton [Client](#losantrestclient) instance. So if you only need a single client instance, you do not need to instantiate one yourself - the LosantRest module will act exactly like an instance of LosantRest::Client.
|
61
52
|
|
62
53
|
<br/>
|
63
54
|
|
@@ -74,240 +65,157 @@ LosantRest::Client.new(auth_token: nil, url: "https://api.losant.com")
|
|
74
65
|
|
75
66
|
The ``Client()`` initializer takes the following arguments:
|
76
67
|
|
77
|
-
*
|
78
|
-
The access token to be used for authentication - by default there is no
|
79
|
-
access token. An access token can be acquired through any of the
|
80
|
-
[Auth](docs/auth.md) methods, or can be created for a particular application
|
81
|
-
through [application_api_tokens](docs/applicationApiTokens.md).
|
68
|
+
* auth_token
|
69
|
+
The access token to be used for authentication - by default there is no access token. An access token can be acquired through any of the [Auth](docs/auth.md) methods, or can be created for a particular application through [application_api_tokens](docs/applicationApiTokens.md).
|
82
70
|
|
83
|
-
*
|
84
|
-
The url of the Losant API - by default <https://api.losant.com>.
|
71
|
+
* url
|
72
|
+
The url of the Losant API - by default <https://api.losant.com>.
|
85
73
|
|
86
|
-
#### Accessors
|
74
|
+
#### Client Accessors
|
87
75
|
|
88
|
-
*
|
89
|
-
The access token can be accessed or changed after Client creation
|
90
|
-
through this accessor.
|
76
|
+
* auth_token
|
77
|
+
The access token can be accessed or changed after Client creation through this accessor.
|
91
78
|
|
92
|
-
*
|
93
|
-
The api base url can be accessed or changed after Client creation
|
94
|
-
through this accessor.
|
79
|
+
* url
|
80
|
+
The api base url can be accessed or changed after Client creation through this accessor.
|
95
81
|
|
96
82
|
#### Resources
|
97
83
|
|
98
|
-
Each of the following is a method on the client object, and returns a wrapper
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
Api
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
as listing all
|
111
|
-
|
112
|
-
*
|
113
|
-
Contains all the actions that can be performed against a single
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
[
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
[
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
*
|
140
|
-
Contains all of the actions that can be performed against a
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
*
|
146
|
-
Contains all of the actions that can be performed against the set of
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
*
|
152
|
-
Contains the actions
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
[
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
[
|
164
|
-
to an Application - such as listing
|
165
|
-
|
166
|
-
*
|
167
|
-
Contains all the actions that can be performed against a single
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
[
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
[
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
[
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
[
|
197
|
-
|
198
|
-
|
199
|
-
*
|
200
|
-
Contains all the actions that can be performed against a single
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
[
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
[
|
212
|
-
|
213
|
-
|
214
|
-
*
|
215
|
-
Contains all the actions that can be performed against the collection of
|
216
|
-
[Experience Endpoints](https://docs.losant.com/experiences/endpoints/) belonging
|
217
|
-
to an Application - such as listing endpoints or creating a new endpoint.
|
218
|
-
|
219
|
-
* [experience_group](docs/experienceGroup.md)
|
220
|
-
Contains all the actions that can be performed against a single
|
221
|
-
[Experience Group](https://docs.losant.com/experiences/groups/), such as updating member information.
|
222
|
-
|
223
|
-
* [experience_groups](docs/experienceGroups.md)
|
224
|
-
Contains all the actions that can be performed against the collection of
|
225
|
-
[Experience Groups](https://docs.losant.com/experiences/groups/) belonging
|
226
|
-
to an Application - such as listing groups or creating a new group.
|
227
|
-
|
228
|
-
* [experience_user](docs/experienceUser.md)
|
229
|
-
Contains all the actions that can be performed against a single
|
230
|
-
[Experience User](https://docs.losant.com/experiences/users/), such as changing their email
|
231
|
-
or password.
|
232
|
-
|
233
|
-
* [experience_users](docs/experienceUsers.md)
|
234
|
-
Contains all the actions that can be performed against the collection of
|
235
|
-
[Experience Users](https://docs.losant.com/experiences/users/) belonging
|
236
|
-
to an Application - such as listing users or creating a new user.
|
237
|
-
|
238
|
-
* [flow](docs/flow.md)
|
239
|
-
Contains all the actions that can be performed against a single
|
240
|
-
[Workflow](https://docs.losant.com/workflows/overview/), such as enabling or
|
241
|
-
disabling a workflow, or triggering a virtual button in the workflow.
|
242
|
-
|
243
|
-
* [flows](docs/flows.md)
|
244
|
-
Contains all the actions that can be performed against the collection of
|
245
|
-
[Workflows](https://docs.losant.com/workflows/overview/) belonging
|
246
|
-
to an Application - such as listing the workflows or creating a new workflow.
|
247
|
-
|
248
|
-
* [flow_version](docs/flowVersion.md)
|
249
|
-
Contains all the actions that can be performed against a single
|
250
|
-
[Workflow Version](https://docs.losant.com/workflows/versioning/), such as enabling or
|
251
|
-
disabling a workflow version, or updating the version notes.
|
252
|
-
|
253
|
-
* [flow_versions](docs/flowVersions.md)
|
254
|
-
Contains all the actions that can be performed against the collection of
|
255
|
-
[Workflow Versions](https://docs.losant.com/workflows/versioning/) belonging
|
256
|
-
to a Workflow - such as listing the versions or creating a new version.
|
257
|
-
|
258
|
-
* [integration](docs/integration.md)
|
259
|
-
Contains all the actions that can be performed against a single
|
260
|
-
[Integration](https://docs.losant.com/applications/integrations/), which
|
261
|
-
include things like removing an integration or updating integration configuration.
|
262
|
-
|
263
|
-
* [integrations](docs/integrations.md)
|
264
|
-
Contains all the actions that can be performed against the collection of
|
265
|
-
[Integrations](https://docs.losant.com/applications/integrations/) belonging
|
266
|
-
to an Application - such as listing integrations or creating a new integration.
|
267
|
-
|
268
|
-
* [me](docs/me.md)
|
269
|
-
Contains the actions for operating against the currently authenticated
|
270
|
-
[User](https://docs.losant.com/user-accounts/overview/) such as changing
|
271
|
-
the password or linking against external services.
|
272
|
-
|
273
|
-
* [org](docs/org.md)
|
274
|
-
Contains all the actions that can be performed against a single
|
275
|
-
[Organization](https://docs.losant.com/organizations/overview/), things like
|
276
|
-
inviting a user to the organization, or modifying the organization.
|
277
|
-
|
278
|
-
* [orgs](docs/orgs.md)
|
279
|
-
Contains all of the actions that can be performed against the set of
|
280
|
-
[Organizations](https://docs.losant.com/organizations/overview/) that the
|
281
|
-
currently authenticated user has access to - such as
|
282
|
-
listing the organizations or creating a new organization.
|
283
|
-
|
284
|
-
* [webhook](docs/webhook.md)
|
285
|
-
Contains all the actions that can be performed against a single
|
286
|
-
[Webhook](https://docs.losant.com/applications/webhooks/), for instance
|
287
|
-
modifying the verification settings or removing the webhook.
|
288
|
-
|
289
|
-
* [webhooks](docs/webhooks.md)
|
290
|
-
Contains all the actions that can be performed against the collection of
|
291
|
-
[Webhooks](https://docs.losant.com/applications/webhooks/) belonging
|
292
|
-
to an Application - such as listing the webhooks or creating a new webhook.
|
84
|
+
Each of the following is a method on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.
|
85
|
+
|
86
|
+
* [application_api_token](docs/applicationApiToken.md)
|
87
|
+
Contains all the actions that can be performed against a single [Api Token](https://docs.losant.com/applications/application-tokens/) belonging to an application - for instance, getting info on a single token or revoking a token.
|
88
|
+
|
89
|
+
* [application_api_tokens](docs/applicationApiTokens.md)
|
90
|
+
Contains all of the actions that can be performed against the collection of [Api Tokens](https://docs.losant.com/applications/application-tokens/) belonging to an Application - such as listing all tokens or creating a new token.
|
91
|
+
|
92
|
+
* [application_key](docs/applicationKey.md)
|
93
|
+
Contains all the actions that can be performed against a single [Application Key](https://docs.losant.com/applications/access-keys/) - for instance, getting info on a single key or revoking a key.
|
94
|
+
|
95
|
+
* [application_keys](docs/applicationKeys.md)
|
96
|
+
Contains all of the actions that can be performed against the collection of [Application Keys](https://docs.losant.com/applications/access-keys/) belonging to an Application - such as listing all keys or creating a new key.
|
97
|
+
|
98
|
+
* [application](docs/application.md)
|
99
|
+
Contains all of the actions that can be performed against a single [Application](https://docs.losant.com/applications/overview/), which include things like getting info on an application or modifying an application.
|
100
|
+
|
101
|
+
* [applications](docs/applications.md)
|
102
|
+
Contains all of the actions that can be performed against the set of [Applications](https://docs.losant.com/applications/overview/) that the currently authenticated user has access to - such as listing the applications or creating a new application.
|
103
|
+
|
104
|
+
* [auth](docs/auth.md)
|
105
|
+
Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.
|
106
|
+
|
107
|
+
* [dashboard](docs/dashboard.md)
|
108
|
+
Contains all of the actions that can be performed against a single [Dashboard](https://docs.losant.com/dashboards/overview/), which include things like getting info on a dashboard or modifying a dashboard.
|
109
|
+
|
110
|
+
* [dashboards](docs/dashboards.md)
|
111
|
+
Contains all of the actions that can be performed against the set of [Dashboards](https://docs.losant.com/dashboards/overview/) that the currently authenticated user has access to - such as listing the dashboards or creating a new dashboard.
|
112
|
+
|
113
|
+
* [data](docs/data.md)
|
114
|
+
Contains the actions for querying against historical Device data across an Application.
|
115
|
+
|
116
|
+
* [data_table](docs/dataTable.md)
|
117
|
+
Contains all the actions that can be performed against a single [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting info on a single data table or modifying the columns of a data table.
|
118
|
+
|
119
|
+
* [data_tables](docs/dataTables.md)
|
120
|
+
Contains all of the actions that can be performed against the collection of [Data Tables](https://docs.losant.com/data-tables/overview/) belonging to an Application - such as listing all data tables or creating a new data table.
|
121
|
+
|
122
|
+
* [data_table_row](docs/dataTableRow.md)
|
123
|
+
Contains all the actions that can be performed against a single row inside of a [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting the contents of a row, or modifying a row.
|
124
|
+
|
125
|
+
* [data_table_rows](docs/dataTableRows.md)
|
126
|
+
Contains all of the actions that can be performed against the collection of rows that make up a [Data Table](https://docs.losant.com/data-tables/overview/) - such as querying for rows in that table, or adding a new row to the table.
|
127
|
+
|
128
|
+
* [device](docs/device.md)
|
129
|
+
Contains all the actions that can be performed against a single [Device](https://docs.losant.com/devices/overview/) - for instance, getting info on a single device or reporting the current state of a device.
|
130
|
+
|
131
|
+
* [devices](docs/devices.md)
|
132
|
+
Contains all of the actions that can be performed against the collection of [Devices](https://docs.losant.com/devices/overview/) belonging to an Application - such as listing all devices or sending a command to a set of devices.
|
133
|
+
|
134
|
+
* [device_recipe](docs/deviceRecipe.md)
|
135
|
+
Contains all the actions that can be performed against a single [Device Recipe](https://docs.losant.com/devices/device-recipes/), which include things like removing a device recipe or creating a device from a device recipe.
|
136
|
+
|
137
|
+
* [device_recipes](docs/deviceRecipes.md)
|
138
|
+
Contains all the actions that can be performed against the collection of [Device Recipes](https://docs.losant.com/devices/device-recipes/) belonging to an Application - such as listing recipes or creating a new recipe.
|
139
|
+
|
140
|
+
* [event](docs/event.md)
|
141
|
+
Contains all the actions that can be performed against a single [Event](https://docs.losant.com/events/overview/), such as commenting on or changing the state of an event.
|
142
|
+
|
143
|
+
* [events](docs/events.md)
|
144
|
+
Contains all the actions that can be performed against the collection of [Events](https://docs.losant.com/events/overview/) belonging to an Application - such as listing open events or creating a new event.
|
145
|
+
|
146
|
+
* [experience_endpoint](docs/experienceEndpoint.md)
|
147
|
+
Contains all the actions that can be performed against a single [Experience Endpoint](https://docs.losant.com/experiences/endpoints/), such as updating route information.
|
148
|
+
|
149
|
+
* [experience_endpoints](docs/experienceEndpoints.md)
|
150
|
+
Contains all the actions that can be performed against the collection of [Experience Endpoints](https://docs.losant.com/experiences/endpoints/) belonging to an Application - such as listing endpoints or creating a new endpoint.
|
151
|
+
|
152
|
+
* [experience_group](docs/experienceGroup.md)
|
153
|
+
Contains all the actions that can be performed against a single [Experience Group](https://docs.losant.com/experiences/groups/), such as updating member information.
|
154
|
+
|
155
|
+
* [experience_groups](docs/experienceGroups.md)
|
156
|
+
Contains all the actions that can be performed against the collection of [Experience Groups](https://docs.losant.com/experiences/groups/) belonging to an Application - such as listing groups or creating a new group.
|
157
|
+
|
158
|
+
* [experience_user](docs/experienceUser.md)
|
159
|
+
Contains all the actions that can be performed against a single [Experience User](https://docs.losant.com/experiences/users/), such as changing their email or password.
|
160
|
+
|
161
|
+
* [experience_users](docs/experienceUsers.md)
|
162
|
+
Contains all the actions that can be performed against the collection of [Experience Users](https://docs.losant.com/experiences/users/) belonging to an Application - such as listing users or creating a new user.
|
163
|
+
|
164
|
+
* [experience_view](docs/experienceView.md)
|
165
|
+
Contains all the actions that can be performed against a single [Experience View](https://docs.losant.com/experiences/views/), such as modifying the body template.
|
166
|
+
|
167
|
+
* [experience_views](docs/experienceViews.md)
|
168
|
+
Contains all the actions that can be performed against the collection of [Experience Views](https://docs.losant.com/experiences/views/) belonging to an Application - such as listing views or creating a new view.
|
169
|
+
|
170
|
+
* [flow](docs/flow.md)
|
171
|
+
Contains all the actions that can be performed against a single [Workflow](https://docs.losant.com/workflows/overview/), such as enabling or disabling a workflow, or triggering a virtual button in the workflow.
|
172
|
+
|
173
|
+
* [flows](docs/flows.md)
|
174
|
+
Contains all the actions that can be performed against the collection of [Workflows](https://docs.losant.com/workflows/overview/) belonging to an Application - such as listing the workflows or creating a new workflow.
|
175
|
+
|
176
|
+
* [flow_version](docs/flowVersion.md)
|
177
|
+
Contains all the actions that can be performed against a single [Workflow Version](https://docs.losant.com/workflows/versioning/), such as enabling or disabling a workflow version, or updating the version notes.
|
178
|
+
|
179
|
+
* [flow_versions](docs/flowVersions.md)
|
180
|
+
Contains all the actions that can be performed against the collection of [Workflow Versions](https://docs.losant.com/workflows/versioning/) belonging to a Workflow - such as listing the versions or creating a new version.
|
181
|
+
|
182
|
+
* [me](docs/me.md)
|
183
|
+
Contains the actions for operating against the currently authenticated [User](https://docs.losant.com/user-accounts/overview/) such as changing the password or linking against external services.
|
184
|
+
|
185
|
+
* [integration](docs/integration.md)
|
186
|
+
Contains all the actions that can be performed against a single [Integration](https://docs.losant.com/applications/integrations/), which include things like removing an integration or updating integration configuration.
|
187
|
+
|
188
|
+
* [integrations](docs/integrations.md)
|
189
|
+
Contains all the actions that can be performed against the collection of [Integrations](https://docs.losant.com/applications/integrations/) belonging to an Application - such as listing integrations or creating a new integration.
|
190
|
+
|
191
|
+
* [org](docs/org.md)
|
192
|
+
Contains all the actions that can be performed against a single [Organization](https://docs.losant.com/organizations/overview/), things like inviting a user to the organization, or modifying the organization.
|
193
|
+
|
194
|
+
* [orgs](docs/orgs.md)
|
195
|
+
Contains all of the actions that can be performed against the set of [Organizations](https://docs.losant.com/organizations/overview/) that the currently authenticated user has access to - such as listing the organizations or creating a new organization.
|
196
|
+
|
197
|
+
* [webhook](docs/webhook.md)
|
198
|
+
Contains all the actions that can be performed against a single [Webhook](https://docs.losant.com/applications/webhooks/), for instance modifying the verification settings or removing the webhook.
|
199
|
+
|
200
|
+
* [webhooks](docs/webhooks.md)
|
201
|
+
Contains all the actions that can be performed against the collection of [Webhooks](https://docs.losant.com/applications/webhooks/) belonging to an Application - such as listing the webhooks or creating a new webhook.
|
293
202
|
|
294
203
|
<br/>
|
295
204
|
|
296
205
|
### LosantRest::ResponseError
|
297
206
|
|
298
|
-
When the Losant API returns a unsuccessful response, an instance of
|
299
|
-
ResponseError is thrown.
|
207
|
+
When the Losant API returns a unsuccessful response, an instance of ResponseError is thrown.
|
300
208
|
|
301
|
-
#### Accessors
|
209
|
+
#### ResponseError Accessors
|
302
210
|
|
303
|
-
*
|
304
|
-
The status code returned from the Losant API.
|
211
|
+
* code
|
212
|
+
The status code returned from the Losant API.
|
305
213
|
|
306
|
-
*
|
307
|
-
The type of error that
|
214
|
+
* type
|
215
|
+
The type of error that occurred, such as "Validation" or "Authorization".
|
308
216
|
|
309
|
-
*
|
310
|
-
A more detailed message about the particulars of the error.
|
217
|
+
* message
|
218
|
+
A more detailed message about the particulars of the error.
|
311
219
|
|
312
220
|
<br/>
|
313
221
|
|
data/docs/_schemas.md
CHANGED
@@ -18,6 +18,7 @@
|
|
18
18
|
* [Authenticated Device](#authenticated-device)
|
19
19
|
* [Authenticated Solution User](#authenticated-solution-user)
|
20
20
|
* [Authenticated User](#authenticated-user)
|
21
|
+
* [Change Password](#change-password)
|
21
22
|
* [Composite Device State](#composite-device-state)
|
22
23
|
* [Dashboard](#dashboard)
|
23
24
|
* [Dashboard Context Instance](#dashboard-context-instance)
|
@@ -32,6 +33,7 @@
|
|
32
33
|
* [Data Table Row](#data-table-row)
|
33
34
|
* [Data Table Row Insert/Update](#data-table-row-insert/update)
|
34
35
|
* [Data Table Rows](#data-table-rows)
|
36
|
+
* [Data Table Export](#data-table-export)
|
35
37
|
* [Data Tables](#data-tables)
|
36
38
|
* [Device](#device)
|
37
39
|
* [Device Command](#device-command)
|
@@ -42,6 +44,7 @@
|
|
42
44
|
* [Device Post](#device-post)
|
43
45
|
* [Device Recipe](#device-recipe)
|
44
46
|
* [Device Recipe Bulk Create](#device-recipe-bulk-create)
|
47
|
+
* [Device Recipe Bulk Create Enqueue](#device-recipe-bulk-create-enqueue)
|
45
48
|
* [Device Recipe Bulk Create Post](#device-recipe-bulk-create-post)
|
46
49
|
* [Device Recipe Patch](#device-recipe-patch)
|
47
50
|
* [Device Recipe Post](#device-recipe-post)
|
@@ -57,6 +60,10 @@
|
|
57
60
|
* [Event Patch](#event-patch)
|
58
61
|
* [Event Post](#event-post)
|
59
62
|
* [Events](#events)
|
63
|
+
* [Experience Domain](#experience-domain)
|
64
|
+
* [Experience Domain Patch](#experience-domain-patch)
|
65
|
+
* [Experience Domain Post](#experience-domain-post)
|
66
|
+
* [Experience Domains](#experience-domains)
|
60
67
|
* [Experience Endpoint](#experience-endpoint)
|
61
68
|
* [Experience Endpoint Patch](#experience-endpoint-patch)
|
62
69
|
* [Experience Endpoint Post](#experience-endpoint-post)
|
@@ -66,14 +73,14 @@
|
|
66
73
|
* [Experience Group Patch](#experience-group-patch)
|
67
74
|
* [Experience Group Post](#experience-group-post)
|
68
75
|
* [Experience Groups](#experience-groups)
|
69
|
-
* [Experience Template](#experience-template)
|
70
|
-
* [Experience Template Patch](#experience-template-patch)
|
71
|
-
* [Experience Template Post](#experience-template-post)
|
72
|
-
* [Experience Templates](#experience-templates)
|
73
76
|
* [Experience User](#experience-user)
|
74
77
|
* [Experience User Patch](#experience-user-patch)
|
75
78
|
* [Experience User Post](#experience-user-post)
|
76
79
|
* [Experience Users](#experience-users)
|
80
|
+
* [Experience View](#experience-view)
|
81
|
+
* [Experience View Patch](#experience-view-patch)
|
82
|
+
* [Experience View Post](#experience-view-post)
|
83
|
+
* [Experience Views](#experience-views)
|
77
84
|
* [Workflow](#workflow)
|
78
85
|
* [Workflow Log](#workflow-log)
|
79
86
|
* [Workflow Patch](#workflow-patch)
|
@@ -387,16 +394,19 @@ Schema for a single Application
|
|
387
394
|
"eventCount": {
|
388
395
|
"type": "number"
|
389
396
|
},
|
397
|
+
"experienceDomainCount": {
|
398
|
+
"type": "number"
|
399
|
+
},
|
390
400
|
"experienceEndpointCount": {
|
391
401
|
"type": "number"
|
392
402
|
},
|
393
403
|
"experienceGroupCount": {
|
394
404
|
"type": "number"
|
395
405
|
},
|
396
|
-
"
|
406
|
+
"experienceUserCount": {
|
397
407
|
"type": "number"
|
398
408
|
},
|
399
|
-
"
|
409
|
+
"experienceViewCount": {
|
400
410
|
"type": "number"
|
401
411
|
},
|
402
412
|
"flowCount": {
|
@@ -409,6 +419,35 @@ Schema for a single Application
|
|
409
419
|
"type": "number"
|
410
420
|
}
|
411
421
|
}
|
422
|
+
},
|
423
|
+
"ftueTracking": {
|
424
|
+
"type": "array",
|
425
|
+
"items": {
|
426
|
+
"type": "object",
|
427
|
+
"properties": {
|
428
|
+
"name": {
|
429
|
+
"type": "string",
|
430
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
431
|
+
},
|
432
|
+
"version": {
|
433
|
+
"type": "number"
|
434
|
+
},
|
435
|
+
"status": {
|
436
|
+
"type": "string",
|
437
|
+
"enum": [
|
438
|
+
"skipped",
|
439
|
+
"completed"
|
440
|
+
]
|
441
|
+
}
|
442
|
+
},
|
443
|
+
"required": [
|
444
|
+
"name",
|
445
|
+
"version",
|
446
|
+
"status"
|
447
|
+
],
|
448
|
+
"additionalProperties": false
|
449
|
+
},
|
450
|
+
"maxItems": 100
|
412
451
|
}
|
413
452
|
}
|
414
453
|
}
|
@@ -485,14 +524,16 @@ Schema for the body of an Application API Token creation request
|
|
485
524
|
"devices.*",
|
486
525
|
"event.*",
|
487
526
|
"events.*",
|
527
|
+
"experienceDomain.*",
|
528
|
+
"experienceDomains.*",
|
488
529
|
"experienceEndpoint.*",
|
489
530
|
"experienceEndpoints.*",
|
490
531
|
"experienceGroup.*",
|
491
532
|
"experienceGroups.*",
|
492
|
-
"experienceTemplate.*",
|
493
|
-
"experienceTemplates.*",
|
494
533
|
"experienceUser.*",
|
495
534
|
"experienceUsers.*",
|
535
|
+
"experienceView.*",
|
536
|
+
"experienceViews.*",
|
496
537
|
"integration.*",
|
497
538
|
"integrations.*",
|
498
539
|
"flow.*",
|
@@ -558,6 +599,11 @@ Schema for the body of an Application API Token creation request
|
|
558
599
|
"events.mostRecentBySeverity",
|
559
600
|
"events.patch",
|
560
601
|
"events.post",
|
602
|
+
"experienceDomain.delete",
|
603
|
+
"experienceDomain.get",
|
604
|
+
"experienceDomain.patch",
|
605
|
+
"experienceDomains.get",
|
606
|
+
"experienceDomains.post",
|
561
607
|
"experienceEndpoint.delete",
|
562
608
|
"experienceEndpoint.get",
|
563
609
|
"experienceEndpoint.patch",
|
@@ -569,16 +615,16 @@ Schema for the body of an Application API Token creation request
|
|
569
615
|
"experienceGroup.patch",
|
570
616
|
"experienceGroups.get",
|
571
617
|
"experienceGroups.post",
|
572
|
-
"experienceTemplate.delete",
|
573
|
-
"experienceTemplate.get",
|
574
|
-
"experienceTemplate.patch",
|
575
|
-
"experienceTemplates.get",
|
576
|
-
"experienceTemplates.post",
|
577
618
|
"experienceUser.delete",
|
578
619
|
"experienceUser.get",
|
579
620
|
"experienceUser.patch",
|
580
621
|
"experienceUsers.get",
|
581
622
|
"experienceUsers.post",
|
623
|
+
"experienceView.delete",
|
624
|
+
"experienceView.get",
|
625
|
+
"experienceView.patch",
|
626
|
+
"experienceViews.get",
|
627
|
+
"experienceViews.post",
|
582
628
|
"flow.delete",
|
583
629
|
"flow.clearStorageEntries",
|
584
630
|
"flow.get",
|
@@ -1118,6 +1164,35 @@ Schema for the body of an Application modification request
|
|
1118
1164
|
"json"
|
1119
1165
|
]
|
1120
1166
|
}
|
1167
|
+
},
|
1168
|
+
"ftueTracking": {
|
1169
|
+
"type": "array",
|
1170
|
+
"items": {
|
1171
|
+
"type": "object",
|
1172
|
+
"properties": {
|
1173
|
+
"name": {
|
1174
|
+
"type": "string",
|
1175
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
1176
|
+
},
|
1177
|
+
"version": {
|
1178
|
+
"type": "number"
|
1179
|
+
},
|
1180
|
+
"status": {
|
1181
|
+
"type": "string",
|
1182
|
+
"enum": [
|
1183
|
+
"skipped",
|
1184
|
+
"completed"
|
1185
|
+
]
|
1186
|
+
}
|
1187
|
+
},
|
1188
|
+
"required": [
|
1189
|
+
"name",
|
1190
|
+
"version",
|
1191
|
+
"status"
|
1192
|
+
],
|
1193
|
+
"additionalProperties": false
|
1194
|
+
},
|
1195
|
+
"maxItems": 100
|
1121
1196
|
}
|
1122
1197
|
},
|
1123
1198
|
"additionalProperties": false
|
@@ -1323,16 +1398,19 @@ Schema for a collection of Applications
|
|
1323
1398
|
"eventCount": {
|
1324
1399
|
"type": "number"
|
1325
1400
|
},
|
1401
|
+
"experienceDomainCount": {
|
1402
|
+
"type": "number"
|
1403
|
+
},
|
1326
1404
|
"experienceEndpointCount": {
|
1327
1405
|
"type": "number"
|
1328
1406
|
},
|
1329
1407
|
"experienceGroupCount": {
|
1330
1408
|
"type": "number"
|
1331
1409
|
},
|
1332
|
-
"
|
1410
|
+
"experienceUserCount": {
|
1333
1411
|
"type": "number"
|
1334
1412
|
},
|
1335
|
-
"
|
1413
|
+
"experienceViewCount": {
|
1336
1414
|
"type": "number"
|
1337
1415
|
},
|
1338
1416
|
"flowCount": {
|
@@ -1345,6 +1423,35 @@ Schema for a collection of Applications
|
|
1345
1423
|
"type": "number"
|
1346
1424
|
}
|
1347
1425
|
}
|
1426
|
+
},
|
1427
|
+
"ftueTracking": {
|
1428
|
+
"type": "array",
|
1429
|
+
"items": {
|
1430
|
+
"type": "object",
|
1431
|
+
"properties": {
|
1432
|
+
"name": {
|
1433
|
+
"type": "string",
|
1434
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
1435
|
+
},
|
1436
|
+
"version": {
|
1437
|
+
"type": "number"
|
1438
|
+
},
|
1439
|
+
"status": {
|
1440
|
+
"type": "string",
|
1441
|
+
"enum": [
|
1442
|
+
"skipped",
|
1443
|
+
"completed"
|
1444
|
+
]
|
1445
|
+
}
|
1446
|
+
},
|
1447
|
+
"required": [
|
1448
|
+
"name",
|
1449
|
+
"version",
|
1450
|
+
"status"
|
1451
|
+
],
|
1452
|
+
"additionalProperties": false
|
1453
|
+
},
|
1454
|
+
"maxItems": 100
|
1348
1455
|
}
|
1349
1456
|
}
|
1350
1457
|
}
|
@@ -1472,9 +1579,10 @@ Schema for a single Audit Log entry
|
|
1472
1579
|
"Device",
|
1473
1580
|
"DeviceRecipe",
|
1474
1581
|
"Event",
|
1582
|
+
"ExperienceDomain",
|
1475
1583
|
"ExperienceEndpoint",
|
1476
1584
|
"ExperienceGroup",
|
1477
|
-
"
|
1585
|
+
"ExperienceView",
|
1478
1586
|
"ExperienceUser",
|
1479
1587
|
"Flow",
|
1480
1588
|
"SolutionUser",
|
@@ -1618,9 +1726,10 @@ Schema for the filter of an audit log query
|
|
1618
1726
|
"Device",
|
1619
1727
|
"DeviceRecipe",
|
1620
1728
|
"Event",
|
1729
|
+
"ExperienceDomain",
|
1621
1730
|
"ExperienceEndpoint",
|
1622
1731
|
"ExperienceGroup",
|
1623
|
-
"
|
1732
|
+
"ExperienceView",
|
1624
1733
|
"ExperienceUser",
|
1625
1734
|
"Flow",
|
1626
1735
|
"SolutionUser",
|
@@ -1781,9 +1890,10 @@ Schema for a collection of Audit Logs
|
|
1781
1890
|
"Device",
|
1782
1891
|
"DeviceRecipe",
|
1783
1892
|
"Event",
|
1893
|
+
"ExperienceDomain",
|
1784
1894
|
"ExperienceEndpoint",
|
1785
1895
|
"ExperienceGroup",
|
1786
|
-
"
|
1896
|
+
"ExperienceView",
|
1787
1897
|
"ExperienceUser",
|
1788
1898
|
"Flow",
|
1789
1899
|
"SolutionUser",
|
@@ -2040,6 +2150,54 @@ Schema for the successful response when authenticating a User
|
|
2040
2150
|
|
2041
2151
|
<br/>
|
2042
2152
|
|
2153
|
+
## Change Password
|
2154
|
+
|
2155
|
+
Schema for the body of a request to change the current user's password
|
2156
|
+
|
2157
|
+
### <a name="change-password-schema"></a> Schema
|
2158
|
+
|
2159
|
+
```json
|
2160
|
+
{
|
2161
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
2162
|
+
"type": "object",
|
2163
|
+
"properties": {
|
2164
|
+
"twoFactorCode": {
|
2165
|
+
"type": "string",
|
2166
|
+
"maxLength": 2048
|
2167
|
+
},
|
2168
|
+
"password": {
|
2169
|
+
"type": "string",
|
2170
|
+
"minLength": 8,
|
2171
|
+
"maxLength": 2048
|
2172
|
+
},
|
2173
|
+
"newPassword": {
|
2174
|
+
"type": "string",
|
2175
|
+
"minLength": 8,
|
2176
|
+
"maxLength": 2048
|
2177
|
+
},
|
2178
|
+
"invalidateExistingTokens": {
|
2179
|
+
"type": "boolean"
|
2180
|
+
}
|
2181
|
+
},
|
2182
|
+
"required": [
|
2183
|
+
"password",
|
2184
|
+
"newPassword"
|
2185
|
+
],
|
2186
|
+
"additionalProperties": false
|
2187
|
+
}
|
2188
|
+
```
|
2189
|
+
### <a name="change-password-example"></a> Example
|
2190
|
+
|
2191
|
+
```json
|
2192
|
+
{
|
2193
|
+
"newPassword": "yourNewPassword",
|
2194
|
+
"password": "yourCurrentPassword",
|
2195
|
+
"invalidateExistingTokens": true
|
2196
|
+
}
|
2197
|
+
```
|
2198
|
+
|
2199
|
+
<br/>
|
2200
|
+
|
2043
2201
|
## Composite Device State
|
2044
2202
|
|
2045
2203
|
Schema for a composite Device state
|
@@ -3805,6 +3963,75 @@ Schema for a collection of Data Table Rows
|
|
3805
3963
|
|
3806
3964
|
<br/>
|
3807
3965
|
|
3966
|
+
## Data Table Export
|
3967
|
+
|
3968
|
+
Schema for the body of a data table export
|
3969
|
+
|
3970
|
+
### <a name="data-table-export-schema"></a> Schema
|
3971
|
+
|
3972
|
+
```json
|
3973
|
+
{
|
3974
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
3975
|
+
"type": "object",
|
3976
|
+
"properties": {
|
3977
|
+
"email": {
|
3978
|
+
"type": "string",
|
3979
|
+
"format": "email",
|
3980
|
+
"maxLength": 1024
|
3981
|
+
},
|
3982
|
+
"query": {
|
3983
|
+
"$ref": "#/definitions/dataTableQuery"
|
3984
|
+
},
|
3985
|
+
"queryOptions": {
|
3986
|
+
"type": "object",
|
3987
|
+
"properties": {
|
3988
|
+
"sortDirection": {
|
3989
|
+
"type": "string",
|
3990
|
+
"enum": [
|
3991
|
+
"desc",
|
3992
|
+
"asc"
|
3993
|
+
]
|
3994
|
+
},
|
3995
|
+
"limit": {
|
3996
|
+
"type": "number"
|
3997
|
+
},
|
3998
|
+
"sortColumn": {
|
3999
|
+
"type": "string"
|
4000
|
+
},
|
4001
|
+
"offset": {
|
4002
|
+
"type": "number"
|
4003
|
+
}
|
4004
|
+
}
|
4005
|
+
}
|
4006
|
+
},
|
4007
|
+
"additionalProperties": false
|
4008
|
+
}
|
4009
|
+
```
|
4010
|
+
### <a name="data-table-export-example"></a> Example
|
4011
|
+
|
4012
|
+
```json
|
4013
|
+
{
|
4014
|
+
"email": "email@example.com",
|
4015
|
+
"query": {
|
4016
|
+
"$or": [
|
4017
|
+
{
|
4018
|
+
"myCol1": {
|
4019
|
+
"$ne": 0
|
4020
|
+
}
|
4021
|
+
},
|
4022
|
+
{
|
4023
|
+
"myCol2": 5
|
4024
|
+
}
|
4025
|
+
]
|
4026
|
+
},
|
4027
|
+
"queryOptions": {
|
4028
|
+
"limit": 10000
|
4029
|
+
}
|
4030
|
+
}
|
4031
|
+
```
|
4032
|
+
|
4033
|
+
<br/>
|
4034
|
+
|
3808
4035
|
## Data Tables
|
3809
4036
|
|
3810
4037
|
Schema for a collection of Data Tables
|
@@ -4791,6 +5018,33 @@ Schema for the result of a bulk Device creation request
|
|
4791
5018
|
|
4792
5019
|
<br/>
|
4793
5020
|
|
5021
|
+
## Device Recipe Bulk Create Enqueue
|
5022
|
+
|
5023
|
+
Schema for the result of a bulk Device creation request when creating more than 750 devices
|
5024
|
+
|
5025
|
+
### <a name="device-recipe-bulk-create-enqueue-schema"></a> Schema
|
5026
|
+
|
5027
|
+
```json
|
5028
|
+
{
|
5029
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
5030
|
+
"type": "object",
|
5031
|
+
"properties": {
|
5032
|
+
"jobQueued": {
|
5033
|
+
"type": "boolean"
|
5034
|
+
}
|
5035
|
+
}
|
5036
|
+
}
|
5037
|
+
```
|
5038
|
+
### <a name="device-recipe-bulk-create-enqueue-example"></a> Example
|
5039
|
+
|
5040
|
+
```json
|
5041
|
+
{
|
5042
|
+
"jobQueued": true
|
5043
|
+
}
|
5044
|
+
```
|
5045
|
+
|
5046
|
+
<br/>
|
5047
|
+
|
4794
5048
|
## Device Recipe Bulk Create Post
|
4795
5049
|
|
4796
5050
|
Schema for the body of a bulk Device creation request
|
@@ -4813,6 +5067,11 @@ Schema for the body of a bulk Device creation request
|
|
4813
5067
|
},
|
4814
5068
|
"makeUniqueKeySecret": {
|
4815
5069
|
"type": "boolean"
|
5070
|
+
},
|
5071
|
+
"email": {
|
5072
|
+
"type": "string",
|
5073
|
+
"format": "email",
|
5074
|
+
"maxLength": 1024
|
4816
5075
|
}
|
4817
5076
|
},
|
4818
5077
|
"additionalProperties": false,
|
@@ -6327,11 +6586,11 @@ Schema for a collection of Events
|
|
6327
6586
|
|
6328
6587
|
<br/>
|
6329
6588
|
|
6330
|
-
## Experience
|
6589
|
+
## Experience Domain
|
6331
6590
|
|
6332
|
-
Schema for a single Experience
|
6591
|
+
Schema for a single Experience Domain
|
6333
6592
|
|
6334
|
-
### <a name="experience-
|
6593
|
+
### <a name="experience-domain-schema"></a> Schema
|
6335
6594
|
|
6336
6595
|
```json
|
6337
6596
|
{
|
@@ -6342,7 +6601,7 @@ Schema for a single Experience Endpoint
|
|
6342
6601
|
"type": "string",
|
6343
6602
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
6344
6603
|
},
|
6345
|
-
"
|
6604
|
+
"experienceDomainId": {
|
6346
6605
|
"type": "string",
|
6347
6606
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
6348
6607
|
},
|
@@ -6358,103 +6617,366 @@ Schema for a single Experience Endpoint
|
|
6358
6617
|
"type": "string",
|
6359
6618
|
"format": "date-time"
|
6360
6619
|
},
|
6361
|
-
"
|
6362
|
-
"type": "string",
|
6363
|
-
"maxLength": 32767
|
6364
|
-
},
|
6365
|
-
"route": {
|
6620
|
+
"sslCert": {
|
6366
6621
|
"type": "string",
|
6367
|
-
"
|
6368
|
-
"
|
6369
|
-
},
|
6370
|
-
"enabled": {
|
6371
|
-
"type": "boolean"
|
6622
|
+
"maxLength": 32767,
|
6623
|
+
"minLength": 50
|
6372
6624
|
},
|
6373
|
-
"
|
6625
|
+
"sslBundle": {
|
6374
6626
|
"type": "string",
|
6375
|
-
"
|
6376
|
-
|
6377
|
-
"get",
|
6378
|
-
"options",
|
6379
|
-
"patch",
|
6380
|
-
"post",
|
6381
|
-
"put"
|
6382
|
-
]
|
6627
|
+
"maxLength": 32767,
|
6628
|
+
"minLength": 50
|
6383
6629
|
},
|
6384
|
-
"
|
6630
|
+
"domainName": {
|
6385
6631
|
"type": "string",
|
6386
|
-
"
|
6387
|
-
|
6388
|
-
"authenticated",
|
6389
|
-
"group"
|
6390
|
-
]
|
6391
|
-
},
|
6392
|
-
"experienceGroups": {
|
6393
|
-
"type": "array",
|
6394
|
-
"items": {
|
6395
|
-
"type": "object",
|
6396
|
-
"properties": {
|
6397
|
-
"name": {
|
6398
|
-
"type": "string",
|
6399
|
-
"minLength": 1,
|
6400
|
-
"maxLength": 255
|
6401
|
-
},
|
6402
|
-
"id": {
|
6403
|
-
"type": "string",
|
6404
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
6405
|
-
}
|
6406
|
-
}
|
6407
|
-
}
|
6632
|
+
"maxLength": 1024,
|
6633
|
+
"minLength": 3
|
6408
6634
|
}
|
6409
6635
|
}
|
6410
6636
|
}
|
6411
6637
|
```
|
6412
|
-
### <a name="experience-
|
6638
|
+
### <a name="experience-domain-example"></a> Example
|
6413
6639
|
|
6414
6640
|
```json
|
6415
6641
|
{
|
6416
6642
|
"id": "58c1de6c8f812590d8e82980",
|
6417
|
-
"
|
6643
|
+
"experienceDomainId": "58c1de6c8f812590d8e82980",
|
6418
6644
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
6419
6645
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
6420
6646
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
6421
|
-
"
|
6422
|
-
"enabled": true,
|
6423
|
-
"method": "get",
|
6424
|
-
"access": "group",
|
6425
|
-
"experienceGroups": [
|
6426
|
-
{
|
6427
|
-
"name": "myGroup",
|
6428
|
-
"id": "58b9d794cbfafe1be675744f"
|
6429
|
-
}
|
6430
|
-
]
|
6647
|
+
"domainName": "my.example.domain.com"
|
6431
6648
|
}
|
6432
6649
|
```
|
6433
6650
|
|
6434
6651
|
<br/>
|
6435
6652
|
|
6436
|
-
## Experience
|
6653
|
+
## Experience Domain Patch
|
6437
6654
|
|
6438
|
-
Schema for the body of an Experience
|
6655
|
+
Schema for the body of an Experience Domain modification request
|
6439
6656
|
|
6440
|
-
### <a name="experience-
|
6657
|
+
### <a name="experience-domain-patch-schema"></a> Schema
|
6441
6658
|
|
6442
6659
|
```json
|
6443
6660
|
{
|
6444
6661
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
6445
6662
|
"type": "object",
|
6446
6663
|
"properties": {
|
6447
|
-
"
|
6664
|
+
"sslKey": {
|
6448
6665
|
"type": "string",
|
6449
|
-
"maxLength": 32767
|
6666
|
+
"maxLength": 32767,
|
6667
|
+
"minLength": 50
|
6450
6668
|
},
|
6451
|
-
"
|
6669
|
+
"sslCert": {
|
6452
6670
|
"type": "string",
|
6453
|
-
"
|
6454
|
-
"
|
6671
|
+
"maxLength": 32767,
|
6672
|
+
"minLength": 50
|
6455
6673
|
},
|
6456
|
-
"
|
6457
|
-
"type": "
|
6674
|
+
"sslBundle": {
|
6675
|
+
"type": "string",
|
6676
|
+
"maxLength": 32767,
|
6677
|
+
"minLength": 50
|
6678
|
+
},
|
6679
|
+
"domainName": {
|
6680
|
+
"type": "string",
|
6681
|
+
"maxLength": 1024,
|
6682
|
+
"minLength": 3
|
6683
|
+
}
|
6684
|
+
},
|
6685
|
+
"additionalProperties": false
|
6686
|
+
}
|
6687
|
+
```
|
6688
|
+
### <a name="experience-domain-patch-example"></a> Example
|
6689
|
+
|
6690
|
+
```json
|
6691
|
+
{
|
6692
|
+
"domainName": "my.example.domain.com",
|
6693
|
+
"sslCert": "MY_SSL_CERTIFICATE",
|
6694
|
+
"sslKey": "MY_SSL_KEY"
|
6695
|
+
}
|
6696
|
+
```
|
6697
|
+
|
6698
|
+
<br/>
|
6699
|
+
|
6700
|
+
## Experience Domain Post
|
6701
|
+
|
6702
|
+
Schema for the body of an Experience Domain creation request
|
6703
|
+
|
6704
|
+
### <a name="experience-domain-post-schema"></a> Schema
|
6705
|
+
|
6706
|
+
```json
|
6707
|
+
{
|
6708
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
6709
|
+
"type": "object",
|
6710
|
+
"properties": {
|
6711
|
+
"sslKey": {
|
6712
|
+
"type": "string",
|
6713
|
+
"maxLength": 32767,
|
6714
|
+
"minLength": 50
|
6715
|
+
},
|
6716
|
+
"sslCert": {
|
6717
|
+
"type": "string",
|
6718
|
+
"maxLength": 32767,
|
6719
|
+
"minLength": 50
|
6720
|
+
},
|
6721
|
+
"sslBundle": {
|
6722
|
+
"type": "string",
|
6723
|
+
"maxLength": 32767,
|
6724
|
+
"minLength": 50
|
6725
|
+
},
|
6726
|
+
"domainName": {
|
6727
|
+
"type": "string",
|
6728
|
+
"maxLength": 1024,
|
6729
|
+
"minLength": 3
|
6730
|
+
}
|
6731
|
+
},
|
6732
|
+
"additionalProperties": false,
|
6733
|
+
"required": [
|
6734
|
+
"domainName"
|
6735
|
+
]
|
6736
|
+
}
|
6737
|
+
```
|
6738
|
+
### <a name="experience-domain-post-example"></a> Example
|
6739
|
+
|
6740
|
+
```json
|
6741
|
+
{
|
6742
|
+
"domainName": "my.example.domain.com",
|
6743
|
+
"sslCert": "MY_SSL_CERTIFICATE",
|
6744
|
+
"sslKey": "MY_SSL_KEY"
|
6745
|
+
}
|
6746
|
+
```
|
6747
|
+
|
6748
|
+
<br/>
|
6749
|
+
|
6750
|
+
## Experience Domains
|
6751
|
+
|
6752
|
+
Schema for a collection of Experience Domains
|
6753
|
+
|
6754
|
+
### <a name="experience-domains-schema"></a> Schema
|
6755
|
+
|
6756
|
+
```json
|
6757
|
+
{
|
6758
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
6759
|
+
"type": "object",
|
6760
|
+
"properties": {
|
6761
|
+
"items": {
|
6762
|
+
"type": "array",
|
6763
|
+
"items": {
|
6764
|
+
"title": "Experience Domain",
|
6765
|
+
"description": "Schema for a single Experience Domain",
|
6766
|
+
"type": "object",
|
6767
|
+
"properties": {
|
6768
|
+
"id": {
|
6769
|
+
"type": "string",
|
6770
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6771
|
+
},
|
6772
|
+
"experienceDomainId": {
|
6773
|
+
"type": "string",
|
6774
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6775
|
+
},
|
6776
|
+
"applicationId": {
|
6777
|
+
"type": "string",
|
6778
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6779
|
+
},
|
6780
|
+
"creationDate": {
|
6781
|
+
"type": "string",
|
6782
|
+
"format": "date-time"
|
6783
|
+
},
|
6784
|
+
"lastUpdated": {
|
6785
|
+
"type": "string",
|
6786
|
+
"format": "date-time"
|
6787
|
+
},
|
6788
|
+
"sslCert": {
|
6789
|
+
"type": "string",
|
6790
|
+
"maxLength": 32767,
|
6791
|
+
"minLength": 50
|
6792
|
+
},
|
6793
|
+
"sslBundle": {
|
6794
|
+
"type": "string",
|
6795
|
+
"maxLength": 32767,
|
6796
|
+
"minLength": 50
|
6797
|
+
},
|
6798
|
+
"domainName": {
|
6799
|
+
"type": "string",
|
6800
|
+
"maxLength": 1024,
|
6801
|
+
"minLength": 3
|
6802
|
+
}
|
6803
|
+
}
|
6804
|
+
}
|
6805
|
+
},
|
6806
|
+
"count": {
|
6807
|
+
"type": "integer"
|
6808
|
+
},
|
6809
|
+
"totalCount": {
|
6810
|
+
"type": "integer"
|
6811
|
+
},
|
6812
|
+
"applicationId": {
|
6813
|
+
"type": "string",
|
6814
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6815
|
+
}
|
6816
|
+
}
|
6817
|
+
}
|
6818
|
+
```
|
6819
|
+
### <a name="experience-domains-example"></a> Example
|
6820
|
+
|
6821
|
+
```json
|
6822
|
+
{
|
6823
|
+
"items": [
|
6824
|
+
{
|
6825
|
+
"id": "58c1de6c8f812590d8e82980",
|
6826
|
+
"experienceDomainId": "58c1de6c8f812590d8e82980",
|
6827
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
6828
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
6829
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
6830
|
+
"domainName": "my.example.domain.com"
|
6831
|
+
}
|
6832
|
+
],
|
6833
|
+
"count": 1,
|
6834
|
+
"totalCount": 1,
|
6835
|
+
"applicationId": "575ec8687ae143cd83dc4a97"
|
6836
|
+
}
|
6837
|
+
```
|
6838
|
+
|
6839
|
+
<br/>
|
6840
|
+
|
6841
|
+
## Experience Endpoint
|
6842
|
+
|
6843
|
+
Schema for a single Experience Endpoint
|
6844
|
+
|
6845
|
+
### <a name="experience-endpoint-schema"></a> Schema
|
6846
|
+
|
6847
|
+
```json
|
6848
|
+
{
|
6849
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
6850
|
+
"type": "object",
|
6851
|
+
"properties": {
|
6852
|
+
"id": {
|
6853
|
+
"type": "string",
|
6854
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6855
|
+
},
|
6856
|
+
"experienceEndpointId": {
|
6857
|
+
"type": "string",
|
6858
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6859
|
+
},
|
6860
|
+
"applicationId": {
|
6861
|
+
"type": "string",
|
6862
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6863
|
+
},
|
6864
|
+
"creationDate": {
|
6865
|
+
"type": "string",
|
6866
|
+
"format": "date-time"
|
6867
|
+
},
|
6868
|
+
"lastUpdated": {
|
6869
|
+
"type": "string",
|
6870
|
+
"format": "date-time"
|
6871
|
+
},
|
6872
|
+
"description": {
|
6873
|
+
"type": "string",
|
6874
|
+
"maxLength": 32767
|
6875
|
+
},
|
6876
|
+
"route": {
|
6877
|
+
"type": "string",
|
6878
|
+
"minLength": 1,
|
6879
|
+
"maxLength": 1024
|
6880
|
+
},
|
6881
|
+
"enabled": {
|
6882
|
+
"type": "boolean"
|
6883
|
+
},
|
6884
|
+
"method": {
|
6885
|
+
"type": "string",
|
6886
|
+
"enum": [
|
6887
|
+
"delete",
|
6888
|
+
"get",
|
6889
|
+
"options",
|
6890
|
+
"patch",
|
6891
|
+
"post",
|
6892
|
+
"put"
|
6893
|
+
]
|
6894
|
+
},
|
6895
|
+
"access": {
|
6896
|
+
"type": "string",
|
6897
|
+
"enum": [
|
6898
|
+
"public",
|
6899
|
+
"authenticated",
|
6900
|
+
"group"
|
6901
|
+
]
|
6902
|
+
},
|
6903
|
+
"endpointTags": {
|
6904
|
+
"type": "object",
|
6905
|
+
"patternProperties": {
|
6906
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
6907
|
+
"type": "string",
|
6908
|
+
"minLength": 1,
|
6909
|
+
"maxLength": 255
|
6910
|
+
}
|
6911
|
+
},
|
6912
|
+
"additionalProperties": false
|
6913
|
+
},
|
6914
|
+
"experienceGroups": {
|
6915
|
+
"type": "array",
|
6916
|
+
"items": {
|
6917
|
+
"type": "object",
|
6918
|
+
"properties": {
|
6919
|
+
"name": {
|
6920
|
+
"type": "string",
|
6921
|
+
"minLength": 1,
|
6922
|
+
"maxLength": 255
|
6923
|
+
},
|
6924
|
+
"id": {
|
6925
|
+
"type": "string",
|
6926
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6927
|
+
}
|
6928
|
+
}
|
6929
|
+
}
|
6930
|
+
}
|
6931
|
+
}
|
6932
|
+
}
|
6933
|
+
```
|
6934
|
+
### <a name="experience-endpoint-example"></a> Example
|
6935
|
+
|
6936
|
+
```json
|
6937
|
+
{
|
6938
|
+
"id": "58c1de6c8f812590d8e82980",
|
6939
|
+
"experienceEndpointId": "58c1de6c8f812590d8e82980",
|
6940
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
6941
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
6942
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
6943
|
+
"route": "/my/route/{id}",
|
6944
|
+
"enabled": true,
|
6945
|
+
"method": "get",
|
6946
|
+
"access": "group",
|
6947
|
+
"experienceGroups": [
|
6948
|
+
{
|
6949
|
+
"name": "myGroup",
|
6950
|
+
"id": "58b9d794cbfafe1be675744f"
|
6951
|
+
}
|
6952
|
+
]
|
6953
|
+
}
|
6954
|
+
```
|
6955
|
+
|
6956
|
+
<br/>
|
6957
|
+
|
6958
|
+
## Experience Endpoint Patch
|
6959
|
+
|
6960
|
+
Schema for the body of an Experience Endpoint modification request
|
6961
|
+
|
6962
|
+
### <a name="experience-endpoint-patch-schema"></a> Schema
|
6963
|
+
|
6964
|
+
```json
|
6965
|
+
{
|
6966
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
6967
|
+
"type": "object",
|
6968
|
+
"properties": {
|
6969
|
+
"description": {
|
6970
|
+
"type": "string",
|
6971
|
+
"maxLength": 32767
|
6972
|
+
},
|
6973
|
+
"route": {
|
6974
|
+
"type": "string",
|
6975
|
+
"minLength": 1,
|
6976
|
+
"maxLength": 1024
|
6977
|
+
},
|
6978
|
+
"enabled": {
|
6979
|
+
"type": "boolean"
|
6458
6980
|
},
|
6459
6981
|
"method": {
|
6460
6982
|
"type": "string",
|
@@ -6475,6 +6997,17 @@ Schema for the body of an Experience Endpoint modification request
|
|
6475
6997
|
"group"
|
6476
6998
|
]
|
6477
6999
|
},
|
7000
|
+
"endpointTags": {
|
7001
|
+
"type": "object",
|
7002
|
+
"patternProperties": {
|
7003
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7004
|
+
"type": "string",
|
7005
|
+
"minLength": 1,
|
7006
|
+
"maxLength": 255
|
7007
|
+
}
|
7008
|
+
},
|
7009
|
+
"additionalProperties": false
|
7010
|
+
},
|
6478
7011
|
"experienceGroupIds": {
|
6479
7012
|
"type": "array",
|
6480
7013
|
"items": {
|
@@ -6542,6 +7075,17 @@ Schema for the body of an Experience Endpoint creation request
|
|
6542
7075
|
"group"
|
6543
7076
|
]
|
6544
7077
|
},
|
7078
|
+
"endpointTags": {
|
7079
|
+
"type": "object",
|
7080
|
+
"patternProperties": {
|
7081
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7082
|
+
"type": "string",
|
7083
|
+
"minLength": 1,
|
7084
|
+
"maxLength": 255
|
7085
|
+
}
|
7086
|
+
},
|
7087
|
+
"additionalProperties": false
|
7088
|
+
},
|
6545
7089
|
"experienceGroupIds": {
|
6546
7090
|
"type": "array",
|
6547
7091
|
"items": {
|
@@ -6697,6 +7241,17 @@ Schema for a collection of Experience Endpoints
|
|
6697
7241
|
"group"
|
6698
7242
|
]
|
6699
7243
|
},
|
7244
|
+
"endpointTags": {
|
7245
|
+
"type": "object",
|
7246
|
+
"patternProperties": {
|
7247
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7248
|
+
"type": "string",
|
7249
|
+
"minLength": 1,
|
7250
|
+
"maxLength": 255
|
7251
|
+
}
|
7252
|
+
},
|
7253
|
+
"additionalProperties": false
|
7254
|
+
},
|
6700
7255
|
"experienceGroups": {
|
6701
7256
|
"type": "array",
|
6702
7257
|
"items": {
|
@@ -6843,6 +7398,17 @@ Schema for a single Experience Group
|
|
6843
7398
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
6844
7399
|
},
|
6845
7400
|
"maxItems": 1000
|
7401
|
+
},
|
7402
|
+
"groupTags": {
|
7403
|
+
"type": "object",
|
7404
|
+
"patternProperties": {
|
7405
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7406
|
+
"type": "string",
|
7407
|
+
"minLength": 1,
|
7408
|
+
"maxLength": 255
|
7409
|
+
}
|
7410
|
+
},
|
7411
|
+
"additionalProperties": false
|
6846
7412
|
}
|
6847
7413
|
}
|
6848
7414
|
}
|
@@ -6905,6 +7471,17 @@ Schema for the body of an Experience Group modification request
|
|
6905
7471
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
6906
7472
|
},
|
6907
7473
|
"maxItems": 1000
|
7474
|
+
},
|
7475
|
+
"groupTags": {
|
7476
|
+
"type": "object",
|
7477
|
+
"patternProperties": {
|
7478
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7479
|
+
"type": "string",
|
7480
|
+
"minLength": 1,
|
7481
|
+
"maxLength": 255
|
7482
|
+
}
|
7483
|
+
},
|
7484
|
+
"additionalProperties": false
|
6908
7485
|
}
|
6909
7486
|
},
|
6910
7487
|
"additionalProperties": false
|
@@ -6963,6 +7540,17 @@ Schema for the body of an Experience Group creation request
|
|
6963
7540
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
6964
7541
|
},
|
6965
7542
|
"maxItems": 1000
|
7543
|
+
},
|
7544
|
+
"groupTags": {
|
7545
|
+
"type": "object",
|
7546
|
+
"patternProperties": {
|
7547
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7548
|
+
"type": "string",
|
7549
|
+
"minLength": 1,
|
7550
|
+
"maxLength": 255
|
7551
|
+
}
|
7552
|
+
},
|
7553
|
+
"additionalProperties": false
|
6966
7554
|
}
|
6967
7555
|
},
|
6968
7556
|
"additionalProperties": false,
|
@@ -7051,6 +7639,17 @@ Schema for a collection of Experience Groups
|
|
7051
7639
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7052
7640
|
},
|
7053
7641
|
"maxItems": 1000
|
7642
|
+
},
|
7643
|
+
"groupTags": {
|
7644
|
+
"type": "object",
|
7645
|
+
"patternProperties": {
|
7646
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
7647
|
+
"type": "string",
|
7648
|
+
"minLength": 1,
|
7649
|
+
"maxLength": 255
|
7650
|
+
}
|
7651
|
+
},
|
7652
|
+
"additionalProperties": false
|
7054
7653
|
}
|
7055
7654
|
}
|
7056
7655
|
}
|
@@ -7124,11 +7723,11 @@ Schema for a collection of Experience Groups
|
|
7124
7723
|
|
7125
7724
|
<br/>
|
7126
7725
|
|
7127
|
-
## Experience
|
7726
|
+
## Experience User
|
7128
7727
|
|
7129
|
-
Schema for a single Experience
|
7728
|
+
Schema for a single Experience User
|
7130
7729
|
|
7131
|
-
### <a name="experience-
|
7730
|
+
### <a name="experience-user-schema"></a> Schema
|
7132
7731
|
|
7133
7732
|
```json
|
7134
7733
|
{
|
@@ -7139,7 +7738,7 @@ Schema for a single Experience Template
|
|
7139
7738
|
"type": "string",
|
7140
7739
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7141
7740
|
},
|
7142
|
-
"
|
7741
|
+
"experienceUserId": {
|
7143
7742
|
"type": "string",
|
7144
7743
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7145
7744
|
},
|
@@ -7155,36 +7754,36 @@ Schema for a single Experience Template
|
|
7155
7754
|
"type": "string",
|
7156
7755
|
"format": "date-time"
|
7157
7756
|
},
|
7158
|
-
"
|
7757
|
+
"passwordLastUpdated": {
|
7159
7758
|
"type": "string",
|
7160
|
-
"
|
7161
|
-
"maxLength": 255
|
7759
|
+
"format": "date-time"
|
7162
7760
|
},
|
7163
|
-
"
|
7761
|
+
"lastLogin": {
|
7164
7762
|
"type": "string",
|
7165
|
-
"
|
7763
|
+
"format": "date-time"
|
7166
7764
|
},
|
7167
|
-
"
|
7765
|
+
"email": {
|
7168
7766
|
"type": "string",
|
7169
|
-
"
|
7170
|
-
|
7171
|
-
"page",
|
7172
|
-
"component"
|
7173
|
-
]
|
7767
|
+
"format": "email",
|
7768
|
+
"maxLength": 1024
|
7174
7769
|
},
|
7175
|
-
"
|
7176
|
-
"type":
|
7177
|
-
|
7178
|
-
"null"
|
7179
|
-
],
|
7180
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7770
|
+
"firstName": {
|
7771
|
+
"type": "string",
|
7772
|
+
"maxLength": 1024
|
7181
7773
|
},
|
7182
|
-
"
|
7774
|
+
"lastName": {
|
7183
7775
|
"type": "string",
|
7184
|
-
"maxLength":
|
7185
|
-
|
7776
|
+
"maxLength": 1024
|
7777
|
+
},
|
7778
|
+
"avatarUrl": {
|
7779
|
+
"type": "string",
|
7780
|
+
"format": "url"
|
7186
7781
|
},
|
7187
|
-
"
|
7782
|
+
"tokenCutoff": {
|
7783
|
+
"type": "string",
|
7784
|
+
"format": "date-time"
|
7785
|
+
},
|
7786
|
+
"userTags": {
|
7188
7787
|
"type": "object",
|
7189
7788
|
"patternProperties": {
|
7190
7789
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7194,24 +7793,43 @@ Schema for a single Experience Template
|
|
7194
7793
|
}
|
7195
7794
|
},
|
7196
7795
|
"additionalProperties": false
|
7796
|
+
},
|
7797
|
+
"experienceGroups": {
|
7798
|
+
"type": "array",
|
7799
|
+
"items": {
|
7800
|
+
"type": "object",
|
7801
|
+
"properties": {
|
7802
|
+
"name": {
|
7803
|
+
"type": "string",
|
7804
|
+
"minLength": 1,
|
7805
|
+
"maxLength": 255
|
7806
|
+
},
|
7807
|
+
"id": {
|
7808
|
+
"type": "string",
|
7809
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7810
|
+
}
|
7811
|
+
}
|
7812
|
+
}
|
7197
7813
|
}
|
7198
7814
|
}
|
7199
7815
|
}
|
7200
7816
|
```
|
7201
|
-
### <a name="experience-
|
7817
|
+
### <a name="experience-user-example"></a> Example
|
7202
7818
|
|
7203
7819
|
```json
|
7204
7820
|
{
|
7205
|
-
"id": "
|
7206
|
-
"
|
7821
|
+
"id": "58b9d782cbfafe1be675744d",
|
7822
|
+
"experienceUserId": "58b9d782cbfafe1be675744d",
|
7207
7823
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
7208
7824
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
7209
7825
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
7210
|
-
"
|
7211
|
-
"
|
7212
|
-
"
|
7213
|
-
"
|
7214
|
-
"
|
7826
|
+
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
|
7827
|
+
"lastLogin": "2016-06-13T04:00:00.000Z",
|
7828
|
+
"email": "example@experienceuser.com",
|
7829
|
+
"firstName": "Example",
|
7830
|
+
"lastName": "Name",
|
7831
|
+
"avatarUrl": "https://example.avatar.url/is_here.png",
|
7832
|
+
"userTags": {
|
7215
7833
|
"customKey": "customValue"
|
7216
7834
|
}
|
7217
7835
|
}
|
@@ -7219,39 +7837,40 @@ Schema for a single Experience Template
|
|
7219
7837
|
|
7220
7838
|
<br/>
|
7221
7839
|
|
7222
|
-
## Experience
|
7840
|
+
## Experience User Patch
|
7223
7841
|
|
7224
|
-
Schema for the body of an Experience
|
7842
|
+
Schema for the body of an Experience User modification request
|
7225
7843
|
|
7226
|
-
### <a name="experience-
|
7844
|
+
### <a name="experience-user-patch-schema"></a> Schema
|
7227
7845
|
|
7228
7846
|
```json
|
7229
7847
|
{
|
7230
7848
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
7231
7849
|
"type": "object",
|
7232
7850
|
"properties": {
|
7233
|
-
"
|
7851
|
+
"email": {
|
7234
7852
|
"type": "string",
|
7235
|
-
"
|
7236
|
-
"maxLength":
|
7853
|
+
"format": "email",
|
7854
|
+
"maxLength": 1024
|
7237
7855
|
},
|
7238
|
-
"
|
7856
|
+
"firstName": {
|
7239
7857
|
"type": "string",
|
7240
|
-
"maxLength":
|
7858
|
+
"maxLength": 1024
|
7241
7859
|
},
|
7242
|
-
"
|
7243
|
-
"type":
|
7244
|
-
|
7245
|
-
"null"
|
7246
|
-
],
|
7247
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7860
|
+
"lastName": {
|
7861
|
+
"type": "string",
|
7862
|
+
"maxLength": 1024
|
7248
7863
|
},
|
7249
|
-
"
|
7864
|
+
"password": {
|
7250
7865
|
"type": "string",
|
7251
|
-
"
|
7252
|
-
"
|
7866
|
+
"minLength": 8,
|
7867
|
+
"maxLength": 2048
|
7868
|
+
},
|
7869
|
+
"tokenCutoff": {
|
7870
|
+
"type": "string",
|
7871
|
+
"format": "date-time"
|
7253
7872
|
},
|
7254
|
-
"
|
7873
|
+
"userTags": {
|
7255
7874
|
"type": "object",
|
7256
7875
|
"patternProperties": {
|
7257
7876
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7261,17 +7880,25 @@ Schema for the body of an Experience Template modification request
|
|
7261
7880
|
}
|
7262
7881
|
},
|
7263
7882
|
"additionalProperties": false
|
7883
|
+
},
|
7884
|
+
"experienceGroupIds": {
|
7885
|
+
"type": "array",
|
7886
|
+
"items": {
|
7887
|
+
"type": "string",
|
7888
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7889
|
+
},
|
7890
|
+
"maxItems": 1000
|
7264
7891
|
}
|
7265
7892
|
},
|
7266
7893
|
"additionalProperties": false
|
7267
7894
|
}
|
7268
7895
|
```
|
7269
|
-
### <a name="experience-
|
7896
|
+
### <a name="experience-user-patch-example"></a> Example
|
7270
7897
|
|
7271
7898
|
```json
|
7272
7899
|
{
|
7273
|
-
"
|
7274
|
-
"
|
7900
|
+
"password": "aNewPassword",
|
7901
|
+
"userTags": {
|
7275
7902
|
"customKey": "newCustomValue"
|
7276
7903
|
}
|
7277
7904
|
}
|
@@ -7279,47 +7906,40 @@ Schema for the body of an Experience Template modification request
|
|
7279
7906
|
|
7280
7907
|
<br/>
|
7281
7908
|
|
7282
|
-
## Experience
|
7909
|
+
## Experience User Post
|
7283
7910
|
|
7284
|
-
Schema for the body of an Experience
|
7911
|
+
Schema for the body of an Experience User creation request
|
7285
7912
|
|
7286
|
-
### <a name="experience-
|
7913
|
+
### <a name="experience-user-post-schema"></a> Schema
|
7287
7914
|
|
7288
7915
|
```json
|
7289
7916
|
{
|
7290
7917
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
7291
7918
|
"type": "object",
|
7292
7919
|
"properties": {
|
7293
|
-
"
|
7920
|
+
"email": {
|
7294
7921
|
"type": "string",
|
7295
|
-
"
|
7296
|
-
"maxLength":
|
7922
|
+
"format": "email",
|
7923
|
+
"maxLength": 1024
|
7297
7924
|
},
|
7298
|
-
"
|
7925
|
+
"firstName": {
|
7299
7926
|
"type": "string",
|
7300
|
-
"maxLength":
|
7927
|
+
"maxLength": 1024
|
7301
7928
|
},
|
7302
|
-
"
|
7929
|
+
"lastName": {
|
7303
7930
|
"type": "string",
|
7304
|
-
"
|
7305
|
-
"layout",
|
7306
|
-
"page",
|
7307
|
-
"component"
|
7308
|
-
]
|
7931
|
+
"maxLength": 1024
|
7309
7932
|
},
|
7310
|
-
"
|
7311
|
-
"type":
|
7312
|
-
|
7313
|
-
|
7314
|
-
],
|
7315
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7933
|
+
"password": {
|
7934
|
+
"type": "string",
|
7935
|
+
"minLength": 8,
|
7936
|
+
"maxLength": 2048
|
7316
7937
|
},
|
7317
|
-
"
|
7938
|
+
"tokenCutoff": {
|
7318
7939
|
"type": "string",
|
7319
|
-
"
|
7320
|
-
"minLength": 1
|
7940
|
+
"format": "date-time"
|
7321
7941
|
},
|
7322
|
-
"
|
7942
|
+
"userTags": {
|
7323
7943
|
"type": "object",
|
7324
7944
|
"patternProperties": {
|
7325
7945
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7329,25 +7949,32 @@ Schema for the body of an Experience Template creation request
|
|
7329
7949
|
}
|
7330
7950
|
},
|
7331
7951
|
"additionalProperties": false
|
7952
|
+
},
|
7953
|
+
"experienceGroupIds": {
|
7954
|
+
"type": "array",
|
7955
|
+
"items": {
|
7956
|
+
"type": "string",
|
7957
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7958
|
+
},
|
7959
|
+
"maxItems": 1000
|
7332
7960
|
}
|
7333
7961
|
},
|
7334
7962
|
"additionalProperties": false,
|
7335
7963
|
"required": [
|
7336
|
-
"
|
7337
|
-
"
|
7338
|
-
"body"
|
7964
|
+
"email",
|
7965
|
+
"password"
|
7339
7966
|
]
|
7340
7967
|
}
|
7341
7968
|
```
|
7342
|
-
### <a name="experience-
|
7969
|
+
### <a name="experience-user-post-example"></a> Example
|
7343
7970
|
|
7344
7971
|
```json
|
7345
7972
|
{
|
7346
|
-
"
|
7347
|
-
"
|
7348
|
-
"
|
7349
|
-
"
|
7350
|
-
"
|
7973
|
+
"email": "example@experienceuser.com",
|
7974
|
+
"firstName": "Example",
|
7975
|
+
"lastName": "Name",
|
7976
|
+
"password": "aUserPassword",
|
7977
|
+
"userTags": {
|
7351
7978
|
"customKey": "customValue"
|
7352
7979
|
}
|
7353
7980
|
}
|
@@ -7355,11 +7982,11 @@ Schema for the body of an Experience Template creation request
|
|
7355
7982
|
|
7356
7983
|
<br/>
|
7357
7984
|
|
7358
|
-
## Experience
|
7985
|
+
## Experience Users
|
7359
7986
|
|
7360
|
-
Schema for a collection of Experience
|
7987
|
+
Schema for a collection of Experience Users
|
7361
7988
|
|
7362
|
-
### <a name="experience-
|
7989
|
+
### <a name="experience-users-schema"></a> Schema
|
7363
7990
|
|
7364
7991
|
```json
|
7365
7992
|
{
|
@@ -7369,15 +7996,15 @@ Schema for a collection of Experience Templates
|
|
7369
7996
|
"items": {
|
7370
7997
|
"type": "array",
|
7371
7998
|
"items": {
|
7372
|
-
"title": "Experience
|
7373
|
-
"description": "Schema for a single Experience
|
7999
|
+
"title": "Experience User",
|
8000
|
+
"description": "Schema for a single Experience User",
|
7374
8001
|
"type": "object",
|
7375
8002
|
"properties": {
|
7376
8003
|
"id": {
|
7377
8004
|
"type": "string",
|
7378
8005
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7379
8006
|
},
|
7380
|
-
"
|
8007
|
+
"experienceUserId": {
|
7381
8008
|
"type": "string",
|
7382
8009
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7383
8010
|
},
|
@@ -7393,36 +8020,36 @@ Schema for a collection of Experience Templates
|
|
7393
8020
|
"type": "string",
|
7394
8021
|
"format": "date-time"
|
7395
8022
|
},
|
7396
|
-
"
|
8023
|
+
"passwordLastUpdated": {
|
7397
8024
|
"type": "string",
|
7398
|
-
"
|
7399
|
-
"maxLength": 255
|
8025
|
+
"format": "date-time"
|
7400
8026
|
},
|
7401
|
-
"
|
8027
|
+
"lastLogin": {
|
7402
8028
|
"type": "string",
|
7403
|
-
"
|
8029
|
+
"format": "date-time"
|
7404
8030
|
},
|
7405
|
-
"
|
8031
|
+
"email": {
|
7406
8032
|
"type": "string",
|
7407
|
-
"
|
7408
|
-
|
7409
|
-
"page",
|
7410
|
-
"component"
|
7411
|
-
]
|
8033
|
+
"format": "email",
|
8034
|
+
"maxLength": 1024
|
7412
8035
|
},
|
7413
|
-
"
|
7414
|
-
"type":
|
7415
|
-
|
7416
|
-
"null"
|
7417
|
-
],
|
7418
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
8036
|
+
"firstName": {
|
8037
|
+
"type": "string",
|
8038
|
+
"maxLength": 1024
|
7419
8039
|
},
|
7420
|
-
"
|
8040
|
+
"lastName": {
|
7421
8041
|
"type": "string",
|
7422
|
-
"maxLength":
|
7423
|
-
|
8042
|
+
"maxLength": 1024
|
8043
|
+
},
|
8044
|
+
"avatarUrl": {
|
8045
|
+
"type": "string",
|
8046
|
+
"format": "url"
|
8047
|
+
},
|
8048
|
+
"tokenCutoff": {
|
8049
|
+
"type": "string",
|
8050
|
+
"format": "date-time"
|
7424
8051
|
},
|
7425
|
-
"
|
8052
|
+
"userTags": {
|
7426
8053
|
"type": "object",
|
7427
8054
|
"patternProperties": {
|
7428
8055
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7432,6 +8059,23 @@ Schema for a collection of Experience Templates
|
|
7432
8059
|
}
|
7433
8060
|
},
|
7434
8061
|
"additionalProperties": false
|
8062
|
+
},
|
8063
|
+
"experienceGroups": {
|
8064
|
+
"type": "array",
|
8065
|
+
"items": {
|
8066
|
+
"type": "object",
|
8067
|
+
"properties": {
|
8068
|
+
"name": {
|
8069
|
+
"type": "string",
|
8070
|
+
"minLength": 1,
|
8071
|
+
"maxLength": 255
|
8072
|
+
},
|
8073
|
+
"id": {
|
8074
|
+
"type": "string",
|
8075
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
8076
|
+
}
|
8077
|
+
}
|
8078
|
+
}
|
7435
8079
|
}
|
7436
8080
|
}
|
7437
8081
|
}
|
@@ -7468,33 +8112,31 @@ Schema for a collection of Experience Templates
|
|
7468
8112
|
"type": "string",
|
7469
8113
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7470
8114
|
},
|
7471
|
-
"
|
8115
|
+
"experienceGroupId": {
|
7472
8116
|
"type": "string",
|
7473
|
-
"
|
7474
|
-
"layout",
|
7475
|
-
"page",
|
7476
|
-
"component"
|
7477
|
-
]
|
8117
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7478
8118
|
}
|
7479
8119
|
}
|
7480
8120
|
}
|
7481
8121
|
```
|
7482
|
-
### <a name="experience-
|
8122
|
+
### <a name="experience-users-example"></a> Example
|
7483
8123
|
|
7484
8124
|
```json
|
7485
8125
|
{
|
7486
8126
|
"items": [
|
7487
8127
|
{
|
7488
|
-
"id": "
|
7489
|
-
"
|
8128
|
+
"id": "58b9d782cbfafe1be675744d",
|
8129
|
+
"experienceUserId": "58b9d782cbfafe1be675744d",
|
7490
8130
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
7491
8131
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
7492
8132
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
7493
|
-
"
|
7494
|
-
"
|
7495
|
-
"
|
7496
|
-
"
|
7497
|
-
"
|
8133
|
+
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
|
8134
|
+
"lastLogin": "2016-06-13T04:00:00.000Z",
|
8135
|
+
"email": "example@experienceuser.com",
|
8136
|
+
"firstName": "Example",
|
8137
|
+
"lastName": "Name",
|
8138
|
+
"avatarUrl": "https://example.avatar.url/is_here.png",
|
8139
|
+
"userTags": {
|
7498
8140
|
"customKey": "customValue"
|
7499
8141
|
}
|
7500
8142
|
}
|
@@ -7511,11 +8153,11 @@ Schema for a collection of Experience Templates
|
|
7511
8153
|
|
7512
8154
|
<br/>
|
7513
8155
|
|
7514
|
-
## Experience
|
8156
|
+
## Experience View
|
7515
8157
|
|
7516
|
-
Schema for a single Experience
|
8158
|
+
Schema for a single Experience View
|
7517
8159
|
|
7518
|
-
### <a name="experience-
|
8160
|
+
### <a name="experience-view-schema"></a> Schema
|
7519
8161
|
|
7520
8162
|
```json
|
7521
8163
|
{
|
@@ -7526,7 +8168,7 @@ Schema for a single Experience User
|
|
7526
8168
|
"type": "string",
|
7527
8169
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7528
8170
|
},
|
7529
|
-
"
|
8171
|
+
"experienceViewId": {
|
7530
8172
|
"type": "string",
|
7531
8173
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7532
8174
|
},
|
@@ -7542,36 +8184,41 @@ Schema for a single Experience User
|
|
7542
8184
|
"type": "string",
|
7543
8185
|
"format": "date-time"
|
7544
8186
|
},
|
7545
|
-
"
|
7546
|
-
"type": "string",
|
7547
|
-
"format": "date-time"
|
7548
|
-
},
|
7549
|
-
"lastLogin": {
|
8187
|
+
"name": {
|
7550
8188
|
"type": "string",
|
7551
|
-
"
|
8189
|
+
"minLength": 1,
|
8190
|
+
"maxLength": 255
|
7552
8191
|
},
|
7553
|
-
"
|
8192
|
+
"description": {
|
7554
8193
|
"type": "string",
|
7555
|
-
"
|
7556
|
-
"maxLength": 1024
|
8194
|
+
"maxLength": 32767
|
7557
8195
|
},
|
7558
|
-
"
|
8196
|
+
"viewType": {
|
7559
8197
|
"type": "string",
|
7560
|
-
"
|
8198
|
+
"enum": [
|
8199
|
+
"layout",
|
8200
|
+
"page",
|
8201
|
+
"component"
|
8202
|
+
]
|
7561
8203
|
},
|
7562
|
-
"
|
7563
|
-
"type":
|
7564
|
-
|
8204
|
+
"layoutId": {
|
8205
|
+
"type": [
|
8206
|
+
"string",
|
8207
|
+
"null"
|
8208
|
+
],
|
8209
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7565
8210
|
},
|
7566
|
-
"
|
8211
|
+
"layoutName": {
|
7567
8212
|
"type": "string",
|
7568
|
-
"
|
8213
|
+
"minLength": 1,
|
8214
|
+
"maxLength": 255
|
7569
8215
|
},
|
7570
|
-
"
|
8216
|
+
"body": {
|
7571
8217
|
"type": "string",
|
7572
|
-
"
|
8218
|
+
"maxLength": 131072,
|
8219
|
+
"minLength": 1
|
7573
8220
|
},
|
7574
|
-
"
|
8221
|
+
"viewTags": {
|
7575
8222
|
"type": "object",
|
7576
8223
|
"patternProperties": {
|
7577
8224
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7581,43 +8228,24 @@ Schema for a single Experience User
|
|
7581
8228
|
}
|
7582
8229
|
},
|
7583
8230
|
"additionalProperties": false
|
7584
|
-
},
|
7585
|
-
"experienceGroups": {
|
7586
|
-
"type": "array",
|
7587
|
-
"items": {
|
7588
|
-
"type": "object",
|
7589
|
-
"properties": {
|
7590
|
-
"name": {
|
7591
|
-
"type": "string",
|
7592
|
-
"minLength": 1,
|
7593
|
-
"maxLength": 255
|
7594
|
-
},
|
7595
|
-
"id": {
|
7596
|
-
"type": "string",
|
7597
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7598
|
-
}
|
7599
|
-
}
|
7600
|
-
}
|
7601
8231
|
}
|
7602
8232
|
}
|
7603
8233
|
}
|
7604
8234
|
```
|
7605
|
-
### <a name="experience-
|
8235
|
+
### <a name="experience-view-example"></a> Example
|
7606
8236
|
|
7607
8237
|
```json
|
7608
8238
|
{
|
7609
|
-
"id": "
|
7610
|
-
"
|
8239
|
+
"id": "59cc5c628246c6caed4b16c1",
|
8240
|
+
"experienceViewId": "59cc5c628246c6caed4b16c1",
|
7611
8241
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
7612
8242
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
7613
8243
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
7614
|
-
"
|
7615
|
-
"
|
7616
|
-
"
|
7617
|
-
"
|
7618
|
-
"
|
7619
|
-
"avatarUrl": "https://example.avatar.url/is_here.png",
|
7620
|
-
"userTags": {
|
8244
|
+
"name": "My Page View",
|
8245
|
+
"viewType": "page",
|
8246
|
+
"body": "<p>{{data}}</p>",
|
8247
|
+
"layoutId": "59cc5cad8246c6caed4b16c2",
|
8248
|
+
"viewTags": {
|
7621
8249
|
"customKey": "customValue"
|
7622
8250
|
}
|
7623
8251
|
}
|
@@ -7625,40 +8253,39 @@ Schema for a single Experience User
|
|
7625
8253
|
|
7626
8254
|
<br/>
|
7627
8255
|
|
7628
|
-
## Experience
|
8256
|
+
## Experience View Patch
|
7629
8257
|
|
7630
|
-
Schema for the body of an Experience
|
8258
|
+
Schema for the body of an Experience View modification request
|
7631
8259
|
|
7632
|
-
### <a name="experience-
|
8260
|
+
### <a name="experience-view-patch-schema"></a> Schema
|
7633
8261
|
|
7634
8262
|
```json
|
7635
8263
|
{
|
7636
8264
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
7637
8265
|
"type": "object",
|
7638
8266
|
"properties": {
|
7639
|
-
"
|
7640
|
-
"type": "string",
|
7641
|
-
"format": "email",
|
7642
|
-
"maxLength": 1024
|
7643
|
-
},
|
7644
|
-
"firstName": {
|
8267
|
+
"name": {
|
7645
8268
|
"type": "string",
|
7646
|
-
"
|
8269
|
+
"minLength": 1,
|
8270
|
+
"maxLength": 255
|
7647
8271
|
},
|
7648
|
-
"
|
8272
|
+
"description": {
|
7649
8273
|
"type": "string",
|
7650
|
-
"maxLength":
|
8274
|
+
"maxLength": 32767
|
7651
8275
|
},
|
7652
|
-
"
|
7653
|
-
"type":
|
7654
|
-
|
7655
|
-
|
8276
|
+
"layoutId": {
|
8277
|
+
"type": [
|
8278
|
+
"string",
|
8279
|
+
"null"
|
8280
|
+
],
|
8281
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7656
8282
|
},
|
7657
|
-
"
|
8283
|
+
"body": {
|
7658
8284
|
"type": "string",
|
7659
|
-
"
|
8285
|
+
"maxLength": 131072,
|
8286
|
+
"minLength": 1
|
7660
8287
|
},
|
7661
|
-
"
|
8288
|
+
"viewTags": {
|
7662
8289
|
"type": "object",
|
7663
8290
|
"patternProperties": {
|
7664
8291
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7668,25 +8295,17 @@ Schema for the body of an Experience User modification request
|
|
7668
8295
|
}
|
7669
8296
|
},
|
7670
8297
|
"additionalProperties": false
|
7671
|
-
},
|
7672
|
-
"experienceGroupIds": {
|
7673
|
-
"type": "array",
|
7674
|
-
"items": {
|
7675
|
-
"type": "string",
|
7676
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7677
|
-
},
|
7678
|
-
"maxItems": 1000
|
7679
8298
|
}
|
7680
8299
|
},
|
7681
8300
|
"additionalProperties": false
|
7682
8301
|
}
|
7683
8302
|
```
|
7684
|
-
### <a name="experience-
|
8303
|
+
### <a name="experience-view-patch-example"></a> Example
|
7685
8304
|
|
7686
8305
|
```json
|
7687
8306
|
{
|
7688
|
-
"
|
7689
|
-
"
|
8307
|
+
"body": "New Content! <p>{{newData}}</p>",
|
8308
|
+
"viewTags": {
|
7690
8309
|
"customKey": "newCustomValue"
|
7691
8310
|
}
|
7692
8311
|
}
|
@@ -7694,40 +8313,47 @@ Schema for the body of an Experience User modification request
|
|
7694
8313
|
|
7695
8314
|
<br/>
|
7696
8315
|
|
7697
|
-
## Experience
|
8316
|
+
## Experience View Post
|
7698
8317
|
|
7699
|
-
Schema for the body of an Experience
|
8318
|
+
Schema for the body of an Experience View creation request
|
7700
8319
|
|
7701
|
-
### <a name="experience-
|
8320
|
+
### <a name="experience-view-post-schema"></a> Schema
|
7702
8321
|
|
7703
8322
|
```json
|
7704
8323
|
{
|
7705
8324
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
7706
8325
|
"type": "object",
|
7707
8326
|
"properties": {
|
7708
|
-
"
|
8327
|
+
"name": {
|
7709
8328
|
"type": "string",
|
7710
|
-
"
|
7711
|
-
"maxLength":
|
8329
|
+
"minLength": 1,
|
8330
|
+
"maxLength": 255
|
7712
8331
|
},
|
7713
|
-
"
|
8332
|
+
"description": {
|
7714
8333
|
"type": "string",
|
7715
|
-
"maxLength":
|
8334
|
+
"maxLength": 32767
|
7716
8335
|
},
|
7717
|
-
"
|
8336
|
+
"viewType": {
|
7718
8337
|
"type": "string",
|
7719
|
-
"
|
8338
|
+
"enum": [
|
8339
|
+
"layout",
|
8340
|
+
"page",
|
8341
|
+
"component"
|
8342
|
+
]
|
7720
8343
|
},
|
7721
|
-
"
|
7722
|
-
"type":
|
7723
|
-
|
7724
|
-
|
8344
|
+
"layoutId": {
|
8345
|
+
"type": [
|
8346
|
+
"string",
|
8347
|
+
"null"
|
8348
|
+
],
|
8349
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7725
8350
|
},
|
7726
|
-
"
|
8351
|
+
"body": {
|
7727
8352
|
"type": "string",
|
7728
|
-
"
|
8353
|
+
"maxLength": 131072,
|
8354
|
+
"minLength": 1
|
7729
8355
|
},
|
7730
|
-
"
|
8356
|
+
"viewTags": {
|
7731
8357
|
"type": "object",
|
7732
8358
|
"patternProperties": {
|
7733
8359
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7737,32 +8363,25 @@ Schema for the body of an Experience User creation request
|
|
7737
8363
|
}
|
7738
8364
|
},
|
7739
8365
|
"additionalProperties": false
|
7740
|
-
},
|
7741
|
-
"experienceGroupIds": {
|
7742
|
-
"type": "array",
|
7743
|
-
"items": {
|
7744
|
-
"type": "string",
|
7745
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7746
|
-
},
|
7747
|
-
"maxItems": 1000
|
7748
8366
|
}
|
7749
8367
|
},
|
7750
8368
|
"additionalProperties": false,
|
7751
8369
|
"required": [
|
7752
|
-
"
|
7753
|
-
"
|
8370
|
+
"name",
|
8371
|
+
"viewType",
|
8372
|
+
"body"
|
7754
8373
|
]
|
7755
8374
|
}
|
7756
8375
|
```
|
7757
|
-
### <a name="experience-
|
8376
|
+
### <a name="experience-view-post-example"></a> Example
|
7758
8377
|
|
7759
8378
|
```json
|
7760
8379
|
{
|
7761
|
-
"
|
7762
|
-
"
|
7763
|
-
"
|
7764
|
-
"
|
7765
|
-
"
|
8380
|
+
"name": "My Page View",
|
8381
|
+
"viewType": "page",
|
8382
|
+
"body": "<p>{{data}}</p>",
|
8383
|
+
"layoutId": "59cc5cad8246c6caed4b16c2",
|
8384
|
+
"viewTags": {
|
7766
8385
|
"customKey": "customValue"
|
7767
8386
|
}
|
7768
8387
|
}
|
@@ -7770,11 +8389,11 @@ Schema for the body of an Experience User creation request
|
|
7770
8389
|
|
7771
8390
|
<br/>
|
7772
8391
|
|
7773
|
-
## Experience
|
8392
|
+
## Experience Views
|
7774
8393
|
|
7775
|
-
Schema for a collection of Experience
|
8394
|
+
Schema for a collection of Experience Views
|
7776
8395
|
|
7777
|
-
### <a name="experience-
|
8396
|
+
### <a name="experience-views-schema"></a> Schema
|
7778
8397
|
|
7779
8398
|
```json
|
7780
8399
|
{
|
@@ -7784,15 +8403,15 @@ Schema for a collection of Experience Users
|
|
7784
8403
|
"items": {
|
7785
8404
|
"type": "array",
|
7786
8405
|
"items": {
|
7787
|
-
"title": "Experience
|
7788
|
-
"description": "Schema for a single Experience
|
8406
|
+
"title": "Experience View",
|
8407
|
+
"description": "Schema for a single Experience View",
|
7789
8408
|
"type": "object",
|
7790
8409
|
"properties": {
|
7791
8410
|
"id": {
|
7792
8411
|
"type": "string",
|
7793
8412
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7794
8413
|
},
|
7795
|
-
"
|
8414
|
+
"experienceViewId": {
|
7796
8415
|
"type": "string",
|
7797
8416
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7798
8417
|
},
|
@@ -7808,36 +8427,41 @@ Schema for a collection of Experience Users
|
|
7808
8427
|
"type": "string",
|
7809
8428
|
"format": "date-time"
|
7810
8429
|
},
|
7811
|
-
"
|
7812
|
-
"type": "string",
|
7813
|
-
"format": "date-time"
|
7814
|
-
},
|
7815
|
-
"lastLogin": {
|
8430
|
+
"name": {
|
7816
8431
|
"type": "string",
|
7817
|
-
"
|
8432
|
+
"minLength": 1,
|
8433
|
+
"maxLength": 255
|
7818
8434
|
},
|
7819
|
-
"
|
8435
|
+
"description": {
|
7820
8436
|
"type": "string",
|
7821
|
-
"
|
7822
|
-
"maxLength": 1024
|
8437
|
+
"maxLength": 32767
|
7823
8438
|
},
|
7824
|
-
"
|
8439
|
+
"viewType": {
|
7825
8440
|
"type": "string",
|
7826
|
-
"
|
8441
|
+
"enum": [
|
8442
|
+
"layout",
|
8443
|
+
"page",
|
8444
|
+
"component"
|
8445
|
+
]
|
7827
8446
|
},
|
7828
|
-
"
|
7829
|
-
"type":
|
7830
|
-
|
8447
|
+
"layoutId": {
|
8448
|
+
"type": [
|
8449
|
+
"string",
|
8450
|
+
"null"
|
8451
|
+
],
|
8452
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
7831
8453
|
},
|
7832
|
-
"
|
8454
|
+
"layoutName": {
|
7833
8455
|
"type": "string",
|
7834
|
-
"
|
8456
|
+
"minLength": 1,
|
8457
|
+
"maxLength": 255
|
7835
8458
|
},
|
7836
|
-
"
|
8459
|
+
"body": {
|
7837
8460
|
"type": "string",
|
7838
|
-
"
|
8461
|
+
"maxLength": 131072,
|
8462
|
+
"minLength": 1
|
7839
8463
|
},
|
7840
|
-
"
|
8464
|
+
"viewTags": {
|
7841
8465
|
"type": "object",
|
7842
8466
|
"patternProperties": {
|
7843
8467
|
"^[0-9a-zA-Z_-]{1,255}$": {
|
@@ -7847,23 +8471,6 @@ Schema for a collection of Experience Users
|
|
7847
8471
|
}
|
7848
8472
|
},
|
7849
8473
|
"additionalProperties": false
|
7850
|
-
},
|
7851
|
-
"experienceGroups": {
|
7852
|
-
"type": "array",
|
7853
|
-
"items": {
|
7854
|
-
"type": "object",
|
7855
|
-
"properties": {
|
7856
|
-
"name": {
|
7857
|
-
"type": "string",
|
7858
|
-
"minLength": 1,
|
7859
|
-
"maxLength": 255
|
7860
|
-
},
|
7861
|
-
"id": {
|
7862
|
-
"type": "string",
|
7863
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
7864
|
-
}
|
7865
|
-
}
|
7866
|
-
}
|
7867
8474
|
}
|
7868
8475
|
}
|
7869
8476
|
}
|
@@ -7900,31 +8507,33 @@ Schema for a collection of Experience Users
|
|
7900
8507
|
"type": "string",
|
7901
8508
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
7902
8509
|
},
|
7903
|
-
"
|
8510
|
+
"viewType": {
|
7904
8511
|
"type": "string",
|
7905
|
-
"
|
8512
|
+
"enum": [
|
8513
|
+
"layout",
|
8514
|
+
"page",
|
8515
|
+
"component"
|
8516
|
+
]
|
7906
8517
|
}
|
7907
8518
|
}
|
7908
8519
|
}
|
7909
8520
|
```
|
7910
|
-
### <a name="experience-
|
8521
|
+
### <a name="experience-views-example"></a> Example
|
7911
8522
|
|
7912
8523
|
```json
|
7913
8524
|
{
|
7914
8525
|
"items": [
|
7915
8526
|
{
|
7916
|
-
"id": "
|
7917
|
-
"
|
8527
|
+
"id": "59cc5c628246c6caed4b16c1",
|
8528
|
+
"experienceViewId": "59cc5c628246c6caed4b16c1",
|
7918
8529
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
7919
8530
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
7920
8531
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
7921
|
-
"
|
7922
|
-
"
|
7923
|
-
"
|
7924
|
-
"
|
7925
|
-
"
|
7926
|
-
"avatarUrl": "https://example.avatar.url/is_here.png",
|
7927
|
-
"userTags": {
|
8532
|
+
"name": "My Page View",
|
8533
|
+
"viewType": "page",
|
8534
|
+
"body": "<p>{{data}}</p>",
|
8535
|
+
"layoutId": "59cc5cad8246c6caed4b16c2",
|
8536
|
+
"viewTags": {
|
7928
8537
|
"customKey": "customValue"
|
7929
8538
|
}
|
7930
8539
|
}
|
@@ -10682,16 +11291,19 @@ Schema for information about the currently authenticated user
|
|
10682
11291
|
"devicerecipe": {
|
10683
11292
|
"type": "number"
|
10684
11293
|
},
|
11294
|
+
"experiencedomain": {
|
11295
|
+
"type": "number"
|
11296
|
+
},
|
10685
11297
|
"experienceendpoint": {
|
10686
11298
|
"type": "number"
|
10687
11299
|
},
|
10688
11300
|
"experiencegroup": {
|
10689
11301
|
"type": "number"
|
10690
11302
|
},
|
10691
|
-
"
|
11303
|
+
"experienceuser": {
|
10692
11304
|
"type": "number"
|
10693
11305
|
},
|
10694
|
-
"
|
11306
|
+
"experienceview": {
|
10695
11307
|
"type": "number"
|
10696
11308
|
},
|
10697
11309
|
"flow": {
|
@@ -10848,16 +11460,19 @@ Schema for information about the currently authenticated user
|
|
10848
11460
|
"deviceRecipeCount": {
|
10849
11461
|
"type": "number"
|
10850
11462
|
},
|
11463
|
+
"experienceDomainCount": {
|
11464
|
+
"type": "number"
|
11465
|
+
},
|
10851
11466
|
"experienceEndpointCount": {
|
10852
11467
|
"type": "number"
|
10853
11468
|
},
|
10854
11469
|
"experienceGroupCount": {
|
10855
11470
|
"type": "number"
|
10856
11471
|
},
|
10857
|
-
"
|
11472
|
+
"experienceUserCount": {
|
10858
11473
|
"type": "number"
|
10859
11474
|
},
|
10860
|
-
"
|
11475
|
+
"experienceViewCount": {
|
10861
11476
|
"type": "number"
|
10862
11477
|
},
|
10863
11478
|
"flowCount": {
|
@@ -11295,16 +11910,19 @@ Schema for a single Organization
|
|
11295
11910
|
"devicerecipe": {
|
11296
11911
|
"type": "number"
|
11297
11912
|
},
|
11913
|
+
"experiencedomain": {
|
11914
|
+
"type": "number"
|
11915
|
+
},
|
11298
11916
|
"experienceendpoint": {
|
11299
11917
|
"type": "number"
|
11300
11918
|
},
|
11301
11919
|
"experiencegroup": {
|
11302
11920
|
"type": "number"
|
11303
11921
|
},
|
11304
|
-
"
|
11922
|
+
"experienceuser": {
|
11305
11923
|
"type": "number"
|
11306
11924
|
},
|
11307
|
-
"
|
11925
|
+
"experienceview": {
|
11308
11926
|
"type": "number"
|
11309
11927
|
},
|
11310
11928
|
"flow": {
|
@@ -11353,16 +11971,19 @@ Schema for a single Organization
|
|
11353
11971
|
"deviceRecipeCount": {
|
11354
11972
|
"type": "number"
|
11355
11973
|
},
|
11974
|
+
"experienceDomainCount": {
|
11975
|
+
"type": "number"
|
11976
|
+
},
|
11356
11977
|
"experienceEndpointCount": {
|
11357
11978
|
"type": "number"
|
11358
11979
|
},
|
11359
11980
|
"experienceGroupCount": {
|
11360
11981
|
"type": "number"
|
11361
11982
|
},
|
11362
|
-
"
|
11983
|
+
"experienceUserCount": {
|
11363
11984
|
"type": "number"
|
11364
11985
|
},
|
11365
|
-
"
|
11986
|
+
"experienceViewCount": {
|
11366
11987
|
"type": "number"
|
11367
11988
|
},
|
11368
11989
|
"flowCount": {
|
@@ -12060,16 +12681,19 @@ Schema for a collection of Organizations
|
|
12060
12681
|
"devicerecipe": {
|
12061
12682
|
"type": "number"
|
12062
12683
|
},
|
12684
|
+
"experiencedomain": {
|
12685
|
+
"type": "number"
|
12686
|
+
},
|
12063
12687
|
"experienceendpoint": {
|
12064
12688
|
"type": "number"
|
12065
12689
|
},
|
12066
12690
|
"experiencegroup": {
|
12067
12691
|
"type": "number"
|
12068
12692
|
},
|
12069
|
-
"
|
12693
|
+
"experienceuser": {
|
12070
12694
|
"type": "number"
|
12071
12695
|
},
|
12072
|
-
"
|
12696
|
+
"experienceview": {
|
12073
12697
|
"type": "number"
|
12074
12698
|
},
|
12075
12699
|
"flow": {
|
@@ -12118,16 +12742,19 @@ Schema for a collection of Organizations
|
|
12118
12742
|
"deviceRecipeCount": {
|
12119
12743
|
"type": "number"
|
12120
12744
|
},
|
12745
|
+
"experienceDomainCount": {
|
12746
|
+
"type": "number"
|
12747
|
+
},
|
12121
12748
|
"experienceEndpointCount": {
|
12122
12749
|
"type": "number"
|
12123
12750
|
},
|
12124
12751
|
"experienceGroupCount": {
|
12125
12752
|
"type": "number"
|
12126
12753
|
},
|
12127
|
-
"
|
12754
|
+
"experienceUserCount": {
|
12128
12755
|
"type": "number"
|
12129
12756
|
},
|
12130
|
-
"
|
12757
|
+
"experienceViewCount": {
|
12131
12758
|
"type": "number"
|
12132
12759
|
},
|
12133
12760
|
"flowCount": {
|
@@ -13039,6 +13666,10 @@ Schema for a single Solution User
|
|
13039
13666
|
"type": "string",
|
13040
13667
|
"format": "url"
|
13041
13668
|
},
|
13669
|
+
"tokenCutoff": {
|
13670
|
+
"type": "string",
|
13671
|
+
"format": "date-time"
|
13672
|
+
},
|
13042
13673
|
"accessRestrictions": {
|
13043
13674
|
"type": "object",
|
13044
13675
|
"properties": {
|
@@ -13190,6 +13821,10 @@ Schema for the body of a Solution User modification request
|
|
13190
13821
|
"minLength": 52,
|
13191
13822
|
"maxLength": 52
|
13192
13823
|
},
|
13824
|
+
"tokenCutoff": {
|
13825
|
+
"type": "string",
|
13826
|
+
"format": "date-time"
|
13827
|
+
},
|
13193
13828
|
"accessRestrictions": {
|
13194
13829
|
"type": "object",
|
13195
13830
|
"properties": {
|
@@ -13274,6 +13909,10 @@ Schema for the body of a Solution User creation request
|
|
13274
13909
|
"minLength": 52,
|
13275
13910
|
"maxLength": 52
|
13276
13911
|
},
|
13912
|
+
"tokenCutoff": {
|
13913
|
+
"type": "string",
|
13914
|
+
"format": "date-time"
|
13915
|
+
},
|
13277
13916
|
"accessRestrictions": {
|
13278
13917
|
"type": "object",
|
13279
13918
|
"properties": {
|
@@ -13411,6 +14050,10 @@ Schema for a collection of Solution Users
|
|
13411
14050
|
"type": "string",
|
13412
14051
|
"format": "url"
|
13413
14052
|
},
|
14053
|
+
"tokenCutoff": {
|
14054
|
+
"type": "string",
|
14055
|
+
"format": "date-time"
|
14056
|
+
},
|
13414
14057
|
"accessRestrictions": {
|
13415
14058
|
"type": "object",
|
13416
14059
|
"properties": {
|