@itentialopensource/adapter-selector_ai 0.1.1
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.
- package/.eslintignore +5 -0
- package/.eslintrc.js +19 -0
- package/.jshintrc +3 -0
- package/AUTH.md +39 -0
- package/BROKER.md +211 -0
- package/CALLS.md +405 -0
- package/CODE_OF_CONDUCT.md +43 -0
- package/CONTRIBUTING.md +13 -0
- package/ENHANCE.md +69 -0
- package/LICENSE +201 -0
- package/PROPERTIES.md +661 -0
- package/README.md +344 -0
- package/SUMMARY.md +9 -0
- package/SYSTEMINFO.md +14 -0
- package/TAB1.md +8 -0
- package/TAB2.md +314 -0
- package/TROUBLESHOOT.md +56 -0
- package/UTILITIES.md +473 -0
- package/adapter.js +4039 -0
- package/adapterBase.js +1488 -0
- package/entities/.generic/action.json +214 -0
- package/entities/.generic/schema.json +28 -0
- package/entities/.system/action.json +50 -0
- package/entities/.system/mockdatafiles/getToken-default.json +3 -0
- package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
- package/entities/.system/schema.json +19 -0
- package/entities/.system/schemaTokenReq.json +53 -0
- package/entities/.system/schemaTokenResp.json +53 -0
- package/entities/InventorySchemaCreation/action.json +24 -0
- package/entities/InventorySchemaCreation/schema.json +19 -0
- package/entities/InventorySchemaDelete/action.json +24 -0
- package/entities/InventorySchemaDelete/schema.json +19 -0
- package/entities/InventorySchemaDeleteType/action.json +24 -0
- package/entities/InventorySchemaDeleteType/schema.json +19 -0
- package/entities/InventorySchemaFileDownload/action.json +24 -0
- package/entities/InventorySchemaFileDownload/schema.json +19 -0
- package/entities/InventorySchemaFileUpload/action.json +24 -0
- package/entities/InventorySchemaFileUpload/schema.json +19 -0
- package/entities/InventorySchemaUpdate/action.json +24 -0
- package/entities/InventorySchemaUpdate/schema.json +19 -0
- package/entities/InventoryV2SchemaDeleteAll/action.json +24 -0
- package/entities/InventoryV2SchemaDeleteAll/schema.json +19 -0
- package/entities/InventoryV2SchemaDeleteType/action.json +24 -0
- package/entities/InventoryV2SchemaDeleteType/schema.json +19 -0
- package/entities/InventoryV2SchemaUpdate/action.json +24 -0
- package/entities/InventoryV2SchemaUpdate/schema.json +19 -0
- package/entities/InventoryV2SchemaUpload/action.json +24 -0
- package/entities/InventoryV2SchemaUpload/schema.json +19 -0
- package/entities/MetastoreInventoryBulkDataUpload/action.json +24 -0
- package/entities/MetastoreInventoryBulkDataUpload/schema.json +19 -0
- package/entities/MetastoreInventoryCSVDataUpload/action.json +24 -0
- package/entities/MetastoreInventoryCSVDataUpload/schema.json +19 -0
- package/entities/MetastoreInventoryCsvFileExport/action.json +25 -0
- package/entities/MetastoreInventoryCsvFileExport/schema.json +19 -0
- package/entities/MetastoreInventoryDataDelete/action.json +24 -0
- package/entities/MetastoreInventoryDataDelete/schema.json +19 -0
- package/entities/MetastoreInventoryDataDownload/action.json +46 -0
- package/entities/MetastoreInventoryDataDownload/schema.json +20 -0
- package/entities/MetastoreInventoryDataEdit/action.json +24 -0
- package/entities/MetastoreInventoryDataEdit/schema.json +19 -0
- package/entities/MetastoreInventoryDataUpload/action.json +24 -0
- package/entities/MetastoreInventoryDataUpload/schema.json +19 -0
- package/entities/MetastoreInventoryFilesExport/action.json +24 -0
- package/entities/MetastoreInventoryFilesExport/schema.json +19 -0
- package/entities/MetastoreInventoryFilesImport/action.json +24 -0
- package/entities/MetastoreInventoryFilesImport/schema.json +30 -0
- package/entities/MetastoreInventoryItems/action.json +25 -0
- package/entities/MetastoreInventoryItems/schema.json +19 -0
- package/entities/MetastoreInventoryNameDelete/action.json +24 -0
- package/entities/MetastoreInventoryNameDelete/schema.json +19 -0
- package/entities/MetastoreInventoryNameUpdate/action.json +24 -0
- package/entities/MetastoreInventoryNameUpdate/schema.json +19 -0
- package/entities/MetastoreInventoryNameUpload/action.json +24 -0
- package/entities/MetastoreInventoryNameUpload/schema.json +19 -0
- package/entities/MetastoreInventoryNamesDownload/action.json +25 -0
- package/entities/MetastoreInventoryNamesDownload/schema.json +19 -0
- package/entities/MetastoreInventorySchemaGet/action.json +25 -0
- package/entities/MetastoreInventorySchemaGet/schema.json +19 -0
- package/entities/MetastoreInventorySystem/action.json +130 -0
- package/entities/MetastoreInventorySystem/schema.json +24 -0
- package/entities/MetastoreV2InventorySchemaGet/action.json +25 -0
- package/entities/MetastoreV2InventorySchemaGet/schema.json +19 -0
- package/error.json +190 -0
- package/metadata.json +58 -0
- package/package.json +77 -0
- package/pronghorn.json +2508 -0
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +1635 -0
- package/report/adapterInfo.json +10 -0
- package/report/auto-adapter-openapi.json +1330 -0
- package/report/creationReport.json +765 -0
- package/report/metastore-inventory-manager.yaml-OpenApi3Json.json +2366 -0
- package/sampleProperties.json +260 -0
- package/test/integration/adapterTestBasicGet.js +117 -0
- package/test/integration/adapterTestConnectivity.js +117 -0
- package/test/integration/adapterTestIntegration.js +1295 -0
- package/test/unit/adapterBaseTestUnit.js +1626 -0
- package/test/unit/adapterTestUnit.js +2288 -0
- package/utils/adapterInfo.js +156 -0
- package/utils/argParser.js +44 -0
- package/utils/checkMigrate.js +102 -0
- package/utils/entitiesToDB.js +190 -0
- package/utils/findPath.js +74 -0
- package/utils/logger.js +26 -0
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +153 -0
- package/utils/mongoDbConnection.js +79 -0
- package/utils/mongoUtils.js +162 -0
- package/utils/pre-commit.sh +32 -0
- package/utils/removeHooks.js +20 -0
- package/utils/setup.js +33 -0
- package/utils/taskMover.js +308 -0
- package/utils/tbScript.js +103 -0
- package/utils/tbUtils.js +347 -0
- package/utils/testRunner.js +298 -0
- package/utils/troubleshootingAdapter.js +177 -0
- package/utils/updateAdapterConfig.js +158 -0
package/pronghorn.json
ADDED
|
@@ -0,0 +1,2508 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "@itentialopensource/adapter-selector_ai",
|
|
3
|
+
"type": "Adapter",
|
|
4
|
+
"export": "SelectorAi",
|
|
5
|
+
"title": "Selector_ai",
|
|
6
|
+
"src": "adapter.js",
|
|
7
|
+
"roles": [
|
|
8
|
+
"admin"
|
|
9
|
+
],
|
|
10
|
+
"methods": [
|
|
11
|
+
{
|
|
12
|
+
"name": "iapUpdateAdapterConfiguration",
|
|
13
|
+
"summary": "Updates the adapter configuration",
|
|
14
|
+
"description": "Updates the adapter configuration file with the provided changes",
|
|
15
|
+
"input": [
|
|
16
|
+
{
|
|
17
|
+
"name": "configFile",
|
|
18
|
+
"type": "string",
|
|
19
|
+
"info": "The name of the file to change",
|
|
20
|
+
"required": true,
|
|
21
|
+
"schema": {
|
|
22
|
+
"title": "configFile",
|
|
23
|
+
"type": "string"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "changes",
|
|
28
|
+
"type": "object",
|
|
29
|
+
"info": "JSON object containing the configuration changes",
|
|
30
|
+
"required": true,
|
|
31
|
+
"schema": {
|
|
32
|
+
"title": "changes",
|
|
33
|
+
"type": "object"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"name": "entity",
|
|
38
|
+
"type": "string",
|
|
39
|
+
"info": "The entity in which the changes are being made",
|
|
40
|
+
"required": false,
|
|
41
|
+
"schema": {
|
|
42
|
+
"title": "entity",
|
|
43
|
+
"type": "string"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "type",
|
|
48
|
+
"type": "string",
|
|
49
|
+
"info": "The type of file to change - action, schema, or mock",
|
|
50
|
+
"required": false,
|
|
51
|
+
"schema": {
|
|
52
|
+
"title": "type",
|
|
53
|
+
"type": "string"
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "action",
|
|
58
|
+
"type": "string",
|
|
59
|
+
"info": "The action to be changed",
|
|
60
|
+
"required": false,
|
|
61
|
+
"schema": {
|
|
62
|
+
"title": "action",
|
|
63
|
+
"type": "string"
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "replace",
|
|
68
|
+
"type": "boolean",
|
|
69
|
+
"info": "True to replace entire mock data, false to merge/append",
|
|
70
|
+
"required": false,
|
|
71
|
+
"schema": {
|
|
72
|
+
"title": "replace",
|
|
73
|
+
"type": "boolean"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
],
|
|
77
|
+
"output": {
|
|
78
|
+
"name": "result",
|
|
79
|
+
"type": "object",
|
|
80
|
+
"description": "A JSON Object containing status, code and the result",
|
|
81
|
+
"schema": {
|
|
82
|
+
"title": "result",
|
|
83
|
+
"type": "object"
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"roles": [
|
|
87
|
+
"admin"
|
|
88
|
+
],
|
|
89
|
+
"route": {
|
|
90
|
+
"verb": "POST",
|
|
91
|
+
"path": "/iapUpdateAdapterConfiguration"
|
|
92
|
+
},
|
|
93
|
+
"task": true
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"name": "iapSuspendAdapter",
|
|
97
|
+
"summary": "Suspends the adapter",
|
|
98
|
+
"description": "Suspends the adapter",
|
|
99
|
+
"input": [
|
|
100
|
+
{
|
|
101
|
+
"name": "mode",
|
|
102
|
+
"type": "enum",
|
|
103
|
+
"enumerals": [
|
|
104
|
+
"pause",
|
|
105
|
+
"error"
|
|
106
|
+
],
|
|
107
|
+
"info": "How incoming requests are handled. Defaults to 'pause'",
|
|
108
|
+
"description": "How incoming requests are handled. Defaults to 'pause'",
|
|
109
|
+
"schema": {
|
|
110
|
+
"title": "mode",
|
|
111
|
+
"type": "string"
|
|
112
|
+
},
|
|
113
|
+
"required": false
|
|
114
|
+
}
|
|
115
|
+
],
|
|
116
|
+
"output": {
|
|
117
|
+
"name": "result",
|
|
118
|
+
"type": "object",
|
|
119
|
+
"description": "A JSON Object containing the adapter suspended status",
|
|
120
|
+
"schema": {
|
|
121
|
+
"title": "result",
|
|
122
|
+
"type": "object"
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"roles": [
|
|
126
|
+
"admin"
|
|
127
|
+
],
|
|
128
|
+
"route": {
|
|
129
|
+
"verb": "POST",
|
|
130
|
+
"path": "/iapSuspendAdapter"
|
|
131
|
+
},
|
|
132
|
+
"task": true
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "iapUnsuspendAdapter",
|
|
136
|
+
"summary": "Unsuspends the adapter",
|
|
137
|
+
"description": "Unsuspends the adapter",
|
|
138
|
+
"input": [],
|
|
139
|
+
"output": {
|
|
140
|
+
"name": "result",
|
|
141
|
+
"type": "object",
|
|
142
|
+
"description": "A JSON Object containing the adapter suspended status",
|
|
143
|
+
"schema": {
|
|
144
|
+
"title": "result",
|
|
145
|
+
"type": "object"
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"roles": [
|
|
149
|
+
"admin"
|
|
150
|
+
],
|
|
151
|
+
"route": {
|
|
152
|
+
"verb": "POST",
|
|
153
|
+
"path": "/iapUnsuspendAdapter"
|
|
154
|
+
},
|
|
155
|
+
"task": true
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"name": "iapGetAdapterQueue",
|
|
159
|
+
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
|
|
160
|
+
"description": "Return the requests that are waiting in the queue if throttling is enabled",
|
|
161
|
+
"input": [],
|
|
162
|
+
"output": {
|
|
163
|
+
"name": "result",
|
|
164
|
+
"type": "object",
|
|
165
|
+
"description": "A JSON Object containing the adapter queue",
|
|
166
|
+
"schema": {
|
|
167
|
+
"title": "result",
|
|
168
|
+
"type": "object"
|
|
169
|
+
}
|
|
170
|
+
},
|
|
171
|
+
"roles": [
|
|
172
|
+
"admin"
|
|
173
|
+
],
|
|
174
|
+
"route": {
|
|
175
|
+
"verb": "POST",
|
|
176
|
+
"path": "/iapGetAdapterQueue"
|
|
177
|
+
},
|
|
178
|
+
"task": true
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"name": "iapFindAdapterPath",
|
|
182
|
+
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
|
|
183
|
+
"description": "Provides the ability to see if a particular API path is supported by the adapter",
|
|
184
|
+
"input": [
|
|
185
|
+
{
|
|
186
|
+
"name": "apiPath",
|
|
187
|
+
"type": "string",
|
|
188
|
+
"info": "The API Path you want to check - make sure to not include base path and version",
|
|
189
|
+
"description": "The API Path you want to check - make sure to not include base path and version",
|
|
190
|
+
"schema": {
|
|
191
|
+
"title": "apiPath",
|
|
192
|
+
"type": "string"
|
|
193
|
+
},
|
|
194
|
+
"required": true
|
|
195
|
+
}
|
|
196
|
+
],
|
|
197
|
+
"output": {
|
|
198
|
+
"name": "result",
|
|
199
|
+
"type": "object",
|
|
200
|
+
"description": "A JSON Object containing the result",
|
|
201
|
+
"schema": {
|
|
202
|
+
"title": "result",
|
|
203
|
+
"type": "object"
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
"roles": [
|
|
207
|
+
"admin"
|
|
208
|
+
],
|
|
209
|
+
"route": {
|
|
210
|
+
"verb": "POST",
|
|
211
|
+
"path": "/iapFindAdapterPath"
|
|
212
|
+
},
|
|
213
|
+
"task": true
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "iapTroubleshootAdapter",
|
|
217
|
+
"summary": "Runs troubleshoot script for adapter",
|
|
218
|
+
"description": "Runs troubleshoot script for adapter",
|
|
219
|
+
"input": [
|
|
220
|
+
{
|
|
221
|
+
"name": "props",
|
|
222
|
+
"type": "object",
|
|
223
|
+
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
|
|
224
|
+
"required": false,
|
|
225
|
+
"schema": {
|
|
226
|
+
"title": "props",
|
|
227
|
+
"type": "object"
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
],
|
|
231
|
+
"output": {
|
|
232
|
+
"name": "result",
|
|
233
|
+
"type": "object",
|
|
234
|
+
"description": "A JSON Object containing the test results",
|
|
235
|
+
"schema": {
|
|
236
|
+
"title": "result",
|
|
237
|
+
"type": "object"
|
|
238
|
+
}
|
|
239
|
+
},
|
|
240
|
+
"roles": [
|
|
241
|
+
"admin"
|
|
242
|
+
],
|
|
243
|
+
"route": {
|
|
244
|
+
"verb": "POST",
|
|
245
|
+
"path": "/iapTroubleshootAdapter"
|
|
246
|
+
},
|
|
247
|
+
"task": true
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"name": "iapRunAdapterHealthcheck",
|
|
251
|
+
"summary": "Runs healthcheck script for adapter",
|
|
252
|
+
"description": "Runs healthcheck script for adapter",
|
|
253
|
+
"input": [],
|
|
254
|
+
"output": {
|
|
255
|
+
"name": "result",
|
|
256
|
+
"type": "boolean",
|
|
257
|
+
"description": "Whether healthcheck passed or failed",
|
|
258
|
+
"schema": {
|
|
259
|
+
"title": "result",
|
|
260
|
+
"type": "boolean"
|
|
261
|
+
}
|
|
262
|
+
},
|
|
263
|
+
"roles": [
|
|
264
|
+
"admin"
|
|
265
|
+
],
|
|
266
|
+
"route": {
|
|
267
|
+
"verb": "POST",
|
|
268
|
+
"path": "/iapRunAdapterHealthcheck"
|
|
269
|
+
},
|
|
270
|
+
"task": true
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "iapRunAdapterConnectivity",
|
|
274
|
+
"summary": "Runs connectivity check script for adapter",
|
|
275
|
+
"description": "Runs connectivity check script for adapter",
|
|
276
|
+
"input": [],
|
|
277
|
+
"output": {
|
|
278
|
+
"name": "result",
|
|
279
|
+
"type": "object",
|
|
280
|
+
"description": "A JSON Object containing the test results",
|
|
281
|
+
"schema": {
|
|
282
|
+
"title": "result",
|
|
283
|
+
"type": "object"
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"roles": [
|
|
287
|
+
"admin"
|
|
288
|
+
],
|
|
289
|
+
"route": {
|
|
290
|
+
"verb": "POST",
|
|
291
|
+
"path": "/iapRunAdapterConnectivity"
|
|
292
|
+
},
|
|
293
|
+
"task": true
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": "iapRunAdapterBasicGet",
|
|
297
|
+
"summary": "Runs basicGet script for adapter",
|
|
298
|
+
"description": "Runs basicGet script for adapter",
|
|
299
|
+
"input": [
|
|
300
|
+
{
|
|
301
|
+
"name": "maxCalls",
|
|
302
|
+
"required": false,
|
|
303
|
+
"type": "number",
|
|
304
|
+
"info": "How many GET endpoints to test (defaults to 5)",
|
|
305
|
+
"schema": {
|
|
306
|
+
"title": "maxCalls",
|
|
307
|
+
"type": "number",
|
|
308
|
+
"default": 5
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
],
|
|
312
|
+
"output": {
|
|
313
|
+
"name": "result",
|
|
314
|
+
"type": "object",
|
|
315
|
+
"description": "A JSON Object containing the test results",
|
|
316
|
+
"schema": {
|
|
317
|
+
"title": "result",
|
|
318
|
+
"type": "object"
|
|
319
|
+
}
|
|
320
|
+
},
|
|
321
|
+
"roles": [
|
|
322
|
+
"admin"
|
|
323
|
+
],
|
|
324
|
+
"route": {
|
|
325
|
+
"verb": "POST",
|
|
326
|
+
"path": "/iapRunAdapterBasicGet"
|
|
327
|
+
},
|
|
328
|
+
"task": true
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "iapMoveAdapterEntitiesToDB",
|
|
332
|
+
"summary": "Moves entities from an adapter into the Itential Platform database",
|
|
333
|
+
"description": "Moves entities from an adapter into the Itential Platform database",
|
|
334
|
+
"input": [],
|
|
335
|
+
"output": {
|
|
336
|
+
"name": "res",
|
|
337
|
+
"type": "object",
|
|
338
|
+
"description": "A JSON Object containing status, code and the response from the mongo transaction",
|
|
339
|
+
"schema": {
|
|
340
|
+
"title": "res",
|
|
341
|
+
"type": "object"
|
|
342
|
+
}
|
|
343
|
+
},
|
|
344
|
+
"roles": [
|
|
345
|
+
"admin"
|
|
346
|
+
],
|
|
347
|
+
"route": {
|
|
348
|
+
"verb": "POST",
|
|
349
|
+
"path": "/iapMoveAdapterEntitiesToDB"
|
|
350
|
+
},
|
|
351
|
+
"task": true
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "iapDeactivateTasks",
|
|
355
|
+
"summary": "Deactivate the inputted tasks",
|
|
356
|
+
"description": "Deactivate the inputted tasks",
|
|
357
|
+
"input": [
|
|
358
|
+
{
|
|
359
|
+
"name": "tasks",
|
|
360
|
+
"type": "array",
|
|
361
|
+
"description": "Tasks to deactivate",
|
|
362
|
+
"schema": {
|
|
363
|
+
"title": "tasks",
|
|
364
|
+
"type": "array"
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
],
|
|
368
|
+
"output": {
|
|
369
|
+
"name": "result",
|
|
370
|
+
"type": "object",
|
|
371
|
+
"description": "A JSON Object containing success status",
|
|
372
|
+
"schema": {
|
|
373
|
+
"title": "result",
|
|
374
|
+
"type": "object"
|
|
375
|
+
}
|
|
376
|
+
},
|
|
377
|
+
"roles": [
|
|
378
|
+
"admin"
|
|
379
|
+
],
|
|
380
|
+
"route": {
|
|
381
|
+
"verb": "POST",
|
|
382
|
+
"path": "/iapDeactivateTasks"
|
|
383
|
+
},
|
|
384
|
+
"task": true
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "iapActivateTasks",
|
|
388
|
+
"summary": "Activate the inputted tasks",
|
|
389
|
+
"description": "activate the inputted tasks",
|
|
390
|
+
"input": [
|
|
391
|
+
{
|
|
392
|
+
"name": "tasks",
|
|
393
|
+
"type": "array",
|
|
394
|
+
"description": "Tasks to activate",
|
|
395
|
+
"schema": {
|
|
396
|
+
"title": "tasks",
|
|
397
|
+
"type": "array"
|
|
398
|
+
}
|
|
399
|
+
}
|
|
400
|
+
],
|
|
401
|
+
"output": {
|
|
402
|
+
"name": "result",
|
|
403
|
+
"type": "object",
|
|
404
|
+
"description": "A JSON Object containing success status",
|
|
405
|
+
"schema": {
|
|
406
|
+
"title": "result",
|
|
407
|
+
"type": "object"
|
|
408
|
+
}
|
|
409
|
+
},
|
|
410
|
+
"roles": [
|
|
411
|
+
"admin"
|
|
412
|
+
],
|
|
413
|
+
"route": {
|
|
414
|
+
"verb": "POST",
|
|
415
|
+
"path": "/iapActivateTasks"
|
|
416
|
+
},
|
|
417
|
+
"task": true
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"name": "iapPopulateEntityCache",
|
|
421
|
+
"summary": "Populate the cache for the given entities",
|
|
422
|
+
"description": "Populate the cache for the given entities",
|
|
423
|
+
"input": [
|
|
424
|
+
{
|
|
425
|
+
"name": "entityTypes",
|
|
426
|
+
"type": "array",
|
|
427
|
+
"info": "the entity type(s) to populate",
|
|
428
|
+
"required": true,
|
|
429
|
+
"schema": {
|
|
430
|
+
"title": "entityTypes",
|
|
431
|
+
"type": "array"
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
],
|
|
435
|
+
"output": {
|
|
436
|
+
"name": "result",
|
|
437
|
+
"type": "object",
|
|
438
|
+
"description": "A JSON Object containing status, code and the result",
|
|
439
|
+
"schema": {
|
|
440
|
+
"title": "result",
|
|
441
|
+
"type": "object"
|
|
442
|
+
}
|
|
443
|
+
},
|
|
444
|
+
"roles": [
|
|
445
|
+
"admin"
|
|
446
|
+
],
|
|
447
|
+
"route": {
|
|
448
|
+
"verb": "POST",
|
|
449
|
+
"path": "/iapPopulateEntityCache"
|
|
450
|
+
},
|
|
451
|
+
"task": true
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"name": "iapRetrieveEntitiesCache",
|
|
455
|
+
"summary": "Retrieves data from cache for specified entity type",
|
|
456
|
+
"description": "Retrieves data from cache for specified entity type",
|
|
457
|
+
"input": [
|
|
458
|
+
{
|
|
459
|
+
"name": "entityType",
|
|
460
|
+
"type": "string",
|
|
461
|
+
"info": "entity of which to retrieve",
|
|
462
|
+
"required": true,
|
|
463
|
+
"schema": {
|
|
464
|
+
"title": "entityType",
|
|
465
|
+
"type": "string"
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "options",
|
|
470
|
+
"type": "object",
|
|
471
|
+
"info": "settings of which data to return and how to return it",
|
|
472
|
+
"required": false,
|
|
473
|
+
"schema": {
|
|
474
|
+
"title": "options",
|
|
475
|
+
"type": "object"
|
|
476
|
+
}
|
|
477
|
+
}
|
|
478
|
+
],
|
|
479
|
+
"output": {
|
|
480
|
+
"name": "result",
|
|
481
|
+
"type": "object",
|
|
482
|
+
"description": "A JSON Object containing status, code and the result",
|
|
483
|
+
"schema": {
|
|
484
|
+
"title": "result",
|
|
485
|
+
"type": "object"
|
|
486
|
+
}
|
|
487
|
+
},
|
|
488
|
+
"roles": [
|
|
489
|
+
"admin"
|
|
490
|
+
],
|
|
491
|
+
"route": {
|
|
492
|
+
"verb": "POST",
|
|
493
|
+
"path": "/iapRetrieveEntitiesCache"
|
|
494
|
+
},
|
|
495
|
+
"task": true
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"name": "getDevice",
|
|
499
|
+
"summary": "Get the Appliance",
|
|
500
|
+
"description": "Get the Appliance",
|
|
501
|
+
"input": [
|
|
502
|
+
{
|
|
503
|
+
"name": "deviceName",
|
|
504
|
+
"type": "string",
|
|
505
|
+
"info": "An Appliance Device Name",
|
|
506
|
+
"required": true,
|
|
507
|
+
"schema": {
|
|
508
|
+
"title": "deviceName",
|
|
509
|
+
"type": "string"
|
|
510
|
+
}
|
|
511
|
+
}
|
|
512
|
+
],
|
|
513
|
+
"output": {
|
|
514
|
+
"name": "result",
|
|
515
|
+
"type": "object",
|
|
516
|
+
"description": "A JSON Object containing status, code and the result",
|
|
517
|
+
"schema": {
|
|
518
|
+
"title": "result",
|
|
519
|
+
"type": "object"
|
|
520
|
+
}
|
|
521
|
+
},
|
|
522
|
+
"roles": [
|
|
523
|
+
"admin"
|
|
524
|
+
],
|
|
525
|
+
"route": {
|
|
526
|
+
"verb": "POST",
|
|
527
|
+
"path": "/getDevice"
|
|
528
|
+
},
|
|
529
|
+
"task": false
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"name": "getDevicesFiltered",
|
|
533
|
+
"summary": "Get Appliances that match the filter",
|
|
534
|
+
"description": "Get Appliances that match the filter",
|
|
535
|
+
"input": [
|
|
536
|
+
{
|
|
537
|
+
"name": "options",
|
|
538
|
+
"type": "object",
|
|
539
|
+
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
|
|
540
|
+
"required": true,
|
|
541
|
+
"schema": {
|
|
542
|
+
"title": "options",
|
|
543
|
+
"type": "object"
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
],
|
|
547
|
+
"output": {
|
|
548
|
+
"name": "result",
|
|
549
|
+
"type": "array",
|
|
550
|
+
"description": "A JSON Object containing status, code and the result",
|
|
551
|
+
"schema": {
|
|
552
|
+
"title": "result",
|
|
553
|
+
"type": "array"
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
"roles": [
|
|
557
|
+
"admin"
|
|
558
|
+
],
|
|
559
|
+
"route": {
|
|
560
|
+
"verb": "POST",
|
|
561
|
+
"path": "/getDevicesFiltered"
|
|
562
|
+
},
|
|
563
|
+
"task": false
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "isAlive",
|
|
567
|
+
"summary": "Checks the status for the provided Appliance",
|
|
568
|
+
"description": "Checks the status for the provided Appliance",
|
|
569
|
+
"input": [
|
|
570
|
+
{
|
|
571
|
+
"name": "deviceName",
|
|
572
|
+
"type": "string",
|
|
573
|
+
"info": "An Appliance Device Name",
|
|
574
|
+
"required": true,
|
|
575
|
+
"schema": {
|
|
576
|
+
"title": "deviceName",
|
|
577
|
+
"type": "string"
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
],
|
|
581
|
+
"output": {
|
|
582
|
+
"name": "result",
|
|
583
|
+
"type": "boolean",
|
|
584
|
+
"description": "A JSON Object containing status, code and the result",
|
|
585
|
+
"schema": {
|
|
586
|
+
"title": "result",
|
|
587
|
+
"type": "boolean"
|
|
588
|
+
}
|
|
589
|
+
},
|
|
590
|
+
"roles": [
|
|
591
|
+
"admin"
|
|
592
|
+
],
|
|
593
|
+
"route": {
|
|
594
|
+
"verb": "POST",
|
|
595
|
+
"path": "/isAlive"
|
|
596
|
+
},
|
|
597
|
+
"task": false
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "getConfig",
|
|
601
|
+
"summary": "Gets a config for the provided Appliance",
|
|
602
|
+
"description": "Gets a config for the provided Appliance",
|
|
603
|
+
"input": [
|
|
604
|
+
{
|
|
605
|
+
"name": "deviceName",
|
|
606
|
+
"type": "string",
|
|
607
|
+
"info": "An Appliance Device Name",
|
|
608
|
+
"required": true,
|
|
609
|
+
"schema": {
|
|
610
|
+
"title": "deviceName",
|
|
611
|
+
"type": "string"
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"name": "format",
|
|
616
|
+
"type": "string",
|
|
617
|
+
"info": "The format to be returned - this is ignored as we always return json",
|
|
618
|
+
"required": false,
|
|
619
|
+
"schema": {
|
|
620
|
+
"title": "format",
|
|
621
|
+
"type": "string"
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
],
|
|
625
|
+
"output": {
|
|
626
|
+
"name": "result",
|
|
627
|
+
"type": "object",
|
|
628
|
+
"description": "A JSON Object containing status, code and the result",
|
|
629
|
+
"schema": {
|
|
630
|
+
"title": "result",
|
|
631
|
+
"type": "object"
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
"roles": [
|
|
635
|
+
"admin"
|
|
636
|
+
],
|
|
637
|
+
"route": {
|
|
638
|
+
"verb": "POST",
|
|
639
|
+
"path": "/getConfig"
|
|
640
|
+
},
|
|
641
|
+
"task": false
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"name": "iapGetDeviceCount",
|
|
645
|
+
"summary": "Gets a device count from the system",
|
|
646
|
+
"description": "Gets a device count from the system",
|
|
647
|
+
"input": [],
|
|
648
|
+
"output": {
|
|
649
|
+
"name": "result",
|
|
650
|
+
"type": "object",
|
|
651
|
+
"description": "A JSON Object containing status, code and the result",
|
|
652
|
+
"schema": {
|
|
653
|
+
"title": "result",
|
|
654
|
+
"type": "object"
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
"roles": [
|
|
658
|
+
"admin"
|
|
659
|
+
],
|
|
660
|
+
"route": {
|
|
661
|
+
"verb": "POST",
|
|
662
|
+
"path": "/iapGetDeviceCount"
|
|
663
|
+
},
|
|
664
|
+
"task": false
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "iapExpandedGenericAdapterRequest",
|
|
668
|
+
"summary": "Makes the requested generic call with additional options",
|
|
669
|
+
"description": "Makes the requested generic call with additional options via metadata",
|
|
670
|
+
"input": [
|
|
671
|
+
{
|
|
672
|
+
"name": "metadata",
|
|
673
|
+
"type": "object",
|
|
674
|
+
"info": "metadata for the call (optional)",
|
|
675
|
+
"description": "metadata for the call - allows for many enhancements (optional)",
|
|
676
|
+
"schema": {
|
|
677
|
+
"title": "metadata",
|
|
678
|
+
"type": "object"
|
|
679
|
+
},
|
|
680
|
+
"required": false
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "uriPath",
|
|
684
|
+
"type": "string",
|
|
685
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
686
|
+
"description": "the path of the api call",
|
|
687
|
+
"schema": {
|
|
688
|
+
"title": "uriPath",
|
|
689
|
+
"type": "string"
|
|
690
|
+
},
|
|
691
|
+
"required": false
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
"name": "restMethod",
|
|
695
|
+
"type": "string",
|
|
696
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
697
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
698
|
+
"schema": {
|
|
699
|
+
"title": "restMethod",
|
|
700
|
+
"type": "string"
|
|
701
|
+
},
|
|
702
|
+
"required": false
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"name": "pathVars",
|
|
706
|
+
"type": "object",
|
|
707
|
+
"info": "the parameters to be put within the url path (optional)",
|
|
708
|
+
"description": "the parameters to be put within the url path (optional)",
|
|
709
|
+
"schema": {
|
|
710
|
+
"title": "pathVars",
|
|
711
|
+
"type": "object"
|
|
712
|
+
},
|
|
713
|
+
"required": false
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "queryData",
|
|
717
|
+
"type": "object",
|
|
718
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
719
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
720
|
+
"schema": {
|
|
721
|
+
"title": "queryData",
|
|
722
|
+
"type": "object"
|
|
723
|
+
},
|
|
724
|
+
"required": false
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
"name": "requestBody",
|
|
728
|
+
"type": "object",
|
|
729
|
+
"info": "the payload to be sent with the request (optional)",
|
|
730
|
+
"description": "the payload to be sent with the request (optional)",
|
|
731
|
+
"schema": {
|
|
732
|
+
"title": "requestBody",
|
|
733
|
+
"type": "object"
|
|
734
|
+
},
|
|
735
|
+
"required": false
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
"name": "addlHeaders",
|
|
739
|
+
"type": "object",
|
|
740
|
+
"info": "additional headers to be put on the call (optional)",
|
|
741
|
+
"description": "additional headers to be put on the call (optional)",
|
|
742
|
+
"schema": {
|
|
743
|
+
"title": "addlHeaders",
|
|
744
|
+
"type": "object"
|
|
745
|
+
},
|
|
746
|
+
"required": false
|
|
747
|
+
}
|
|
748
|
+
],
|
|
749
|
+
"output": {
|
|
750
|
+
"name": "result",
|
|
751
|
+
"type": "object",
|
|
752
|
+
"description": "A JSON Object containing status, code and the result",
|
|
753
|
+
"schema": {
|
|
754
|
+
"title": "result",
|
|
755
|
+
"type": "object"
|
|
756
|
+
}
|
|
757
|
+
},
|
|
758
|
+
"roles": [
|
|
759
|
+
"admin"
|
|
760
|
+
],
|
|
761
|
+
"route": {
|
|
762
|
+
"verb": "POST",
|
|
763
|
+
"path": "/iapExpandedGenericAdapterRequest"
|
|
764
|
+
},
|
|
765
|
+
"task": true
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
"name": "genericAdapterRequest",
|
|
769
|
+
"summary": "Makes the requested generic call",
|
|
770
|
+
"description": "Makes the requested generic call",
|
|
771
|
+
"input": [
|
|
772
|
+
{
|
|
773
|
+
"name": "uriPath",
|
|
774
|
+
"type": "string",
|
|
775
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
776
|
+
"description": "the path of the api call",
|
|
777
|
+
"schema": {
|
|
778
|
+
"title": "uriPath",
|
|
779
|
+
"type": "string"
|
|
780
|
+
},
|
|
781
|
+
"required": true
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"name": "restMethod",
|
|
785
|
+
"type": "string",
|
|
786
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
787
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
788
|
+
"schema": {
|
|
789
|
+
"title": "restMethod",
|
|
790
|
+
"type": "string"
|
|
791
|
+
},
|
|
792
|
+
"required": true
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "queryData",
|
|
796
|
+
"type": "object",
|
|
797
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
798
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
799
|
+
"schema": {
|
|
800
|
+
"title": "queryData",
|
|
801
|
+
"type": "object"
|
|
802
|
+
},
|
|
803
|
+
"required": false
|
|
804
|
+
},
|
|
805
|
+
{
|
|
806
|
+
"name": "requestBody",
|
|
807
|
+
"type": "object",
|
|
808
|
+
"info": "the payload to be sent with the request (optional)",
|
|
809
|
+
"description": "the payload to be sent with the request (optional)",
|
|
810
|
+
"schema": {
|
|
811
|
+
"title": "requestBody",
|
|
812
|
+
"type": "object"
|
|
813
|
+
},
|
|
814
|
+
"required": false
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
"name": "addlHeaders",
|
|
818
|
+
"type": "object",
|
|
819
|
+
"info": "additional headers to be put on the call (optional)",
|
|
820
|
+
"description": "additional headers to be put on the call (optional)",
|
|
821
|
+
"schema": {
|
|
822
|
+
"title": "addlHeaders",
|
|
823
|
+
"type": "object"
|
|
824
|
+
},
|
|
825
|
+
"required": false
|
|
826
|
+
}
|
|
827
|
+
],
|
|
828
|
+
"output": {
|
|
829
|
+
"name": "result",
|
|
830
|
+
"type": "object",
|
|
831
|
+
"description": "A JSON Object containing status, code and the result",
|
|
832
|
+
"schema": {
|
|
833
|
+
"title": "result",
|
|
834
|
+
"type": "object"
|
|
835
|
+
}
|
|
836
|
+
},
|
|
837
|
+
"roles": [
|
|
838
|
+
"admin"
|
|
839
|
+
],
|
|
840
|
+
"route": {
|
|
841
|
+
"verb": "POST",
|
|
842
|
+
"path": "/genericAdapterRequest"
|
|
843
|
+
},
|
|
844
|
+
"task": true
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "genericAdapterRequestNoBasePath",
|
|
848
|
+
"summary": "Makes the requested generic call",
|
|
849
|
+
"description": "Makes the requested generic call",
|
|
850
|
+
"input": [
|
|
851
|
+
{
|
|
852
|
+
"name": "uriPath",
|
|
853
|
+
"type": "string",
|
|
854
|
+
"info": "the path of the api call - do not include the host, port, base path or version",
|
|
855
|
+
"description": "the path of the api call",
|
|
856
|
+
"schema": {
|
|
857
|
+
"title": "uriPath",
|
|
858
|
+
"type": "string"
|
|
859
|
+
},
|
|
860
|
+
"required": true
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"name": "restMethod",
|
|
864
|
+
"type": "string",
|
|
865
|
+
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
866
|
+
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
|
|
867
|
+
"schema": {
|
|
868
|
+
"title": "restMethod",
|
|
869
|
+
"type": "string"
|
|
870
|
+
},
|
|
871
|
+
"required": true
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"name": "queryData",
|
|
875
|
+
"type": "object",
|
|
876
|
+
"info": "the query parameters to be put on the url (optional)",
|
|
877
|
+
"description": "the query parameters to be put on the url (optional)",
|
|
878
|
+
"schema": {
|
|
879
|
+
"title": "queryData",
|
|
880
|
+
"type": "object"
|
|
881
|
+
},
|
|
882
|
+
"required": false
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "requestBody",
|
|
886
|
+
"type": "object",
|
|
887
|
+
"info": "the payload to be sent with the request (optional)",
|
|
888
|
+
"description": "the payload to be sent with the request (optional)",
|
|
889
|
+
"schema": {
|
|
890
|
+
"title": "requestBody",
|
|
891
|
+
"type": "object"
|
|
892
|
+
},
|
|
893
|
+
"required": false
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "addlHeaders",
|
|
897
|
+
"type": "object",
|
|
898
|
+
"info": "additional headers to be put on the call (optional)",
|
|
899
|
+
"description": "additional headers to be put on the call (optional)",
|
|
900
|
+
"schema": {
|
|
901
|
+
"title": "addlHeaders",
|
|
902
|
+
"type": "object"
|
|
903
|
+
},
|
|
904
|
+
"required": false
|
|
905
|
+
}
|
|
906
|
+
],
|
|
907
|
+
"output": {
|
|
908
|
+
"name": "result",
|
|
909
|
+
"type": "object",
|
|
910
|
+
"description": "A JSON Object containing status, code and the result",
|
|
911
|
+
"schema": {
|
|
912
|
+
"title": "result",
|
|
913
|
+
"type": "object"
|
|
914
|
+
}
|
|
915
|
+
},
|
|
916
|
+
"roles": [
|
|
917
|
+
"admin"
|
|
918
|
+
],
|
|
919
|
+
"route": {
|
|
920
|
+
"verb": "POST",
|
|
921
|
+
"path": "/genericAdapterRequestNoBasePath"
|
|
922
|
+
},
|
|
923
|
+
"task": true
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "iapRunAdapterLint",
|
|
927
|
+
"summary": "Run the adapter lint script to return the results",
|
|
928
|
+
"description": "Run the adapter lint script to return the results",
|
|
929
|
+
"input": [],
|
|
930
|
+
"output": {
|
|
931
|
+
"name": "result",
|
|
932
|
+
"type": "string",
|
|
933
|
+
"description": "A string containing the run results",
|
|
934
|
+
"schema": {
|
|
935
|
+
"title": "result",
|
|
936
|
+
"type": "string"
|
|
937
|
+
}
|
|
938
|
+
},
|
|
939
|
+
"roles": [
|
|
940
|
+
"admin"
|
|
941
|
+
],
|
|
942
|
+
"route": {
|
|
943
|
+
"verb": "GET",
|
|
944
|
+
"path": "/iapRunAdapterLint"
|
|
945
|
+
},
|
|
946
|
+
"task": true
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
"name": "iapRunAdapterTests",
|
|
950
|
+
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
|
|
951
|
+
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
|
|
952
|
+
"input": [],
|
|
953
|
+
"output": {
|
|
954
|
+
"name": "result",
|
|
955
|
+
"type": "object",
|
|
956
|
+
"description": "A JSON Object containing status, code and the result",
|
|
957
|
+
"schema": {
|
|
958
|
+
"title": "result",
|
|
959
|
+
"type": "object"
|
|
960
|
+
}
|
|
961
|
+
},
|
|
962
|
+
"roles": [
|
|
963
|
+
"admin"
|
|
964
|
+
],
|
|
965
|
+
"route": {
|
|
966
|
+
"verb": "GET",
|
|
967
|
+
"path": "/iapRunAdapterTests"
|
|
968
|
+
},
|
|
969
|
+
"task": true
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"name": "iapGetAdapterInventory",
|
|
973
|
+
"summary": "Provide inventory information abbout the adapter",
|
|
974
|
+
"description": "Provide inventory information abbout the adapter",
|
|
975
|
+
"input": [],
|
|
976
|
+
"output": {
|
|
977
|
+
"name": "result",
|
|
978
|
+
"type": "object",
|
|
979
|
+
"description": "A JSON Object containing status, code and the result",
|
|
980
|
+
"schema": {
|
|
981
|
+
"title": "result",
|
|
982
|
+
"type": "object"
|
|
983
|
+
}
|
|
984
|
+
},
|
|
985
|
+
"roles": [
|
|
986
|
+
"admin"
|
|
987
|
+
],
|
|
988
|
+
"route": {
|
|
989
|
+
"verb": "GET",
|
|
990
|
+
"path": "/iapGetAdapterInventory"
|
|
991
|
+
},
|
|
992
|
+
"task": true
|
|
993
|
+
},
|
|
994
|
+
{
|
|
995
|
+
"name": "getAllInventoryV1InventoryGet",
|
|
996
|
+
"summary": "Get_all_inventory_v1_inventory_get",
|
|
997
|
+
"description": "The Api returns current metastore inventory names in the form of a json object.\n\nThe response section of the json contains a list of metastore inventory objects which has 2 keys:\n- **type**: The type of the Metastore inventory object\n- **name**: The name of the Metastore inventory object",
|
|
998
|
+
"input": [
|
|
999
|
+
{
|
|
1000
|
+
"name": "iapMetadata",
|
|
1001
|
+
"type": "object",
|
|
1002
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1003
|
+
"required": false,
|
|
1004
|
+
"schema": {
|
|
1005
|
+
"title": "iapMetadata",
|
|
1006
|
+
"type": "object"
|
|
1007
|
+
}
|
|
1008
|
+
}
|
|
1009
|
+
],
|
|
1010
|
+
"output": {
|
|
1011
|
+
"name": "result",
|
|
1012
|
+
"type": "object",
|
|
1013
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1014
|
+
"schema": {
|
|
1015
|
+
"title": "result",
|
|
1016
|
+
"type": "object"
|
|
1017
|
+
}
|
|
1018
|
+
},
|
|
1019
|
+
"roles": [
|
|
1020
|
+
"admin"
|
|
1021
|
+
],
|
|
1022
|
+
"route": {
|
|
1023
|
+
"verb": "GET",
|
|
1024
|
+
"path": "/getAllInventoryV1InventoryGet"
|
|
1025
|
+
},
|
|
1026
|
+
"task": true
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "inventoryCreationV1InventoryPost",
|
|
1030
|
+
"summary": "Inventory_creation_v1_inventory_post",
|
|
1031
|
+
"description": "Executes a post operation to the API to create a new inventory name in the metasore",
|
|
1032
|
+
"input": [
|
|
1033
|
+
{
|
|
1034
|
+
"name": "body",
|
|
1035
|
+
"type": "object",
|
|
1036
|
+
"info": ": object",
|
|
1037
|
+
"required": true,
|
|
1038
|
+
"schema": {
|
|
1039
|
+
"type": "object",
|
|
1040
|
+
"definitions": {}
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
"name": "iapMetadata",
|
|
1045
|
+
"type": "object",
|
|
1046
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1047
|
+
"required": false,
|
|
1048
|
+
"schema": {
|
|
1049
|
+
"title": "iapMetadata",
|
|
1050
|
+
"type": "object"
|
|
1051
|
+
}
|
|
1052
|
+
}
|
|
1053
|
+
],
|
|
1054
|
+
"output": {
|
|
1055
|
+
"name": "result",
|
|
1056
|
+
"type": "object",
|
|
1057
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1058
|
+
"schema": {
|
|
1059
|
+
"title": "result",
|
|
1060
|
+
"type": "object"
|
|
1061
|
+
}
|
|
1062
|
+
},
|
|
1063
|
+
"roles": [
|
|
1064
|
+
"admin"
|
|
1065
|
+
],
|
|
1066
|
+
"route": {
|
|
1067
|
+
"verb": "POST",
|
|
1068
|
+
"path": "/inventoryCreationV1InventoryPost"
|
|
1069
|
+
},
|
|
1070
|
+
"task": true
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
"name": "inventoryUpdateV1InventoryNamePut",
|
|
1074
|
+
"summary": "Inventory_update_v1_inventory__name__put",
|
|
1075
|
+
"description": "Executes a put operation to the API to update existing inventory tags in the metasore",
|
|
1076
|
+
"input": [
|
|
1077
|
+
{
|
|
1078
|
+
"name": "name",
|
|
1079
|
+
"type": "string",
|
|
1080
|
+
"info": "Name of the inventory to delete: string",
|
|
1081
|
+
"required": true,
|
|
1082
|
+
"schema": {
|
|
1083
|
+
"title": "name",
|
|
1084
|
+
"type": "string"
|
|
1085
|
+
}
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"name": "body",
|
|
1089
|
+
"type": "object",
|
|
1090
|
+
"info": ": object",
|
|
1091
|
+
"required": true,
|
|
1092
|
+
"schema": {
|
|
1093
|
+
"type": "object",
|
|
1094
|
+
"definitions": {}
|
|
1095
|
+
}
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"name": "iapMetadata",
|
|
1099
|
+
"type": "object",
|
|
1100
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1101
|
+
"required": false,
|
|
1102
|
+
"schema": {
|
|
1103
|
+
"title": "iapMetadata",
|
|
1104
|
+
"type": "object"
|
|
1105
|
+
}
|
|
1106
|
+
}
|
|
1107
|
+
],
|
|
1108
|
+
"output": {
|
|
1109
|
+
"name": "result",
|
|
1110
|
+
"type": "object",
|
|
1111
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1112
|
+
"schema": {
|
|
1113
|
+
"title": "result",
|
|
1114
|
+
"type": "object"
|
|
1115
|
+
}
|
|
1116
|
+
},
|
|
1117
|
+
"roles": [
|
|
1118
|
+
"admin"
|
|
1119
|
+
],
|
|
1120
|
+
"route": {
|
|
1121
|
+
"verb": "POST",
|
|
1122
|
+
"path": "/inventoryUpdateV1InventoryNamePut"
|
|
1123
|
+
},
|
|
1124
|
+
"task": true
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"name": "deletingSpecificInventoryV1InventoryNameDelete",
|
|
1128
|
+
"summary": "Deleting_Specific_Inventory_v1_inventory__name__delete",
|
|
1129
|
+
"description": "Executes a delete operation through the API to delete an inventory in the metasore",
|
|
1130
|
+
"input": [
|
|
1131
|
+
{
|
|
1132
|
+
"name": "name",
|
|
1133
|
+
"type": "string",
|
|
1134
|
+
"info": "Name of the inventory to delete: string",
|
|
1135
|
+
"required": true,
|
|
1136
|
+
"schema": {
|
|
1137
|
+
"title": "name",
|
|
1138
|
+
"type": "string"
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"name": "iapMetadata",
|
|
1143
|
+
"type": "object",
|
|
1144
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1145
|
+
"required": false,
|
|
1146
|
+
"schema": {
|
|
1147
|
+
"title": "iapMetadata",
|
|
1148
|
+
"type": "object"
|
|
1149
|
+
}
|
|
1150
|
+
}
|
|
1151
|
+
],
|
|
1152
|
+
"output": {
|
|
1153
|
+
"name": "result",
|
|
1154
|
+
"type": "object",
|
|
1155
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1156
|
+
"schema": {
|
|
1157
|
+
"title": "result",
|
|
1158
|
+
"type": "object"
|
|
1159
|
+
}
|
|
1160
|
+
},
|
|
1161
|
+
"roles": [
|
|
1162
|
+
"admin"
|
|
1163
|
+
],
|
|
1164
|
+
"route": {
|
|
1165
|
+
"verb": "POST",
|
|
1166
|
+
"path": "/deletingSpecificInventoryV1InventoryNameDelete"
|
|
1167
|
+
},
|
|
1168
|
+
"task": true
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
"name": "inventoryItemGetV1InventoryNameGet",
|
|
1172
|
+
"summary": "Inventory_Item_get_v1_inventory__name__get",
|
|
1173
|
+
"description": "The Api returns inventory data of the inventory name provided in the API endpoint in the form of a list of jsons.\n\nThe response section of the json contains a list of jsons which map the column name to a value along with an extra key named **ID**.\n\nThe **ID** key is unique for all the elements in the inventory and we need to use this for all **row specific operations**.",
|
|
1174
|
+
"input": [
|
|
1175
|
+
{
|
|
1176
|
+
"name": "name",
|
|
1177
|
+
"type": "string",
|
|
1178
|
+
"info": ": string",
|
|
1179
|
+
"required": true,
|
|
1180
|
+
"schema": {
|
|
1181
|
+
"title": "name",
|
|
1182
|
+
"type": "string"
|
|
1183
|
+
}
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"name": "pattern",
|
|
1187
|
+
"type": "string",
|
|
1188
|
+
"info": ": string",
|
|
1189
|
+
"required": false,
|
|
1190
|
+
"schema": {
|
|
1191
|
+
"title": "pattern",
|
|
1192
|
+
"type": "string"
|
|
1193
|
+
}
|
|
1194
|
+
},
|
|
1195
|
+
{
|
|
1196
|
+
"name": "iapMetadata",
|
|
1197
|
+
"type": "object",
|
|
1198
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1199
|
+
"required": false,
|
|
1200
|
+
"schema": {
|
|
1201
|
+
"title": "iapMetadata",
|
|
1202
|
+
"type": "object"
|
|
1203
|
+
}
|
|
1204
|
+
}
|
|
1205
|
+
],
|
|
1206
|
+
"output": {
|
|
1207
|
+
"name": "result",
|
|
1208
|
+
"type": "object",
|
|
1209
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1210
|
+
"schema": {
|
|
1211
|
+
"title": "result",
|
|
1212
|
+
"type": "object"
|
|
1213
|
+
}
|
|
1214
|
+
},
|
|
1215
|
+
"roles": [
|
|
1216
|
+
"admin"
|
|
1217
|
+
],
|
|
1218
|
+
"route": {
|
|
1219
|
+
"verb": "POST",
|
|
1220
|
+
"path": "/inventoryItemGetV1InventoryNameGet"
|
|
1221
|
+
},
|
|
1222
|
+
"task": true
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"name": "inventoryItemGetV1InventoryNameIdGet",
|
|
1226
|
+
"summary": "Inventory_Item_get_v1_inventory__name___id__get",
|
|
1227
|
+
"description": "The Api returns inventory data of the inventory name and ID provided in the API endpoint in the form of a json.\n\nThe response section of the json contains a list of jsons which map the column name to a value along with an extra key named **ID**.\n\nThe **ID** key is unique for all the elements in the inventory and we need to use this for all **row specific operations**.",
|
|
1228
|
+
"input": [
|
|
1229
|
+
{
|
|
1230
|
+
"name": "name",
|
|
1231
|
+
"type": "string",
|
|
1232
|
+
"info": ": string",
|
|
1233
|
+
"required": true,
|
|
1234
|
+
"schema": {
|
|
1235
|
+
"title": "name",
|
|
1236
|
+
"type": "string"
|
|
1237
|
+
}
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
"name": "id",
|
|
1241
|
+
"type": "string",
|
|
1242
|
+
"info": ": string",
|
|
1243
|
+
"required": true,
|
|
1244
|
+
"schema": {
|
|
1245
|
+
"title": "id",
|
|
1246
|
+
"type": "string"
|
|
1247
|
+
}
|
|
1248
|
+
},
|
|
1249
|
+
{
|
|
1250
|
+
"name": "iapMetadata",
|
|
1251
|
+
"type": "object",
|
|
1252
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1253
|
+
"required": false,
|
|
1254
|
+
"schema": {
|
|
1255
|
+
"title": "iapMetadata",
|
|
1256
|
+
"type": "object"
|
|
1257
|
+
}
|
|
1258
|
+
}
|
|
1259
|
+
],
|
|
1260
|
+
"output": {
|
|
1261
|
+
"name": "result",
|
|
1262
|
+
"type": "object",
|
|
1263
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1264
|
+
"schema": {
|
|
1265
|
+
"title": "result",
|
|
1266
|
+
"type": "object"
|
|
1267
|
+
}
|
|
1268
|
+
},
|
|
1269
|
+
"roles": [
|
|
1270
|
+
"admin"
|
|
1271
|
+
],
|
|
1272
|
+
"route": {
|
|
1273
|
+
"verb": "POST",
|
|
1274
|
+
"path": "/inventoryItemGetV1InventoryNameIdGet"
|
|
1275
|
+
},
|
|
1276
|
+
"task": true
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
"name": "inventoryItemCreationV1InventoryNamePost",
|
|
1280
|
+
"summary": "Inventory_Item_creation_v1_inventory__name__post",
|
|
1281
|
+
"description": "Executes a post operation through the API to upload a row from an inventory table in the metasore",
|
|
1282
|
+
"input": [
|
|
1283
|
+
{
|
|
1284
|
+
"name": "name",
|
|
1285
|
+
"type": "string",
|
|
1286
|
+
"info": ": string",
|
|
1287
|
+
"required": true,
|
|
1288
|
+
"schema": {
|
|
1289
|
+
"title": "name",
|
|
1290
|
+
"type": "string"
|
|
1291
|
+
}
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"name": "body",
|
|
1295
|
+
"type": "object",
|
|
1296
|
+
"info": ": object",
|
|
1297
|
+
"required": true,
|
|
1298
|
+
"schema": {
|
|
1299
|
+
"type": "object",
|
|
1300
|
+
"additionalProperties": {
|
|
1301
|
+
"type": "object"
|
|
1302
|
+
},
|
|
1303
|
+
"definitions": {}
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
{
|
|
1307
|
+
"name": "iapMetadata",
|
|
1308
|
+
"type": "object",
|
|
1309
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1310
|
+
"required": false,
|
|
1311
|
+
"schema": {
|
|
1312
|
+
"title": "iapMetadata",
|
|
1313
|
+
"type": "object"
|
|
1314
|
+
}
|
|
1315
|
+
}
|
|
1316
|
+
],
|
|
1317
|
+
"output": {
|
|
1318
|
+
"name": "result",
|
|
1319
|
+
"type": "object",
|
|
1320
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1321
|
+
"schema": {
|
|
1322
|
+
"title": "result",
|
|
1323
|
+
"type": "object"
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
"roles": [
|
|
1327
|
+
"admin"
|
|
1328
|
+
],
|
|
1329
|
+
"route": {
|
|
1330
|
+
"verb": "POST",
|
|
1331
|
+
"path": "/inventoryItemCreationV1InventoryNamePost"
|
|
1332
|
+
},
|
|
1333
|
+
"task": true
|
|
1334
|
+
},
|
|
1335
|
+
{
|
|
1336
|
+
"name": "inventoryItemCreationV1InventoryNameIdPut",
|
|
1337
|
+
"summary": "Inventory_Item_creation_v1_inventory__name___id__put",
|
|
1338
|
+
"description": "Executes a put operation through the API to edit a row in the metasore",
|
|
1339
|
+
"input": [
|
|
1340
|
+
{
|
|
1341
|
+
"name": "name",
|
|
1342
|
+
"type": "string",
|
|
1343
|
+
"info": ": string",
|
|
1344
|
+
"required": true,
|
|
1345
|
+
"schema": {
|
|
1346
|
+
"title": "name",
|
|
1347
|
+
"type": "string"
|
|
1348
|
+
}
|
|
1349
|
+
},
|
|
1350
|
+
{
|
|
1351
|
+
"name": "id",
|
|
1352
|
+
"type": "string",
|
|
1353
|
+
"info": ": string",
|
|
1354
|
+
"required": true,
|
|
1355
|
+
"schema": {
|
|
1356
|
+
"title": "id",
|
|
1357
|
+
"type": "string"
|
|
1358
|
+
}
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"name": "body",
|
|
1362
|
+
"type": "object",
|
|
1363
|
+
"info": ": object",
|
|
1364
|
+
"required": true,
|
|
1365
|
+
"schema": {
|
|
1366
|
+
"type": "object",
|
|
1367
|
+
"additionalProperties": {
|
|
1368
|
+
"type": "object"
|
|
1369
|
+
},
|
|
1370
|
+
"definitions": {}
|
|
1371
|
+
}
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"name": "iapMetadata",
|
|
1375
|
+
"type": "object",
|
|
1376
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1377
|
+
"required": false,
|
|
1378
|
+
"schema": {
|
|
1379
|
+
"title": "iapMetadata",
|
|
1380
|
+
"type": "object"
|
|
1381
|
+
}
|
|
1382
|
+
}
|
|
1383
|
+
],
|
|
1384
|
+
"output": {
|
|
1385
|
+
"name": "result",
|
|
1386
|
+
"type": "object",
|
|
1387
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1388
|
+
"schema": {
|
|
1389
|
+
"title": "result",
|
|
1390
|
+
"type": "object"
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
"roles": [
|
|
1394
|
+
"admin"
|
|
1395
|
+
],
|
|
1396
|
+
"route": {
|
|
1397
|
+
"verb": "POST",
|
|
1398
|
+
"path": "/inventoryItemCreationV1InventoryNameIdPut"
|
|
1399
|
+
},
|
|
1400
|
+
"task": true
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"name": "inventoryItemDeletionV1InventoryNameIdDelete",
|
|
1404
|
+
"summary": "Inventory_Item_deletion_v1_inventory__name___id__delete",
|
|
1405
|
+
"description": "Executes a delete operation through the API to delete a row from an inventory table in the metasore",
|
|
1406
|
+
"input": [
|
|
1407
|
+
{
|
|
1408
|
+
"name": "name",
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"info": ": string",
|
|
1411
|
+
"required": true,
|
|
1412
|
+
"schema": {
|
|
1413
|
+
"title": "name",
|
|
1414
|
+
"type": "string"
|
|
1415
|
+
}
|
|
1416
|
+
},
|
|
1417
|
+
{
|
|
1418
|
+
"name": "id",
|
|
1419
|
+
"type": "string",
|
|
1420
|
+
"info": ": string",
|
|
1421
|
+
"required": true,
|
|
1422
|
+
"schema": {
|
|
1423
|
+
"title": "id",
|
|
1424
|
+
"type": "string"
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1427
|
+
{
|
|
1428
|
+
"name": "iapMetadata",
|
|
1429
|
+
"type": "object",
|
|
1430
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1431
|
+
"required": false,
|
|
1432
|
+
"schema": {
|
|
1433
|
+
"title": "iapMetadata",
|
|
1434
|
+
"type": "object"
|
|
1435
|
+
}
|
|
1436
|
+
}
|
|
1437
|
+
],
|
|
1438
|
+
"output": {
|
|
1439
|
+
"name": "result",
|
|
1440
|
+
"type": "object",
|
|
1441
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1442
|
+
"schema": {
|
|
1443
|
+
"title": "result",
|
|
1444
|
+
"type": "object"
|
|
1445
|
+
}
|
|
1446
|
+
},
|
|
1447
|
+
"roles": [
|
|
1448
|
+
"admin"
|
|
1449
|
+
],
|
|
1450
|
+
"route": {
|
|
1451
|
+
"verb": "POST",
|
|
1452
|
+
"path": "/inventoryItemDeletionV1InventoryNameIdDelete"
|
|
1453
|
+
},
|
|
1454
|
+
"task": true
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
"name": "inventoryItemCreationV1InventoryBulkNamePost",
|
|
1458
|
+
"summary": "Inventory_Item_creation_v1_inventory_bulk__name__post",
|
|
1459
|
+
"description": "The bulk upload supports 3 operations:\n- **Merge** : This will merge the data into the exisiting metastore and no items will be deleted. Any overlap will just lead to an overlap and will overwrite that row. This can be enabled by setting the **merge flag** to **true** in the body params of the API call.\n- **Overwrite** : This will overwrite the entire metastore entries. If the **merge flag** is set to **false** the data upload will replace the entire metastore by delteing the old entires and add...(description truncated)",
|
|
1460
|
+
"input": [
|
|
1461
|
+
{
|
|
1462
|
+
"name": "name",
|
|
1463
|
+
"type": "string",
|
|
1464
|
+
"info": ": string",
|
|
1465
|
+
"required": true,
|
|
1466
|
+
"schema": {
|
|
1467
|
+
"title": "name",
|
|
1468
|
+
"type": "string"
|
|
1469
|
+
}
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
"name": "merge",
|
|
1473
|
+
"type": "boolean",
|
|
1474
|
+
"info": ": boolean",
|
|
1475
|
+
"required": false,
|
|
1476
|
+
"schema": {
|
|
1477
|
+
"title": "merge",
|
|
1478
|
+
"type": "boolean"
|
|
1479
|
+
}
|
|
1480
|
+
},
|
|
1481
|
+
{
|
|
1482
|
+
"name": "body",
|
|
1483
|
+
"type": "array",
|
|
1484
|
+
"info": ": array",
|
|
1485
|
+
"required": true,
|
|
1486
|
+
"schema": {
|
|
1487
|
+
"type": "array",
|
|
1488
|
+
"items": {
|
|
1489
|
+
"type": "object"
|
|
1490
|
+
},
|
|
1491
|
+
"description": "",
|
|
1492
|
+
"definitions": {}
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
{
|
|
1496
|
+
"name": "iapMetadata",
|
|
1497
|
+
"type": "object",
|
|
1498
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1499
|
+
"required": false,
|
|
1500
|
+
"schema": {
|
|
1501
|
+
"title": "iapMetadata",
|
|
1502
|
+
"type": "object"
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
],
|
|
1506
|
+
"output": {
|
|
1507
|
+
"name": "result",
|
|
1508
|
+
"type": "object",
|
|
1509
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1510
|
+
"schema": {
|
|
1511
|
+
"title": "result",
|
|
1512
|
+
"type": "object"
|
|
1513
|
+
}
|
|
1514
|
+
},
|
|
1515
|
+
"roles": [
|
|
1516
|
+
"admin"
|
|
1517
|
+
],
|
|
1518
|
+
"route": {
|
|
1519
|
+
"verb": "POST",
|
|
1520
|
+
"path": "/inventoryItemCreationV1InventoryBulkNamePost"
|
|
1521
|
+
},
|
|
1522
|
+
"task": true
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"name": "inventoryItemCreationV1InventoryCsvNamePost",
|
|
1526
|
+
"summary": "Inventory_Item_creation_v1_inventory_csv__name__post",
|
|
1527
|
+
"description": "The bulk upload supports 2 operations:\n- **Merge** : This will merge the data into the exisiting metastore and no items will be deleted. Any overlap will just lead to an overlap and will overwrite that row. This can be enabled by setting the **merge flag** to **true** in the body params of the API call.\n- **Overwrite** : This will overwrite the entire metastore entries. If the **merge flag** is set to **false** the data upload will replace the entire metastore by delteing the old entires and add...(description truncated)",
|
|
1528
|
+
"input": [
|
|
1529
|
+
{
|
|
1530
|
+
"name": "name",
|
|
1531
|
+
"type": "string",
|
|
1532
|
+
"info": ": string",
|
|
1533
|
+
"required": true,
|
|
1534
|
+
"schema": {
|
|
1535
|
+
"title": "name",
|
|
1536
|
+
"type": "string"
|
|
1537
|
+
}
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"name": "merge",
|
|
1541
|
+
"type": "boolean",
|
|
1542
|
+
"info": ": boolean",
|
|
1543
|
+
"required": false,
|
|
1544
|
+
"schema": {
|
|
1545
|
+
"title": "merge",
|
|
1546
|
+
"type": "boolean"
|
|
1547
|
+
}
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
"name": "file",
|
|
1551
|
+
"type": "string",
|
|
1552
|
+
"info": ": string",
|
|
1553
|
+
"required": true,
|
|
1554
|
+
"schema": {
|
|
1555
|
+
"title": "file",
|
|
1556
|
+
"type": "string"
|
|
1557
|
+
}
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"name": "iapMetadata",
|
|
1561
|
+
"type": "object",
|
|
1562
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1563
|
+
"required": false,
|
|
1564
|
+
"schema": {
|
|
1565
|
+
"title": "iapMetadata",
|
|
1566
|
+
"type": "object"
|
|
1567
|
+
}
|
|
1568
|
+
}
|
|
1569
|
+
],
|
|
1570
|
+
"output": {
|
|
1571
|
+
"name": "result",
|
|
1572
|
+
"type": "object",
|
|
1573
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1574
|
+
"schema": {
|
|
1575
|
+
"title": "result",
|
|
1576
|
+
"type": "object"
|
|
1577
|
+
}
|
|
1578
|
+
},
|
|
1579
|
+
"roles": [
|
|
1580
|
+
"admin"
|
|
1581
|
+
],
|
|
1582
|
+
"route": {
|
|
1583
|
+
"verb": "POST",
|
|
1584
|
+
"path": "/inventoryItemCreationV1InventoryCsvNamePost"
|
|
1585
|
+
},
|
|
1586
|
+
"task": true
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"name": "inventoryItemGetV1InventoryItemsGet",
|
|
1590
|
+
"summary": "Inventory_Item_get_v1_inventory_items_get",
|
|
1591
|
+
"description": "Executes a get operation through the API to get all inventory data of same type",
|
|
1592
|
+
"input": [
|
|
1593
|
+
{
|
|
1594
|
+
"name": "type",
|
|
1595
|
+
"type": "string",
|
|
1596
|
+
"info": ": string",
|
|
1597
|
+
"required": false,
|
|
1598
|
+
"schema": {
|
|
1599
|
+
"title": "type",
|
|
1600
|
+
"type": "string"
|
|
1601
|
+
}
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "iapMetadata",
|
|
1605
|
+
"type": "object",
|
|
1606
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1607
|
+
"required": false,
|
|
1608
|
+
"schema": {
|
|
1609
|
+
"title": "iapMetadata",
|
|
1610
|
+
"type": "object"
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
],
|
|
1614
|
+
"output": {
|
|
1615
|
+
"name": "result",
|
|
1616
|
+
"type": "object",
|
|
1617
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1618
|
+
"schema": {
|
|
1619
|
+
"title": "result",
|
|
1620
|
+
"type": "object"
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"roles": [
|
|
1624
|
+
"admin"
|
|
1625
|
+
],
|
|
1626
|
+
"route": {
|
|
1627
|
+
"verb": "POST",
|
|
1628
|
+
"path": "/inventoryItemGetV1InventoryItemsGet"
|
|
1629
|
+
},
|
|
1630
|
+
"task": true
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"name": "getAllInventoryV1InventorySchemaGet",
|
|
1634
|
+
"summary": "Get_all_inventory_v1_inventory_schema_get",
|
|
1635
|
+
"description": "Executes a get operation though the API to get all inventory schemas",
|
|
1636
|
+
"input": [
|
|
1637
|
+
{
|
|
1638
|
+
"name": "iapMetadata",
|
|
1639
|
+
"type": "object",
|
|
1640
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1641
|
+
"required": false,
|
|
1642
|
+
"schema": {
|
|
1643
|
+
"title": "iapMetadata",
|
|
1644
|
+
"type": "object"
|
|
1645
|
+
}
|
|
1646
|
+
}
|
|
1647
|
+
],
|
|
1648
|
+
"output": {
|
|
1649
|
+
"name": "result",
|
|
1650
|
+
"type": "object",
|
|
1651
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1652
|
+
"schema": {
|
|
1653
|
+
"title": "result",
|
|
1654
|
+
"type": "object"
|
|
1655
|
+
}
|
|
1656
|
+
},
|
|
1657
|
+
"roles": [
|
|
1658
|
+
"admin"
|
|
1659
|
+
],
|
|
1660
|
+
"route": {
|
|
1661
|
+
"verb": "GET",
|
|
1662
|
+
"path": "/getAllInventoryV1InventorySchemaGet"
|
|
1663
|
+
},
|
|
1664
|
+
"task": true
|
|
1665
|
+
},
|
|
1666
|
+
{
|
|
1667
|
+
"name": "postInventoryV1InventorySchema",
|
|
1668
|
+
"summary": "Post_inventory_v1_inventory_schema",
|
|
1669
|
+
"description": "Executes a psot operation though the API to post inventory schemas",
|
|
1670
|
+
"input": [
|
|
1671
|
+
{
|
|
1672
|
+
"name": "file",
|
|
1673
|
+
"type": "string",
|
|
1674
|
+
"info": "The YAML file to be uploaded: string",
|
|
1675
|
+
"required": false,
|
|
1676
|
+
"schema": {
|
|
1677
|
+
"title": "file",
|
|
1678
|
+
"type": "string"
|
|
1679
|
+
}
|
|
1680
|
+
},
|
|
1681
|
+
{
|
|
1682
|
+
"name": "iapMetadata",
|
|
1683
|
+
"type": "object",
|
|
1684
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1685
|
+
"required": false,
|
|
1686
|
+
"schema": {
|
|
1687
|
+
"title": "iapMetadata",
|
|
1688
|
+
"type": "object"
|
|
1689
|
+
}
|
|
1690
|
+
}
|
|
1691
|
+
],
|
|
1692
|
+
"output": {
|
|
1693
|
+
"name": "result",
|
|
1694
|
+
"type": "object",
|
|
1695
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1696
|
+
"schema": {
|
|
1697
|
+
"title": "result",
|
|
1698
|
+
"type": "object"
|
|
1699
|
+
}
|
|
1700
|
+
},
|
|
1701
|
+
"roles": [
|
|
1702
|
+
"admin"
|
|
1703
|
+
],
|
|
1704
|
+
"route": {
|
|
1705
|
+
"verb": "POST",
|
|
1706
|
+
"path": "/postInventoryV1InventorySchema"
|
|
1707
|
+
},
|
|
1708
|
+
"task": true
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
"name": "putInventoryV1InventorySchema",
|
|
1712
|
+
"summary": "Put_inventory_v1_inventory_schema",
|
|
1713
|
+
"description": "Executes a put operation though the API to update inventory schemas",
|
|
1714
|
+
"input": [
|
|
1715
|
+
{
|
|
1716
|
+
"name": "file",
|
|
1717
|
+
"type": "string",
|
|
1718
|
+
"info": "The YAML file to be uploaded: string",
|
|
1719
|
+
"required": false,
|
|
1720
|
+
"schema": {
|
|
1721
|
+
"title": "file",
|
|
1722
|
+
"type": "string"
|
|
1723
|
+
}
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"name": "iapMetadata",
|
|
1727
|
+
"type": "object",
|
|
1728
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1729
|
+
"required": false,
|
|
1730
|
+
"schema": {
|
|
1731
|
+
"title": "iapMetadata",
|
|
1732
|
+
"type": "object"
|
|
1733
|
+
}
|
|
1734
|
+
}
|
|
1735
|
+
],
|
|
1736
|
+
"output": {
|
|
1737
|
+
"name": "result",
|
|
1738
|
+
"type": "object",
|
|
1739
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1740
|
+
"schema": {
|
|
1741
|
+
"title": "result",
|
|
1742
|
+
"type": "object"
|
|
1743
|
+
}
|
|
1744
|
+
},
|
|
1745
|
+
"roles": [
|
|
1746
|
+
"admin"
|
|
1747
|
+
],
|
|
1748
|
+
"route": {
|
|
1749
|
+
"verb": "POST",
|
|
1750
|
+
"path": "/putInventoryV1InventorySchema"
|
|
1751
|
+
},
|
|
1752
|
+
"task": true
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "processinventoryschemadelete",
|
|
1756
|
+
"summary": "Process inventory schema delete",
|
|
1757
|
+
"description": "Executes a delete operation though the API to delete all inventory schemas",
|
|
1758
|
+
"input": [
|
|
1759
|
+
{
|
|
1760
|
+
"name": "iapMetadata",
|
|
1761
|
+
"type": "object",
|
|
1762
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1763
|
+
"required": false,
|
|
1764
|
+
"schema": {
|
|
1765
|
+
"title": "iapMetadata",
|
|
1766
|
+
"type": "object"
|
|
1767
|
+
}
|
|
1768
|
+
}
|
|
1769
|
+
],
|
|
1770
|
+
"output": {
|
|
1771
|
+
"name": "result",
|
|
1772
|
+
"type": "object",
|
|
1773
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1774
|
+
"schema": {
|
|
1775
|
+
"title": "result",
|
|
1776
|
+
"type": "object"
|
|
1777
|
+
}
|
|
1778
|
+
},
|
|
1779
|
+
"roles": [
|
|
1780
|
+
"admin"
|
|
1781
|
+
],
|
|
1782
|
+
"route": {
|
|
1783
|
+
"verb": "GET",
|
|
1784
|
+
"path": "/processinventoryschemadelete"
|
|
1785
|
+
},
|
|
1786
|
+
"task": true
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"name": "deleteProcessinventoryschemadelete",
|
|
1790
|
+
"summary": "Process inventory schema delete",
|
|
1791
|
+
"description": "Executes a delete operation though the API to delete specific inventory schemas",
|
|
1792
|
+
"input": [
|
|
1793
|
+
{
|
|
1794
|
+
"name": "type",
|
|
1795
|
+
"type": "string",
|
|
1796
|
+
"info": ": string",
|
|
1797
|
+
"required": true,
|
|
1798
|
+
"schema": {
|
|
1799
|
+
"title": "type",
|
|
1800
|
+
"type": "string"
|
|
1801
|
+
}
|
|
1802
|
+
},
|
|
1803
|
+
{
|
|
1804
|
+
"name": "iapMetadata",
|
|
1805
|
+
"type": "object",
|
|
1806
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1807
|
+
"required": false,
|
|
1808
|
+
"schema": {
|
|
1809
|
+
"title": "iapMetadata",
|
|
1810
|
+
"type": "object"
|
|
1811
|
+
}
|
|
1812
|
+
}
|
|
1813
|
+
],
|
|
1814
|
+
"output": {
|
|
1815
|
+
"name": "result",
|
|
1816
|
+
"type": "object",
|
|
1817
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1818
|
+
"schema": {
|
|
1819
|
+
"title": "result",
|
|
1820
|
+
"type": "object"
|
|
1821
|
+
}
|
|
1822
|
+
},
|
|
1823
|
+
"roles": [
|
|
1824
|
+
"admin"
|
|
1825
|
+
],
|
|
1826
|
+
"route": {
|
|
1827
|
+
"verb": "POST",
|
|
1828
|
+
"path": "/deleteProcessinventoryschemadelete"
|
|
1829
|
+
},
|
|
1830
|
+
"task": true
|
|
1831
|
+
},
|
|
1832
|
+
{
|
|
1833
|
+
"name": "getsAllInventoryschema",
|
|
1834
|
+
"summary": "Gets All Inventory schema",
|
|
1835
|
+
"description": "Executes a get operation though the API to get all inventory schemas",
|
|
1836
|
+
"input": [
|
|
1837
|
+
{
|
|
1838
|
+
"name": "iapMetadata",
|
|
1839
|
+
"type": "object",
|
|
1840
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1841
|
+
"required": false,
|
|
1842
|
+
"schema": {
|
|
1843
|
+
"title": "iapMetadata",
|
|
1844
|
+
"type": "object"
|
|
1845
|
+
}
|
|
1846
|
+
}
|
|
1847
|
+
],
|
|
1848
|
+
"output": {
|
|
1849
|
+
"name": "result",
|
|
1850
|
+
"type": "object",
|
|
1851
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1852
|
+
"schema": {
|
|
1853
|
+
"title": "result",
|
|
1854
|
+
"type": "object"
|
|
1855
|
+
}
|
|
1856
|
+
},
|
|
1857
|
+
"roles": [
|
|
1858
|
+
"admin"
|
|
1859
|
+
],
|
|
1860
|
+
"route": {
|
|
1861
|
+
"verb": "GET",
|
|
1862
|
+
"path": "/getsAllInventoryschema"
|
|
1863
|
+
},
|
|
1864
|
+
"task": true
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
"name": "processinventoryschemaJSONinput",
|
|
1868
|
+
"summary": "Process inventory schema JSON input",
|
|
1869
|
+
"description": "Executes a post operation though the API to post inventory schemas",
|
|
1870
|
+
"input": [
|
|
1871
|
+
{
|
|
1872
|
+
"name": "body",
|
|
1873
|
+
"type": "object",
|
|
1874
|
+
"info": ": object",
|
|
1875
|
+
"required": true,
|
|
1876
|
+
"schema": {
|
|
1877
|
+
"type": "object",
|
|
1878
|
+
"definitions": {}
|
|
1879
|
+
}
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"name": "iapMetadata",
|
|
1883
|
+
"type": "object",
|
|
1884
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1885
|
+
"required": false,
|
|
1886
|
+
"schema": {
|
|
1887
|
+
"title": "iapMetadata",
|
|
1888
|
+
"type": "object"
|
|
1889
|
+
}
|
|
1890
|
+
}
|
|
1891
|
+
],
|
|
1892
|
+
"output": {
|
|
1893
|
+
"name": "result",
|
|
1894
|
+
"type": "object",
|
|
1895
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1896
|
+
"schema": {
|
|
1897
|
+
"title": "result",
|
|
1898
|
+
"type": "object"
|
|
1899
|
+
}
|
|
1900
|
+
},
|
|
1901
|
+
"roles": [
|
|
1902
|
+
"admin"
|
|
1903
|
+
],
|
|
1904
|
+
"route": {
|
|
1905
|
+
"verb": "POST",
|
|
1906
|
+
"path": "/processinventoryschemaJSONinput"
|
|
1907
|
+
},
|
|
1908
|
+
"task": true
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"name": "deleteProcessinventoryschemadelete1",
|
|
1912
|
+
"summary": "Process inventory schema delete",
|
|
1913
|
+
"description": "Executes a delete operation though the API to delete all inventory schemas",
|
|
1914
|
+
"input": [
|
|
1915
|
+
{
|
|
1916
|
+
"name": "iapMetadata",
|
|
1917
|
+
"type": "object",
|
|
1918
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1919
|
+
"required": false,
|
|
1920
|
+
"schema": {
|
|
1921
|
+
"title": "iapMetadata",
|
|
1922
|
+
"type": "object"
|
|
1923
|
+
}
|
|
1924
|
+
}
|
|
1925
|
+
],
|
|
1926
|
+
"output": {
|
|
1927
|
+
"name": "result",
|
|
1928
|
+
"type": "object",
|
|
1929
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1930
|
+
"schema": {
|
|
1931
|
+
"title": "result",
|
|
1932
|
+
"type": "object"
|
|
1933
|
+
}
|
|
1934
|
+
},
|
|
1935
|
+
"roles": [
|
|
1936
|
+
"admin"
|
|
1937
|
+
],
|
|
1938
|
+
"route": {
|
|
1939
|
+
"verb": "GET",
|
|
1940
|
+
"path": "/deleteProcessinventoryschemadelete1"
|
|
1941
|
+
},
|
|
1942
|
+
"task": true
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"name": "putProcessinventoryschemaJSONinput",
|
|
1946
|
+
"summary": "Process inventory schema JSON input",
|
|
1947
|
+
"description": "Executes a put operation though the API to post inventory schemas",
|
|
1948
|
+
"input": [
|
|
1949
|
+
{
|
|
1950
|
+
"name": "type",
|
|
1951
|
+
"type": "string",
|
|
1952
|
+
"info": ": string",
|
|
1953
|
+
"required": true,
|
|
1954
|
+
"schema": {
|
|
1955
|
+
"title": "type",
|
|
1956
|
+
"type": "string"
|
|
1957
|
+
}
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
"name": "body",
|
|
1961
|
+
"type": "object",
|
|
1962
|
+
"info": ": object",
|
|
1963
|
+
"required": true,
|
|
1964
|
+
"schema": {
|
|
1965
|
+
"type": "object",
|
|
1966
|
+
"definitions": {}
|
|
1967
|
+
}
|
|
1968
|
+
},
|
|
1969
|
+
{
|
|
1970
|
+
"name": "iapMetadata",
|
|
1971
|
+
"type": "object",
|
|
1972
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
1973
|
+
"required": false,
|
|
1974
|
+
"schema": {
|
|
1975
|
+
"title": "iapMetadata",
|
|
1976
|
+
"type": "object"
|
|
1977
|
+
}
|
|
1978
|
+
}
|
|
1979
|
+
],
|
|
1980
|
+
"output": {
|
|
1981
|
+
"name": "result",
|
|
1982
|
+
"type": "object",
|
|
1983
|
+
"description": "A JSON Object containing status, code and the result",
|
|
1984
|
+
"schema": {
|
|
1985
|
+
"title": "result",
|
|
1986
|
+
"type": "object"
|
|
1987
|
+
}
|
|
1988
|
+
},
|
|
1989
|
+
"roles": [
|
|
1990
|
+
"admin"
|
|
1991
|
+
],
|
|
1992
|
+
"route": {
|
|
1993
|
+
"verb": "POST",
|
|
1994
|
+
"path": "/putProcessinventoryschemaJSONinput"
|
|
1995
|
+
},
|
|
1996
|
+
"task": true
|
|
1997
|
+
},
|
|
1998
|
+
{
|
|
1999
|
+
"name": "deleteProcessinventoryschemadelete2",
|
|
2000
|
+
"summary": "Process inventory schema delete",
|
|
2001
|
+
"description": "Executes a delete operation though the API to delete specific inventory schemas",
|
|
2002
|
+
"input": [
|
|
2003
|
+
{
|
|
2004
|
+
"name": "type",
|
|
2005
|
+
"type": "string",
|
|
2006
|
+
"info": ": string",
|
|
2007
|
+
"required": true,
|
|
2008
|
+
"schema": {
|
|
2009
|
+
"title": "type",
|
|
2010
|
+
"type": "string"
|
|
2011
|
+
}
|
|
2012
|
+
},
|
|
2013
|
+
{
|
|
2014
|
+
"name": "iapMetadata",
|
|
2015
|
+
"type": "object",
|
|
2016
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2017
|
+
"required": false,
|
|
2018
|
+
"schema": {
|
|
2019
|
+
"title": "iapMetadata",
|
|
2020
|
+
"type": "object"
|
|
2021
|
+
}
|
|
2022
|
+
}
|
|
2023
|
+
],
|
|
2024
|
+
"output": {
|
|
2025
|
+
"name": "result",
|
|
2026
|
+
"type": "object",
|
|
2027
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2028
|
+
"schema": {
|
|
2029
|
+
"title": "result",
|
|
2030
|
+
"type": "object"
|
|
2031
|
+
}
|
|
2032
|
+
},
|
|
2033
|
+
"roles": [
|
|
2034
|
+
"admin"
|
|
2035
|
+
],
|
|
2036
|
+
"route": {
|
|
2037
|
+
"verb": "POST",
|
|
2038
|
+
"path": "/deleteProcessinventoryschemadelete2"
|
|
2039
|
+
},
|
|
2040
|
+
"task": true
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "porcessuploadJSONfile",
|
|
2044
|
+
"summary": "Porcess upload JSON file",
|
|
2045
|
+
"description": "Executes a post operation though the API to upload inventory schema file",
|
|
2046
|
+
"input": [
|
|
2047
|
+
{
|
|
2048
|
+
"name": "encodeType",
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"info": ": Must be one of [json]",
|
|
2051
|
+
"required": false,
|
|
2052
|
+
"schema": {
|
|
2053
|
+
"title": "encodeType",
|
|
2054
|
+
"type": "string"
|
|
2055
|
+
}
|
|
2056
|
+
},
|
|
2057
|
+
{
|
|
2058
|
+
"name": "file",
|
|
2059
|
+
"type": "string",
|
|
2060
|
+
"info": ": string",
|
|
2061
|
+
"required": false,
|
|
2062
|
+
"schema": {
|
|
2063
|
+
"title": "file",
|
|
2064
|
+
"type": "string"
|
|
2065
|
+
}
|
|
2066
|
+
},
|
|
2067
|
+
{
|
|
2068
|
+
"name": "iapMetadata",
|
|
2069
|
+
"type": "object",
|
|
2070
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2071
|
+
"required": false,
|
|
2072
|
+
"schema": {
|
|
2073
|
+
"title": "iapMetadata",
|
|
2074
|
+
"type": "object"
|
|
2075
|
+
}
|
|
2076
|
+
}
|
|
2077
|
+
],
|
|
2078
|
+
"output": {
|
|
2079
|
+
"name": "result",
|
|
2080
|
+
"type": "object",
|
|
2081
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2082
|
+
"schema": {
|
|
2083
|
+
"title": "result",
|
|
2084
|
+
"type": "object"
|
|
2085
|
+
}
|
|
2086
|
+
},
|
|
2087
|
+
"roles": [
|
|
2088
|
+
"admin"
|
|
2089
|
+
],
|
|
2090
|
+
"route": {
|
|
2091
|
+
"verb": "POST",
|
|
2092
|
+
"path": "/porcessuploadJSONfile"
|
|
2093
|
+
},
|
|
2094
|
+
"task": true
|
|
2095
|
+
},
|
|
2096
|
+
{
|
|
2097
|
+
"name": "downloadinventoryschemaJSONfile",
|
|
2098
|
+
"summary": "Download inventory schema JSON file",
|
|
2099
|
+
"description": "Executes a post operation though the API to download inventory schema file",
|
|
2100
|
+
"input": [
|
|
2101
|
+
{
|
|
2102
|
+
"name": "encodeType",
|
|
2103
|
+
"type": "string",
|
|
2104
|
+
"info": ": Must be one of [json]",
|
|
2105
|
+
"required": false,
|
|
2106
|
+
"schema": {
|
|
2107
|
+
"title": "encodeType",
|
|
2108
|
+
"type": "string"
|
|
2109
|
+
}
|
|
2110
|
+
},
|
|
2111
|
+
{
|
|
2112
|
+
"name": "body",
|
|
2113
|
+
"type": "object",
|
|
2114
|
+
"info": ": object",
|
|
2115
|
+
"required": false,
|
|
2116
|
+
"schema": {
|
|
2117
|
+
"type": "object",
|
|
2118
|
+
"definitions": {}
|
|
2119
|
+
}
|
|
2120
|
+
},
|
|
2121
|
+
{
|
|
2122
|
+
"name": "iapMetadata",
|
|
2123
|
+
"type": "object",
|
|
2124
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2125
|
+
"required": false,
|
|
2126
|
+
"schema": {
|
|
2127
|
+
"title": "iapMetadata",
|
|
2128
|
+
"type": "object"
|
|
2129
|
+
}
|
|
2130
|
+
}
|
|
2131
|
+
],
|
|
2132
|
+
"output": {
|
|
2133
|
+
"name": "result",
|
|
2134
|
+
"type": "object",
|
|
2135
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2136
|
+
"schema": {
|
|
2137
|
+
"title": "result",
|
|
2138
|
+
"type": "object"
|
|
2139
|
+
}
|
|
2140
|
+
},
|
|
2141
|
+
"roles": [
|
|
2142
|
+
"admin"
|
|
2143
|
+
],
|
|
2144
|
+
"route": {
|
|
2145
|
+
"verb": "POST",
|
|
2146
|
+
"path": "/downloadinventoryschemaJSONfile"
|
|
2147
|
+
},
|
|
2148
|
+
"task": true
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "handleInventoryFilesPostInventoryFilesImportPost",
|
|
2152
|
+
"summary": "handle_inventory_files_post_inventory_files_import_post",
|
|
2153
|
+
"description": "Executes a post operation through the API to import inventories zip file",
|
|
2154
|
+
"input": [
|
|
2155
|
+
{
|
|
2156
|
+
"name": "encodeType",
|
|
2157
|
+
"type": "string",
|
|
2158
|
+
"info": ": string",
|
|
2159
|
+
"required": false,
|
|
2160
|
+
"schema": {
|
|
2161
|
+
"title": "encodeType",
|
|
2162
|
+
"type": "string"
|
|
2163
|
+
}
|
|
2164
|
+
},
|
|
2165
|
+
{
|
|
2166
|
+
"name": "zipFile",
|
|
2167
|
+
"type": "string",
|
|
2168
|
+
"info": ": string",
|
|
2169
|
+
"required": false,
|
|
2170
|
+
"schema": {
|
|
2171
|
+
"title": "zipFile",
|
|
2172
|
+
"type": "string"
|
|
2173
|
+
}
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"name": "iapMetadata",
|
|
2177
|
+
"type": "object",
|
|
2178
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2179
|
+
"required": false,
|
|
2180
|
+
"schema": {
|
|
2181
|
+
"title": "iapMetadata",
|
|
2182
|
+
"type": "object"
|
|
2183
|
+
}
|
|
2184
|
+
}
|
|
2185
|
+
],
|
|
2186
|
+
"output": {
|
|
2187
|
+
"name": "result",
|
|
2188
|
+
"type": "object",
|
|
2189
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2190
|
+
"schema": {
|
|
2191
|
+
"title": "result",
|
|
2192
|
+
"type": "object"
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
"roles": [
|
|
2196
|
+
"admin"
|
|
2197
|
+
],
|
|
2198
|
+
"route": {
|
|
2199
|
+
"verb": "POST",
|
|
2200
|
+
"path": "/handleInventoryFilesPostInventoryFilesImportPost"
|
|
2201
|
+
},
|
|
2202
|
+
"task": true
|
|
2203
|
+
},
|
|
2204
|
+
{
|
|
2205
|
+
"name": "handleInventoryFilesGetInventoryFilesExportPost",
|
|
2206
|
+
"summary": "handle_inventory_files_get_inventory_files_export_post",
|
|
2207
|
+
"description": "Executes a post operation through the API to export inventories zip file",
|
|
2208
|
+
"input": [
|
|
2209
|
+
{
|
|
2210
|
+
"name": "encodeType",
|
|
2211
|
+
"type": "string",
|
|
2212
|
+
"info": ": string",
|
|
2213
|
+
"required": false,
|
|
2214
|
+
"schema": {
|
|
2215
|
+
"title": "encodeType",
|
|
2216
|
+
"type": "string"
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"name": "body",
|
|
2221
|
+
"type": "object",
|
|
2222
|
+
"info": ": object",
|
|
2223
|
+
"required": true,
|
|
2224
|
+
"schema": {
|
|
2225
|
+
"type": "object",
|
|
2226
|
+
"definitions": {}
|
|
2227
|
+
}
|
|
2228
|
+
},
|
|
2229
|
+
{
|
|
2230
|
+
"name": "iapMetadata",
|
|
2231
|
+
"type": "object",
|
|
2232
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2233
|
+
"required": false,
|
|
2234
|
+
"schema": {
|
|
2235
|
+
"title": "iapMetadata",
|
|
2236
|
+
"type": "object"
|
|
2237
|
+
}
|
|
2238
|
+
}
|
|
2239
|
+
],
|
|
2240
|
+
"output": {
|
|
2241
|
+
"name": "result",
|
|
2242
|
+
"type": "object",
|
|
2243
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2244
|
+
"schema": {
|
|
2245
|
+
"title": "result",
|
|
2246
|
+
"type": "object"
|
|
2247
|
+
}
|
|
2248
|
+
},
|
|
2249
|
+
"roles": [
|
|
2250
|
+
"admin"
|
|
2251
|
+
],
|
|
2252
|
+
"route": {
|
|
2253
|
+
"verb": "POST",
|
|
2254
|
+
"path": "/handleInventoryFilesGetInventoryFilesExportPost"
|
|
2255
|
+
},
|
|
2256
|
+
"task": true
|
|
2257
|
+
},
|
|
2258
|
+
{
|
|
2259
|
+
"name": "handleInventoryCsvFileGet",
|
|
2260
|
+
"summary": "handle_inventory_csv_file_get",
|
|
2261
|
+
"description": "handle_inventory_csv_file_get",
|
|
2262
|
+
"input": [
|
|
2263
|
+
{
|
|
2264
|
+
"name": "name",
|
|
2265
|
+
"type": "string",
|
|
2266
|
+
"info": "The name of the inventory item: string",
|
|
2267
|
+
"required": true,
|
|
2268
|
+
"schema": {
|
|
2269
|
+
"title": "name",
|
|
2270
|
+
"type": "string"
|
|
2271
|
+
}
|
|
2272
|
+
},
|
|
2273
|
+
{
|
|
2274
|
+
"name": "iapMetadata",
|
|
2275
|
+
"type": "object",
|
|
2276
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2277
|
+
"required": false,
|
|
2278
|
+
"schema": {
|
|
2279
|
+
"title": "iapMetadata",
|
|
2280
|
+
"type": "object"
|
|
2281
|
+
}
|
|
2282
|
+
}
|
|
2283
|
+
],
|
|
2284
|
+
"output": {
|
|
2285
|
+
"name": "result",
|
|
2286
|
+
"type": "object",
|
|
2287
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2288
|
+
"schema": {
|
|
2289
|
+
"title": "result",
|
|
2290
|
+
"type": "object"
|
|
2291
|
+
}
|
|
2292
|
+
},
|
|
2293
|
+
"roles": [
|
|
2294
|
+
"admin"
|
|
2295
|
+
],
|
|
2296
|
+
"route": {
|
|
2297
|
+
"verb": "POST",
|
|
2298
|
+
"path": "/handleInventoryCsvFileGet"
|
|
2299
|
+
},
|
|
2300
|
+
"task": true
|
|
2301
|
+
},
|
|
2302
|
+
{
|
|
2303
|
+
"name": "get",
|
|
2304
|
+
"summary": "home_page__get",
|
|
2305
|
+
"description": "home_page__get",
|
|
2306
|
+
"input": [
|
|
2307
|
+
{
|
|
2308
|
+
"name": "iapMetadata",
|
|
2309
|
+
"type": "object",
|
|
2310
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2311
|
+
"required": false,
|
|
2312
|
+
"schema": {
|
|
2313
|
+
"title": "iapMetadata",
|
|
2314
|
+
"type": "object"
|
|
2315
|
+
}
|
|
2316
|
+
}
|
|
2317
|
+
],
|
|
2318
|
+
"output": {
|
|
2319
|
+
"name": "result",
|
|
2320
|
+
"type": "object",
|
|
2321
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2322
|
+
"schema": {
|
|
2323
|
+
"title": "result",
|
|
2324
|
+
"type": "object"
|
|
2325
|
+
}
|
|
2326
|
+
},
|
|
2327
|
+
"roles": [
|
|
2328
|
+
"admin"
|
|
2329
|
+
],
|
|
2330
|
+
"route": {
|
|
2331
|
+
"verb": "GET",
|
|
2332
|
+
"path": "/get"
|
|
2333
|
+
},
|
|
2334
|
+
"task": true
|
|
2335
|
+
},
|
|
2336
|
+
{
|
|
2337
|
+
"name": "getOpstats",
|
|
2338
|
+
"summary": "opstats_opstats_get",
|
|
2339
|
+
"description": "Rest endpoint /opstats\nReturns service opstats",
|
|
2340
|
+
"input": [
|
|
2341
|
+
{
|
|
2342
|
+
"name": "iapMetadata",
|
|
2343
|
+
"type": "object",
|
|
2344
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2345
|
+
"required": false,
|
|
2346
|
+
"schema": {
|
|
2347
|
+
"title": "iapMetadata",
|
|
2348
|
+
"type": "object"
|
|
2349
|
+
}
|
|
2350
|
+
}
|
|
2351
|
+
],
|
|
2352
|
+
"output": {
|
|
2353
|
+
"name": "result",
|
|
2354
|
+
"type": "object",
|
|
2355
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2356
|
+
"schema": {
|
|
2357
|
+
"title": "result",
|
|
2358
|
+
"type": "object"
|
|
2359
|
+
}
|
|
2360
|
+
},
|
|
2361
|
+
"roles": [
|
|
2362
|
+
"admin"
|
|
2363
|
+
],
|
|
2364
|
+
"route": {
|
|
2365
|
+
"verb": "GET",
|
|
2366
|
+
"path": "/getOpstats"
|
|
2367
|
+
},
|
|
2368
|
+
"task": true
|
|
2369
|
+
},
|
|
2370
|
+
{
|
|
2371
|
+
"name": "getVersion",
|
|
2372
|
+
"summary": "version_version_get",
|
|
2373
|
+
"description": "Rest endpoint /version\nReturns version info",
|
|
2374
|
+
"input": [
|
|
2375
|
+
{
|
|
2376
|
+
"name": "iapMetadata",
|
|
2377
|
+
"type": "object",
|
|
2378
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2379
|
+
"required": false,
|
|
2380
|
+
"schema": {
|
|
2381
|
+
"title": "iapMetadata",
|
|
2382
|
+
"type": "object"
|
|
2383
|
+
}
|
|
2384
|
+
}
|
|
2385
|
+
],
|
|
2386
|
+
"output": {
|
|
2387
|
+
"name": "result",
|
|
2388
|
+
"type": "object",
|
|
2389
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2390
|
+
"schema": {
|
|
2391
|
+
"title": "result",
|
|
2392
|
+
"type": "object"
|
|
2393
|
+
}
|
|
2394
|
+
},
|
|
2395
|
+
"roles": [
|
|
2396
|
+
"admin"
|
|
2397
|
+
],
|
|
2398
|
+
"route": {
|
|
2399
|
+
"verb": "GET",
|
|
2400
|
+
"path": "/getVersion"
|
|
2401
|
+
},
|
|
2402
|
+
"task": true
|
|
2403
|
+
},
|
|
2404
|
+
{
|
|
2405
|
+
"name": "getAIConfig",
|
|
2406
|
+
"summary": "config_config_get",
|
|
2407
|
+
"description": "Rest endpoint /config",
|
|
2408
|
+
"input": [
|
|
2409
|
+
{
|
|
2410
|
+
"name": "iapMetadata",
|
|
2411
|
+
"type": "object",
|
|
2412
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2413
|
+
"required": false,
|
|
2414
|
+
"schema": {
|
|
2415
|
+
"title": "iapMetadata",
|
|
2416
|
+
"type": "object"
|
|
2417
|
+
}
|
|
2418
|
+
}
|
|
2419
|
+
],
|
|
2420
|
+
"output": {
|
|
2421
|
+
"name": "result",
|
|
2422
|
+
"type": "object",
|
|
2423
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2424
|
+
"schema": {
|
|
2425
|
+
"title": "result",
|
|
2426
|
+
"type": "object"
|
|
2427
|
+
}
|
|
2428
|
+
},
|
|
2429
|
+
"roles": [
|
|
2430
|
+
"admin"
|
|
2431
|
+
],
|
|
2432
|
+
"route": {
|
|
2433
|
+
"verb": "GET",
|
|
2434
|
+
"path": "/getAIConfig"
|
|
2435
|
+
},
|
|
2436
|
+
"task": true
|
|
2437
|
+
},
|
|
2438
|
+
{
|
|
2439
|
+
"name": "getHealth",
|
|
2440
|
+
"summary": "health_health_get",
|
|
2441
|
+
"description": "Rest endpoint for /health\n\nHealth status for the service",
|
|
2442
|
+
"input": [
|
|
2443
|
+
{
|
|
2444
|
+
"name": "iapMetadata",
|
|
2445
|
+
"type": "object",
|
|
2446
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2447
|
+
"required": false,
|
|
2448
|
+
"schema": {
|
|
2449
|
+
"title": "iapMetadata",
|
|
2450
|
+
"type": "object"
|
|
2451
|
+
}
|
|
2452
|
+
}
|
|
2453
|
+
],
|
|
2454
|
+
"output": {
|
|
2455
|
+
"name": "result",
|
|
2456
|
+
"type": "object",
|
|
2457
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2458
|
+
"schema": {
|
|
2459
|
+
"title": "result",
|
|
2460
|
+
"type": "object"
|
|
2461
|
+
}
|
|
2462
|
+
},
|
|
2463
|
+
"roles": [
|
|
2464
|
+
"admin"
|
|
2465
|
+
],
|
|
2466
|
+
"route": {
|
|
2467
|
+
"verb": "GET",
|
|
2468
|
+
"path": "/getHealth"
|
|
2469
|
+
},
|
|
2470
|
+
"task": true
|
|
2471
|
+
},
|
|
2472
|
+
{
|
|
2473
|
+
"name": "healthLogsGet",
|
|
2474
|
+
"summary": "health_logs_get",
|
|
2475
|
+
"description": "Rest endpoint /logs",
|
|
2476
|
+
"input": [
|
|
2477
|
+
{
|
|
2478
|
+
"name": "iapMetadata",
|
|
2479
|
+
"type": "object",
|
|
2480
|
+
"info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
|
|
2481
|
+
"required": false,
|
|
2482
|
+
"schema": {
|
|
2483
|
+
"title": "iapMetadata",
|
|
2484
|
+
"type": "object"
|
|
2485
|
+
}
|
|
2486
|
+
}
|
|
2487
|
+
],
|
|
2488
|
+
"output": {
|
|
2489
|
+
"name": "result",
|
|
2490
|
+
"type": "object",
|
|
2491
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2492
|
+
"schema": {
|
|
2493
|
+
"title": "result",
|
|
2494
|
+
"type": "object"
|
|
2495
|
+
}
|
|
2496
|
+
},
|
|
2497
|
+
"roles": [
|
|
2498
|
+
"admin"
|
|
2499
|
+
],
|
|
2500
|
+
"route": {
|
|
2501
|
+
"verb": "GET",
|
|
2502
|
+
"path": "/healthLogsGet"
|
|
2503
|
+
},
|
|
2504
|
+
"task": true
|
|
2505
|
+
}
|
|
2506
|
+
],
|
|
2507
|
+
"views": []
|
|
2508
|
+
}
|