losant_rest 1.3.2 → 1.3.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6048f4b3865747d2dc87a82f9c571c27e6c933a7
4
- data.tar.gz: 8e54f646dac21793b8cddad8434f3475cffb5e06
3
+ metadata.gz: 630fe702483cb32346c4dbef4fb372ae5bdaec7f
4
+ data.tar.gz: f1b5ee369399ed2439a8fb52ea59c02ad07a0199
5
5
  SHA512:
6
- metadata.gz: fdb9c3986c7f8e7ec2442188236f1ae9c5af0041ceb54816c19d97b2d3006e6be611a96522610f6c8e149000700867d504d56d64e618538bdbdb172c39805955
7
- data.tar.gz: 7b9119eb4e95a18106f0e048e9dbe3778efcbafe4f44d7ea51ccb674affa0578f1dc091c4d3a1b3ae808ecb275ae85e38a3469ac08de20f3c9edb35806c86d5c
6
+ metadata.gz: f882d188beee7ed72da0defdd7aa14881545837d588497203e3dfbc72416a4e91f522ddd4edfce51fc1d403020d8bb7dd9c6500c1267117f6b761782c54d4652
7
+ data.tar.gz: 8a99eb86cd25f1be89fc25cb0884cd102fc42a364f14047e52d98d76fe616382d7e883766ee2e8eb1eb607953294653b69ed36808bf1bcac4cf7c698cb9a837d
data/docs/_schemas.md CHANGED
@@ -66,6 +66,10 @@
66
66
  * [Experience Group Patch](#experience-group-patch)
67
67
  * [Experience Group Post](#experience-group-post)
68
68
  * [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)
69
73
  * [Experience User](#experience-user)
70
74
  * [Experience User Patch](#experience-user-patch)
71
75
  * [Experience User Post](#experience-user-post)
@@ -83,9 +87,9 @@
83
87
  * [Workflow Versions](#workflow-versions)
84
88
  * [Workflows](#workflows)
85
89
  * [Github Login](#github-login)
86
- * [Integrations](#integrations)
87
- * [Integrations Patch](#integrations-patch)
88
- * [Integrations Post](#integrations-post)
90
+ * [Integration](#integration)
91
+ * [Integration Patch](#integration-patch)
92
+ * [Integration Post](#integration-post)
89
93
  * [Integrations](#integrations)
90
94
  * [Last Value Data](#last-value-data)
91
95
  * [Last Value Query](#last-value-query)
@@ -389,6 +393,9 @@ Schema for a single Application
389
393
  "experienceGroupCount": {
390
394
  "type": "number"
391
395
  },
396
+ "experienceTemplateCount": {
397
+ "type": "number"
398
+ },
392
399
  "experienceUserCount": {
393
400
  "type": "number"
394
401
  },
@@ -482,6 +489,8 @@ Schema for the body of an Application API Token creation request
482
489
  "experienceEndpoints.*",
483
490
  "experienceGroup.*",
484
491
  "experienceGroups.*",
492
+ "experienceTemplate.*",
493
+ "experienceTemplates.*",
485
494
  "experienceUser.*",
486
495
  "experienceUsers.*",
487
496
  "integration.*",
@@ -560,6 +569,11 @@ Schema for the body of an Application API Token creation request
560
569
  "experienceGroup.patch",
561
570
  "experienceGroups.get",
562
571
  "experienceGroups.post",
572
+ "experienceTemplate.delete",
573
+ "experienceTemplate.get",
574
+ "experienceTemplate.patch",
575
+ "experienceTemplates.get",
576
+ "experienceTemplates.post",
563
577
  "experienceUser.delete",
564
578
  "experienceUser.get",
565
579
  "experienceUser.patch",
@@ -1315,6 +1329,9 @@ Schema for a collection of Applications
1315
1329
  "experienceGroupCount": {
1316
1330
  "type": "number"
1317
1331
  },
1332
+ "experienceTemplateCount": {
1333
+ "type": "number"
1334
+ },
1318
1335
  "experienceUserCount": {
1319
1336
  "type": "number"
1320
1337
  },
@@ -1457,6 +1474,7 @@ Schema for a single Audit Log entry
1457
1474
  "Event",
1458
1475
  "ExperienceEndpoint",
1459
1476
  "ExperienceGroup",
1477
+ "ExperienceTemplate",
1460
1478
  "ExperienceUser",
1461
1479
  "Flow",
1462
1480
  "SolutionUser",
@@ -1602,6 +1620,7 @@ Schema for the filter of an audit log query
1602
1620
  "Event",
1603
1621
  "ExperienceEndpoint",
1604
1622
  "ExperienceGroup",
1623
+ "ExperienceTemplate",
1605
1624
  "ExperienceUser",
1606
1625
  "Flow",
1607
1626
  "SolutionUser",
@@ -1764,6 +1783,7 @@ Schema for a collection of Audit Logs
1764
1783
  "Event",
1765
1784
  "ExperienceEndpoint",
1766
1785
  "ExperienceGroup",
1786
+ "ExperienceTemplate",
1767
1787
  "ExperienceUser",
1768
1788
  "Flow",
1769
1789
  "SolutionUser",
@@ -2147,6 +2167,56 @@ Schema for a single Dashboard
2147
2167
  "public": {
2148
2168
  "type": "boolean"
2149
2169
  },
2170
+ "reportConfigs": {
2171
+ "type": "array",
2172
+ "max": 10,
2173
+ "items": {
2174
+ "type": "object",
2175
+ "additionalProperties": false,
2176
+ "required": [
2177
+ "cron",
2178
+ "toEmail"
2179
+ ],
2180
+ "properties": {
2181
+ "id": {
2182
+ "type": "string",
2183
+ "max": 14
2184
+ },
2185
+ "cron": {
2186
+ "type": "string"
2187
+ },
2188
+ "toEmail": {
2189
+ "type": "array",
2190
+ "min": 1,
2191
+ "max": 10,
2192
+ "items": {
2193
+ "type": "string",
2194
+ "format": "email",
2195
+ "maxLength": 1024
2196
+ }
2197
+ },
2198
+ "subject": {
2199
+ "type": "string",
2200
+ "max": 255
2201
+ },
2202
+ "message": {
2203
+ "type": "string",
2204
+ "max": 32767
2205
+ },
2206
+ "theme": {
2207
+ "type": "string",
2208
+ "enum": [
2209
+ "dark",
2210
+ "light"
2211
+ ]
2212
+ },
2213
+ "timezone": {
2214
+ "type": "string",
2215
+ "max": 255
2216
+ }
2217
+ }
2218
+ }
2219
+ },
2150
2220
  "blocks": {
2151
2221
  "type": "array",
2152
2222
  "items": {
@@ -2299,7 +2369,17 @@ Schema for a single Dashboard
2299
2369
  "description": "The best dashboard description",
2300
2370
  "refreshRate": 60,
2301
2371
  "public": false,
2302
- "blocks": []
2372
+ "blocks": [],
2373
+ "reportConfigs": [
2374
+ {
2375
+ "toEmail": [
2376
+ "test@email.com"
2377
+ ],
2378
+ "cron": "0 0 12 * * MON-FRI *",
2379
+ "theme": "dark",
2380
+ "subject": "Daily Dashboard Report"
2381
+ }
2382
+ ]
2303
2383
  }
2304
2384
  ```
2305
2385
 
@@ -2398,6 +2478,56 @@ Schema for the body of a Dashboard modification request
2398
2478
  "additionalProperties": false
2399
2479
  }
2400
2480
  },
2481
+ "reportConfigs": {
2482
+ "type": "array",
2483
+ "max": 10,
2484
+ "items": {
2485
+ "type": "object",
2486
+ "additionalProperties": false,
2487
+ "required": [
2488
+ "cron",
2489
+ "toEmail"
2490
+ ],
2491
+ "properties": {
2492
+ "id": {
2493
+ "type": "string",
2494
+ "max": 14
2495
+ },
2496
+ "cron": {
2497
+ "type": "string"
2498
+ },
2499
+ "toEmail": {
2500
+ "type": "array",
2501
+ "min": 1,
2502
+ "max": 10,
2503
+ "items": {
2504
+ "type": "string",
2505
+ "format": "email",
2506
+ "maxLength": 1024
2507
+ }
2508
+ },
2509
+ "subject": {
2510
+ "type": "string",
2511
+ "max": 255
2512
+ },
2513
+ "message": {
2514
+ "type": "string",
2515
+ "max": 32767
2516
+ },
2517
+ "theme": {
2518
+ "type": "string",
2519
+ "enum": [
2520
+ "dark",
2521
+ "light"
2522
+ ]
2523
+ },
2524
+ "timezone": {
2525
+ "type": "string",
2526
+ "max": 255
2527
+ }
2528
+ }
2529
+ }
2530
+ },
2401
2531
  "description": {
2402
2532
  "type": "string",
2403
2533
  "maxLength": 32767
@@ -2597,6 +2727,56 @@ Schema for the body of a Dashboard creation request
2597
2727
  "minimum": 5,
2598
2728
  "maximum": 600
2599
2729
  },
2730
+ "reportConfigs": {
2731
+ "type": "array",
2732
+ "max": 10,
2733
+ "items": {
2734
+ "type": "object",
2735
+ "additionalProperties": false,
2736
+ "required": [
2737
+ "cron",
2738
+ "toEmail"
2739
+ ],
2740
+ "properties": {
2741
+ "id": {
2742
+ "type": "string",
2743
+ "max": 14
2744
+ },
2745
+ "cron": {
2746
+ "type": "string"
2747
+ },
2748
+ "toEmail": {
2749
+ "type": "array",
2750
+ "min": 1,
2751
+ "max": 10,
2752
+ "items": {
2753
+ "type": "string",
2754
+ "format": "email",
2755
+ "maxLength": 1024
2756
+ }
2757
+ },
2758
+ "subject": {
2759
+ "type": "string",
2760
+ "max": 255
2761
+ },
2762
+ "message": {
2763
+ "type": "string",
2764
+ "max": 32767
2765
+ },
2766
+ "theme": {
2767
+ "type": "string",
2768
+ "enum": [
2769
+ "dark",
2770
+ "light"
2771
+ ]
2772
+ },
2773
+ "timezone": {
2774
+ "type": "string",
2775
+ "max": 255
2776
+ }
2777
+ }
2778
+ }
2779
+ },
2600
2780
  "public": {
2601
2781
  "type": "boolean"
2602
2782
  },
@@ -2779,6 +2959,56 @@ Schema for a collection of Dashboards
2779
2959
  "public": {
2780
2960
  "type": "boolean"
2781
2961
  },
2962
+ "reportConfigs": {
2963
+ "type": "array",
2964
+ "max": 10,
2965
+ "items": {
2966
+ "type": "object",
2967
+ "additionalProperties": false,
2968
+ "required": [
2969
+ "cron",
2970
+ "toEmail"
2971
+ ],
2972
+ "properties": {
2973
+ "id": {
2974
+ "type": "string",
2975
+ "max": 14
2976
+ },
2977
+ "cron": {
2978
+ "type": "string"
2979
+ },
2980
+ "toEmail": {
2981
+ "type": "array",
2982
+ "min": 1,
2983
+ "max": 10,
2984
+ "items": {
2985
+ "type": "string",
2986
+ "format": "email",
2987
+ "maxLength": 1024
2988
+ }
2989
+ },
2990
+ "subject": {
2991
+ "type": "string",
2992
+ "max": 255
2993
+ },
2994
+ "message": {
2995
+ "type": "string",
2996
+ "max": 32767
2997
+ },
2998
+ "theme": {
2999
+ "type": "string",
3000
+ "enum": [
3001
+ "dark",
3002
+ "light"
3003
+ ]
3004
+ },
3005
+ "timezone": {
3006
+ "type": "string",
3007
+ "max": 255
3008
+ }
3009
+ }
3010
+ }
3011
+ },
2782
3012
  "blocks": {
2783
3013
  "type": "array",
2784
3014
  "items": {
@@ -2964,7 +3194,17 @@ Schema for a collection of Dashboards
2964
3194
  "description": "The best dashboard description",
2965
3195
  "refreshRate": 60,
2966
3196
  "public": false,
2967
- "blocks": []
3197
+ "blocks": [],
3198
+ "reportConfigs": [
3199
+ {
3200
+ "toEmail": [
3201
+ "test@email.com"
3202
+ ],
3203
+ "cron": "0 0 12 * * MON-FRI *",
3204
+ "theme": "dark",
3205
+ "subject": "Daily Dashboard Report"
3206
+ }
3207
+ ]
2968
3208
  }
2969
3209
  ],
2970
3210
  "count": 1,
@@ -6402,7 +6642,79 @@ Schema for a collection of Experience Endpoints
6402
6642
  "items": {
6403
6643
  "type": "array",
6404
6644
  "items": {
6405
- "$ref": "#/definitions/experienceEndpoints"
6645
+ "title": "Experience Endpoint",
6646
+ "description": "Schema for a single Experience Endpoint",
6647
+ "type": "object",
6648
+ "properties": {
6649
+ "id": {
6650
+ "type": "string",
6651
+ "pattern": "^[A-Fa-f\\d]{24}$"
6652
+ },
6653
+ "experienceEndpointId": {
6654
+ "type": "string",
6655
+ "pattern": "^[A-Fa-f\\d]{24}$"
6656
+ },
6657
+ "applicationId": {
6658
+ "type": "string",
6659
+ "pattern": "^[A-Fa-f\\d]{24}$"
6660
+ },
6661
+ "creationDate": {
6662
+ "type": "string",
6663
+ "format": "date-time"
6664
+ },
6665
+ "lastUpdated": {
6666
+ "type": "string",
6667
+ "format": "date-time"
6668
+ },
6669
+ "description": {
6670
+ "type": "string",
6671
+ "maxLength": 32767
6672
+ },
6673
+ "route": {
6674
+ "type": "string",
6675
+ "minLength": 1,
6676
+ "maxLength": 1024
6677
+ },
6678
+ "enabled": {
6679
+ "type": "boolean"
6680
+ },
6681
+ "method": {
6682
+ "type": "string",
6683
+ "enum": [
6684
+ "delete",
6685
+ "get",
6686
+ "options",
6687
+ "patch",
6688
+ "post",
6689
+ "put"
6690
+ ]
6691
+ },
6692
+ "access": {
6693
+ "type": "string",
6694
+ "enum": [
6695
+ "public",
6696
+ "authenticated",
6697
+ "group"
6698
+ ]
6699
+ },
6700
+ "experienceGroups": {
6701
+ "type": "array",
6702
+ "items": {
6703
+ "type": "object",
6704
+ "properties": {
6705
+ "name": {
6706
+ "type": "string",
6707
+ "minLength": 1,
6708
+ "maxLength": 255
6709
+ },
6710
+ "id": {
6711
+ "type": "string",
6712
+ "pattern": "^[A-Fa-f\\d]{24}$"
6713
+ }
6714
+ }
6715
+ }
6716
+ }
6717
+ }
6406
6718
  }
6407
6719
  },
6408
6720
  "count": {
@@ -6812,11 +7124,11 @@ Schema for a collection of Experience Groups
6812
7124
 
6813
7125
  <br/>
6814
7126
 
6815
- ## Experience User
7127
+ ## Experience Template
6816
7128
 
6817
- Schema for a single Experience User
7129
+ Schema for a single Experience Template
6818
7130
 
6819
- ### <a name="experience-user-schema"></a> Schema
7131
+ ### <a name="experience-template-schema"></a> Schema
6820
7132
 
6821
7133
  ```json
6822
7134
  {
@@ -6827,7 +7139,7 @@ Schema for a single Experience User
6827
7139
  "type": "string",
6828
7140
  "pattern": "^[A-Fa-f\\d]{24}$"
6829
7141
  },
6830
- "experienceUserId": {
7142
+ "experienceTemplateId": {
6831
7143
  "type": "string",
6832
7144
  "pattern": "^[A-Fa-f\\d]{24}$"
6833
7145
  },
@@ -6843,36 +7155,36 @@ Schema for a single Experience User
6843
7155
  "type": "string",
6844
7156
  "format": "date-time"
6845
7157
  },
6846
- "passwordLastUpdated": {
6847
- "type": "string",
6848
- "format": "date-time"
6849
- },
6850
- "lastLogin": {
6851
- "type": "string",
6852
- "format": "date-time"
6853
- },
6854
- "email": {
7158
+ "name": {
6855
7159
  "type": "string",
6856
- "format": "email",
6857
- "maxLength": 1024
7160
+ "minLength": 1,
7161
+ "maxLength": 255
6858
7162
  },
6859
- "firstName": {
7163
+ "description": {
6860
7164
  "type": "string",
6861
- "maxLength": 1024
7165
+ "maxLength": 32767
6862
7166
  },
6863
- "lastName": {
7167
+ "templateType": {
6864
7168
  "type": "string",
6865
- "maxLength": 1024
7169
+ "enum": [
7170
+ "layout",
7171
+ "page",
7172
+ "component"
7173
+ ]
6866
7174
  },
6867
- "avatarUrl": {
6868
- "type": "string",
6869
- "format": "url"
7175
+ "layoutId": {
7176
+ "type": [
7177
+ "string",
7178
+ "null"
7179
+ ],
7180
+ "pattern": "^[A-Fa-f\\d]{24}$"
6870
7181
  },
6871
- "tokenCutoff": {
7182
+ "body": {
6872
7183
  "type": "string",
6873
- "format": "date-time"
7184
+ "maxLength": 131072,
7185
+ "minLength": 1
6874
7186
  },
6875
- "userTags": {
7187
+ "templateTags": {
6876
7188
  "type": "object",
6877
7189
  "patternProperties": {
6878
7190
  "^[0-9a-zA-Z_-]{1,255}$": {
@@ -6882,32 +7194,419 @@ Schema for a single Experience User
6882
7194
  }
6883
7195
  },
6884
7196
  "additionalProperties": false
6885
- },
6886
- "experienceGroups": {
6887
- "type": "array",
6888
- "items": {
6889
- "type": "object",
6890
- "properties": {
6891
- "name": {
6892
- "type": "string",
6893
- "minLength": 1,
6894
- "maxLength": 255
6895
- },
6896
- "id": {
6897
- "type": "string",
6898
- "pattern": "^[A-Fa-f\\d]{24}$"
6899
- }
6900
- }
6901
- }
6902
7197
  }
6903
7198
  }
6904
7199
  }
6905
7200
  ```
6906
- ### <a name="experience-user-example"></a> Example
7201
+ ### <a name="experience-template-example"></a> Example
6907
7202
 
6908
7203
  ```json
6909
7204
  {
6910
- "id": "58b9d782cbfafe1be675744d",
7205
+ "id": "59cc5c628246c6caed4b16c1",
7206
+ "experienceTemplateId": "59cc5c628246c6caed4b16c1",
7207
+ "applicationId": "575ec8687ae143cd83dc4a97",
7208
+ "creationDate": "2016-06-13T04:00:00.000Z",
7209
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
7210
+ "name": "My Page Template",
7211
+ "templateType": "page",
7212
+ "body": "<p>{{data}}</p>",
7213
+ "layoutId": "59cc5cad8246c6caed4b16c2",
7214
+ "templateTags": {
7215
+ "customKey": "customValue"
7216
+ }
7217
+ }
7218
+ ```
7219
+
7220
+ <br/>
7221
+
7222
+ ## Experience Template Patch
7223
+
7224
+ Schema for the body of an Experience Template modification request
7225
+
7226
+ ### <a name="experience-template-patch-schema"></a> Schema
7227
+
7228
+ ```json
7229
+ {
7230
+ "$schema": "http://json-schema.org/draft-04/schema#",
7231
+ "type": "object",
7232
+ "properties": {
7233
+ "name": {
7234
+ "type": "string",
7235
+ "minLength": 1,
7236
+ "maxLength": 255
7237
+ },
7238
+ "description": {
7239
+ "type": "string",
7240
+ "maxLength": 32767
7241
+ },
7242
+ "layoutId": {
7243
+ "type": [
7244
+ "string",
7245
+ "null"
7246
+ ],
7247
+ "pattern": "^[A-Fa-f\\d]{24}$"
7248
+ },
7249
+ "body": {
7250
+ "type": "string",
7251
+ "maxLength": 131072,
7252
+ "minLength": 1
7253
+ },
7254
+ "templateTags": {
7255
+ "type": "object",
7256
+ "patternProperties": {
7257
+ "^[0-9a-zA-Z_-]{1,255}$": {
7258
+ "type": "string",
7259
+ "minLength": 1,
7260
+ "maxLength": 255
7261
+ }
7262
+ },
7263
+ "additionalProperties": false
7264
+ }
7265
+ },
7266
+ "additionalProperties": false
7267
+ }
7268
+ ```
7269
+ ### <a name="experience-template-patch-example"></a> Example
7270
+
7271
+ ```json
7272
+ {
7273
+ "body": "New Content! <p>{{newData}}</p>",
7274
+ "templateTags": {
7275
+ "customKey": "newCustomValue"
7276
+ }
7277
+ }
7278
+ ```
7279
+
7280
+ <br/>
7281
+
7282
+ ## Experience Template Post
7283
+
7284
+ Schema for the body of an Experience Template creation request
7285
+
7286
+ ### <a name="experience-template-post-schema"></a> Schema
7287
+
7288
+ ```json
7289
+ {
7290
+ "$schema": "http://json-schema.org/draft-04/schema#",
7291
+ "type": "object",
7292
+ "properties": {
7293
+ "name": {
7294
+ "type": "string",
7295
+ "minLength": 1,
7296
+ "maxLength": 255
7297
+ },
7298
+ "description": {
7299
+ "type": "string",
7300
+ "maxLength": 32767
7301
+ },
7302
+ "templateType": {
7303
+ "type": "string",
7304
+ "enum": [
7305
+ "layout",
7306
+ "page",
7307
+ "component"
7308
+ ]
7309
+ },
7310
+ "layoutId": {
7311
+ "type": [
7312
+ "string",
7313
+ "null"
7314
+ ],
7315
+ "pattern": "^[A-Fa-f\\d]{24}$"
7316
+ },
7317
+ "body": {
7318
+ "type": "string",
7319
+ "maxLength": 131072,
7320
+ "minLength": 1
7321
+ },
7322
+ "templateTags": {
7323
+ "type": "object",
7324
+ "patternProperties": {
7325
+ "^[0-9a-zA-Z_-]{1,255}$": {
7326
+ "type": "string",
7327
+ "minLength": 1,
7328
+ "maxLength": 255
7329
+ }
7330
+ },
7331
+ "additionalProperties": false
7332
+ }
7333
+ },
7334
+ "additionalProperties": false,
7335
+ "required": [
7336
+ "name",
7337
+ "templateType",
7338
+ "body"
7339
+ ]
7340
+ }
7341
+ ```
7342
+ ### <a name="experience-template-post-example"></a> Example
7343
+
7344
+ ```json
7345
+ {
7346
+ "name": "My Page Template",
7347
+ "templateType": "page",
7348
+ "body": "<p>{{data}}</p>",
7349
+ "layoutId": "59cc5cad8246c6caed4b16c2",
7350
+ "templateTags": {
7351
+ "customKey": "customValue"
7352
+ }
7353
+ }
7354
+ ```
7355
+
7356
+ <br/>
7357
+
7358
+ ## Experience Templates
7359
+
7360
+ Schema for a collection of Experience Templates
7361
+
7362
+ ### <a name="experience-templates-schema"></a> Schema
7363
+
7364
+ ```json
7365
+ {
7366
+ "$schema": "http://json-schema.org/draft-04/schema#",
7367
+ "type": "object",
7368
+ "properties": {
7369
+ "items": {
7370
+ "type": "array",
7371
+ "items": {
7372
+ "title": "Experience Template",
7373
+ "description": "Schema for a single Experience Template",
7374
+ "type": "object",
7375
+ "properties": {
7376
+ "id": {
7377
+ "type": "string",
7378
+ "pattern": "^[A-Fa-f\\d]{24}$"
7379
+ },
7380
+ "experienceTemplateId": {
7381
+ "type": "string",
7382
+ "pattern": "^[A-Fa-f\\d]{24}$"
7383
+ },
7384
+ "applicationId": {
7385
+ "type": "string",
7386
+ "pattern": "^[A-Fa-f\\d]{24}$"
7387
+ },
7388
+ "creationDate": {
7389
+ "type": "string",
7390
+ "format": "date-time"
7391
+ },
7392
+ "lastUpdated": {
7393
+ "type": "string",
7394
+ "format": "date-time"
7395
+ },
7396
+ "name": {
7397
+ "type": "string",
7398
+ "minLength": 1,
7399
+ "maxLength": 255
7400
+ },
7401
+ "description": {
7402
+ "type": "string",
7403
+ "maxLength": 32767
7404
+ },
7405
+ "templateType": {
7406
+ "type": "string",
7407
+ "enum": [
7408
+ "layout",
7409
+ "page",
7410
+ "component"
7411
+ ]
7412
+ },
7413
+ "layoutId": {
7414
+ "type": [
7415
+ "string",
7416
+ "null"
7417
+ ],
7418
+ "pattern": "^[A-Fa-f\\d]{24}$"
7419
+ },
7420
+ "body": {
7421
+ "type": "string",
7422
+ "maxLength": 131072,
7423
+ "minLength": 1
7424
+ },
7425
+ "templateTags": {
7426
+ "type": "object",
7427
+ "patternProperties": {
7428
+ "^[0-9a-zA-Z_-]{1,255}$": {
7429
+ "type": "string",
7430
+ "minLength": 1,
7431
+ "maxLength": 255
7432
+ }
7433
+ },
7434
+ "additionalProperties": false
7435
+ }
7436
+ }
7437
+ }
7438
+ },
7439
+ "count": {
7440
+ "type": "integer"
7441
+ },
7442
+ "totalCount": {
7443
+ "type": "integer"
7444
+ },
7445
+ "perPage": {
7446
+ "type": "integer"
7447
+ },
7448
+ "page": {
7449
+ "type": "integer"
7450
+ },
7451
+ "filter": {
7452
+ "type": "string"
7453
+ },
7454
+ "filterField": {
7455
+ "type": "string"
7456
+ },
7457
+ "sortField": {
7458
+ "type": "string"
7459
+ },
7460
+ "sortDirection": {
7461
+ "type": "string",
7462
+ "enum": [
7463
+ "asc",
7464
+ "desc"
7465
+ ]
7466
+ },
7467
+ "applicationId": {
7468
+ "type": "string",
7469
+ "pattern": "^[A-Fa-f\\d]{24}$"
7470
+ },
7471
+ "templateType": {
7472
+ "type": "string",
7473
+ "enum": [
7474
+ "layout",
7475
+ "page",
7476
+ "component"
7477
+ ]
7478
+ }
7479
+ }
7480
+ }
7481
+ ```
7482
+ ### <a name="experience-templates-example"></a> Example
7483
+
7484
+ ```json
7485
+ {
7486
+ "items": [
7487
+ {
7488
+ "id": "59cc5c628246c6caed4b16c1",
7489
+ "experienceTemplateId": "59cc5c628246c6caed4b16c1",
7490
+ "applicationId": "575ec8687ae143cd83dc4a97",
7491
+ "creationDate": "2016-06-13T04:00:00.000Z",
7492
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
7493
+ "name": "My Page Template",
7494
+ "templateType": "page",
7495
+ "body": "<p>{{data}}</p>",
7496
+ "layoutId": "59cc5cad8246c6caed4b16c2",
7497
+ "templateTags": {
7498
+ "customKey": "customValue"
7499
+ }
7500
+ }
7501
+ ],
7502
+ "count": 1,
7503
+ "totalCount": 4,
7504
+ "perPage": 1,
7505
+ "page": 0,
7506
+ "sortField": "name",
7507
+ "sortDirection": "asc",
7508
+ "applicationId": "575ec8687ae143cd83dc4a97"
7509
+ }
7510
+ ```
7511
+
7512
+ <br/>
7513
+
7514
+ ## Experience User
7515
+
7516
+ Schema for a single Experience User
7517
+
7518
+ ### <a name="experience-user-schema"></a> Schema
7519
+
7520
+ ```json
7521
+ {
7522
+ "$schema": "http://json-schema.org/draft-04/schema#",
7523
+ "type": "object",
7524
+ "properties": {
7525
+ "id": {
7526
+ "type": "string",
7527
+ "pattern": "^[A-Fa-f\\d]{24}$"
7528
+ },
7529
+ "experienceUserId": {
7530
+ "type": "string",
7531
+ "pattern": "^[A-Fa-f\\d]{24}$"
7532
+ },
7533
+ "applicationId": {
7534
+ "type": "string",
7535
+ "pattern": "^[A-Fa-f\\d]{24}$"
7536
+ },
7537
+ "creationDate": {
7538
+ "type": "string",
7539
+ "format": "date-time"
7540
+ },
7541
+ "lastUpdated": {
7542
+ "type": "string",
7543
+ "format": "date-time"
7544
+ },
7545
+ "passwordLastUpdated": {
7546
+ "type": "string",
7547
+ "format": "date-time"
7548
+ },
7549
+ "lastLogin": {
7550
+ "type": "string",
7551
+ "format": "date-time"
7552
+ },
7553
+ "email": {
7554
+ "type": "string",
7555
+ "format": "email",
7556
+ "maxLength": 1024
7557
+ },
7558
+ "firstName": {
7559
+ "type": "string",
7560
+ "maxLength": 1024
7561
+ },
7562
+ "lastName": {
7563
+ "type": "string",
7564
+ "maxLength": 1024
7565
+ },
7566
+ "avatarUrl": {
7567
+ "type": "string",
7568
+ "format": "url"
7569
+ },
7570
+ "tokenCutoff": {
7571
+ "type": "string",
7572
+ "format": "date-time"
7573
+ },
7574
+ "userTags": {
7575
+ "type": "object",
7576
+ "patternProperties": {
7577
+ "^[0-9a-zA-Z_-]{1,255}$": {
7578
+ "type": "string",
7579
+ "minLength": 1,
7580
+ "maxLength": 255
7581
+ }
7582
+ },
7583
+ "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
+ }
7602
+ }
7603
+ }
7604
+ ```
7605
+ ### <a name="experience-user-example"></a> Example
7606
+
7607
+ ```json
7608
+ {
7609
+ "id": "58b9d782cbfafe1be675744d",
6911
7610
  "experienceUserId": "58b9d782cbfafe1be675744d",
6912
7611
  "applicationId": "575ec8687ae143cd83dc4a97",
6913
7612
  "creationDate": "2016-06-13T04:00:00.000Z",
@@ -8898,11 +9597,11 @@ Schema for the body of a Github login request
8898
9597
 
8899
9598
  <br/>
8900
9599
 
8901
- ## Integrations
9600
+ ## Integration
8902
9601
 
8903
- Schema for a single Integrations
9602
+ Schema for a single Integration
8904
9603
 
8905
- ### <a name="integrations-schema"></a> Schema
9604
+ ### <a name="integration-schema"></a> Schema
8906
9605
 
8907
9606
  ```json
8908
9607
  {
@@ -9105,7 +9804,7 @@ Schema for a single Integrations
9105
9804
  }
9106
9805
  }
9107
9806
  ```
9108
- ### <a name="integrations-example"></a> Example
9807
+ ### <a name="integration-example"></a> Example
9109
9808
 
9110
9809
  ```json
9111
9810
  {
@@ -9143,11 +9842,11 @@ Schema for a single Integrations
9143
9842
 
9144
9843
  <br/>
9145
9844
 
9146
- ## Integrations Patch
9845
+ ## Integration Patch
9147
9846
 
9148
- Schema for the body of an Integrations modification request
9847
+ Schema for the body of an Integration modification request
9149
9848
 
9150
- ### <a name="integrations-patch-schema"></a> Schema
9849
+ ### <a name="integration-patch-schema"></a> Schema
9151
9850
 
9152
9851
  ```json
9153
9852
  {
@@ -9294,7 +9993,7 @@ Schema for the body of an Integrations modification request
9294
9993
  "additionalProperties": false
9295
9994
  }
9296
9995
  ```
9297
- ### <a name="integrations-patch-example"></a> Example
9996
+ ### <a name="integration-patch-example"></a> Example
9298
9997
 
9299
9998
  ```json
9300
9999
  {
@@ -9306,11 +10005,11 @@ Schema for the body of an Integrations modification request
9306
10005
 
9307
10006
  <br/>
9308
10007
 
9309
- ## Integrations Post
10008
+ ## Integration Post
9310
10009
 
9311
- Schema for the body of an Integrations creation request
10010
+ Schema for the body of an Integration creation request
9312
10011
 
9313
- ### <a name="integrations-post-schema"></a> Schema
10012
+ ### <a name="integration-post-schema"></a> Schema
9314
10013
 
9315
10014
  ```json
9316
10015
  {
@@ -9461,7 +10160,7 @@ Schema for the body of an Integrations creation request
9461
10160
  ]
9462
10161
  }
9463
10162
  ```
9464
- ### <a name="integrations-post-example"></a> Example
10163
+ ### <a name="integration-post-example"></a> Example
9465
10164
 
9466
10165
  ```json
9467
10166
  {
@@ -9497,8 +10196,8 @@ Schema for a collection of Integrations
9497
10196
  "items": {
9498
10197
  "type": "array",
9499
10198
  "items": {
9500
- "title": "Integrations",
9501
- "description": "Schema for a single Integrations",
10199
+ "title": "Integration",
10200
+ "description": "Schema for a single Integration",
9502
10201
  "type": "object",
9503
10202
  "properties": {
9504
10203
  "id": {
@@ -9989,6 +10688,9 @@ Schema for information about the currently authenticated user
9989
10688
  "experiencegroup": {
9990
10689
  "type": "number"
9991
10690
  },
10691
+ "experiencetemplate": {
10692
+ "type": "number"
10693
+ },
9992
10694
  "experienceuser": {
9993
10695
  "type": "number"
9994
10696
  },
@@ -10152,6 +10854,9 @@ Schema for information about the currently authenticated user
10152
10854
  "experienceGroupCount": {
10153
10855
  "type": "number"
10154
10856
  },
10857
+ "experienceTemplateCount": {
10858
+ "type": "number"
10859
+ },
10155
10860
  "experienceUserCount": {
10156
10861
  "type": "number"
10157
10862
  },
@@ -10596,6 +11301,9 @@ Schema for a single Organization
10596
11301
  "experiencegroup": {
10597
11302
  "type": "number"
10598
11303
  },
11304
+ "experiencetemplate": {
11305
+ "type": "number"
11306
+ },
10599
11307
  "experienceuser": {
10600
11308
  "type": "number"
10601
11309
  },
@@ -10651,6 +11359,9 @@ Schema for a single Organization
10651
11359
  "experienceGroupCount": {
10652
11360
  "type": "number"
10653
11361
  },
11362
+ "experienceTemplateCount": {
11363
+ "type": "number"
11364
+ },
10654
11365
  "experienceUserCount": {
10655
11366
  "type": "number"
10656
11367
  },
@@ -11355,6 +12066,9 @@ Schema for a collection of Organizations
11355
12066
  "experiencegroup": {
11356
12067
  "type": "number"
11357
12068
  },
12069
+ "experiencetemplate": {
12070
+ "type": "number"
12071
+ },
11358
12072
  "experienceuser": {
11359
12073
  "type": "number"
11360
12074
  },
@@ -11410,6 +12124,9 @@ Schema for a collection of Organizations
11410
12124
  "experienceGroupCount": {
11411
12125
  "type": "number"
11412
12126
  },
12127
+ "experienceTemplateCount": {
12128
+ "type": "number"
12129
+ },
11413
12130
  "experienceUserCount": {
11414
12131
  "type": "number"
11415
12132
  },