losant_rest 1.8.2 → 1.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a00e4f322e3eb13ed7039b50b7b585832628db3118a8946740e14f55286fbd99
4
- data.tar.gz: ca6b8e733ad3c4ecec741b5c2f1ea68f220753e4735edb6e7dddc2242a318c78
3
+ metadata.gz: bd48938b608d6a1b8a68dea90a7f7df3b6a89b50c70daeae0847d92c5a11a346
4
+ data.tar.gz: 65dc220f3a4d835bafcda0c174d6880c82d6ec6d0baab3db6713fced112116f0
5
5
  SHA512:
6
- metadata.gz: de8652209e1d56f331536e4c0fddee0f6da015cd0a6aee44e8a1897832608aaed1cc1bce9e9ecee353eeb3e187ea09ceb7ad5cf88b7aea73f826744cc9ab0037
7
- data.tar.gz: 515ccf96d76c92e0c95e92bde9bea98b3530540c90954085b17235e5c74d557eda2add037b3b2d1ab701ff1fafc68e02b6394ce686d82ce6716d314ebf33f89a
6
+ metadata.gz: 3b5822b47e60014744dc0d55c812b568dc084b866a7670f4a7b3a40589aab68083cb9fae2bd8a80d7f40e6cf6c3f637e65dddf0c801497713661b84b15168b7e
7
+ data.tar.gz: aa51d1b563f5c2c6e0601493fd475fd8630aca36309ba9fb85885e39cf40deb192fc43b0d978b323738198fe730fb0785e4a016aac73808abd5b6a62304d638d
data/docs/_schemas.md CHANGED
@@ -12,6 +12,7 @@
12
12
  * [Application Keys](#application-keys)
13
13
  * [Application Patch](#application-patch)
14
14
  * [Application Post](#application-post)
15
+ * [Application Search Result](#application-search-result)
15
16
  * [Applications](#applications)
16
17
  * [Audit Log](#audit-log)
17
18
  * [Audit Log Filter](#audit-log-filter)
@@ -536,6 +537,14 @@ Schema for a single Application
536
537
  "organization"
537
538
  ]
538
539
  },
540
+ "organizationName": {
541
+ "type": "string",
542
+ "minLength": 1,
543
+ "maxLength": 255
544
+ },
545
+ "organizationIconColor": {
546
+ "type": "string"
547
+ },
539
548
  "name": {
540
549
  "type": "string",
541
550
  "minLength": 1,
@@ -896,6 +905,7 @@ Schema for the body of an Application API Token creation request
896
905
  "application.mqttSubscriptionStream",
897
906
  "application.patch",
898
907
  "application.payloadCounts",
908
+ "application.search",
899
909
  "applicationApiToken.delete",
900
910
  "applicationApiToken.get",
901
911
  "applicationApiToken.patch",
@@ -1883,6 +1893,83 @@ Schema for the body of an Application creation request
1883
1893
 
1884
1894
  <br/>
1885
1895
 
1896
+ ## Application Search Result
1897
+
1898
+ Results of a search of an application&#x27;s resources
1899
+
1900
+ ### <a name="application-search-result-schema"></a> Schema
1901
+
1902
+ ```json
1903
+ {
1904
+ "$schema": "http://json-schema.org/draft-04/schema#",
1905
+ "type": "array",
1906
+ "items": {
1907
+ "type": "object",
1908
+ "properties": {
1909
+ "id": {
1910
+ "type": "string",
1911
+ "pattern": "^[A-Fa-f\\d]{24}$"
1912
+ },
1913
+ "name": {
1914
+ "type": "string"
1915
+ },
1916
+ "metadata": {
1917
+ "type": "object"
1918
+ },
1919
+ "viewType": {
1920
+ "type": "string"
1921
+ },
1922
+ "version": {
1923
+ "type": "string"
1924
+ },
1925
+ "_type": {
1926
+ "type": "string",
1927
+ "enum": [
1928
+ "applicationKey",
1929
+ "dashboard",
1930
+ "dataTable",
1931
+ "deviceRecipe",
1932
+ "device",
1933
+ "domain",
1934
+ "event",
1935
+ "experienceEndpoint",
1936
+ "experienceGroup",
1937
+ "experienceSlug",
1938
+ "experienceUser",
1939
+ "experienceVersion",
1940
+ "experienceView",
1941
+ "file",
1942
+ "flow",
1943
+ "integration",
1944
+ "webhook"
1945
+ ]
1946
+ }
1947
+ },
1948
+ "required": [
1949
+ "id",
1950
+ "name",
1951
+ "_type"
1952
+ ]
1953
+ }
1954
+ }
1955
+ ```
1956
+ ### <a name="application-search-result-example"></a> Example
1957
+
1958
+ ```json
1959
+ [
1960
+ {
1961
+ "type": "device",
1962
+ "name": "My Device #1",
1963
+ "metadata": {
1964
+ "descriptor": "a basic description of device #1"
1965
+ },
1966
+ "id": "575ec8687ae143cd83dc4a97"
1967
+ }
1968
+ ]
1969
+ ```
1970
+
1971
+ <br/>
1972
+
1886
1973
  ## Applications
1887
1974
 
1888
1975
  Schema for a collection of Applications
@@ -1928,6 +2015,14 @@ Schema for a collection of Applications
1928
2015
  "organization"
1929
2016
  ]
1930
2017
  },
2018
+ "organizationName": {
2019
+ "type": "string",
2020
+ "minLength": 1,
2021
+ "maxLength": 255
2022
+ },
2023
+ "organizationIconColor": {
2024
+ "type": "string"
2025
+ },
1931
2026
  "name": {
1932
2027
  "type": "string",
1933
2028
  "minLength": 1,
@@ -3042,6 +3137,23 @@ Schema for a single Dashboard
3042
3137
  "organization"
3043
3138
  ]
3044
3139
  },
3140
+ "organizationName": {
3141
+ "type": "string",
3142
+ "minLength": 1,
3143
+ "maxLength": 255
3144
+ },
3145
+ "organizationIconColor": {
3146
+ "type": "string"
3147
+ },
3148
+ "applicationId": {
3149
+ "type": "string",
3150
+ "pattern": "^[A-Fa-f\\d]{24}$"
3151
+ },
3152
+ "applicationName": {
3153
+ "type": "string",
3154
+ "minLength": 1,
3155
+ "maxLength": 255
3156
+ },
3045
3157
  "name": {
3046
3158
  "type": "string",
3047
3159
  "minLength": 1,
@@ -3703,6 +3815,10 @@ Schema for the body of a Dashboard creation request
3703
3815
  "type": "string",
3704
3816
  "pattern": "^[A-Fa-f\\d]{24}$"
3705
3817
  },
3818
+ "applicationId": {
3819
+ "type": "string",
3820
+ "pattern": "^[A-Fa-f\\d]{24}$"
3821
+ },
3706
3822
  "name": {
3707
3823
  "type": "string",
3708
3824
  "minLength": 1,
@@ -4034,6 +4150,23 @@ Schema for a collection of Dashboards
4034
4150
  "organization"
4035
4151
  ]
4036
4152
  },
4153
+ "organizationName": {
4154
+ "type": "string",
4155
+ "minLength": 1,
4156
+ "maxLength": 255
4157
+ },
4158
+ "organizationIconColor": {
4159
+ "type": "string"
4160
+ },
4161
+ "applicationId": {
4162
+ "type": "string",
4163
+ "pattern": "^[A-Fa-f\\d]{24}$"
4164
+ },
4165
+ "applicationName": {
4166
+ "type": "string",
4167
+ "minLength": 1,
4168
+ "maxLength": 255
4169
+ },
4037
4170
  "name": {
4038
4171
  "type": "string",
4039
4172
  "minLength": 1,
@@ -4329,6 +4462,14 @@ Schema for a collection of Dashboards
4329
4462
  "asc",
4330
4463
  "desc"
4331
4464
  ]
4465
+ },
4466
+ "orgId": {
4467
+ "type": "string",
4468
+ "pattern": "^[A-Fa-f\\d]{24}$"
4469
+ },
4470
+ "applicationId": {
4471
+ "type": "string",
4472
+ "pattern": "^[A-Fa-f\\d]{24}$"
4332
4473
  }
4333
4474
  }
4334
4475
  }
@@ -12404,6 +12545,7 @@ Schema for a single Workflow
12404
12545
  "type": {
12405
12546
  "type": "string",
12406
12547
  "enum": [
12548
+ "customNodeStart",
12407
12549
  "dataTable",
12408
12550
  "deviceCommand",
12409
12551
  "deviceId",
@@ -12419,8 +12561,8 @@ Schema for a single Workflow
12419
12561
  "fileWatch",
12420
12562
  "integration",
12421
12563
  "mqttTopic",
12564
+ "redis",
12422
12565
  "request",
12423
- "customNodeStart",
12424
12566
  "timer",
12425
12567
  "udp",
12426
12568
  "virtualButton",
@@ -13022,6 +13164,7 @@ Schema for the body of a Workflow modification request
13022
13164
  "type": {
13023
13165
  "type": "string",
13024
13166
  "enum": [
13167
+ "customNodeStart",
13025
13168
  "dataTable",
13026
13169
  "deviceCommand",
13027
13170
  "deviceId",
@@ -13037,8 +13180,8 @@ Schema for the body of a Workflow modification request
13037
13180
  "fileWatch",
13038
13181
  "integration",
13039
13182
  "mqttTopic",
13183
+ "redis",
13040
13184
  "request",
13041
- "customNodeStart",
13042
13185
  "timer",
13043
13186
  "udp",
13044
13187
  "virtualButton",
@@ -13513,6 +13656,7 @@ Schema for the body of a Workflow creation request
13513
13656
  "type": {
13514
13657
  "type": "string",
13515
13658
  "enum": [
13659
+ "customNodeStart",
13516
13660
  "dataTable",
13517
13661
  "deviceCommand",
13518
13662
  "deviceId",
@@ -13528,8 +13672,8 @@ Schema for the body of a Workflow creation request
13528
13672
  "fileWatch",
13529
13673
  "integration",
13530
13674
  "mqttTopic",
13675
+ "redis",
13531
13676
  "request",
13532
- "customNodeStart",
13533
13677
  "timer",
13534
13678
  "udp",
13535
13679
  "virtualButton",
@@ -14144,6 +14288,7 @@ Schema for a single Workflow Version
14144
14288
  "type": {
14145
14289
  "type": "string",
14146
14290
  "enum": [
14291
+ "customNodeStart",
14147
14292
  "dataTable",
14148
14293
  "deviceCommand",
14149
14294
  "deviceId",
@@ -14159,8 +14304,8 @@ Schema for a single Workflow Version
14159
14304
  "fileWatch",
14160
14305
  "integration",
14161
14306
  "mqttTopic",
14307
+ "redis",
14162
14308
  "request",
14163
- "customNodeStart",
14164
14309
  "timer",
14165
14310
  "udp",
14166
14311
  "virtualButton",
@@ -14672,6 +14817,7 @@ Schema for a single Workflow Version
14672
14817
  "type": {
14673
14818
  "type": "string",
14674
14819
  "enum": [
14820
+ "customNodeStart",
14675
14821
  "dataTable",
14676
14822
  "deviceCommand",
14677
14823
  "deviceId",
@@ -14687,8 +14833,8 @@ Schema for a single Workflow Version
14687
14833
  "fileWatch",
14688
14834
  "integration",
14689
14835
  "mqttTopic",
14836
+ "redis",
14690
14837
  "request",
14691
- "customNodeStart",
14692
14838
  "timer",
14693
14839
  "udp",
14694
14840
  "virtualButton",
@@ -14903,6 +15049,7 @@ Schema for the body of a Workflow Version creation request
14903
15049
  "type": {
14904
15050
  "type": "string",
14905
15051
  "enum": [
15052
+ "customNodeStart",
14906
15053
  "dataTable",
14907
15054
  "deviceCommand",
14908
15055
  "deviceId",
@@ -14918,8 +15065,8 @@ Schema for the body of a Workflow Version creation request
14918
15065
  "fileWatch",
14919
15066
  "integration",
14920
15067
  "mqttTopic",
15068
+ "redis",
14921
15069
  "request",
14922
- "customNodeStart",
14923
15070
  "timer",
14924
15071
  "udp",
14925
15072
  "virtualButton",
@@ -15419,6 +15566,7 @@ Schema for a collection of Workflow Versions
15419
15566
  "type": {
15420
15567
  "type": "string",
15421
15568
  "enum": [
15569
+ "customNodeStart",
15422
15570
  "dataTable",
15423
15571
  "deviceCommand",
15424
15572
  "deviceId",
@@ -15434,8 +15582,8 @@ Schema for a collection of Workflow Versions
15434
15582
  "fileWatch",
15435
15583
  "integration",
15436
15584
  "mqttTopic",
15585
+ "redis",
15437
15586
  "request",
15438
- "customNodeStart",
15439
15587
  "timer",
15440
15588
  "udp",
15441
15589
  "virtualButton",
@@ -15947,6 +16095,7 @@ Schema for a collection of Workflow Versions
15947
16095
  "type": {
15948
16096
  "type": "string",
15949
16097
  "enum": [
16098
+ "customNodeStart",
15950
16099
  "dataTable",
15951
16100
  "deviceCommand",
15952
16101
  "deviceId",
@@ -15962,8 +16111,8 @@ Schema for a collection of Workflow Versions
15962
16111
  "fileWatch",
15963
16112
  "integration",
15964
16113
  "mqttTopic",
16114
+ "redis",
15965
16115
  "request",
15966
- "customNodeStart",
15967
16116
  "timer",
15968
16117
  "udp",
15969
16118
  "virtualButton",
@@ -16245,6 +16394,7 @@ Schema for a collection of Workflows
16245
16394
  "type": {
16246
16395
  "type": "string",
16247
16396
  "enum": [
16397
+ "customNodeStart",
16248
16398
  "dataTable",
16249
16399
  "deviceCommand",
16250
16400
  "deviceId",
@@ -16260,8 +16410,8 @@ Schema for a collection of Workflows
16260
16410
  "fileWatch",
16261
16411
  "integration",
16262
16412
  "mqttTopic",
16413
+ "redis",
16263
16414
  "request",
16264
- "customNodeStart",
16265
16415
  "timer",
16266
16416
  "udp",
16267
16417
  "virtualButton",
@@ -16847,6 +16997,7 @@ Schema for the body of a workflow import request
16847
16997
  "type": {
16848
16998
  "type": "string",
16849
16999
  "enum": [
17000
+ "customNodeStart",
16850
17001
  "dataTable",
16851
17002
  "deviceCommand",
16852
17003
  "deviceId",
@@ -16862,8 +17013,8 @@ Schema for the body of a workflow import request
16862
17013
  "fileWatch",
16863
17014
  "integration",
16864
17015
  "mqttTopic",
17016
+ "redis",
16865
17017
  "request",
16866
- "customNodeStart",
16867
17018
  "timer",
16868
17019
  "udp",
16869
17020
  "virtualButton",
@@ -17356,6 +17507,7 @@ Schema for the body of a workflow import request
17356
17507
  "type": {
17357
17508
  "type": "string",
17358
17509
  "enum": [
17510
+ "customNodeStart",
17359
17511
  "dataTable",
17360
17512
  "deviceCommand",
17361
17513
  "deviceId",
@@ -17371,8 +17523,8 @@ Schema for the body of a workflow import request
17371
17523
  "fileWatch",
17372
17524
  "integration",
17373
17525
  "mqttTopic",
17526
+ "redis",
17374
17527
  "request",
17375
- "customNodeStart",
17376
17528
  "timer",
17377
17529
  "udp",
17378
17530
  "virtualButton",
@@ -17912,6 +18064,7 @@ Schema for the result of a workflow import request
17912
18064
  "type": {
17913
18065
  "type": "string",
17914
18066
  "enum": [
18067
+ "customNodeStart",
17915
18068
  "dataTable",
17916
18069
  "deviceCommand",
17917
18070
  "deviceId",
@@ -17927,8 +18080,8 @@ Schema for the result of a workflow import request
17927
18080
  "fileWatch",
17928
18081
  "integration",
17929
18082
  "mqttTopic",
18083
+ "redis",
17930
18084
  "request",
17931
- "customNodeStart",
17932
18085
  "timer",
17933
18086
  "udp",
17934
18087
  "virtualButton",
@@ -18440,6 +18593,7 @@ Schema for the result of a workflow import request
18440
18593
  "type": {
18441
18594
  "type": "string",
18442
18595
  "enum": [
18596
+ "customNodeStart",
18443
18597
  "dataTable",
18444
18598
  "deviceCommand",
18445
18599
  "deviceId",
@@ -18455,8 +18609,8 @@ Schema for the result of a workflow import request
18455
18609
  "fileWatch",
18456
18610
  "integration",
18457
18611
  "mqttTopic",
18612
+ "redis",
18458
18613
  "request",
18459
- "customNodeStart",
18460
18614
  "timer",
18461
18615
  "udp",
18462
18616
  "virtualButton",
@@ -18968,6 +19122,7 @@ Schema for the result of a workflow import request
18968
19122
  "type": {
18969
19123
  "type": "string",
18970
19124
  "enum": [
19125
+ "customNodeStart",
18971
19126
  "dataTable",
18972
19127
  "deviceCommand",
18973
19128
  "deviceId",
@@ -18983,8 +19138,8 @@ Schema for the result of a workflow import request
18983
19138
  "fileWatch",
18984
19139
  "integration",
18985
19140
  "mqttTopic",
19141
+ "redis",
18986
19142
  "request",
18987
- "customNodeStart",
18988
19143
  "timer",
18989
19144
  "udp",
18990
19145
  "virtualButton",
@@ -19244,6 +19399,7 @@ Schema for the body of a Github login request
19244
19399
  "application.mqttSubscriptionStream",
19245
19400
  "application.patch",
19246
19401
  "application.payloadCounts",
19402
+ "application.search",
19247
19403
  "applicationApiToken.delete",
19248
19404
  "applicationApiToken.get",
19249
19405
  "applicationApiToken.patch",
@@ -19406,6 +19562,7 @@ Schema for the body of a Github login request
19406
19562
  "solutionUsers.*",
19407
19563
  "applications.get",
19408
19564
  "applications.post",
19565
+ "applications.detailedSummary",
19409
19566
  "auditLog.get",
19410
19567
  "auditLogs.get",
19411
19568
  "dashboard.patch",
@@ -20437,7 +20594,35 @@ Schema for a collection of Integrations
20437
20594
  {
20438
20595
  "items": [
20439
20596
  {
20440
- "$ref": "#/examples/integrations"
20597
+ "id": "58ec07f20c747f65243d0d76",
20598
+ "integrationId": "58ec07f20c747f65243d0d76",
20599
+ "applicationId": "575ec8687ae143cd83dc4a97",
20600
+ "creationDate": "2016-06-13T04:00:00.000Z",
20601
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
20602
+ "name": "Example Integrations",
20603
+ "integrationType": "mqtt",
20604
+ "enabled": true,
20605
+ "topics": [
20606
+ "myTopic"
20607
+ ],
20608
+ "mqttConfig": {
20609
+ "clientId": "exampleClientId",
20610
+ "username": "exampleUsername",
20611
+ "password": "examplePassword",
20612
+ "port": 8883,
20613
+ "protocol": "mqtts",
20614
+ "host": "broker.example.com"
20615
+ },
20616
+ "status": {
20617
+ "lastKeepAlive": 1491863679994,
20618
+ "connectInfo": {
20619
+ "ts": 1490629589313
20620
+ },
20621
+ "disconnectInfo": {
20622
+ "ts": 1490629587190,
20623
+ "error": "Keepalive Timeout"
20624
+ }
20625
+ }
20441
20626
  }
20442
20627
  ],
20443
20628
  "count": 1,
@@ -24470,6 +24655,7 @@ Schema for the result of a time series query
24470
24655
  "MEDIAN",
24471
24656
  "MEAN",
24472
24657
  "SUM",
24658
+ "STD_DEV",
24473
24659
  "NONE"
24474
24660
  ]
24475
24661
  },
@@ -24618,6 +24804,7 @@ Schema for the body of a time series query request
24618
24804
  "MEDIAN",
24619
24805
  "MEAN",
24620
24806
  "SUM",
24807
+ "STD_DEV",
24621
24808
  "NONE"
24622
24809
  ]
24623
24810
  },
@@ -24782,6 +24969,7 @@ Schema for the body of a User authentication request
24782
24969
  "application.mqttSubscriptionStream",
24783
24970
  "application.patch",
24784
24971
  "application.payloadCounts",
24972
+ "application.search",
24785
24973
  "applicationApiToken.delete",
24786
24974
  "applicationApiToken.get",
24787
24975
  "applicationApiToken.patch",
@@ -24944,6 +25132,7 @@ Schema for the body of a User authentication request
24944
25132
  "solutionUsers.*",
24945
25133
  "applications.get",
24946
25134
  "applications.post",
25135
+ "applications.detailedSummary",
24947
25136
  "auditLog.get",
24948
25137
  "auditLogs.get",
24949
25138
  "dashboard.patch",
@@ -25174,6 +25363,7 @@ Schema for the body of a User creation request
25174
25363
  "application.mqttSubscriptionStream",
25175
25364
  "application.patch",
25176
25365
  "application.payloadCounts",
25366
+ "application.search",
25177
25367
  "applicationApiToken.delete",
25178
25368
  "applicationApiToken.get",
25179
25369
  "applicationApiToken.patch",
@@ -25336,6 +25526,7 @@ Schema for the body of a User creation request
25336
25526
  "solutionUsers.*",
25337
25527
  "applications.get",
25338
25528
  "applications.post",
25529
+ "applications.detailedSummary",
25339
25530
  "auditLog.get",
25340
25531
  "auditLogs.get",
25341
25532
  "dashboard.patch",
@@ -25461,6 +25652,10 @@ Schema for the body of a request to press a Workflow virtual button
25461
25652
  "type": "string",
25462
25653
  "minLength": 1,
25463
25654
  "maxLength": 255
25655
+ },
25656
+ "deviceId": {
25657
+ "type": "string",
25658
+ "pattern": "^[A-Fa-f\\d]{24}$"
25464
25659
  }
25465
25660
  },
25466
25661
  "required": [