development-framework-cli 1.7.3__py3-none-any.whl
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.
- development_framework_cli-1.7.3.dist-info/METADATA +141 -0
- development_framework_cli-1.7.3.dist-info/RECORD +71 -0
- development_framework_cli-1.7.3.dist-info/WHEEL +4 -0
- development_framework_cli-1.7.3.dist-info/entry_points.txt +2 -0
- development_framework_cli-1.7.3.dist-info/licenses/LICENSE +21 -0
- dm_cli/__init__.py +1 -0
- dm_cli/cli.py +180 -0
- dm_cli/command_group/__init__.py +0 -0
- dm_cli/command_group/data_source.py +176 -0
- dm_cli/command_group/entities.py +116 -0
- dm_cli/dmss.py +104 -0
- dm_cli/dmss_api/__init__.py +27 -0
- dm_cli/dmss_api/api/__init__.py +3 -0
- dm_cli/dmss_api/api/access_control_api.py +349 -0
- dm_cli/dmss_api/api/attribute_api.py +175 -0
- dm_cli/dmss_api/api/blob_api.py +344 -0
- dm_cli/dmss_api/api/blueprint_api.py +326 -0
- dm_cli/dmss_api/api/datasource_api.py +448 -0
- dm_cli/dmss_api/api/default_api.py +4439 -0
- dm_cli/dmss_api/api/document_api.py +922 -0
- dm_cli/dmss_api/api/entity_api.py +464 -0
- dm_cli/dmss_api/api/export_api.py +313 -0
- dm_cli/dmss_api/api/file_api.py +197 -0
- dm_cli/dmss_api/api/health_check_api.py +160 -0
- dm_cli/dmss_api/api/lookup_table_api.py +323 -0
- dm_cli/dmss_api/api/meta_api.py +185 -0
- dm_cli/dmss_api/api/personal_access_token_api.py +433 -0
- dm_cli/dmss_api/api/reference_api.py +174 -0
- dm_cli/dmss_api/api/search_api.py +183 -0
- dm_cli/dmss_api/api/whoami_api.py +163 -0
- dm_cli/dmss_api/api_client.py +896 -0
- dm_cli/dmss_api/apis/__init__.py +32 -0
- dm_cli/dmss_api/configuration.py +482 -0
- dm_cli/dmss_api/exceptions.py +158 -0
- dm_cli/dmss_api/model/__init__.py +5 -0
- dm_cli/dmss_api/model/access_control_list.py +287 -0
- dm_cli/dmss_api/model/access_level.py +290 -0
- dm_cli/dmss_api/model/acl.py +287 -0
- dm_cli/dmss_api/model/data_source_information.py +282 -0
- dm_cli/dmss_api/model/data_source_request.py +281 -0
- dm_cli/dmss_api/model/dependency.py +294 -0
- dm_cli/dmss_api/model/entity.py +275 -0
- dm_cli/dmss_api/model/error_response.py +278 -0
- dm_cli/dmss_api/model/export_meta_response.py +277 -0
- dm_cli/dmss_api/model/get_blueprint_response.py +280 -0
- dm_cli/dmss_api/model/lookup.py +283 -0
- dm_cli/dmss_api/model/pat_data.py +299 -0
- dm_cli/dmss_api/model/recipe.py +311 -0
- dm_cli/dmss_api/model/recipe_attribute.py +304 -0
- dm_cli/dmss_api/model/reference.py +280 -0
- dm_cli/dmss_api/model/reference_entity.py +288 -0
- dm_cli/dmss_api/model/repository.py +317 -0
- dm_cli/dmss_api/model/repository_type.py +290 -0
- dm_cli/dmss_api/model/storage_attribute.py +295 -0
- dm_cli/dmss_api/model/storage_data_types.py +292 -0
- dm_cli/dmss_api/model/storage_recipe.py +293 -0
- dm_cli/dmss_api/model_utils.py +2057 -0
- dm_cli/dmss_api/models/__init__.py +29 -0
- dm_cli/dmss_api/rest.py +358 -0
- dm_cli/domain.py +166 -0
- dm_cli/enums.py +48 -0
- dm_cli/import_entity.py +128 -0
- dm_cli/import_package.py +173 -0
- dm_cli/package_tree_from_zip.py +120 -0
- dm_cli/state.py +12 -0
- dm_cli/utils/__init__.py +0 -0
- dm_cli/utils/file_structure.py +31 -0
- dm_cli/utils/reference.py +129 -0
- dm_cli/utils/resolve_local_ids.py +142 -0
- dm_cli/utils/utils.py +161 -0
- dm_cli/utils/zip.py +70 -0
|
@@ -0,0 +1,4439 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Data Modelling Storage Service
|
|
3
|
+
|
|
4
|
+
API for basic data modelling interaction # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.3.0
|
|
7
|
+
Generated by: https://openapi-generator.tech
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
import re # noqa: F401
|
|
12
|
+
import sys # noqa: F401
|
|
13
|
+
|
|
14
|
+
from dm_cli.dmss_api.api_client import ApiClient
|
|
15
|
+
from dm_cli.dmss_api.api_client import Endpoint as _Endpoint
|
|
16
|
+
from dm_cli.dmss_api.model.access_control_list import AccessControlList
|
|
17
|
+
from dm_cli.dmss_api.model.data_source_information import DataSourceInformation
|
|
18
|
+
from dm_cli.dmss_api.model.data_source_request import DataSourceRequest
|
|
19
|
+
from dm_cli.dmss_api.model.entity import Entity
|
|
20
|
+
from dm_cli.dmss_api.model.error_response import ErrorResponse
|
|
21
|
+
from dm_cli.dmss_api.model.export_meta_response import ExportMetaResponse
|
|
22
|
+
from dm_cli.dmss_api.model.get_blueprint_response import GetBlueprintResponse
|
|
23
|
+
from dm_cli.dmss_api.model.lookup import Lookup
|
|
24
|
+
from dm_cli.dmss_api.model.pat_data import PATData
|
|
25
|
+
from dm_cli.dmss_api.model_utils import ( # noqa: F401
|
|
26
|
+
check_allowed_values,
|
|
27
|
+
check_validations,
|
|
28
|
+
date,
|
|
29
|
+
datetime,
|
|
30
|
+
file_type,
|
|
31
|
+
none_type,
|
|
32
|
+
validate_and_convert_types,
|
|
33
|
+
)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class DefaultApi(object):
|
|
37
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
38
|
+
Ref: https://openapi-generator.tech
|
|
39
|
+
|
|
40
|
+
Do not edit the class manually.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
def __init__(self, api_client=None):
|
|
44
|
+
if api_client is None:
|
|
45
|
+
api_client = ApiClient()
|
|
46
|
+
self.api_client = api_client
|
|
47
|
+
self.attribute_get_endpoint = _Endpoint(
|
|
48
|
+
settings={
|
|
49
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
50
|
+
'auth': [
|
|
51
|
+
'APIKeyHeader',
|
|
52
|
+
'OAuth2AuthorizationCodeBearer'
|
|
53
|
+
],
|
|
54
|
+
'endpoint_path': '/api/attribute/{address}',
|
|
55
|
+
'operation_id': 'attribute_get',
|
|
56
|
+
'http_method': 'GET',
|
|
57
|
+
'servers': None,
|
|
58
|
+
},
|
|
59
|
+
params_map={
|
|
60
|
+
'all': [
|
|
61
|
+
'address',
|
|
62
|
+
],
|
|
63
|
+
'required': [
|
|
64
|
+
'address',
|
|
65
|
+
],
|
|
66
|
+
'nullable': [
|
|
67
|
+
],
|
|
68
|
+
'enum': [
|
|
69
|
+
],
|
|
70
|
+
'validation': [
|
|
71
|
+
]
|
|
72
|
+
},
|
|
73
|
+
root_map={
|
|
74
|
+
'validations': {
|
|
75
|
+
},
|
|
76
|
+
'allowed_values': {
|
|
77
|
+
},
|
|
78
|
+
'openapi_types': {
|
|
79
|
+
'address':
|
|
80
|
+
(str,),
|
|
81
|
+
},
|
|
82
|
+
'attribute_map': {
|
|
83
|
+
'address': 'address',
|
|
84
|
+
},
|
|
85
|
+
'location_map': {
|
|
86
|
+
'address': 'path',
|
|
87
|
+
},
|
|
88
|
+
'collection_format_map': {
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
headers_map={
|
|
92
|
+
'accept': [
|
|
93
|
+
'application/json',
|
|
94
|
+
'text/plain'
|
|
95
|
+
],
|
|
96
|
+
'content_type': [],
|
|
97
|
+
},
|
|
98
|
+
api_client=api_client
|
|
99
|
+
)
|
|
100
|
+
self.blob_get_by_id_endpoint = _Endpoint(
|
|
101
|
+
settings={
|
|
102
|
+
'response_type': (file_type,),
|
|
103
|
+
'auth': [
|
|
104
|
+
'APIKeyHeader',
|
|
105
|
+
'OAuth2AuthorizationCodeBearer'
|
|
106
|
+
],
|
|
107
|
+
'endpoint_path': '/api/blobs/{data_source_id}/{blob_id}',
|
|
108
|
+
'operation_id': 'blob_get_by_id',
|
|
109
|
+
'http_method': 'GET',
|
|
110
|
+
'servers': None,
|
|
111
|
+
},
|
|
112
|
+
params_map={
|
|
113
|
+
'all': [
|
|
114
|
+
'data_source_id',
|
|
115
|
+
'blob_id',
|
|
116
|
+
],
|
|
117
|
+
'required': [
|
|
118
|
+
'data_source_id',
|
|
119
|
+
'blob_id',
|
|
120
|
+
],
|
|
121
|
+
'nullable': [
|
|
122
|
+
],
|
|
123
|
+
'enum': [
|
|
124
|
+
],
|
|
125
|
+
'validation': [
|
|
126
|
+
]
|
|
127
|
+
},
|
|
128
|
+
root_map={
|
|
129
|
+
'validations': {
|
|
130
|
+
},
|
|
131
|
+
'allowed_values': {
|
|
132
|
+
},
|
|
133
|
+
'openapi_types': {
|
|
134
|
+
'data_source_id':
|
|
135
|
+
(str,),
|
|
136
|
+
'blob_id':
|
|
137
|
+
(str,),
|
|
138
|
+
},
|
|
139
|
+
'attribute_map': {
|
|
140
|
+
'data_source_id': 'data_source_id',
|
|
141
|
+
'blob_id': 'blob_id',
|
|
142
|
+
},
|
|
143
|
+
'location_map': {
|
|
144
|
+
'data_source_id': 'path',
|
|
145
|
+
'blob_id': 'path',
|
|
146
|
+
},
|
|
147
|
+
'collection_format_map': {
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
headers_map={
|
|
151
|
+
'accept': [
|
|
152
|
+
'application/octet-stream',
|
|
153
|
+
'application/json',
|
|
154
|
+
'text/plain'
|
|
155
|
+
],
|
|
156
|
+
'content_type': [],
|
|
157
|
+
},
|
|
158
|
+
api_client=api_client
|
|
159
|
+
)
|
|
160
|
+
self.blob_upload_endpoint = _Endpoint(
|
|
161
|
+
settings={
|
|
162
|
+
'response_type': (str,),
|
|
163
|
+
'auth': [
|
|
164
|
+
'APIKeyHeader',
|
|
165
|
+
'OAuth2AuthorizationCodeBearer'
|
|
166
|
+
],
|
|
167
|
+
'endpoint_path': '/api/blobs/{data_source_id}/{blob_id}',
|
|
168
|
+
'operation_id': 'blob_upload',
|
|
169
|
+
'http_method': 'PUT',
|
|
170
|
+
'servers': None,
|
|
171
|
+
},
|
|
172
|
+
params_map={
|
|
173
|
+
'all': [
|
|
174
|
+
'data_source_id',
|
|
175
|
+
'blob_id',
|
|
176
|
+
'file',
|
|
177
|
+
],
|
|
178
|
+
'required': [
|
|
179
|
+
'data_source_id',
|
|
180
|
+
'blob_id',
|
|
181
|
+
'file',
|
|
182
|
+
],
|
|
183
|
+
'nullable': [
|
|
184
|
+
],
|
|
185
|
+
'enum': [
|
|
186
|
+
],
|
|
187
|
+
'validation': [
|
|
188
|
+
]
|
|
189
|
+
},
|
|
190
|
+
root_map={
|
|
191
|
+
'validations': {
|
|
192
|
+
},
|
|
193
|
+
'allowed_values': {
|
|
194
|
+
},
|
|
195
|
+
'openapi_types': {
|
|
196
|
+
'data_source_id':
|
|
197
|
+
(str,),
|
|
198
|
+
'blob_id':
|
|
199
|
+
(str,),
|
|
200
|
+
'file':
|
|
201
|
+
(file_type,),
|
|
202
|
+
},
|
|
203
|
+
'attribute_map': {
|
|
204
|
+
'data_source_id': 'data_source_id',
|
|
205
|
+
'blob_id': 'blob_id',
|
|
206
|
+
'file': 'file',
|
|
207
|
+
},
|
|
208
|
+
'location_map': {
|
|
209
|
+
'data_source_id': 'path',
|
|
210
|
+
'blob_id': 'path',
|
|
211
|
+
'file': 'form',
|
|
212
|
+
},
|
|
213
|
+
'collection_format_map': {
|
|
214
|
+
}
|
|
215
|
+
},
|
|
216
|
+
headers_map={
|
|
217
|
+
'accept': [
|
|
218
|
+
'application/json',
|
|
219
|
+
'text/plain'
|
|
220
|
+
],
|
|
221
|
+
'content_type': [
|
|
222
|
+
'multipart/form-data'
|
|
223
|
+
]
|
|
224
|
+
},
|
|
225
|
+
api_client=api_client
|
|
226
|
+
)
|
|
227
|
+
self.blueprint_get_endpoint = _Endpoint(
|
|
228
|
+
settings={
|
|
229
|
+
'response_type': (GetBlueprintResponse,),
|
|
230
|
+
'auth': [
|
|
231
|
+
'APIKeyHeader',
|
|
232
|
+
'OAuth2AuthorizationCodeBearer'
|
|
233
|
+
],
|
|
234
|
+
'endpoint_path': '/api/blueprint/{type_ref}',
|
|
235
|
+
'operation_id': 'blueprint_get',
|
|
236
|
+
'http_method': 'GET',
|
|
237
|
+
'servers': None,
|
|
238
|
+
},
|
|
239
|
+
params_map={
|
|
240
|
+
'all': [
|
|
241
|
+
'type_ref',
|
|
242
|
+
'context',
|
|
243
|
+
],
|
|
244
|
+
'required': [
|
|
245
|
+
'type_ref',
|
|
246
|
+
],
|
|
247
|
+
'nullable': [
|
|
248
|
+
],
|
|
249
|
+
'enum': [
|
|
250
|
+
],
|
|
251
|
+
'validation': [
|
|
252
|
+
'type_ref',
|
|
253
|
+
]
|
|
254
|
+
},
|
|
255
|
+
root_map={
|
|
256
|
+
'validations': {
|
|
257
|
+
('type_ref',): {
|
|
258
|
+
'max_length': 128,
|
|
259
|
+
'min_length': 3,
|
|
260
|
+
'regex': {
|
|
261
|
+
'pattern': r'^[A-Z:a-z0-9_\/-]*$', # noqa: E501
|
|
262
|
+
},
|
|
263
|
+
},
|
|
264
|
+
},
|
|
265
|
+
'allowed_values': {
|
|
266
|
+
},
|
|
267
|
+
'openapi_types': {
|
|
268
|
+
'type_ref':
|
|
269
|
+
(str,),
|
|
270
|
+
'context':
|
|
271
|
+
(str,),
|
|
272
|
+
},
|
|
273
|
+
'attribute_map': {
|
|
274
|
+
'type_ref': 'type_ref',
|
|
275
|
+
'context': 'context',
|
|
276
|
+
},
|
|
277
|
+
'location_map': {
|
|
278
|
+
'type_ref': 'path',
|
|
279
|
+
'context': 'query',
|
|
280
|
+
},
|
|
281
|
+
'collection_format_map': {
|
|
282
|
+
}
|
|
283
|
+
},
|
|
284
|
+
headers_map={
|
|
285
|
+
'accept': [
|
|
286
|
+
'application/json',
|
|
287
|
+
'text/plain'
|
|
288
|
+
],
|
|
289
|
+
'content_type': [],
|
|
290
|
+
},
|
|
291
|
+
api_client=api_client
|
|
292
|
+
)
|
|
293
|
+
self.blueprint_resolve_endpoint = _Endpoint(
|
|
294
|
+
settings={
|
|
295
|
+
'response_type': (str,),
|
|
296
|
+
'auth': [
|
|
297
|
+
'APIKeyHeader',
|
|
298
|
+
'OAuth2AuthorizationCodeBearer'
|
|
299
|
+
],
|
|
300
|
+
'endpoint_path': '/api/resolve-path/{address}',
|
|
301
|
+
'operation_id': 'blueprint_resolve',
|
|
302
|
+
'http_method': 'GET',
|
|
303
|
+
'servers': None,
|
|
304
|
+
},
|
|
305
|
+
params_map={
|
|
306
|
+
'all': [
|
|
307
|
+
'address',
|
|
308
|
+
],
|
|
309
|
+
'required': [
|
|
310
|
+
'address',
|
|
311
|
+
],
|
|
312
|
+
'nullable': [
|
|
313
|
+
],
|
|
314
|
+
'enum': [
|
|
315
|
+
],
|
|
316
|
+
'validation': [
|
|
317
|
+
]
|
|
318
|
+
},
|
|
319
|
+
root_map={
|
|
320
|
+
'validations': {
|
|
321
|
+
},
|
|
322
|
+
'allowed_values': {
|
|
323
|
+
},
|
|
324
|
+
'openapi_types': {
|
|
325
|
+
'address':
|
|
326
|
+
(str,),
|
|
327
|
+
},
|
|
328
|
+
'attribute_map': {
|
|
329
|
+
'address': 'address',
|
|
330
|
+
},
|
|
331
|
+
'location_map': {
|
|
332
|
+
'address': 'path',
|
|
333
|
+
},
|
|
334
|
+
'collection_format_map': {
|
|
335
|
+
}
|
|
336
|
+
},
|
|
337
|
+
headers_map={
|
|
338
|
+
'accept': [
|
|
339
|
+
'application/json',
|
|
340
|
+
'text/plain'
|
|
341
|
+
],
|
|
342
|
+
'content_type': [],
|
|
343
|
+
},
|
|
344
|
+
api_client=api_client
|
|
345
|
+
)
|
|
346
|
+
self.create_lookup_endpoint = _Endpoint(
|
|
347
|
+
settings={
|
|
348
|
+
'response_type': None,
|
|
349
|
+
'auth': [
|
|
350
|
+
'APIKeyHeader',
|
|
351
|
+
'OAuth2AuthorizationCodeBearer'
|
|
352
|
+
],
|
|
353
|
+
'endpoint_path': '/api/application/{application}',
|
|
354
|
+
'operation_id': 'create_lookup',
|
|
355
|
+
'http_method': 'POST',
|
|
356
|
+
'servers': None,
|
|
357
|
+
},
|
|
358
|
+
params_map={
|
|
359
|
+
'all': [
|
|
360
|
+
'application',
|
|
361
|
+
'recipe_package',
|
|
362
|
+
],
|
|
363
|
+
'required': [
|
|
364
|
+
'application',
|
|
365
|
+
'recipe_package',
|
|
366
|
+
],
|
|
367
|
+
'nullable': [
|
|
368
|
+
],
|
|
369
|
+
'enum': [
|
|
370
|
+
],
|
|
371
|
+
'validation': [
|
|
372
|
+
]
|
|
373
|
+
},
|
|
374
|
+
root_map={
|
|
375
|
+
'validations': {
|
|
376
|
+
},
|
|
377
|
+
'allowed_values': {
|
|
378
|
+
},
|
|
379
|
+
'openapi_types': {
|
|
380
|
+
'application':
|
|
381
|
+
(str,),
|
|
382
|
+
'recipe_package':
|
|
383
|
+
([str],),
|
|
384
|
+
},
|
|
385
|
+
'attribute_map': {
|
|
386
|
+
'application': 'application',
|
|
387
|
+
'recipe_package': 'recipe_package',
|
|
388
|
+
},
|
|
389
|
+
'location_map': {
|
|
390
|
+
'application': 'path',
|
|
391
|
+
'recipe_package': 'query',
|
|
392
|
+
},
|
|
393
|
+
'collection_format_map': {
|
|
394
|
+
'recipe_package': 'multi',
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
headers_map={
|
|
398
|
+
'accept': [
|
|
399
|
+
'application/json',
|
|
400
|
+
'text/plain'
|
|
401
|
+
],
|
|
402
|
+
'content_type': [],
|
|
403
|
+
},
|
|
404
|
+
api_client=api_client
|
|
405
|
+
)
|
|
406
|
+
self.data_source_get_endpoint = _Endpoint(
|
|
407
|
+
settings={
|
|
408
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
409
|
+
'auth': [
|
|
410
|
+
'APIKeyHeader',
|
|
411
|
+
'OAuth2AuthorizationCodeBearer'
|
|
412
|
+
],
|
|
413
|
+
'endpoint_path': '/api/data-sources/{data_source_id}',
|
|
414
|
+
'operation_id': 'data_source_get',
|
|
415
|
+
'http_method': 'GET',
|
|
416
|
+
'servers': None,
|
|
417
|
+
},
|
|
418
|
+
params_map={
|
|
419
|
+
'all': [
|
|
420
|
+
'data_source_id',
|
|
421
|
+
],
|
|
422
|
+
'required': [
|
|
423
|
+
'data_source_id',
|
|
424
|
+
],
|
|
425
|
+
'nullable': [
|
|
426
|
+
],
|
|
427
|
+
'enum': [
|
|
428
|
+
],
|
|
429
|
+
'validation': [
|
|
430
|
+
]
|
|
431
|
+
},
|
|
432
|
+
root_map={
|
|
433
|
+
'validations': {
|
|
434
|
+
},
|
|
435
|
+
'allowed_values': {
|
|
436
|
+
},
|
|
437
|
+
'openapi_types': {
|
|
438
|
+
'data_source_id':
|
|
439
|
+
(str,),
|
|
440
|
+
},
|
|
441
|
+
'attribute_map': {
|
|
442
|
+
'data_source_id': 'data_source_id',
|
|
443
|
+
},
|
|
444
|
+
'location_map': {
|
|
445
|
+
'data_source_id': 'path',
|
|
446
|
+
},
|
|
447
|
+
'collection_format_map': {
|
|
448
|
+
}
|
|
449
|
+
},
|
|
450
|
+
headers_map={
|
|
451
|
+
'accept': [
|
|
452
|
+
'application/json',
|
|
453
|
+
'text/plain'
|
|
454
|
+
],
|
|
455
|
+
'content_type': [],
|
|
456
|
+
},
|
|
457
|
+
api_client=api_client
|
|
458
|
+
)
|
|
459
|
+
self.data_source_get_all_endpoint = _Endpoint(
|
|
460
|
+
settings={
|
|
461
|
+
'response_type': ([DataSourceInformation],),
|
|
462
|
+
'auth': [
|
|
463
|
+
'APIKeyHeader',
|
|
464
|
+
'OAuth2AuthorizationCodeBearer'
|
|
465
|
+
],
|
|
466
|
+
'endpoint_path': '/api/data-sources',
|
|
467
|
+
'operation_id': 'data_source_get_all',
|
|
468
|
+
'http_method': 'GET',
|
|
469
|
+
'servers': None,
|
|
470
|
+
},
|
|
471
|
+
params_map={
|
|
472
|
+
'all': [
|
|
473
|
+
],
|
|
474
|
+
'required': [],
|
|
475
|
+
'nullable': [
|
|
476
|
+
],
|
|
477
|
+
'enum': [
|
|
478
|
+
],
|
|
479
|
+
'validation': [
|
|
480
|
+
]
|
|
481
|
+
},
|
|
482
|
+
root_map={
|
|
483
|
+
'validations': {
|
|
484
|
+
},
|
|
485
|
+
'allowed_values': {
|
|
486
|
+
},
|
|
487
|
+
'openapi_types': {
|
|
488
|
+
},
|
|
489
|
+
'attribute_map': {
|
|
490
|
+
},
|
|
491
|
+
'location_map': {
|
|
492
|
+
},
|
|
493
|
+
'collection_format_map': {
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
headers_map={
|
|
497
|
+
'accept': [
|
|
498
|
+
'application/json',
|
|
499
|
+
'text/plain'
|
|
500
|
+
],
|
|
501
|
+
'content_type': [],
|
|
502
|
+
},
|
|
503
|
+
api_client=api_client
|
|
504
|
+
)
|
|
505
|
+
self.data_source_save_endpoint = _Endpoint(
|
|
506
|
+
settings={
|
|
507
|
+
'response_type': (str,),
|
|
508
|
+
'auth': [
|
|
509
|
+
'APIKeyHeader',
|
|
510
|
+
'OAuth2AuthorizationCodeBearer'
|
|
511
|
+
],
|
|
512
|
+
'endpoint_path': '/api/data-sources/{data_source_id}',
|
|
513
|
+
'operation_id': 'data_source_save',
|
|
514
|
+
'http_method': 'POST',
|
|
515
|
+
'servers': None,
|
|
516
|
+
},
|
|
517
|
+
params_map={
|
|
518
|
+
'all': [
|
|
519
|
+
'data_source_id',
|
|
520
|
+
'data_source_request',
|
|
521
|
+
],
|
|
522
|
+
'required': [
|
|
523
|
+
'data_source_id',
|
|
524
|
+
'data_source_request',
|
|
525
|
+
],
|
|
526
|
+
'nullable': [
|
|
527
|
+
],
|
|
528
|
+
'enum': [
|
|
529
|
+
],
|
|
530
|
+
'validation': [
|
|
531
|
+
]
|
|
532
|
+
},
|
|
533
|
+
root_map={
|
|
534
|
+
'validations': {
|
|
535
|
+
},
|
|
536
|
+
'allowed_values': {
|
|
537
|
+
},
|
|
538
|
+
'openapi_types': {
|
|
539
|
+
'data_source_id':
|
|
540
|
+
(str,),
|
|
541
|
+
'data_source_request':
|
|
542
|
+
(DataSourceRequest,),
|
|
543
|
+
},
|
|
544
|
+
'attribute_map': {
|
|
545
|
+
'data_source_id': 'data_source_id',
|
|
546
|
+
},
|
|
547
|
+
'location_map': {
|
|
548
|
+
'data_source_id': 'path',
|
|
549
|
+
'data_source_request': 'body',
|
|
550
|
+
},
|
|
551
|
+
'collection_format_map': {
|
|
552
|
+
}
|
|
553
|
+
},
|
|
554
|
+
headers_map={
|
|
555
|
+
'accept': [
|
|
556
|
+
'application/json',
|
|
557
|
+
'text/plain'
|
|
558
|
+
],
|
|
559
|
+
'content_type': [
|
|
560
|
+
'application/json'
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
api_client=api_client
|
|
564
|
+
)
|
|
565
|
+
self.document_add_endpoint = _Endpoint(
|
|
566
|
+
settings={
|
|
567
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
568
|
+
'auth': [
|
|
569
|
+
'APIKeyHeader',
|
|
570
|
+
'OAuth2AuthorizationCodeBearer'
|
|
571
|
+
],
|
|
572
|
+
'endpoint_path': '/api/documents/{address}',
|
|
573
|
+
'operation_id': 'document_add',
|
|
574
|
+
'http_method': 'POST',
|
|
575
|
+
'servers': None,
|
|
576
|
+
},
|
|
577
|
+
params_map={
|
|
578
|
+
'all': [
|
|
579
|
+
'address',
|
|
580
|
+
'document',
|
|
581
|
+
'update_uncontained',
|
|
582
|
+
'files',
|
|
583
|
+
],
|
|
584
|
+
'required': [
|
|
585
|
+
'address',
|
|
586
|
+
'document',
|
|
587
|
+
],
|
|
588
|
+
'nullable': [
|
|
589
|
+
],
|
|
590
|
+
'enum': [
|
|
591
|
+
],
|
|
592
|
+
'validation': [
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
root_map={
|
|
596
|
+
'validations': {
|
|
597
|
+
},
|
|
598
|
+
'allowed_values': {
|
|
599
|
+
},
|
|
600
|
+
'openapi_types': {
|
|
601
|
+
'address':
|
|
602
|
+
(str,),
|
|
603
|
+
'document':
|
|
604
|
+
(str,),
|
|
605
|
+
'update_uncontained':
|
|
606
|
+
(bool,),
|
|
607
|
+
'files':
|
|
608
|
+
([file_type],),
|
|
609
|
+
},
|
|
610
|
+
'attribute_map': {
|
|
611
|
+
'address': 'address',
|
|
612
|
+
'document': 'document',
|
|
613
|
+
'update_uncontained': 'update_uncontained',
|
|
614
|
+
'files': 'files',
|
|
615
|
+
},
|
|
616
|
+
'location_map': {
|
|
617
|
+
'address': 'path',
|
|
618
|
+
'document': 'form',
|
|
619
|
+
'update_uncontained': 'query',
|
|
620
|
+
'files': 'form',
|
|
621
|
+
},
|
|
622
|
+
'collection_format_map': {
|
|
623
|
+
'files': 'csv',
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
headers_map={
|
|
627
|
+
'accept': [
|
|
628
|
+
'application/json',
|
|
629
|
+
'text/plain'
|
|
630
|
+
],
|
|
631
|
+
'content_type': [
|
|
632
|
+
'multipart/form-data'
|
|
633
|
+
]
|
|
634
|
+
},
|
|
635
|
+
api_client=api_client
|
|
636
|
+
)
|
|
637
|
+
self.document_add_simple_endpoint = _Endpoint(
|
|
638
|
+
settings={
|
|
639
|
+
'response_type': (str,),
|
|
640
|
+
'auth': [
|
|
641
|
+
'APIKeyHeader',
|
|
642
|
+
'OAuth2AuthorizationCodeBearer'
|
|
643
|
+
],
|
|
644
|
+
'endpoint_path': '/api/documents-add-raw/{data_source_id}',
|
|
645
|
+
'operation_id': 'document_add_simple',
|
|
646
|
+
'http_method': 'POST',
|
|
647
|
+
'servers': None,
|
|
648
|
+
},
|
|
649
|
+
params_map={
|
|
650
|
+
'all': [
|
|
651
|
+
'data_source_id',
|
|
652
|
+
'body',
|
|
653
|
+
],
|
|
654
|
+
'required': [
|
|
655
|
+
'data_source_id',
|
|
656
|
+
'body',
|
|
657
|
+
],
|
|
658
|
+
'nullable': [
|
|
659
|
+
],
|
|
660
|
+
'enum': [
|
|
661
|
+
],
|
|
662
|
+
'validation': [
|
|
663
|
+
]
|
|
664
|
+
},
|
|
665
|
+
root_map={
|
|
666
|
+
'validations': {
|
|
667
|
+
},
|
|
668
|
+
'allowed_values': {
|
|
669
|
+
},
|
|
670
|
+
'openapi_types': {
|
|
671
|
+
'data_source_id':
|
|
672
|
+
(str,),
|
|
673
|
+
'body':
|
|
674
|
+
({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
675
|
+
},
|
|
676
|
+
'attribute_map': {
|
|
677
|
+
'data_source_id': 'data_source_id',
|
|
678
|
+
},
|
|
679
|
+
'location_map': {
|
|
680
|
+
'data_source_id': 'path',
|
|
681
|
+
'body': 'body',
|
|
682
|
+
},
|
|
683
|
+
'collection_format_map': {
|
|
684
|
+
}
|
|
685
|
+
},
|
|
686
|
+
headers_map={
|
|
687
|
+
'accept': [
|
|
688
|
+
'application/json',
|
|
689
|
+
'text/plain'
|
|
690
|
+
],
|
|
691
|
+
'content_type': [
|
|
692
|
+
'application/json'
|
|
693
|
+
]
|
|
694
|
+
},
|
|
695
|
+
api_client=api_client
|
|
696
|
+
)
|
|
697
|
+
self.document_check_endpoint = _Endpoint(
|
|
698
|
+
settings={
|
|
699
|
+
'response_type': (bool,),
|
|
700
|
+
'auth': [
|
|
701
|
+
'APIKeyHeader',
|
|
702
|
+
'OAuth2AuthorizationCodeBearer'
|
|
703
|
+
],
|
|
704
|
+
'endpoint_path': '/api/documents-existence/{address}',
|
|
705
|
+
'operation_id': 'document_check',
|
|
706
|
+
'http_method': 'GET',
|
|
707
|
+
'servers': None,
|
|
708
|
+
},
|
|
709
|
+
params_map={
|
|
710
|
+
'all': [
|
|
711
|
+
'address',
|
|
712
|
+
],
|
|
713
|
+
'required': [
|
|
714
|
+
'address',
|
|
715
|
+
],
|
|
716
|
+
'nullable': [
|
|
717
|
+
],
|
|
718
|
+
'enum': [
|
|
719
|
+
],
|
|
720
|
+
'validation': [
|
|
721
|
+
]
|
|
722
|
+
},
|
|
723
|
+
root_map={
|
|
724
|
+
'validations': {
|
|
725
|
+
},
|
|
726
|
+
'allowed_values': {
|
|
727
|
+
},
|
|
728
|
+
'openapi_types': {
|
|
729
|
+
'address':
|
|
730
|
+
(str,),
|
|
731
|
+
},
|
|
732
|
+
'attribute_map': {
|
|
733
|
+
'address': 'address',
|
|
734
|
+
},
|
|
735
|
+
'location_map': {
|
|
736
|
+
'address': 'path',
|
|
737
|
+
},
|
|
738
|
+
'collection_format_map': {
|
|
739
|
+
}
|
|
740
|
+
},
|
|
741
|
+
headers_map={
|
|
742
|
+
'accept': [
|
|
743
|
+
'application/json',
|
|
744
|
+
'text/plain'
|
|
745
|
+
],
|
|
746
|
+
'content_type': [],
|
|
747
|
+
},
|
|
748
|
+
api_client=api_client
|
|
749
|
+
)
|
|
750
|
+
self.document_get_endpoint = _Endpoint(
|
|
751
|
+
settings={
|
|
752
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
753
|
+
'auth': [
|
|
754
|
+
'APIKeyHeader',
|
|
755
|
+
'OAuth2AuthorizationCodeBearer'
|
|
756
|
+
],
|
|
757
|
+
'endpoint_path': '/api/documents/{address}',
|
|
758
|
+
'operation_id': 'document_get',
|
|
759
|
+
'http_method': 'GET',
|
|
760
|
+
'servers': None,
|
|
761
|
+
},
|
|
762
|
+
params_map={
|
|
763
|
+
'all': [
|
|
764
|
+
'address',
|
|
765
|
+
'depth',
|
|
766
|
+
],
|
|
767
|
+
'required': [
|
|
768
|
+
'address',
|
|
769
|
+
],
|
|
770
|
+
'nullable': [
|
|
771
|
+
],
|
|
772
|
+
'enum': [
|
|
773
|
+
],
|
|
774
|
+
'validation': [
|
|
775
|
+
]
|
|
776
|
+
},
|
|
777
|
+
root_map={
|
|
778
|
+
'validations': {
|
|
779
|
+
},
|
|
780
|
+
'allowed_values': {
|
|
781
|
+
},
|
|
782
|
+
'openapi_types': {
|
|
783
|
+
'address':
|
|
784
|
+
(str,),
|
|
785
|
+
'depth':
|
|
786
|
+
(int,),
|
|
787
|
+
},
|
|
788
|
+
'attribute_map': {
|
|
789
|
+
'address': 'address',
|
|
790
|
+
'depth': 'depth',
|
|
791
|
+
},
|
|
792
|
+
'location_map': {
|
|
793
|
+
'address': 'path',
|
|
794
|
+
'depth': 'query',
|
|
795
|
+
},
|
|
796
|
+
'collection_format_map': {
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
headers_map={
|
|
800
|
+
'accept': [
|
|
801
|
+
'application/json',
|
|
802
|
+
'text/plain'
|
|
803
|
+
],
|
|
804
|
+
'content_type': [],
|
|
805
|
+
},
|
|
806
|
+
api_client=api_client
|
|
807
|
+
)
|
|
808
|
+
self.document_remove_endpoint = _Endpoint(
|
|
809
|
+
settings={
|
|
810
|
+
'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
|
|
811
|
+
'auth': [
|
|
812
|
+
'APIKeyHeader',
|
|
813
|
+
'OAuth2AuthorizationCodeBearer'
|
|
814
|
+
],
|
|
815
|
+
'endpoint_path': '/api/documents/{address}',
|
|
816
|
+
'operation_id': 'document_remove',
|
|
817
|
+
'http_method': 'DELETE',
|
|
818
|
+
'servers': None,
|
|
819
|
+
},
|
|
820
|
+
params_map={
|
|
821
|
+
'all': [
|
|
822
|
+
'address',
|
|
823
|
+
],
|
|
824
|
+
'required': [
|
|
825
|
+
'address',
|
|
826
|
+
],
|
|
827
|
+
'nullable': [
|
|
828
|
+
],
|
|
829
|
+
'enum': [
|
|
830
|
+
],
|
|
831
|
+
'validation': [
|
|
832
|
+
]
|
|
833
|
+
},
|
|
834
|
+
root_map={
|
|
835
|
+
'validations': {
|
|
836
|
+
},
|
|
837
|
+
'allowed_values': {
|
|
838
|
+
},
|
|
839
|
+
'openapi_types': {
|
|
840
|
+
'address':
|
|
841
|
+
(str,),
|
|
842
|
+
},
|
|
843
|
+
'attribute_map': {
|
|
844
|
+
'address': 'address',
|
|
845
|
+
},
|
|
846
|
+
'location_map': {
|
|
847
|
+
'address': 'path',
|
|
848
|
+
},
|
|
849
|
+
'collection_format_map': {
|
|
850
|
+
}
|
|
851
|
+
},
|
|
852
|
+
headers_map={
|
|
853
|
+
'accept': [
|
|
854
|
+
'application/json',
|
|
855
|
+
'text/plain'
|
|
856
|
+
],
|
|
857
|
+
'content_type': [],
|
|
858
|
+
},
|
|
859
|
+
api_client=api_client
|
|
860
|
+
)
|
|
861
|
+
self.document_update_endpoint = _Endpoint(
|
|
862
|
+
settings={
|
|
863
|
+
'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
|
|
864
|
+
'auth': [
|
|
865
|
+
'APIKeyHeader',
|
|
866
|
+
'OAuth2AuthorizationCodeBearer'
|
|
867
|
+
],
|
|
868
|
+
'endpoint_path': '/api/documents/{id_address}',
|
|
869
|
+
'operation_id': 'document_update',
|
|
870
|
+
'http_method': 'PUT',
|
|
871
|
+
'servers': None,
|
|
872
|
+
},
|
|
873
|
+
params_map={
|
|
874
|
+
'all': [
|
|
875
|
+
'id_address',
|
|
876
|
+
'data',
|
|
877
|
+
'update_uncontained',
|
|
878
|
+
'files',
|
|
879
|
+
],
|
|
880
|
+
'required': [
|
|
881
|
+
'id_address',
|
|
882
|
+
'data',
|
|
883
|
+
],
|
|
884
|
+
'nullable': [
|
|
885
|
+
],
|
|
886
|
+
'enum': [
|
|
887
|
+
],
|
|
888
|
+
'validation': [
|
|
889
|
+
]
|
|
890
|
+
},
|
|
891
|
+
root_map={
|
|
892
|
+
'validations': {
|
|
893
|
+
},
|
|
894
|
+
'allowed_values': {
|
|
895
|
+
},
|
|
896
|
+
'openapi_types': {
|
|
897
|
+
'id_address':
|
|
898
|
+
(str,),
|
|
899
|
+
'data':
|
|
900
|
+
(str,),
|
|
901
|
+
'update_uncontained':
|
|
902
|
+
(bool,),
|
|
903
|
+
'files':
|
|
904
|
+
([file_type],),
|
|
905
|
+
},
|
|
906
|
+
'attribute_map': {
|
|
907
|
+
'id_address': 'id_address',
|
|
908
|
+
'data': 'data',
|
|
909
|
+
'update_uncontained': 'update_uncontained',
|
|
910
|
+
'files': 'files',
|
|
911
|
+
},
|
|
912
|
+
'location_map': {
|
|
913
|
+
'id_address': 'path',
|
|
914
|
+
'data': 'form',
|
|
915
|
+
'update_uncontained': 'query',
|
|
916
|
+
'files': 'form',
|
|
917
|
+
},
|
|
918
|
+
'collection_format_map': {
|
|
919
|
+
'files': 'csv',
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
headers_map={
|
|
923
|
+
'accept': [
|
|
924
|
+
'application/json',
|
|
925
|
+
'text/plain'
|
|
926
|
+
],
|
|
927
|
+
'content_type': [
|
|
928
|
+
'multipart/form-data'
|
|
929
|
+
]
|
|
930
|
+
},
|
|
931
|
+
api_client=api_client
|
|
932
|
+
)
|
|
933
|
+
self.export_endpoint = _Endpoint(
|
|
934
|
+
settings={
|
|
935
|
+
'response_type': None,
|
|
936
|
+
'auth': [
|
|
937
|
+
'APIKeyHeader',
|
|
938
|
+
'OAuth2AuthorizationCodeBearer'
|
|
939
|
+
],
|
|
940
|
+
'endpoint_path': '/api/export/{path_address}',
|
|
941
|
+
'operation_id': 'export',
|
|
942
|
+
'http_method': 'GET',
|
|
943
|
+
'servers': None,
|
|
944
|
+
},
|
|
945
|
+
params_map={
|
|
946
|
+
'all': [
|
|
947
|
+
'path_address',
|
|
948
|
+
],
|
|
949
|
+
'required': [
|
|
950
|
+
'path_address',
|
|
951
|
+
],
|
|
952
|
+
'nullable': [
|
|
953
|
+
],
|
|
954
|
+
'enum': [
|
|
955
|
+
],
|
|
956
|
+
'validation': [
|
|
957
|
+
]
|
|
958
|
+
},
|
|
959
|
+
root_map={
|
|
960
|
+
'validations': {
|
|
961
|
+
},
|
|
962
|
+
'allowed_values': {
|
|
963
|
+
},
|
|
964
|
+
'openapi_types': {
|
|
965
|
+
'path_address':
|
|
966
|
+
(str,),
|
|
967
|
+
},
|
|
968
|
+
'attribute_map': {
|
|
969
|
+
'path_address': 'path_address',
|
|
970
|
+
},
|
|
971
|
+
'location_map': {
|
|
972
|
+
'path_address': 'path',
|
|
973
|
+
},
|
|
974
|
+
'collection_format_map': {
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
headers_map={
|
|
978
|
+
'accept': [
|
|
979
|
+
'application/zip',
|
|
980
|
+
'application/json',
|
|
981
|
+
'text/plain'
|
|
982
|
+
],
|
|
983
|
+
'content_type': [],
|
|
984
|
+
},
|
|
985
|
+
api_client=api_client
|
|
986
|
+
)
|
|
987
|
+
self.export_meta_endpoint = _Endpoint(
|
|
988
|
+
settings={
|
|
989
|
+
'response_type': (ExportMetaResponse,),
|
|
990
|
+
'auth': [
|
|
991
|
+
'APIKeyHeader',
|
|
992
|
+
'OAuth2AuthorizationCodeBearer'
|
|
993
|
+
],
|
|
994
|
+
'endpoint_path': '/api/export/meta/{path_address}',
|
|
995
|
+
'operation_id': 'export_meta',
|
|
996
|
+
'http_method': 'GET',
|
|
997
|
+
'servers': None,
|
|
998
|
+
},
|
|
999
|
+
params_map={
|
|
1000
|
+
'all': [
|
|
1001
|
+
'path_address',
|
|
1002
|
+
],
|
|
1003
|
+
'required': [
|
|
1004
|
+
'path_address',
|
|
1005
|
+
],
|
|
1006
|
+
'nullable': [
|
|
1007
|
+
],
|
|
1008
|
+
'enum': [
|
|
1009
|
+
],
|
|
1010
|
+
'validation': [
|
|
1011
|
+
]
|
|
1012
|
+
},
|
|
1013
|
+
root_map={
|
|
1014
|
+
'validations': {
|
|
1015
|
+
},
|
|
1016
|
+
'allowed_values': {
|
|
1017
|
+
},
|
|
1018
|
+
'openapi_types': {
|
|
1019
|
+
'path_address':
|
|
1020
|
+
(str,),
|
|
1021
|
+
},
|
|
1022
|
+
'attribute_map': {
|
|
1023
|
+
'path_address': 'path_address',
|
|
1024
|
+
},
|
|
1025
|
+
'location_map': {
|
|
1026
|
+
'path_address': 'path',
|
|
1027
|
+
},
|
|
1028
|
+
'collection_format_map': {
|
|
1029
|
+
}
|
|
1030
|
+
},
|
|
1031
|
+
headers_map={
|
|
1032
|
+
'accept': [
|
|
1033
|
+
'application/json',
|
|
1034
|
+
'text/plain'
|
|
1035
|
+
],
|
|
1036
|
+
'content_type': [],
|
|
1037
|
+
},
|
|
1038
|
+
api_client=api_client
|
|
1039
|
+
)
|
|
1040
|
+
self.file_upload_endpoint = _Endpoint(
|
|
1041
|
+
settings={
|
|
1042
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
1043
|
+
'auth': [
|
|
1044
|
+
'APIKeyHeader',
|
|
1045
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1046
|
+
],
|
|
1047
|
+
'endpoint_path': '/api/files/{data_source_id}',
|
|
1048
|
+
'operation_id': 'file_upload',
|
|
1049
|
+
'http_method': 'POST',
|
|
1050
|
+
'servers': None,
|
|
1051
|
+
},
|
|
1052
|
+
params_map={
|
|
1053
|
+
'all': [
|
|
1054
|
+
'data_source_id',
|
|
1055
|
+
'data',
|
|
1056
|
+
'file',
|
|
1057
|
+
],
|
|
1058
|
+
'required': [
|
|
1059
|
+
'data_source_id',
|
|
1060
|
+
'data',
|
|
1061
|
+
'file',
|
|
1062
|
+
],
|
|
1063
|
+
'nullable': [
|
|
1064
|
+
],
|
|
1065
|
+
'enum': [
|
|
1066
|
+
],
|
|
1067
|
+
'validation': [
|
|
1068
|
+
]
|
|
1069
|
+
},
|
|
1070
|
+
root_map={
|
|
1071
|
+
'validations': {
|
|
1072
|
+
},
|
|
1073
|
+
'allowed_values': {
|
|
1074
|
+
},
|
|
1075
|
+
'openapi_types': {
|
|
1076
|
+
'data_source_id':
|
|
1077
|
+
(str,),
|
|
1078
|
+
'data':
|
|
1079
|
+
(str,),
|
|
1080
|
+
'file':
|
|
1081
|
+
(file_type,),
|
|
1082
|
+
},
|
|
1083
|
+
'attribute_map': {
|
|
1084
|
+
'data_source_id': 'data_source_id',
|
|
1085
|
+
'data': 'data',
|
|
1086
|
+
'file': 'file',
|
|
1087
|
+
},
|
|
1088
|
+
'location_map': {
|
|
1089
|
+
'data_source_id': 'path',
|
|
1090
|
+
'data': 'form',
|
|
1091
|
+
'file': 'form',
|
|
1092
|
+
},
|
|
1093
|
+
'collection_format_map': {
|
|
1094
|
+
}
|
|
1095
|
+
},
|
|
1096
|
+
headers_map={
|
|
1097
|
+
'accept': [
|
|
1098
|
+
'application/json',
|
|
1099
|
+
'text/plain'
|
|
1100
|
+
],
|
|
1101
|
+
'content_type': [
|
|
1102
|
+
'multipart/form-data'
|
|
1103
|
+
]
|
|
1104
|
+
},
|
|
1105
|
+
api_client=api_client
|
|
1106
|
+
)
|
|
1107
|
+
self.get_acl_endpoint = _Endpoint(
|
|
1108
|
+
settings={
|
|
1109
|
+
'response_type': (AccessControlList,),
|
|
1110
|
+
'auth': [
|
|
1111
|
+
'APIKeyHeader',
|
|
1112
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1113
|
+
],
|
|
1114
|
+
'endpoint_path': '/api/acl/{data_source_id}/{document_id}',
|
|
1115
|
+
'operation_id': 'get_acl',
|
|
1116
|
+
'http_method': 'GET',
|
|
1117
|
+
'servers': None,
|
|
1118
|
+
},
|
|
1119
|
+
params_map={
|
|
1120
|
+
'all': [
|
|
1121
|
+
'data_source_id',
|
|
1122
|
+
'document_id',
|
|
1123
|
+
],
|
|
1124
|
+
'required': [
|
|
1125
|
+
'data_source_id',
|
|
1126
|
+
'document_id',
|
|
1127
|
+
],
|
|
1128
|
+
'nullable': [
|
|
1129
|
+
],
|
|
1130
|
+
'enum': [
|
|
1131
|
+
],
|
|
1132
|
+
'validation': [
|
|
1133
|
+
]
|
|
1134
|
+
},
|
|
1135
|
+
root_map={
|
|
1136
|
+
'validations': {
|
|
1137
|
+
},
|
|
1138
|
+
'allowed_values': {
|
|
1139
|
+
},
|
|
1140
|
+
'openapi_types': {
|
|
1141
|
+
'data_source_id':
|
|
1142
|
+
(str,),
|
|
1143
|
+
'document_id':
|
|
1144
|
+
(str,),
|
|
1145
|
+
},
|
|
1146
|
+
'attribute_map': {
|
|
1147
|
+
'data_source_id': 'data_source_id',
|
|
1148
|
+
'document_id': 'document_id',
|
|
1149
|
+
},
|
|
1150
|
+
'location_map': {
|
|
1151
|
+
'data_source_id': 'path',
|
|
1152
|
+
'document_id': 'path',
|
|
1153
|
+
},
|
|
1154
|
+
'collection_format_map': {
|
|
1155
|
+
}
|
|
1156
|
+
},
|
|
1157
|
+
headers_map={
|
|
1158
|
+
'accept': [
|
|
1159
|
+
'application/json',
|
|
1160
|
+
'text/plain'
|
|
1161
|
+
],
|
|
1162
|
+
'content_type': [],
|
|
1163
|
+
},
|
|
1164
|
+
api_client=api_client
|
|
1165
|
+
)
|
|
1166
|
+
self.get_api_healthcheck_get_endpoint = _Endpoint(
|
|
1167
|
+
settings={
|
|
1168
|
+
'response_type': (str,),
|
|
1169
|
+
'auth': [],
|
|
1170
|
+
'endpoint_path': '/api/healthcheck',
|
|
1171
|
+
'operation_id': 'get_api_healthcheck_get',
|
|
1172
|
+
'http_method': 'GET',
|
|
1173
|
+
'servers': None,
|
|
1174
|
+
},
|
|
1175
|
+
params_map={
|
|
1176
|
+
'all': [
|
|
1177
|
+
],
|
|
1178
|
+
'required': [],
|
|
1179
|
+
'nullable': [
|
|
1180
|
+
],
|
|
1181
|
+
'enum': [
|
|
1182
|
+
],
|
|
1183
|
+
'validation': [
|
|
1184
|
+
]
|
|
1185
|
+
},
|
|
1186
|
+
root_map={
|
|
1187
|
+
'validations': {
|
|
1188
|
+
},
|
|
1189
|
+
'allowed_values': {
|
|
1190
|
+
},
|
|
1191
|
+
'openapi_types': {
|
|
1192
|
+
},
|
|
1193
|
+
'attribute_map': {
|
|
1194
|
+
},
|
|
1195
|
+
'location_map': {
|
|
1196
|
+
},
|
|
1197
|
+
'collection_format_map': {
|
|
1198
|
+
}
|
|
1199
|
+
},
|
|
1200
|
+
headers_map={
|
|
1201
|
+
'accept': [
|
|
1202
|
+
'text/plain',
|
|
1203
|
+
'application/json'
|
|
1204
|
+
],
|
|
1205
|
+
'content_type': [],
|
|
1206
|
+
},
|
|
1207
|
+
api_client=api_client
|
|
1208
|
+
)
|
|
1209
|
+
self.get_lookup_endpoint = _Endpoint(
|
|
1210
|
+
settings={
|
|
1211
|
+
'response_type': (Lookup,),
|
|
1212
|
+
'auth': [
|
|
1213
|
+
'APIKeyHeader',
|
|
1214
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1215
|
+
],
|
|
1216
|
+
'endpoint_path': '/api/application/{application}',
|
|
1217
|
+
'operation_id': 'get_lookup',
|
|
1218
|
+
'http_method': 'GET',
|
|
1219
|
+
'servers': None,
|
|
1220
|
+
},
|
|
1221
|
+
params_map={
|
|
1222
|
+
'all': [
|
|
1223
|
+
'application',
|
|
1224
|
+
],
|
|
1225
|
+
'required': [
|
|
1226
|
+
'application',
|
|
1227
|
+
],
|
|
1228
|
+
'nullable': [
|
|
1229
|
+
],
|
|
1230
|
+
'enum': [
|
|
1231
|
+
],
|
|
1232
|
+
'validation': [
|
|
1233
|
+
]
|
|
1234
|
+
},
|
|
1235
|
+
root_map={
|
|
1236
|
+
'validations': {
|
|
1237
|
+
},
|
|
1238
|
+
'allowed_values': {
|
|
1239
|
+
},
|
|
1240
|
+
'openapi_types': {
|
|
1241
|
+
'application':
|
|
1242
|
+
(str,),
|
|
1243
|
+
},
|
|
1244
|
+
'attribute_map': {
|
|
1245
|
+
'application': 'application',
|
|
1246
|
+
},
|
|
1247
|
+
'location_map': {
|
|
1248
|
+
'application': 'path',
|
|
1249
|
+
},
|
|
1250
|
+
'collection_format_map': {
|
|
1251
|
+
}
|
|
1252
|
+
},
|
|
1253
|
+
headers_map={
|
|
1254
|
+
'accept': [
|
|
1255
|
+
'application/json',
|
|
1256
|
+
'text/plain'
|
|
1257
|
+
],
|
|
1258
|
+
'content_type': [],
|
|
1259
|
+
},
|
|
1260
|
+
api_client=api_client
|
|
1261
|
+
)
|
|
1262
|
+
self.instantiate_entity_endpoint = _Endpoint(
|
|
1263
|
+
settings={
|
|
1264
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
1265
|
+
'auth': [
|
|
1266
|
+
'APIKeyHeader',
|
|
1267
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1268
|
+
],
|
|
1269
|
+
'endpoint_path': '/api/entity',
|
|
1270
|
+
'operation_id': 'instantiate_entity',
|
|
1271
|
+
'http_method': 'POST',
|
|
1272
|
+
'servers': None,
|
|
1273
|
+
},
|
|
1274
|
+
params_map={
|
|
1275
|
+
'all': [
|
|
1276
|
+
'entity',
|
|
1277
|
+
],
|
|
1278
|
+
'required': [
|
|
1279
|
+
'entity',
|
|
1280
|
+
],
|
|
1281
|
+
'nullable': [
|
|
1282
|
+
],
|
|
1283
|
+
'enum': [
|
|
1284
|
+
],
|
|
1285
|
+
'validation': [
|
|
1286
|
+
]
|
|
1287
|
+
},
|
|
1288
|
+
root_map={
|
|
1289
|
+
'validations': {
|
|
1290
|
+
},
|
|
1291
|
+
'allowed_values': {
|
|
1292
|
+
},
|
|
1293
|
+
'openapi_types': {
|
|
1294
|
+
'entity':
|
|
1295
|
+
(Entity,),
|
|
1296
|
+
},
|
|
1297
|
+
'attribute_map': {
|
|
1298
|
+
},
|
|
1299
|
+
'location_map': {
|
|
1300
|
+
'entity': 'body',
|
|
1301
|
+
},
|
|
1302
|
+
'collection_format_map': {
|
|
1303
|
+
}
|
|
1304
|
+
},
|
|
1305
|
+
headers_map={
|
|
1306
|
+
'accept': [
|
|
1307
|
+
'application/json',
|
|
1308
|
+
'text/plain'
|
|
1309
|
+
],
|
|
1310
|
+
'content_type': [
|
|
1311
|
+
'application/json'
|
|
1312
|
+
]
|
|
1313
|
+
},
|
|
1314
|
+
api_client=api_client
|
|
1315
|
+
)
|
|
1316
|
+
self.meta_by_id_endpoint = _Endpoint(
|
|
1317
|
+
settings={
|
|
1318
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
1319
|
+
'auth': [
|
|
1320
|
+
'APIKeyHeader',
|
|
1321
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1322
|
+
],
|
|
1323
|
+
'endpoint_path': '/api/meta/{data_source_id}/{document_id}',
|
|
1324
|
+
'operation_id': 'meta_by_id',
|
|
1325
|
+
'http_method': 'GET',
|
|
1326
|
+
'servers': None,
|
|
1327
|
+
},
|
|
1328
|
+
params_map={
|
|
1329
|
+
'all': [
|
|
1330
|
+
'data_source_id',
|
|
1331
|
+
'document_id',
|
|
1332
|
+
],
|
|
1333
|
+
'required': [
|
|
1334
|
+
'data_source_id',
|
|
1335
|
+
'document_id',
|
|
1336
|
+
],
|
|
1337
|
+
'nullable': [
|
|
1338
|
+
],
|
|
1339
|
+
'enum': [
|
|
1340
|
+
],
|
|
1341
|
+
'validation': [
|
|
1342
|
+
]
|
|
1343
|
+
},
|
|
1344
|
+
root_map={
|
|
1345
|
+
'validations': {
|
|
1346
|
+
},
|
|
1347
|
+
'allowed_values': {
|
|
1348
|
+
},
|
|
1349
|
+
'openapi_types': {
|
|
1350
|
+
'data_source_id':
|
|
1351
|
+
(str,),
|
|
1352
|
+
'document_id':
|
|
1353
|
+
(str,),
|
|
1354
|
+
},
|
|
1355
|
+
'attribute_map': {
|
|
1356
|
+
'data_source_id': 'data_source_id',
|
|
1357
|
+
'document_id': 'document_id',
|
|
1358
|
+
},
|
|
1359
|
+
'location_map': {
|
|
1360
|
+
'data_source_id': 'path',
|
|
1361
|
+
'document_id': 'path',
|
|
1362
|
+
},
|
|
1363
|
+
'collection_format_map': {
|
|
1364
|
+
}
|
|
1365
|
+
},
|
|
1366
|
+
headers_map={
|
|
1367
|
+
'accept': [
|
|
1368
|
+
'application/json',
|
|
1369
|
+
'text/plain'
|
|
1370
|
+
],
|
|
1371
|
+
'content_type': [],
|
|
1372
|
+
},
|
|
1373
|
+
api_client=api_client
|
|
1374
|
+
)
|
|
1375
|
+
self.search_endpoint = _Endpoint(
|
|
1376
|
+
settings={
|
|
1377
|
+
'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
1378
|
+
'auth': [
|
|
1379
|
+
'APIKeyHeader',
|
|
1380
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1381
|
+
],
|
|
1382
|
+
'endpoint_path': '/api/search',
|
|
1383
|
+
'operation_id': 'search',
|
|
1384
|
+
'http_method': 'POST',
|
|
1385
|
+
'servers': None,
|
|
1386
|
+
},
|
|
1387
|
+
params_map={
|
|
1388
|
+
'all': [
|
|
1389
|
+
'data_sources',
|
|
1390
|
+
'sort_by_attribute',
|
|
1391
|
+
'body',
|
|
1392
|
+
],
|
|
1393
|
+
'required': [],
|
|
1394
|
+
'nullable': [
|
|
1395
|
+
],
|
|
1396
|
+
'enum': [
|
|
1397
|
+
],
|
|
1398
|
+
'validation': [
|
|
1399
|
+
]
|
|
1400
|
+
},
|
|
1401
|
+
root_map={
|
|
1402
|
+
'validations': {
|
|
1403
|
+
},
|
|
1404
|
+
'allowed_values': {
|
|
1405
|
+
},
|
|
1406
|
+
'openapi_types': {
|
|
1407
|
+
'data_sources':
|
|
1408
|
+
([str],),
|
|
1409
|
+
'sort_by_attribute':
|
|
1410
|
+
(str,),
|
|
1411
|
+
'body':
|
|
1412
|
+
({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),
|
|
1413
|
+
},
|
|
1414
|
+
'attribute_map': {
|
|
1415
|
+
'data_sources': 'data_sources',
|
|
1416
|
+
'sort_by_attribute': 'sort_by_attribute',
|
|
1417
|
+
},
|
|
1418
|
+
'location_map': {
|
|
1419
|
+
'data_sources': 'query',
|
|
1420
|
+
'sort_by_attribute': 'query',
|
|
1421
|
+
'body': 'body',
|
|
1422
|
+
},
|
|
1423
|
+
'collection_format_map': {
|
|
1424
|
+
'data_sources': 'multi',
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1427
|
+
headers_map={
|
|
1428
|
+
'accept': [
|
|
1429
|
+
'application/json',
|
|
1430
|
+
'text/plain'
|
|
1431
|
+
],
|
|
1432
|
+
'content_type': [
|
|
1433
|
+
'application/json'
|
|
1434
|
+
]
|
|
1435
|
+
},
|
|
1436
|
+
api_client=api_client
|
|
1437
|
+
)
|
|
1438
|
+
self.set_acl_endpoint = _Endpoint(
|
|
1439
|
+
settings={
|
|
1440
|
+
'response_type': (str,),
|
|
1441
|
+
'auth': [
|
|
1442
|
+
'APIKeyHeader',
|
|
1443
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1444
|
+
],
|
|
1445
|
+
'endpoint_path': '/api/acl/{data_source_id}/{document_id}',
|
|
1446
|
+
'operation_id': 'set_acl',
|
|
1447
|
+
'http_method': 'PUT',
|
|
1448
|
+
'servers': None,
|
|
1449
|
+
},
|
|
1450
|
+
params_map={
|
|
1451
|
+
'all': [
|
|
1452
|
+
'data_source_id',
|
|
1453
|
+
'document_id',
|
|
1454
|
+
'access_control_list',
|
|
1455
|
+
'recursively',
|
|
1456
|
+
],
|
|
1457
|
+
'required': [
|
|
1458
|
+
'data_source_id',
|
|
1459
|
+
'document_id',
|
|
1460
|
+
'access_control_list',
|
|
1461
|
+
],
|
|
1462
|
+
'nullable': [
|
|
1463
|
+
],
|
|
1464
|
+
'enum': [
|
|
1465
|
+
],
|
|
1466
|
+
'validation': [
|
|
1467
|
+
]
|
|
1468
|
+
},
|
|
1469
|
+
root_map={
|
|
1470
|
+
'validations': {
|
|
1471
|
+
},
|
|
1472
|
+
'allowed_values': {
|
|
1473
|
+
},
|
|
1474
|
+
'openapi_types': {
|
|
1475
|
+
'data_source_id':
|
|
1476
|
+
(str,),
|
|
1477
|
+
'document_id':
|
|
1478
|
+
(str,),
|
|
1479
|
+
'access_control_list':
|
|
1480
|
+
(AccessControlList,),
|
|
1481
|
+
'recursively':
|
|
1482
|
+
(bool,),
|
|
1483
|
+
},
|
|
1484
|
+
'attribute_map': {
|
|
1485
|
+
'data_source_id': 'data_source_id',
|
|
1486
|
+
'document_id': 'document_id',
|
|
1487
|
+
'recursively': 'recursively',
|
|
1488
|
+
},
|
|
1489
|
+
'location_map': {
|
|
1490
|
+
'data_source_id': 'path',
|
|
1491
|
+
'document_id': 'path',
|
|
1492
|
+
'access_control_list': 'body',
|
|
1493
|
+
'recursively': 'query',
|
|
1494
|
+
},
|
|
1495
|
+
'collection_format_map': {
|
|
1496
|
+
}
|
|
1497
|
+
},
|
|
1498
|
+
headers_map={
|
|
1499
|
+
'accept': [
|
|
1500
|
+
'application/json',
|
|
1501
|
+
'text/plain'
|
|
1502
|
+
],
|
|
1503
|
+
'content_type': [
|
|
1504
|
+
'application/json'
|
|
1505
|
+
]
|
|
1506
|
+
},
|
|
1507
|
+
api_client=api_client
|
|
1508
|
+
)
|
|
1509
|
+
self.token_create_endpoint = _Endpoint(
|
|
1510
|
+
settings={
|
|
1511
|
+
'response_type': (str,),
|
|
1512
|
+
'auth': [
|
|
1513
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1514
|
+
],
|
|
1515
|
+
'endpoint_path': '/api/token',
|
|
1516
|
+
'operation_id': 'token_create',
|
|
1517
|
+
'http_method': 'POST',
|
|
1518
|
+
'servers': None,
|
|
1519
|
+
},
|
|
1520
|
+
params_map={
|
|
1521
|
+
'all': [
|
|
1522
|
+
'scope',
|
|
1523
|
+
'time_to_live',
|
|
1524
|
+
],
|
|
1525
|
+
'required': [],
|
|
1526
|
+
'nullable': [
|
|
1527
|
+
],
|
|
1528
|
+
'enum': [
|
|
1529
|
+
],
|
|
1530
|
+
'validation': [
|
|
1531
|
+
]
|
|
1532
|
+
},
|
|
1533
|
+
root_map={
|
|
1534
|
+
'validations': {
|
|
1535
|
+
},
|
|
1536
|
+
'allowed_values': {
|
|
1537
|
+
},
|
|
1538
|
+
'openapi_types': {
|
|
1539
|
+
'scope':
|
|
1540
|
+
(bool, date, datetime, dict, float, int, list, str, none_type,),
|
|
1541
|
+
'time_to_live':
|
|
1542
|
+
(int,),
|
|
1543
|
+
},
|
|
1544
|
+
'attribute_map': {
|
|
1545
|
+
'scope': 'scope',
|
|
1546
|
+
'time_to_live': 'time_to_live',
|
|
1547
|
+
},
|
|
1548
|
+
'location_map': {
|
|
1549
|
+
'scope': 'query',
|
|
1550
|
+
'time_to_live': 'query',
|
|
1551
|
+
},
|
|
1552
|
+
'collection_format_map': {
|
|
1553
|
+
}
|
|
1554
|
+
},
|
|
1555
|
+
headers_map={
|
|
1556
|
+
'accept': [
|
|
1557
|
+
'application/json',
|
|
1558
|
+
'text/plain'
|
|
1559
|
+
],
|
|
1560
|
+
'content_type': [],
|
|
1561
|
+
},
|
|
1562
|
+
api_client=api_client
|
|
1563
|
+
)
|
|
1564
|
+
self.token_delete_endpoint = _Endpoint(
|
|
1565
|
+
settings={
|
|
1566
|
+
'response_type': (str,),
|
|
1567
|
+
'auth': [
|
|
1568
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1569
|
+
],
|
|
1570
|
+
'endpoint_path': '/api/token/{token_id}',
|
|
1571
|
+
'operation_id': 'token_delete',
|
|
1572
|
+
'http_method': 'DELETE',
|
|
1573
|
+
'servers': None,
|
|
1574
|
+
},
|
|
1575
|
+
params_map={
|
|
1576
|
+
'all': [
|
|
1577
|
+
'token_id',
|
|
1578
|
+
],
|
|
1579
|
+
'required': [
|
|
1580
|
+
'token_id',
|
|
1581
|
+
],
|
|
1582
|
+
'nullable': [
|
|
1583
|
+
],
|
|
1584
|
+
'enum': [
|
|
1585
|
+
],
|
|
1586
|
+
'validation': [
|
|
1587
|
+
]
|
|
1588
|
+
},
|
|
1589
|
+
root_map={
|
|
1590
|
+
'validations': {
|
|
1591
|
+
},
|
|
1592
|
+
'allowed_values': {
|
|
1593
|
+
},
|
|
1594
|
+
'openapi_types': {
|
|
1595
|
+
'token_id':
|
|
1596
|
+
(str,),
|
|
1597
|
+
},
|
|
1598
|
+
'attribute_map': {
|
|
1599
|
+
'token_id': 'token_id',
|
|
1600
|
+
},
|
|
1601
|
+
'location_map': {
|
|
1602
|
+
'token_id': 'path',
|
|
1603
|
+
},
|
|
1604
|
+
'collection_format_map': {
|
|
1605
|
+
}
|
|
1606
|
+
},
|
|
1607
|
+
headers_map={
|
|
1608
|
+
'accept': [
|
|
1609
|
+
'application/json',
|
|
1610
|
+
'text/plain'
|
|
1611
|
+
],
|
|
1612
|
+
'content_type': [],
|
|
1613
|
+
},
|
|
1614
|
+
api_client=api_client
|
|
1615
|
+
)
|
|
1616
|
+
self.token_list_all_endpoint = _Endpoint(
|
|
1617
|
+
settings={
|
|
1618
|
+
'response_type': ([PATData],),
|
|
1619
|
+
'auth': [
|
|
1620
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1621
|
+
],
|
|
1622
|
+
'endpoint_path': '/api/token',
|
|
1623
|
+
'operation_id': 'token_list_all',
|
|
1624
|
+
'http_method': 'GET',
|
|
1625
|
+
'servers': None,
|
|
1626
|
+
},
|
|
1627
|
+
params_map={
|
|
1628
|
+
'all': [
|
|
1629
|
+
],
|
|
1630
|
+
'required': [],
|
|
1631
|
+
'nullable': [
|
|
1632
|
+
],
|
|
1633
|
+
'enum': [
|
|
1634
|
+
],
|
|
1635
|
+
'validation': [
|
|
1636
|
+
]
|
|
1637
|
+
},
|
|
1638
|
+
root_map={
|
|
1639
|
+
'validations': {
|
|
1640
|
+
},
|
|
1641
|
+
'allowed_values': {
|
|
1642
|
+
},
|
|
1643
|
+
'openapi_types': {
|
|
1644
|
+
},
|
|
1645
|
+
'attribute_map': {
|
|
1646
|
+
},
|
|
1647
|
+
'location_map': {
|
|
1648
|
+
},
|
|
1649
|
+
'collection_format_map': {
|
|
1650
|
+
}
|
|
1651
|
+
},
|
|
1652
|
+
headers_map={
|
|
1653
|
+
'accept': [
|
|
1654
|
+
'application/json',
|
|
1655
|
+
'text/plain'
|
|
1656
|
+
],
|
|
1657
|
+
'content_type': [],
|
|
1658
|
+
},
|
|
1659
|
+
api_client=api_client
|
|
1660
|
+
)
|
|
1661
|
+
self.validate_entity_endpoint = _Endpoint(
|
|
1662
|
+
settings={
|
|
1663
|
+
'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
|
|
1664
|
+
'auth': [
|
|
1665
|
+
'APIKeyHeader',
|
|
1666
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1667
|
+
],
|
|
1668
|
+
'endpoint_path': '/api/entity/validate',
|
|
1669
|
+
'operation_id': 'validate_entity',
|
|
1670
|
+
'http_method': 'POST',
|
|
1671
|
+
'servers': None,
|
|
1672
|
+
},
|
|
1673
|
+
params_map={
|
|
1674
|
+
'all': [
|
|
1675
|
+
'entity',
|
|
1676
|
+
'as_type',
|
|
1677
|
+
],
|
|
1678
|
+
'required': [
|
|
1679
|
+
'entity',
|
|
1680
|
+
],
|
|
1681
|
+
'nullable': [
|
|
1682
|
+
],
|
|
1683
|
+
'enum': [
|
|
1684
|
+
],
|
|
1685
|
+
'validation': [
|
|
1686
|
+
'as_type',
|
|
1687
|
+
]
|
|
1688
|
+
},
|
|
1689
|
+
root_map={
|
|
1690
|
+
'validations': {
|
|
1691
|
+
('as_type',): {
|
|
1692
|
+
'max_length': 128,
|
|
1693
|
+
'min_length': 3,
|
|
1694
|
+
'regex': {
|
|
1695
|
+
'pattern': r'^[A-Z:a-z0-9_\/-]*$', # noqa: E501
|
|
1696
|
+
},
|
|
1697
|
+
},
|
|
1698
|
+
},
|
|
1699
|
+
'allowed_values': {
|
|
1700
|
+
},
|
|
1701
|
+
'openapi_types': {
|
|
1702
|
+
'entity':
|
|
1703
|
+
(Entity,),
|
|
1704
|
+
'as_type':
|
|
1705
|
+
(str,),
|
|
1706
|
+
},
|
|
1707
|
+
'attribute_map': {
|
|
1708
|
+
'as_type': 'as_type',
|
|
1709
|
+
},
|
|
1710
|
+
'location_map': {
|
|
1711
|
+
'entity': 'body',
|
|
1712
|
+
'as_type': 'query',
|
|
1713
|
+
},
|
|
1714
|
+
'collection_format_map': {
|
|
1715
|
+
}
|
|
1716
|
+
},
|
|
1717
|
+
headers_map={
|
|
1718
|
+
'accept': [
|
|
1719
|
+
'application/json',
|
|
1720
|
+
'text/plain'
|
|
1721
|
+
],
|
|
1722
|
+
'content_type': [
|
|
1723
|
+
'application/json'
|
|
1724
|
+
]
|
|
1725
|
+
},
|
|
1726
|
+
api_client=api_client
|
|
1727
|
+
)
|
|
1728
|
+
self.validate_existing_entity_endpoint = _Endpoint(
|
|
1729
|
+
settings={
|
|
1730
|
+
'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
|
|
1731
|
+
'auth': [
|
|
1732
|
+
'APIKeyHeader',
|
|
1733
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1734
|
+
],
|
|
1735
|
+
'endpoint_path': '/api/entity/validate-existing-entity/{address}',
|
|
1736
|
+
'operation_id': 'validate_existing_entity',
|
|
1737
|
+
'http_method': 'POST',
|
|
1738
|
+
'servers': None,
|
|
1739
|
+
},
|
|
1740
|
+
params_map={
|
|
1741
|
+
'all': [
|
|
1742
|
+
'address',
|
|
1743
|
+
],
|
|
1744
|
+
'required': [
|
|
1745
|
+
'address',
|
|
1746
|
+
],
|
|
1747
|
+
'nullable': [
|
|
1748
|
+
],
|
|
1749
|
+
'enum': [
|
|
1750
|
+
],
|
|
1751
|
+
'validation': [
|
|
1752
|
+
]
|
|
1753
|
+
},
|
|
1754
|
+
root_map={
|
|
1755
|
+
'validations': {
|
|
1756
|
+
},
|
|
1757
|
+
'allowed_values': {
|
|
1758
|
+
},
|
|
1759
|
+
'openapi_types': {
|
|
1760
|
+
'address':
|
|
1761
|
+
(str,),
|
|
1762
|
+
},
|
|
1763
|
+
'attribute_map': {
|
|
1764
|
+
'address': 'address',
|
|
1765
|
+
},
|
|
1766
|
+
'location_map': {
|
|
1767
|
+
'address': 'path',
|
|
1768
|
+
},
|
|
1769
|
+
'collection_format_map': {
|
|
1770
|
+
}
|
|
1771
|
+
},
|
|
1772
|
+
headers_map={
|
|
1773
|
+
'accept': [
|
|
1774
|
+
'application/json',
|
|
1775
|
+
'text/plain'
|
|
1776
|
+
],
|
|
1777
|
+
'content_type': [],
|
|
1778
|
+
},
|
|
1779
|
+
api_client=api_client
|
|
1780
|
+
)
|
|
1781
|
+
self.whoami_endpoint = _Endpoint(
|
|
1782
|
+
settings={
|
|
1783
|
+
'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
|
|
1784
|
+
'auth': [
|
|
1785
|
+
'APIKeyHeader',
|
|
1786
|
+
'OAuth2AuthorizationCodeBearer'
|
|
1787
|
+
],
|
|
1788
|
+
'endpoint_path': '/api/whoami',
|
|
1789
|
+
'operation_id': 'whoami',
|
|
1790
|
+
'http_method': 'GET',
|
|
1791
|
+
'servers': None,
|
|
1792
|
+
},
|
|
1793
|
+
params_map={
|
|
1794
|
+
'all': [
|
|
1795
|
+
],
|
|
1796
|
+
'required': [],
|
|
1797
|
+
'nullable': [
|
|
1798
|
+
],
|
|
1799
|
+
'enum': [
|
|
1800
|
+
],
|
|
1801
|
+
'validation': [
|
|
1802
|
+
]
|
|
1803
|
+
},
|
|
1804
|
+
root_map={
|
|
1805
|
+
'validations': {
|
|
1806
|
+
},
|
|
1807
|
+
'allowed_values': {
|
|
1808
|
+
},
|
|
1809
|
+
'openapi_types': {
|
|
1810
|
+
},
|
|
1811
|
+
'attribute_map': {
|
|
1812
|
+
},
|
|
1813
|
+
'location_map': {
|
|
1814
|
+
},
|
|
1815
|
+
'collection_format_map': {
|
|
1816
|
+
}
|
|
1817
|
+
},
|
|
1818
|
+
headers_map={
|
|
1819
|
+
'accept': [
|
|
1820
|
+
'application/json',
|
|
1821
|
+
'text/plain'
|
|
1822
|
+
],
|
|
1823
|
+
'content_type': [],
|
|
1824
|
+
},
|
|
1825
|
+
api_client=api_client
|
|
1826
|
+
)
|
|
1827
|
+
|
|
1828
|
+
def attribute_get(
|
|
1829
|
+
self,
|
|
1830
|
+
address,
|
|
1831
|
+
**kwargs
|
|
1832
|
+
):
|
|
1833
|
+
"""Get Attribute # noqa: E501
|
|
1834
|
+
|
|
1835
|
+
Fetch the BlueprintAttribute which is the container for the addressed object. This endpoint is used for fetching a BlueprintAttribute in which the addressed entity is contained. Args: - address (str): The address to the entity. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: The blueprint-attribute object. # noqa: E501
|
|
1836
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1837
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1838
|
+
|
|
1839
|
+
>>> thread = api.attribute_get(address, async_req=True)
|
|
1840
|
+
>>> result = thread.get()
|
|
1841
|
+
|
|
1842
|
+
Args:
|
|
1843
|
+
address (str):
|
|
1844
|
+
|
|
1845
|
+
Keyword Args:
|
|
1846
|
+
_return_http_data_only (bool): response data without head status
|
|
1847
|
+
code and headers. Default is True.
|
|
1848
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
1849
|
+
will be returned without reading/decoding response data.
|
|
1850
|
+
Default is True.
|
|
1851
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
1852
|
+
one number provided, it will be total request timeout. It can also
|
|
1853
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
1854
|
+
Default is None.
|
|
1855
|
+
_check_input_type (bool): specifies if type checking
|
|
1856
|
+
should be done one the data sent to the server.
|
|
1857
|
+
Default is True.
|
|
1858
|
+
_check_return_type (bool): specifies if type checking
|
|
1859
|
+
should be done one the data received from the server.
|
|
1860
|
+
Default is True.
|
|
1861
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
1862
|
+
are serialized names, as specified in the OpenAPI document.
|
|
1863
|
+
False if the variable names in the input data
|
|
1864
|
+
are pythonic names, e.g. snake case (default)
|
|
1865
|
+
_content_type (str/None): force body content-type.
|
|
1866
|
+
Default is None and content-type will be predicted by allowed
|
|
1867
|
+
content-types and body.
|
|
1868
|
+
_host_index (int/None): specifies the index of the server
|
|
1869
|
+
that we want to use.
|
|
1870
|
+
Default is read from the configuration.
|
|
1871
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
1872
|
+
request; this effectively ignores the authentication
|
|
1873
|
+
in the spec for a single request.
|
|
1874
|
+
Default is None
|
|
1875
|
+
async_req (bool): execute request asynchronously
|
|
1876
|
+
|
|
1877
|
+
Returns:
|
|
1878
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
1879
|
+
If the method is called asynchronously, returns the request
|
|
1880
|
+
thread.
|
|
1881
|
+
"""
|
|
1882
|
+
kwargs['async_req'] = kwargs.get(
|
|
1883
|
+
'async_req', False
|
|
1884
|
+
)
|
|
1885
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
1886
|
+
'_return_http_data_only', True
|
|
1887
|
+
)
|
|
1888
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
1889
|
+
'_preload_content', True
|
|
1890
|
+
)
|
|
1891
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
1892
|
+
'_request_timeout', None
|
|
1893
|
+
)
|
|
1894
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
1895
|
+
'_check_input_type', True
|
|
1896
|
+
)
|
|
1897
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
1898
|
+
'_check_return_type', True
|
|
1899
|
+
)
|
|
1900
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
1901
|
+
'_spec_property_naming', False
|
|
1902
|
+
)
|
|
1903
|
+
kwargs['_content_type'] = kwargs.get(
|
|
1904
|
+
'_content_type')
|
|
1905
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
1906
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
1907
|
+
kwargs['address'] = \
|
|
1908
|
+
address
|
|
1909
|
+
return self.attribute_get_endpoint.call_with_http_info(**kwargs)
|
|
1910
|
+
|
|
1911
|
+
def blob_get_by_id(
|
|
1912
|
+
self,
|
|
1913
|
+
data_source_id,
|
|
1914
|
+
blob_id,
|
|
1915
|
+
**kwargs
|
|
1916
|
+
):
|
|
1917
|
+
"""Get By Id # noqa: E501
|
|
1918
|
+
|
|
1919
|
+
Get blob from id. A blob file is a binary object, which can be any kind of data object. Args: - data_source_id (str): The ID of the data source in which to find the blob. - blob_id (str): The ID of the requested blob. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - Filestream: The requested blob. # noqa: E501
|
|
1920
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1921
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1922
|
+
|
|
1923
|
+
>>> thread = api.blob_get_by_id(data_source_id, blob_id, async_req=True)
|
|
1924
|
+
>>> result = thread.get()
|
|
1925
|
+
|
|
1926
|
+
Args:
|
|
1927
|
+
data_source_id (str):
|
|
1928
|
+
blob_id (str):
|
|
1929
|
+
|
|
1930
|
+
Keyword Args:
|
|
1931
|
+
_return_http_data_only (bool): response data without head status
|
|
1932
|
+
code and headers. Default is True.
|
|
1933
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
1934
|
+
will be returned without reading/decoding response data.
|
|
1935
|
+
Default is True.
|
|
1936
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
1937
|
+
one number provided, it will be total request timeout. It can also
|
|
1938
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
1939
|
+
Default is None.
|
|
1940
|
+
_check_input_type (bool): specifies if type checking
|
|
1941
|
+
should be done one the data sent to the server.
|
|
1942
|
+
Default is True.
|
|
1943
|
+
_check_return_type (bool): specifies if type checking
|
|
1944
|
+
should be done one the data received from the server.
|
|
1945
|
+
Default is True.
|
|
1946
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
1947
|
+
are serialized names, as specified in the OpenAPI document.
|
|
1948
|
+
False if the variable names in the input data
|
|
1949
|
+
are pythonic names, e.g. snake case (default)
|
|
1950
|
+
_content_type (str/None): force body content-type.
|
|
1951
|
+
Default is None and content-type will be predicted by allowed
|
|
1952
|
+
content-types and body.
|
|
1953
|
+
_host_index (int/None): specifies the index of the server
|
|
1954
|
+
that we want to use.
|
|
1955
|
+
Default is read from the configuration.
|
|
1956
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
1957
|
+
request; this effectively ignores the authentication
|
|
1958
|
+
in the spec for a single request.
|
|
1959
|
+
Default is None
|
|
1960
|
+
async_req (bool): execute request asynchronously
|
|
1961
|
+
|
|
1962
|
+
Returns:
|
|
1963
|
+
file_type
|
|
1964
|
+
If the method is called asynchronously, returns the request
|
|
1965
|
+
thread.
|
|
1966
|
+
"""
|
|
1967
|
+
kwargs['async_req'] = kwargs.get(
|
|
1968
|
+
'async_req', False
|
|
1969
|
+
)
|
|
1970
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
1971
|
+
'_return_http_data_only', True
|
|
1972
|
+
)
|
|
1973
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
1974
|
+
'_preload_content', True
|
|
1975
|
+
)
|
|
1976
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
1977
|
+
'_request_timeout', None
|
|
1978
|
+
)
|
|
1979
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
1980
|
+
'_check_input_type', True
|
|
1981
|
+
)
|
|
1982
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
1983
|
+
'_check_return_type', True
|
|
1984
|
+
)
|
|
1985
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
1986
|
+
'_spec_property_naming', False
|
|
1987
|
+
)
|
|
1988
|
+
kwargs['_content_type'] = kwargs.get(
|
|
1989
|
+
'_content_type')
|
|
1990
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
1991
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
1992
|
+
kwargs['data_source_id'] = \
|
|
1993
|
+
data_source_id
|
|
1994
|
+
kwargs['blob_id'] = \
|
|
1995
|
+
blob_id
|
|
1996
|
+
return self.blob_get_by_id_endpoint.call_with_http_info(**kwargs)
|
|
1997
|
+
|
|
1998
|
+
def blob_upload(
|
|
1999
|
+
self,
|
|
2000
|
+
data_source_id,
|
|
2001
|
+
blob_id,
|
|
2002
|
+
file,
|
|
2003
|
+
**kwargs
|
|
2004
|
+
):
|
|
2005
|
+
"""Upload # noqa: E501
|
|
2006
|
+
|
|
2007
|
+
Upload a new blob or modify an existings blob. A blob (binary large object) can be anything from video to text file. If you give an ID to a blob that already exists, the old blob will be updated in place. Args: - data_source_id (str): The ID of the data source in which to store the blob. - blob_id (str): The ID that the blob should be stored under. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - str: OK (200) # noqa: E501
|
|
2008
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2009
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2010
|
+
|
|
2011
|
+
>>> thread = api.blob_upload(data_source_id, blob_id, file, async_req=True)
|
|
2012
|
+
>>> result = thread.get()
|
|
2013
|
+
|
|
2014
|
+
Args:
|
|
2015
|
+
data_source_id (str):
|
|
2016
|
+
blob_id (str):
|
|
2017
|
+
file (file_type):
|
|
2018
|
+
|
|
2019
|
+
Keyword Args:
|
|
2020
|
+
_return_http_data_only (bool): response data without head status
|
|
2021
|
+
code and headers. Default is True.
|
|
2022
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2023
|
+
will be returned without reading/decoding response data.
|
|
2024
|
+
Default is True.
|
|
2025
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2026
|
+
one number provided, it will be total request timeout. It can also
|
|
2027
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2028
|
+
Default is None.
|
|
2029
|
+
_check_input_type (bool): specifies if type checking
|
|
2030
|
+
should be done one the data sent to the server.
|
|
2031
|
+
Default is True.
|
|
2032
|
+
_check_return_type (bool): specifies if type checking
|
|
2033
|
+
should be done one the data received from the server.
|
|
2034
|
+
Default is True.
|
|
2035
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2036
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2037
|
+
False if the variable names in the input data
|
|
2038
|
+
are pythonic names, e.g. snake case (default)
|
|
2039
|
+
_content_type (str/None): force body content-type.
|
|
2040
|
+
Default is None and content-type will be predicted by allowed
|
|
2041
|
+
content-types and body.
|
|
2042
|
+
_host_index (int/None): specifies the index of the server
|
|
2043
|
+
that we want to use.
|
|
2044
|
+
Default is read from the configuration.
|
|
2045
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2046
|
+
request; this effectively ignores the authentication
|
|
2047
|
+
in the spec for a single request.
|
|
2048
|
+
Default is None
|
|
2049
|
+
async_req (bool): execute request asynchronously
|
|
2050
|
+
|
|
2051
|
+
Returns:
|
|
2052
|
+
str
|
|
2053
|
+
If the method is called asynchronously, returns the request
|
|
2054
|
+
thread.
|
|
2055
|
+
"""
|
|
2056
|
+
kwargs['async_req'] = kwargs.get(
|
|
2057
|
+
'async_req', False
|
|
2058
|
+
)
|
|
2059
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2060
|
+
'_return_http_data_only', True
|
|
2061
|
+
)
|
|
2062
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2063
|
+
'_preload_content', True
|
|
2064
|
+
)
|
|
2065
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2066
|
+
'_request_timeout', None
|
|
2067
|
+
)
|
|
2068
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2069
|
+
'_check_input_type', True
|
|
2070
|
+
)
|
|
2071
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2072
|
+
'_check_return_type', True
|
|
2073
|
+
)
|
|
2074
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2075
|
+
'_spec_property_naming', False
|
|
2076
|
+
)
|
|
2077
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2078
|
+
'_content_type')
|
|
2079
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2080
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2081
|
+
kwargs['data_source_id'] = \
|
|
2082
|
+
data_source_id
|
|
2083
|
+
kwargs['blob_id'] = \
|
|
2084
|
+
blob_id
|
|
2085
|
+
kwargs['file'] = \
|
|
2086
|
+
file
|
|
2087
|
+
return self.blob_upload_endpoint.call_with_http_info(**kwargs)
|
|
2088
|
+
|
|
2089
|
+
def blueprint_get(
|
|
2090
|
+
self,
|
|
2091
|
+
type_ref,
|
|
2092
|
+
**kwargs
|
|
2093
|
+
):
|
|
2094
|
+
"""Get Blueprint # noqa: E501
|
|
2095
|
+
|
|
2096
|
+
Get a Blueprint and all Ui- and StorageRecipes connected to it, given a Blueprint address. Args: - type_ref (str): The address of the blueprint. - Example: PROTOCOL://<DATA-SOURCE>/<PACKAGE>/<FOLDER>/<NAME> - context (str): Optional name of application that has Ui-/StorageRecipe lookup table. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - GetBlueprintResponse: An object containing the blueprint, a list of all UI- recipes and a list of all StorageRecipes. # noqa: E501
|
|
2097
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2098
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2099
|
+
|
|
2100
|
+
>>> thread = api.blueprint_get(type_ref, async_req=True)
|
|
2101
|
+
>>> result = thread.get()
|
|
2102
|
+
|
|
2103
|
+
Args:
|
|
2104
|
+
type_ref (str):
|
|
2105
|
+
|
|
2106
|
+
Keyword Args:
|
|
2107
|
+
context (str): [optional]
|
|
2108
|
+
_return_http_data_only (bool): response data without head status
|
|
2109
|
+
code and headers. Default is True.
|
|
2110
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2111
|
+
will be returned without reading/decoding response data.
|
|
2112
|
+
Default is True.
|
|
2113
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2114
|
+
one number provided, it will be total request timeout. It can also
|
|
2115
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2116
|
+
Default is None.
|
|
2117
|
+
_check_input_type (bool): specifies if type checking
|
|
2118
|
+
should be done one the data sent to the server.
|
|
2119
|
+
Default is True.
|
|
2120
|
+
_check_return_type (bool): specifies if type checking
|
|
2121
|
+
should be done one the data received from the server.
|
|
2122
|
+
Default is True.
|
|
2123
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2124
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2125
|
+
False if the variable names in the input data
|
|
2126
|
+
are pythonic names, e.g. snake case (default)
|
|
2127
|
+
_content_type (str/None): force body content-type.
|
|
2128
|
+
Default is None and content-type will be predicted by allowed
|
|
2129
|
+
content-types and body.
|
|
2130
|
+
_host_index (int/None): specifies the index of the server
|
|
2131
|
+
that we want to use.
|
|
2132
|
+
Default is read from the configuration.
|
|
2133
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2134
|
+
request; this effectively ignores the authentication
|
|
2135
|
+
in the spec for a single request.
|
|
2136
|
+
Default is None
|
|
2137
|
+
async_req (bool): execute request asynchronously
|
|
2138
|
+
|
|
2139
|
+
Returns:
|
|
2140
|
+
GetBlueprintResponse
|
|
2141
|
+
If the method is called asynchronously, returns the request
|
|
2142
|
+
thread.
|
|
2143
|
+
"""
|
|
2144
|
+
kwargs['async_req'] = kwargs.get(
|
|
2145
|
+
'async_req', False
|
|
2146
|
+
)
|
|
2147
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2148
|
+
'_return_http_data_only', True
|
|
2149
|
+
)
|
|
2150
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2151
|
+
'_preload_content', True
|
|
2152
|
+
)
|
|
2153
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2154
|
+
'_request_timeout', None
|
|
2155
|
+
)
|
|
2156
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2157
|
+
'_check_input_type', True
|
|
2158
|
+
)
|
|
2159
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2160
|
+
'_check_return_type', True
|
|
2161
|
+
)
|
|
2162
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2163
|
+
'_spec_property_naming', False
|
|
2164
|
+
)
|
|
2165
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2166
|
+
'_content_type')
|
|
2167
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2168
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2169
|
+
kwargs['type_ref'] = \
|
|
2170
|
+
type_ref
|
|
2171
|
+
return self.blueprint_get_endpoint.call_with_http_info(**kwargs)
|
|
2172
|
+
|
|
2173
|
+
def blueprint_resolve(
|
|
2174
|
+
self,
|
|
2175
|
+
address,
|
|
2176
|
+
**kwargs
|
|
2177
|
+
):
|
|
2178
|
+
"""Resolve Blueprint Id # noqa: E501
|
|
2179
|
+
|
|
2180
|
+
Resolve path address of a blueprint given id address. This endpoint takes in an ID-address of a blueprint and finds the full path address to the blueprint. Args: - address (str): The ID address of the blueprint. - Example: PROTOCOL://<DATA-SOURCE>/$<UUID> Returns: - str: the path address of the blueprint. - Example: PROTOCOL://<DATA-SOURCE>/<PACKAGE>/<FOLDER>/<NAME> # noqa: E501
|
|
2181
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2182
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2183
|
+
|
|
2184
|
+
>>> thread = api.blueprint_resolve(address, async_req=True)
|
|
2185
|
+
>>> result = thread.get()
|
|
2186
|
+
|
|
2187
|
+
Args:
|
|
2188
|
+
address (str):
|
|
2189
|
+
|
|
2190
|
+
Keyword Args:
|
|
2191
|
+
_return_http_data_only (bool): response data without head status
|
|
2192
|
+
code and headers. Default is True.
|
|
2193
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2194
|
+
will be returned without reading/decoding response data.
|
|
2195
|
+
Default is True.
|
|
2196
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2197
|
+
one number provided, it will be total request timeout. It can also
|
|
2198
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2199
|
+
Default is None.
|
|
2200
|
+
_check_input_type (bool): specifies if type checking
|
|
2201
|
+
should be done one the data sent to the server.
|
|
2202
|
+
Default is True.
|
|
2203
|
+
_check_return_type (bool): specifies if type checking
|
|
2204
|
+
should be done one the data received from the server.
|
|
2205
|
+
Default is True.
|
|
2206
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2207
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2208
|
+
False if the variable names in the input data
|
|
2209
|
+
are pythonic names, e.g. snake case (default)
|
|
2210
|
+
_content_type (str/None): force body content-type.
|
|
2211
|
+
Default is None and content-type will be predicted by allowed
|
|
2212
|
+
content-types and body.
|
|
2213
|
+
_host_index (int/None): specifies the index of the server
|
|
2214
|
+
that we want to use.
|
|
2215
|
+
Default is read from the configuration.
|
|
2216
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2217
|
+
request; this effectively ignores the authentication
|
|
2218
|
+
in the spec for a single request.
|
|
2219
|
+
Default is None
|
|
2220
|
+
async_req (bool): execute request asynchronously
|
|
2221
|
+
|
|
2222
|
+
Returns:
|
|
2223
|
+
str
|
|
2224
|
+
If the method is called asynchronously, returns the request
|
|
2225
|
+
thread.
|
|
2226
|
+
"""
|
|
2227
|
+
kwargs['async_req'] = kwargs.get(
|
|
2228
|
+
'async_req', False
|
|
2229
|
+
)
|
|
2230
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2231
|
+
'_return_http_data_only', True
|
|
2232
|
+
)
|
|
2233
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2234
|
+
'_preload_content', True
|
|
2235
|
+
)
|
|
2236
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2237
|
+
'_request_timeout', None
|
|
2238
|
+
)
|
|
2239
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2240
|
+
'_check_input_type', True
|
|
2241
|
+
)
|
|
2242
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2243
|
+
'_check_return_type', True
|
|
2244
|
+
)
|
|
2245
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2246
|
+
'_spec_property_naming', False
|
|
2247
|
+
)
|
|
2248
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2249
|
+
'_content_type')
|
|
2250
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2251
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2252
|
+
kwargs['address'] = \
|
|
2253
|
+
address
|
|
2254
|
+
return self.blueprint_resolve_endpoint.call_with_http_info(**kwargs)
|
|
2255
|
+
|
|
2256
|
+
def create_lookup(
|
|
2257
|
+
self,
|
|
2258
|
+
application,
|
|
2259
|
+
recipe_package,
|
|
2260
|
+
**kwargs
|
|
2261
|
+
):
|
|
2262
|
+
"""Create Lookup # noqa: E501
|
|
2263
|
+
|
|
2264
|
+
Creates a Recipe Lookup Table for an Application, given a Package Containing RecipeLinks. This endpoint creates a lookup table for an application. This lookup table is used to find UI- and Storage recipes given a blueprint. This recipe is associated with an application, based on application name. Args: - application (str): Name of an application. - recipe_package (list[str]): A list of one or more paths to packages that contain recipe links. - Example: [\"system/SIMOS/recipe_links\"] - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - None, with status Code 204 (No Content). # noqa: E501
|
|
2265
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2266
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2267
|
+
|
|
2268
|
+
>>> thread = api.create_lookup(application, recipe_package, async_req=True)
|
|
2269
|
+
>>> result = thread.get()
|
|
2270
|
+
|
|
2271
|
+
Args:
|
|
2272
|
+
application (str):
|
|
2273
|
+
recipe_package ([str]):
|
|
2274
|
+
|
|
2275
|
+
Keyword Args:
|
|
2276
|
+
_return_http_data_only (bool): response data without head status
|
|
2277
|
+
code and headers. Default is True.
|
|
2278
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2279
|
+
will be returned without reading/decoding response data.
|
|
2280
|
+
Default is True.
|
|
2281
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2282
|
+
one number provided, it will be total request timeout. It can also
|
|
2283
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2284
|
+
Default is None.
|
|
2285
|
+
_check_input_type (bool): specifies if type checking
|
|
2286
|
+
should be done one the data sent to the server.
|
|
2287
|
+
Default is True.
|
|
2288
|
+
_check_return_type (bool): specifies if type checking
|
|
2289
|
+
should be done one the data received from the server.
|
|
2290
|
+
Default is True.
|
|
2291
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2292
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2293
|
+
False if the variable names in the input data
|
|
2294
|
+
are pythonic names, e.g. snake case (default)
|
|
2295
|
+
_content_type (str/None): force body content-type.
|
|
2296
|
+
Default is None and content-type will be predicted by allowed
|
|
2297
|
+
content-types and body.
|
|
2298
|
+
_host_index (int/None): specifies the index of the server
|
|
2299
|
+
that we want to use.
|
|
2300
|
+
Default is read from the configuration.
|
|
2301
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2302
|
+
request; this effectively ignores the authentication
|
|
2303
|
+
in the spec for a single request.
|
|
2304
|
+
Default is None
|
|
2305
|
+
async_req (bool): execute request asynchronously
|
|
2306
|
+
|
|
2307
|
+
Returns:
|
|
2308
|
+
None
|
|
2309
|
+
If the method is called asynchronously, returns the request
|
|
2310
|
+
thread.
|
|
2311
|
+
"""
|
|
2312
|
+
kwargs['async_req'] = kwargs.get(
|
|
2313
|
+
'async_req', False
|
|
2314
|
+
)
|
|
2315
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2316
|
+
'_return_http_data_only', True
|
|
2317
|
+
)
|
|
2318
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2319
|
+
'_preload_content', True
|
|
2320
|
+
)
|
|
2321
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2322
|
+
'_request_timeout', None
|
|
2323
|
+
)
|
|
2324
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2325
|
+
'_check_input_type', True
|
|
2326
|
+
)
|
|
2327
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2328
|
+
'_check_return_type', True
|
|
2329
|
+
)
|
|
2330
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2331
|
+
'_spec_property_naming', False
|
|
2332
|
+
)
|
|
2333
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2334
|
+
'_content_type')
|
|
2335
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2336
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2337
|
+
kwargs['application'] = \
|
|
2338
|
+
application
|
|
2339
|
+
kwargs['recipe_package'] = \
|
|
2340
|
+
recipe_package
|
|
2341
|
+
return self.create_lookup_endpoint.call_with_http_info(**kwargs)
|
|
2342
|
+
|
|
2343
|
+
def data_source_get(
|
|
2344
|
+
self,
|
|
2345
|
+
data_source_id,
|
|
2346
|
+
**kwargs
|
|
2347
|
+
):
|
|
2348
|
+
"""Get # noqa: E501
|
|
2349
|
+
|
|
2350
|
+
Get configuration of a single data source. Args: - data_source_id (str): ID of the data source - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: A dictionary containing configuration for the specified data source. # noqa: E501
|
|
2351
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2352
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2353
|
+
|
|
2354
|
+
>>> thread = api.data_source_get(data_source_id, async_req=True)
|
|
2355
|
+
>>> result = thread.get()
|
|
2356
|
+
|
|
2357
|
+
Args:
|
|
2358
|
+
data_source_id (str):
|
|
2359
|
+
|
|
2360
|
+
Keyword Args:
|
|
2361
|
+
_return_http_data_only (bool): response data without head status
|
|
2362
|
+
code and headers. Default is True.
|
|
2363
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2364
|
+
will be returned without reading/decoding response data.
|
|
2365
|
+
Default is True.
|
|
2366
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2367
|
+
one number provided, it will be total request timeout. It can also
|
|
2368
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2369
|
+
Default is None.
|
|
2370
|
+
_check_input_type (bool): specifies if type checking
|
|
2371
|
+
should be done one the data sent to the server.
|
|
2372
|
+
Default is True.
|
|
2373
|
+
_check_return_type (bool): specifies if type checking
|
|
2374
|
+
should be done one the data received from the server.
|
|
2375
|
+
Default is True.
|
|
2376
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2377
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2378
|
+
False if the variable names in the input data
|
|
2379
|
+
are pythonic names, e.g. snake case (default)
|
|
2380
|
+
_content_type (str/None): force body content-type.
|
|
2381
|
+
Default is None and content-type will be predicted by allowed
|
|
2382
|
+
content-types and body.
|
|
2383
|
+
_host_index (int/None): specifies the index of the server
|
|
2384
|
+
that we want to use.
|
|
2385
|
+
Default is read from the configuration.
|
|
2386
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2387
|
+
request; this effectively ignores the authentication
|
|
2388
|
+
in the spec for a single request.
|
|
2389
|
+
Default is None
|
|
2390
|
+
async_req (bool): execute request asynchronously
|
|
2391
|
+
|
|
2392
|
+
Returns:
|
|
2393
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
2394
|
+
If the method is called asynchronously, returns the request
|
|
2395
|
+
thread.
|
|
2396
|
+
"""
|
|
2397
|
+
kwargs['async_req'] = kwargs.get(
|
|
2398
|
+
'async_req', False
|
|
2399
|
+
)
|
|
2400
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2401
|
+
'_return_http_data_only', True
|
|
2402
|
+
)
|
|
2403
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2404
|
+
'_preload_content', True
|
|
2405
|
+
)
|
|
2406
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2407
|
+
'_request_timeout', None
|
|
2408
|
+
)
|
|
2409
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2410
|
+
'_check_input_type', True
|
|
2411
|
+
)
|
|
2412
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2413
|
+
'_check_return_type', True
|
|
2414
|
+
)
|
|
2415
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2416
|
+
'_spec_property_naming', False
|
|
2417
|
+
)
|
|
2418
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2419
|
+
'_content_type')
|
|
2420
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2421
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2422
|
+
kwargs['data_source_id'] = \
|
|
2423
|
+
data_source_id
|
|
2424
|
+
return self.data_source_get_endpoint.call_with_http_info(**kwargs)
|
|
2425
|
+
|
|
2426
|
+
def data_source_get_all(
|
|
2427
|
+
self,
|
|
2428
|
+
**kwargs
|
|
2429
|
+
):
|
|
2430
|
+
"""Get All # noqa: E501
|
|
2431
|
+
|
|
2432
|
+
Get list of all data sources found in DMSS. Args: - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - list (DataSourceInformation): A list of information about each data source found in the DMSS protocol. # noqa: E501
|
|
2433
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2434
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2435
|
+
|
|
2436
|
+
>>> thread = api.data_source_get_all(async_req=True)
|
|
2437
|
+
>>> result = thread.get()
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
Keyword Args:
|
|
2441
|
+
_return_http_data_only (bool): response data without head status
|
|
2442
|
+
code and headers. Default is True.
|
|
2443
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2444
|
+
will be returned without reading/decoding response data.
|
|
2445
|
+
Default is True.
|
|
2446
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2447
|
+
one number provided, it will be total request timeout. It can also
|
|
2448
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2449
|
+
Default is None.
|
|
2450
|
+
_check_input_type (bool): specifies if type checking
|
|
2451
|
+
should be done one the data sent to the server.
|
|
2452
|
+
Default is True.
|
|
2453
|
+
_check_return_type (bool): specifies if type checking
|
|
2454
|
+
should be done one the data received from the server.
|
|
2455
|
+
Default is True.
|
|
2456
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2457
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2458
|
+
False if the variable names in the input data
|
|
2459
|
+
are pythonic names, e.g. snake case (default)
|
|
2460
|
+
_content_type (str/None): force body content-type.
|
|
2461
|
+
Default is None and content-type will be predicted by allowed
|
|
2462
|
+
content-types and body.
|
|
2463
|
+
_host_index (int/None): specifies the index of the server
|
|
2464
|
+
that we want to use.
|
|
2465
|
+
Default is read from the configuration.
|
|
2466
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2467
|
+
request; this effectively ignores the authentication
|
|
2468
|
+
in the spec for a single request.
|
|
2469
|
+
Default is None
|
|
2470
|
+
async_req (bool): execute request asynchronously
|
|
2471
|
+
|
|
2472
|
+
Returns:
|
|
2473
|
+
[DataSourceInformation]
|
|
2474
|
+
If the method is called asynchronously, returns the request
|
|
2475
|
+
thread.
|
|
2476
|
+
"""
|
|
2477
|
+
kwargs['async_req'] = kwargs.get(
|
|
2478
|
+
'async_req', False
|
|
2479
|
+
)
|
|
2480
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2481
|
+
'_return_http_data_only', True
|
|
2482
|
+
)
|
|
2483
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2484
|
+
'_preload_content', True
|
|
2485
|
+
)
|
|
2486
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2487
|
+
'_request_timeout', None
|
|
2488
|
+
)
|
|
2489
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2490
|
+
'_check_input_type', True
|
|
2491
|
+
)
|
|
2492
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2493
|
+
'_check_return_type', True
|
|
2494
|
+
)
|
|
2495
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2496
|
+
'_spec_property_naming', False
|
|
2497
|
+
)
|
|
2498
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2499
|
+
'_content_type')
|
|
2500
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2501
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2502
|
+
return self.data_source_get_all_endpoint.call_with_http_info(**kwargs)
|
|
2503
|
+
|
|
2504
|
+
def data_source_save(
|
|
2505
|
+
self,
|
|
2506
|
+
data_source_id,
|
|
2507
|
+
data_source_request,
|
|
2508
|
+
**kwargs
|
|
2509
|
+
):
|
|
2510
|
+
"""Save # noqa: E501
|
|
2511
|
+
|
|
2512
|
+
Create or update a data source configuration. This endpoint is used for creating or updating a data source configuration. A data source can have multiple repositories. Args: - data_source_id (str): ID of the data source - new_data_source (DataSourceRequest): A dict object with keys \"name\" and \"repositories\" which is another dict of str and repository configuration. This is the config of the data source. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - str: The ID of the newly created or updated data source. # noqa: E501
|
|
2513
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2514
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2515
|
+
|
|
2516
|
+
>>> thread = api.data_source_save(data_source_id, data_source_request, async_req=True)
|
|
2517
|
+
>>> result = thread.get()
|
|
2518
|
+
|
|
2519
|
+
Args:
|
|
2520
|
+
data_source_id (str):
|
|
2521
|
+
data_source_request (DataSourceRequest):
|
|
2522
|
+
|
|
2523
|
+
Keyword Args:
|
|
2524
|
+
_return_http_data_only (bool): response data without head status
|
|
2525
|
+
code and headers. Default is True.
|
|
2526
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2527
|
+
will be returned without reading/decoding response data.
|
|
2528
|
+
Default is True.
|
|
2529
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2530
|
+
one number provided, it will be total request timeout. It can also
|
|
2531
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2532
|
+
Default is None.
|
|
2533
|
+
_check_input_type (bool): specifies if type checking
|
|
2534
|
+
should be done one the data sent to the server.
|
|
2535
|
+
Default is True.
|
|
2536
|
+
_check_return_type (bool): specifies if type checking
|
|
2537
|
+
should be done one the data received from the server.
|
|
2538
|
+
Default is True.
|
|
2539
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2540
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2541
|
+
False if the variable names in the input data
|
|
2542
|
+
are pythonic names, e.g. snake case (default)
|
|
2543
|
+
_content_type (str/None): force body content-type.
|
|
2544
|
+
Default is None and content-type will be predicted by allowed
|
|
2545
|
+
content-types and body.
|
|
2546
|
+
_host_index (int/None): specifies the index of the server
|
|
2547
|
+
that we want to use.
|
|
2548
|
+
Default is read from the configuration.
|
|
2549
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2550
|
+
request; this effectively ignores the authentication
|
|
2551
|
+
in the spec for a single request.
|
|
2552
|
+
Default is None
|
|
2553
|
+
async_req (bool): execute request asynchronously
|
|
2554
|
+
|
|
2555
|
+
Returns:
|
|
2556
|
+
str
|
|
2557
|
+
If the method is called asynchronously, returns the request
|
|
2558
|
+
thread.
|
|
2559
|
+
"""
|
|
2560
|
+
kwargs['async_req'] = kwargs.get(
|
|
2561
|
+
'async_req', False
|
|
2562
|
+
)
|
|
2563
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2564
|
+
'_return_http_data_only', True
|
|
2565
|
+
)
|
|
2566
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2567
|
+
'_preload_content', True
|
|
2568
|
+
)
|
|
2569
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2570
|
+
'_request_timeout', None
|
|
2571
|
+
)
|
|
2572
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2573
|
+
'_check_input_type', True
|
|
2574
|
+
)
|
|
2575
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2576
|
+
'_check_return_type', True
|
|
2577
|
+
)
|
|
2578
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2579
|
+
'_spec_property_naming', False
|
|
2580
|
+
)
|
|
2581
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2582
|
+
'_content_type')
|
|
2583
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2584
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2585
|
+
kwargs['data_source_id'] = \
|
|
2586
|
+
data_source_id
|
|
2587
|
+
kwargs['data_source_request'] = \
|
|
2588
|
+
data_source_request
|
|
2589
|
+
return self.data_source_save_endpoint.call_with_http_info(**kwargs)
|
|
2590
|
+
|
|
2591
|
+
def document_add(
|
|
2592
|
+
self,
|
|
2593
|
+
address,
|
|
2594
|
+
document,
|
|
2595
|
+
**kwargs
|
|
2596
|
+
):
|
|
2597
|
+
"""Add Document # noqa: E501
|
|
2598
|
+
|
|
2599
|
+
Add a document to a package or a data source using an address. This endpoint can be used for: - Adding a new document to a package / data source. - Adding an object to an entity (for example filling in an optional, complex attribute) - Adding elements to a list attribute in an entity. Args: - address: path address to where the document should be stored. - Example: Reference to data source: PROTOCOL://DATA SOURCE - Example: Reference to package by id: PROTOCOL://DATA SOURCE/$ID - Example: Reference to package by path: PROTOCOL://DATA SOURCE/ROOT PACKAGE/SUB PACKAGE - The PROTOCOL is optional, and the default is dmss. - document (dict): The document that is to be stored. - files: Optional list of files to be stored as part of this document. - update_uncontained (bool): Optional flag specifying whether to also update uncontained attributes in the document. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: A dictionary with one element, \"uid\", which is the ID of the created document. # noqa: E501
|
|
2600
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2601
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2602
|
+
|
|
2603
|
+
>>> thread = api.document_add(address, document, async_req=True)
|
|
2604
|
+
>>> result = thread.get()
|
|
2605
|
+
|
|
2606
|
+
Args:
|
|
2607
|
+
address (str):
|
|
2608
|
+
document (str):
|
|
2609
|
+
|
|
2610
|
+
Keyword Args:
|
|
2611
|
+
update_uncontained (bool): [optional] if omitted the server will use the default value of False
|
|
2612
|
+
files ([file_type]): [optional]
|
|
2613
|
+
_return_http_data_only (bool): response data without head status
|
|
2614
|
+
code and headers. Default is True.
|
|
2615
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2616
|
+
will be returned without reading/decoding response data.
|
|
2617
|
+
Default is True.
|
|
2618
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2619
|
+
one number provided, it will be total request timeout. It can also
|
|
2620
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2621
|
+
Default is None.
|
|
2622
|
+
_check_input_type (bool): specifies if type checking
|
|
2623
|
+
should be done one the data sent to the server.
|
|
2624
|
+
Default is True.
|
|
2625
|
+
_check_return_type (bool): specifies if type checking
|
|
2626
|
+
should be done one the data received from the server.
|
|
2627
|
+
Default is True.
|
|
2628
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2629
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2630
|
+
False if the variable names in the input data
|
|
2631
|
+
are pythonic names, e.g. snake case (default)
|
|
2632
|
+
_content_type (str/None): force body content-type.
|
|
2633
|
+
Default is None and content-type will be predicted by allowed
|
|
2634
|
+
content-types and body.
|
|
2635
|
+
_host_index (int/None): specifies the index of the server
|
|
2636
|
+
that we want to use.
|
|
2637
|
+
Default is read from the configuration.
|
|
2638
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2639
|
+
request; this effectively ignores the authentication
|
|
2640
|
+
in the spec for a single request.
|
|
2641
|
+
Default is None
|
|
2642
|
+
async_req (bool): execute request asynchronously
|
|
2643
|
+
|
|
2644
|
+
Returns:
|
|
2645
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
2646
|
+
If the method is called asynchronously, returns the request
|
|
2647
|
+
thread.
|
|
2648
|
+
"""
|
|
2649
|
+
kwargs['async_req'] = kwargs.get(
|
|
2650
|
+
'async_req', False
|
|
2651
|
+
)
|
|
2652
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2653
|
+
'_return_http_data_only', True
|
|
2654
|
+
)
|
|
2655
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2656
|
+
'_preload_content', True
|
|
2657
|
+
)
|
|
2658
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2659
|
+
'_request_timeout', None
|
|
2660
|
+
)
|
|
2661
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2662
|
+
'_check_input_type', True
|
|
2663
|
+
)
|
|
2664
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2665
|
+
'_check_return_type', True
|
|
2666
|
+
)
|
|
2667
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2668
|
+
'_spec_property_naming', False
|
|
2669
|
+
)
|
|
2670
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2671
|
+
'_content_type')
|
|
2672
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2673
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2674
|
+
kwargs['address'] = \
|
|
2675
|
+
address
|
|
2676
|
+
kwargs['document'] = \
|
|
2677
|
+
document
|
|
2678
|
+
return self.document_add_endpoint.call_with_http_info(**kwargs)
|
|
2679
|
+
|
|
2680
|
+
def document_add_simple(
|
|
2681
|
+
self,
|
|
2682
|
+
data_source_id,
|
|
2683
|
+
body,
|
|
2684
|
+
**kwargs
|
|
2685
|
+
):
|
|
2686
|
+
"""Add Raw # noqa: E501
|
|
2687
|
+
|
|
2688
|
+
Adding a document 'as-is' to the data source, mainly used for bootstrapping and imports. This endpoint adds a document to the data source, without any validation or splitting up of entities. A blueprint for the entity need not exist. Posted document must be a valid Entity, with a \"type\" defined. Args: - data_source_id (str): The ID of the data source where the document should be added. - document (dict): The document to add to the data source. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - str: ID of the document that was uploaded. # noqa: E501
|
|
2689
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2690
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2691
|
+
|
|
2692
|
+
>>> thread = api.document_add_simple(data_source_id, body, async_req=True)
|
|
2693
|
+
>>> result = thread.get()
|
|
2694
|
+
|
|
2695
|
+
Args:
|
|
2696
|
+
data_source_id (str):
|
|
2697
|
+
body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}):
|
|
2698
|
+
|
|
2699
|
+
Keyword Args:
|
|
2700
|
+
_return_http_data_only (bool): response data without head status
|
|
2701
|
+
code and headers. Default is True.
|
|
2702
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2703
|
+
will be returned without reading/decoding response data.
|
|
2704
|
+
Default is True.
|
|
2705
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2706
|
+
one number provided, it will be total request timeout. It can also
|
|
2707
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2708
|
+
Default is None.
|
|
2709
|
+
_check_input_type (bool): specifies if type checking
|
|
2710
|
+
should be done one the data sent to the server.
|
|
2711
|
+
Default is True.
|
|
2712
|
+
_check_return_type (bool): specifies if type checking
|
|
2713
|
+
should be done one the data received from the server.
|
|
2714
|
+
Default is True.
|
|
2715
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2716
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2717
|
+
False if the variable names in the input data
|
|
2718
|
+
are pythonic names, e.g. snake case (default)
|
|
2719
|
+
_content_type (str/None): force body content-type.
|
|
2720
|
+
Default is None and content-type will be predicted by allowed
|
|
2721
|
+
content-types and body.
|
|
2722
|
+
_host_index (int/None): specifies the index of the server
|
|
2723
|
+
that we want to use.
|
|
2724
|
+
Default is read from the configuration.
|
|
2725
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2726
|
+
request; this effectively ignores the authentication
|
|
2727
|
+
in the spec for a single request.
|
|
2728
|
+
Default is None
|
|
2729
|
+
async_req (bool): execute request asynchronously
|
|
2730
|
+
|
|
2731
|
+
Returns:
|
|
2732
|
+
str
|
|
2733
|
+
If the method is called asynchronously, returns the request
|
|
2734
|
+
thread.
|
|
2735
|
+
"""
|
|
2736
|
+
kwargs['async_req'] = kwargs.get(
|
|
2737
|
+
'async_req', False
|
|
2738
|
+
)
|
|
2739
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2740
|
+
'_return_http_data_only', True
|
|
2741
|
+
)
|
|
2742
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2743
|
+
'_preload_content', True
|
|
2744
|
+
)
|
|
2745
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2746
|
+
'_request_timeout', None
|
|
2747
|
+
)
|
|
2748
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2749
|
+
'_check_input_type', True
|
|
2750
|
+
)
|
|
2751
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2752
|
+
'_check_return_type', True
|
|
2753
|
+
)
|
|
2754
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2755
|
+
'_spec_property_naming', False
|
|
2756
|
+
)
|
|
2757
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2758
|
+
'_content_type')
|
|
2759
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2760
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2761
|
+
kwargs['data_source_id'] = \
|
|
2762
|
+
data_source_id
|
|
2763
|
+
kwargs['body'] = \
|
|
2764
|
+
body
|
|
2765
|
+
return self.document_add_simple_endpoint.call_with_http_info(**kwargs)
|
|
2766
|
+
|
|
2767
|
+
def document_check(
|
|
2768
|
+
self,
|
|
2769
|
+
address,
|
|
2770
|
+
**kwargs
|
|
2771
|
+
):
|
|
2772
|
+
"""Check Existence # noqa: E501
|
|
2773
|
+
|
|
2774
|
+
Checks if an entity exists, given an address. Args: - Address Returns: - bool: 'true' if the address points to an existing document, else 'false'. # noqa: E501
|
|
2775
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2776
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2777
|
+
|
|
2778
|
+
>>> thread = api.document_check(address, async_req=True)
|
|
2779
|
+
>>> result = thread.get()
|
|
2780
|
+
|
|
2781
|
+
Args:
|
|
2782
|
+
address (str):
|
|
2783
|
+
|
|
2784
|
+
Keyword Args:
|
|
2785
|
+
_return_http_data_only (bool): response data without head status
|
|
2786
|
+
code and headers. Default is True.
|
|
2787
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2788
|
+
will be returned without reading/decoding response data.
|
|
2789
|
+
Default is True.
|
|
2790
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2791
|
+
one number provided, it will be total request timeout. It can also
|
|
2792
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2793
|
+
Default is None.
|
|
2794
|
+
_check_input_type (bool): specifies if type checking
|
|
2795
|
+
should be done one the data sent to the server.
|
|
2796
|
+
Default is True.
|
|
2797
|
+
_check_return_type (bool): specifies if type checking
|
|
2798
|
+
should be done one the data received from the server.
|
|
2799
|
+
Default is True.
|
|
2800
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2801
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2802
|
+
False if the variable names in the input data
|
|
2803
|
+
are pythonic names, e.g. snake case (default)
|
|
2804
|
+
_content_type (str/None): force body content-type.
|
|
2805
|
+
Default is None and content-type will be predicted by allowed
|
|
2806
|
+
content-types and body.
|
|
2807
|
+
_host_index (int/None): specifies the index of the server
|
|
2808
|
+
that we want to use.
|
|
2809
|
+
Default is read from the configuration.
|
|
2810
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2811
|
+
request; this effectively ignores the authentication
|
|
2812
|
+
in the spec for a single request.
|
|
2813
|
+
Default is None
|
|
2814
|
+
async_req (bool): execute request asynchronously
|
|
2815
|
+
|
|
2816
|
+
Returns:
|
|
2817
|
+
bool
|
|
2818
|
+
If the method is called asynchronously, returns the request
|
|
2819
|
+
thread.
|
|
2820
|
+
"""
|
|
2821
|
+
kwargs['async_req'] = kwargs.get(
|
|
2822
|
+
'async_req', False
|
|
2823
|
+
)
|
|
2824
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2825
|
+
'_return_http_data_only', True
|
|
2826
|
+
)
|
|
2827
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2828
|
+
'_preload_content', True
|
|
2829
|
+
)
|
|
2830
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2831
|
+
'_request_timeout', None
|
|
2832
|
+
)
|
|
2833
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2834
|
+
'_check_input_type', True
|
|
2835
|
+
)
|
|
2836
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2837
|
+
'_check_return_type', True
|
|
2838
|
+
)
|
|
2839
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2840
|
+
'_spec_property_naming', False
|
|
2841
|
+
)
|
|
2842
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2843
|
+
'_content_type')
|
|
2844
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2845
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2846
|
+
kwargs['address'] = \
|
|
2847
|
+
address
|
|
2848
|
+
return self.document_check_endpoint.call_with_http_info(**kwargs)
|
|
2849
|
+
|
|
2850
|
+
def document_get(
|
|
2851
|
+
self,
|
|
2852
|
+
address,
|
|
2853
|
+
**kwargs
|
|
2854
|
+
):
|
|
2855
|
+
"""Get # noqa: E501
|
|
2856
|
+
|
|
2857
|
+
Get a Document as JSON String This endpoint can be used for getting entities, blueprints or other json documents from the database. Args: - address: path address to where the document should be stored. - Example: Reference to data source: PROTOCOL://DATA SOURCE - Example: Reference to package by id: PROTOCOL://DATA SOURCE/$ID - Example: Reference to package by path: PROTOCOL://DATA SOURCE/ROOT PACKAGE/SUB PACKAGE - The PROTOCOL is optional, and the default is dmss. - document (dict): The document that is to be stored. - depth (int): The maximum depth for resolving nested documents. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: The document requested. # noqa: E501
|
|
2858
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2859
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2860
|
+
|
|
2861
|
+
>>> thread = api.document_get(address, async_req=True)
|
|
2862
|
+
>>> result = thread.get()
|
|
2863
|
+
|
|
2864
|
+
Args:
|
|
2865
|
+
address (str):
|
|
2866
|
+
|
|
2867
|
+
Keyword Args:
|
|
2868
|
+
depth (int): [optional] if omitted the server will use the default value of 1
|
|
2869
|
+
_return_http_data_only (bool): response data without head status
|
|
2870
|
+
code and headers. Default is True.
|
|
2871
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2872
|
+
will be returned without reading/decoding response data.
|
|
2873
|
+
Default is True.
|
|
2874
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2875
|
+
one number provided, it will be total request timeout. It can also
|
|
2876
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2877
|
+
Default is None.
|
|
2878
|
+
_check_input_type (bool): specifies if type checking
|
|
2879
|
+
should be done one the data sent to the server.
|
|
2880
|
+
Default is True.
|
|
2881
|
+
_check_return_type (bool): specifies if type checking
|
|
2882
|
+
should be done one the data received from the server.
|
|
2883
|
+
Default is True.
|
|
2884
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2885
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2886
|
+
False if the variable names in the input data
|
|
2887
|
+
are pythonic names, e.g. snake case (default)
|
|
2888
|
+
_content_type (str/None): force body content-type.
|
|
2889
|
+
Default is None and content-type will be predicted by allowed
|
|
2890
|
+
content-types and body.
|
|
2891
|
+
_host_index (int/None): specifies the index of the server
|
|
2892
|
+
that we want to use.
|
|
2893
|
+
Default is read from the configuration.
|
|
2894
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2895
|
+
request; this effectively ignores the authentication
|
|
2896
|
+
in the spec for a single request.
|
|
2897
|
+
Default is None
|
|
2898
|
+
async_req (bool): execute request asynchronously
|
|
2899
|
+
|
|
2900
|
+
Returns:
|
|
2901
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
2902
|
+
If the method is called asynchronously, returns the request
|
|
2903
|
+
thread.
|
|
2904
|
+
"""
|
|
2905
|
+
kwargs['async_req'] = kwargs.get(
|
|
2906
|
+
'async_req', False
|
|
2907
|
+
)
|
|
2908
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2909
|
+
'_return_http_data_only', True
|
|
2910
|
+
)
|
|
2911
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2912
|
+
'_preload_content', True
|
|
2913
|
+
)
|
|
2914
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2915
|
+
'_request_timeout', None
|
|
2916
|
+
)
|
|
2917
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2918
|
+
'_check_input_type', True
|
|
2919
|
+
)
|
|
2920
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2921
|
+
'_check_return_type', True
|
|
2922
|
+
)
|
|
2923
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2924
|
+
'_spec_property_naming', False
|
|
2925
|
+
)
|
|
2926
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2927
|
+
'_content_type')
|
|
2928
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2929
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2930
|
+
kwargs['address'] = \
|
|
2931
|
+
address
|
|
2932
|
+
return self.document_get_endpoint.call_with_http_info(**kwargs)
|
|
2933
|
+
|
|
2934
|
+
def document_remove(
|
|
2935
|
+
self,
|
|
2936
|
+
address,
|
|
2937
|
+
**kwargs
|
|
2938
|
+
):
|
|
2939
|
+
"""Remove # noqa: E501
|
|
2940
|
+
|
|
2941
|
+
Remove a document from the database. Args: - address (str): path address to the document that is to be deleted. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - str: \"OK\" (200) # noqa: E501
|
|
2942
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2943
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2944
|
+
|
|
2945
|
+
>>> thread = api.document_remove(address, async_req=True)
|
|
2946
|
+
>>> result = thread.get()
|
|
2947
|
+
|
|
2948
|
+
Args:
|
|
2949
|
+
address (str):
|
|
2950
|
+
|
|
2951
|
+
Keyword Args:
|
|
2952
|
+
_return_http_data_only (bool): response data without head status
|
|
2953
|
+
code and headers. Default is True.
|
|
2954
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2955
|
+
will be returned without reading/decoding response data.
|
|
2956
|
+
Default is True.
|
|
2957
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2958
|
+
one number provided, it will be total request timeout. It can also
|
|
2959
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2960
|
+
Default is None.
|
|
2961
|
+
_check_input_type (bool): specifies if type checking
|
|
2962
|
+
should be done one the data sent to the server.
|
|
2963
|
+
Default is True.
|
|
2964
|
+
_check_return_type (bool): specifies if type checking
|
|
2965
|
+
should be done one the data received from the server.
|
|
2966
|
+
Default is True.
|
|
2967
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2968
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2969
|
+
False if the variable names in the input data
|
|
2970
|
+
are pythonic names, e.g. snake case (default)
|
|
2971
|
+
_content_type (str/None): force body content-type.
|
|
2972
|
+
Default is None and content-type will be predicted by allowed
|
|
2973
|
+
content-types and body.
|
|
2974
|
+
_host_index (int/None): specifies the index of the server
|
|
2975
|
+
that we want to use.
|
|
2976
|
+
Default is read from the configuration.
|
|
2977
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2978
|
+
request; this effectively ignores the authentication
|
|
2979
|
+
in the spec for a single request.
|
|
2980
|
+
Default is None
|
|
2981
|
+
async_req (bool): execute request asynchronously
|
|
2982
|
+
|
|
2983
|
+
Returns:
|
|
2984
|
+
bool, date, datetime, dict, float, int, list, str, none_type
|
|
2985
|
+
If the method is called asynchronously, returns the request
|
|
2986
|
+
thread.
|
|
2987
|
+
"""
|
|
2988
|
+
kwargs['async_req'] = kwargs.get(
|
|
2989
|
+
'async_req', False
|
|
2990
|
+
)
|
|
2991
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2992
|
+
'_return_http_data_only', True
|
|
2993
|
+
)
|
|
2994
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2995
|
+
'_preload_content', True
|
|
2996
|
+
)
|
|
2997
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2998
|
+
'_request_timeout', None
|
|
2999
|
+
)
|
|
3000
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3001
|
+
'_check_input_type', True
|
|
3002
|
+
)
|
|
3003
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3004
|
+
'_check_return_type', True
|
|
3005
|
+
)
|
|
3006
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3007
|
+
'_spec_property_naming', False
|
|
3008
|
+
)
|
|
3009
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3010
|
+
'_content_type')
|
|
3011
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3012
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3013
|
+
kwargs['address'] = \
|
|
3014
|
+
address
|
|
3015
|
+
return self.document_remove_endpoint.call_with_http_info(**kwargs)
|
|
3016
|
+
|
|
3017
|
+
def document_update(
|
|
3018
|
+
self,
|
|
3019
|
+
id_address,
|
|
3020
|
+
data,
|
|
3021
|
+
**kwargs
|
|
3022
|
+
):
|
|
3023
|
+
"""Update # noqa: E501
|
|
3024
|
+
|
|
3025
|
+
Update an Existing Document in the Database. This endpoint can be used for updating an existing document Args: - address: Path address to the document that should be updated. - Example: Reference to data source: PROTOCOL://DATA SOURCE - Example: Reference to package by id: PROTOCOL://DATA SOURCE/$ID - Example: Reference to package by path: PROTOCOL://DATA SOURCE/ROOT PACKAGE/SUB PACKAGE - The PROTOCOL is optional, and the default is dmss. - document (dict): The document to replace the previous version. - files: Optional list of files to be stored as part of this document. - update_uncontained (bool): Optional flag specifying whether to also update uncontained attributes in the document. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: The updated document. # noqa: E501
|
|
3026
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3027
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3028
|
+
|
|
3029
|
+
>>> thread = api.document_update(id_address, data, async_req=True)
|
|
3030
|
+
>>> result = thread.get()
|
|
3031
|
+
|
|
3032
|
+
Args:
|
|
3033
|
+
id_address (str):
|
|
3034
|
+
data (str):
|
|
3035
|
+
|
|
3036
|
+
Keyword Args:
|
|
3037
|
+
update_uncontained (bool): [optional] if omitted the server will use the default value of False
|
|
3038
|
+
files ([file_type]): [optional]
|
|
3039
|
+
_return_http_data_only (bool): response data without head status
|
|
3040
|
+
code and headers. Default is True.
|
|
3041
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3042
|
+
will be returned without reading/decoding response data.
|
|
3043
|
+
Default is True.
|
|
3044
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3045
|
+
one number provided, it will be total request timeout. It can also
|
|
3046
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3047
|
+
Default is None.
|
|
3048
|
+
_check_input_type (bool): specifies if type checking
|
|
3049
|
+
should be done one the data sent to the server.
|
|
3050
|
+
Default is True.
|
|
3051
|
+
_check_return_type (bool): specifies if type checking
|
|
3052
|
+
should be done one the data received from the server.
|
|
3053
|
+
Default is True.
|
|
3054
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3055
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3056
|
+
False if the variable names in the input data
|
|
3057
|
+
are pythonic names, e.g. snake case (default)
|
|
3058
|
+
_content_type (str/None): force body content-type.
|
|
3059
|
+
Default is None and content-type will be predicted by allowed
|
|
3060
|
+
content-types and body.
|
|
3061
|
+
_host_index (int/None): specifies the index of the server
|
|
3062
|
+
that we want to use.
|
|
3063
|
+
Default is read from the configuration.
|
|
3064
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3065
|
+
request; this effectively ignores the authentication
|
|
3066
|
+
in the spec for a single request.
|
|
3067
|
+
Default is None
|
|
3068
|
+
async_req (bool): execute request asynchronously
|
|
3069
|
+
|
|
3070
|
+
Returns:
|
|
3071
|
+
bool, date, datetime, dict, float, int, list, str, none_type
|
|
3072
|
+
If the method is called asynchronously, returns the request
|
|
3073
|
+
thread.
|
|
3074
|
+
"""
|
|
3075
|
+
kwargs['async_req'] = kwargs.get(
|
|
3076
|
+
'async_req', False
|
|
3077
|
+
)
|
|
3078
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3079
|
+
'_return_http_data_only', True
|
|
3080
|
+
)
|
|
3081
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3082
|
+
'_preload_content', True
|
|
3083
|
+
)
|
|
3084
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3085
|
+
'_request_timeout', None
|
|
3086
|
+
)
|
|
3087
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3088
|
+
'_check_input_type', True
|
|
3089
|
+
)
|
|
3090
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3091
|
+
'_check_return_type', True
|
|
3092
|
+
)
|
|
3093
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3094
|
+
'_spec_property_naming', False
|
|
3095
|
+
)
|
|
3096
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3097
|
+
'_content_type')
|
|
3098
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3099
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3100
|
+
kwargs['id_address'] = \
|
|
3101
|
+
id_address
|
|
3102
|
+
kwargs['data'] = \
|
|
3103
|
+
data
|
|
3104
|
+
return self.document_update_endpoint.call_with_http_info(**kwargs)
|
|
3105
|
+
|
|
3106
|
+
def export(
|
|
3107
|
+
self,
|
|
3108
|
+
path_address,
|
|
3109
|
+
**kwargs
|
|
3110
|
+
):
|
|
3111
|
+
"""Export # noqa: E501
|
|
3112
|
+
|
|
3113
|
+
Download a zip-folder Containing One or More Documents as JSON Files. This endpoint creates a zip-folder with the contents of the document and it's children. Args: - path_address: Address to the entity or package that should be exported. - Example: PROTOCOL://DATA SOURCE/ROOT PACKAGE/SUB PACKAGE/ENTITY (PROTOCOL is optional, and the default is dmss.) - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - FileResponse: A FileResponse containing the zip file. # noqa: E501
|
|
3114
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3115
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3116
|
+
|
|
3117
|
+
>>> thread = api.export(path_address, async_req=True)
|
|
3118
|
+
>>> result = thread.get()
|
|
3119
|
+
|
|
3120
|
+
Args:
|
|
3121
|
+
path_address (str):
|
|
3122
|
+
|
|
3123
|
+
Keyword Args:
|
|
3124
|
+
_return_http_data_only (bool): response data without head status
|
|
3125
|
+
code and headers. Default is True.
|
|
3126
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3127
|
+
will be returned without reading/decoding response data.
|
|
3128
|
+
Default is True.
|
|
3129
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3130
|
+
one number provided, it will be total request timeout. It can also
|
|
3131
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3132
|
+
Default is None.
|
|
3133
|
+
_check_input_type (bool): specifies if type checking
|
|
3134
|
+
should be done one the data sent to the server.
|
|
3135
|
+
Default is True.
|
|
3136
|
+
_check_return_type (bool): specifies if type checking
|
|
3137
|
+
should be done one the data received from the server.
|
|
3138
|
+
Default is True.
|
|
3139
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3140
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3141
|
+
False if the variable names in the input data
|
|
3142
|
+
are pythonic names, e.g. snake case (default)
|
|
3143
|
+
_content_type (str/None): force body content-type.
|
|
3144
|
+
Default is None and content-type will be predicted by allowed
|
|
3145
|
+
content-types and body.
|
|
3146
|
+
_host_index (int/None): specifies the index of the server
|
|
3147
|
+
that we want to use.
|
|
3148
|
+
Default is read from the configuration.
|
|
3149
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3150
|
+
request; this effectively ignores the authentication
|
|
3151
|
+
in the spec for a single request.
|
|
3152
|
+
Default is None
|
|
3153
|
+
async_req (bool): execute request asynchronously
|
|
3154
|
+
|
|
3155
|
+
Returns:
|
|
3156
|
+
None
|
|
3157
|
+
If the method is called asynchronously, returns the request
|
|
3158
|
+
thread.
|
|
3159
|
+
"""
|
|
3160
|
+
kwargs['async_req'] = kwargs.get(
|
|
3161
|
+
'async_req', False
|
|
3162
|
+
)
|
|
3163
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3164
|
+
'_return_http_data_only', True
|
|
3165
|
+
)
|
|
3166
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3167
|
+
'_preload_content', True
|
|
3168
|
+
)
|
|
3169
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3170
|
+
'_request_timeout', None
|
|
3171
|
+
)
|
|
3172
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3173
|
+
'_check_input_type', True
|
|
3174
|
+
)
|
|
3175
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3176
|
+
'_check_return_type', True
|
|
3177
|
+
)
|
|
3178
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3179
|
+
'_spec_property_naming', False
|
|
3180
|
+
)
|
|
3181
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3182
|
+
'_content_type')
|
|
3183
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3184
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3185
|
+
kwargs['path_address'] = \
|
|
3186
|
+
path_address
|
|
3187
|
+
return self.export_endpoint.call_with_http_info(**kwargs)
|
|
3188
|
+
|
|
3189
|
+
def export_meta(
|
|
3190
|
+
self,
|
|
3191
|
+
path_address,
|
|
3192
|
+
**kwargs
|
|
3193
|
+
):
|
|
3194
|
+
"""Export Meta # noqa: E501
|
|
3195
|
+
|
|
3196
|
+
Get Meta Information About a Document This endpoint returns meta information about a document provided document id and data source id in which it is located. For more information about the meta-object, see [the docs](https://equinor.github.io/dm-docs/docs/concepts/meta) Args: - path_address (str): Address of the object for which to get the meta-information. - Example: PROTOCOL://DATA SOURCE/ROOT PACKAGE/SUB PACKAGE/ENTITY (PROTOCOL is optional, and the default is dmss.) - user (User): The authenticated user accessing the endpoint. Returns: - dict: A dictionary containing the meta information for the object. # noqa: E501
|
|
3197
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3198
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3199
|
+
|
|
3200
|
+
>>> thread = api.export_meta(path_address, async_req=True)
|
|
3201
|
+
>>> result = thread.get()
|
|
3202
|
+
|
|
3203
|
+
Args:
|
|
3204
|
+
path_address (str):
|
|
3205
|
+
|
|
3206
|
+
Keyword Args:
|
|
3207
|
+
_return_http_data_only (bool): response data without head status
|
|
3208
|
+
code and headers. Default is True.
|
|
3209
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3210
|
+
will be returned without reading/decoding response data.
|
|
3211
|
+
Default is True.
|
|
3212
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3213
|
+
one number provided, it will be total request timeout. It can also
|
|
3214
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3215
|
+
Default is None.
|
|
3216
|
+
_check_input_type (bool): specifies if type checking
|
|
3217
|
+
should be done one the data sent to the server.
|
|
3218
|
+
Default is True.
|
|
3219
|
+
_check_return_type (bool): specifies if type checking
|
|
3220
|
+
should be done one the data received from the server.
|
|
3221
|
+
Default is True.
|
|
3222
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3223
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3224
|
+
False if the variable names in the input data
|
|
3225
|
+
are pythonic names, e.g. snake case (default)
|
|
3226
|
+
_content_type (str/None): force body content-type.
|
|
3227
|
+
Default is None and content-type will be predicted by allowed
|
|
3228
|
+
content-types and body.
|
|
3229
|
+
_host_index (int/None): specifies the index of the server
|
|
3230
|
+
that we want to use.
|
|
3231
|
+
Default is read from the configuration.
|
|
3232
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3233
|
+
request; this effectively ignores the authentication
|
|
3234
|
+
in the spec for a single request.
|
|
3235
|
+
Default is None
|
|
3236
|
+
async_req (bool): execute request asynchronously
|
|
3237
|
+
|
|
3238
|
+
Returns:
|
|
3239
|
+
ExportMetaResponse
|
|
3240
|
+
If the method is called asynchronously, returns the request
|
|
3241
|
+
thread.
|
|
3242
|
+
"""
|
|
3243
|
+
kwargs['async_req'] = kwargs.get(
|
|
3244
|
+
'async_req', False
|
|
3245
|
+
)
|
|
3246
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3247
|
+
'_return_http_data_only', True
|
|
3248
|
+
)
|
|
3249
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3250
|
+
'_preload_content', True
|
|
3251
|
+
)
|
|
3252
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3253
|
+
'_request_timeout', None
|
|
3254
|
+
)
|
|
3255
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3256
|
+
'_check_input_type', True
|
|
3257
|
+
)
|
|
3258
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3259
|
+
'_check_return_type', True
|
|
3260
|
+
)
|
|
3261
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3262
|
+
'_spec_property_naming', False
|
|
3263
|
+
)
|
|
3264
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3265
|
+
'_content_type')
|
|
3266
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3267
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3268
|
+
kwargs['path_address'] = \
|
|
3269
|
+
path_address
|
|
3270
|
+
return self.export_meta_endpoint.call_with_http_info(**kwargs)
|
|
3271
|
+
|
|
3272
|
+
def file_upload(
|
|
3273
|
+
self,
|
|
3274
|
+
data_source_id,
|
|
3275
|
+
data,
|
|
3276
|
+
file,
|
|
3277
|
+
**kwargs
|
|
3278
|
+
):
|
|
3279
|
+
"""Upload File # noqa: E501
|
|
3280
|
+
|
|
3281
|
+
Upload a New Binary File This endpoint uploads a new file and creates a file entity with the uploaded binary data as content. Args: - data_source_id (str): ID of the data source to which the file should be uploaded. - data (dict with a \"file_id\" attribute): A dict containing data source ID to be used for the file entity that will be created. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: The file entity that was created to contain the file. # noqa: E501
|
|
3282
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3283
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3284
|
+
|
|
3285
|
+
>>> thread = api.file_upload(data_source_id, data, file, async_req=True)
|
|
3286
|
+
>>> result = thread.get()
|
|
3287
|
+
|
|
3288
|
+
Args:
|
|
3289
|
+
data_source_id (str):
|
|
3290
|
+
data (str):
|
|
3291
|
+
file (file_type):
|
|
3292
|
+
|
|
3293
|
+
Keyword Args:
|
|
3294
|
+
_return_http_data_only (bool): response data without head status
|
|
3295
|
+
code and headers. Default is True.
|
|
3296
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3297
|
+
will be returned without reading/decoding response data.
|
|
3298
|
+
Default is True.
|
|
3299
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3300
|
+
one number provided, it will be total request timeout. It can also
|
|
3301
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3302
|
+
Default is None.
|
|
3303
|
+
_check_input_type (bool): specifies if type checking
|
|
3304
|
+
should be done one the data sent to the server.
|
|
3305
|
+
Default is True.
|
|
3306
|
+
_check_return_type (bool): specifies if type checking
|
|
3307
|
+
should be done one the data received from the server.
|
|
3308
|
+
Default is True.
|
|
3309
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3310
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3311
|
+
False if the variable names in the input data
|
|
3312
|
+
are pythonic names, e.g. snake case (default)
|
|
3313
|
+
_content_type (str/None): force body content-type.
|
|
3314
|
+
Default is None and content-type will be predicted by allowed
|
|
3315
|
+
content-types and body.
|
|
3316
|
+
_host_index (int/None): specifies the index of the server
|
|
3317
|
+
that we want to use.
|
|
3318
|
+
Default is read from the configuration.
|
|
3319
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3320
|
+
request; this effectively ignores the authentication
|
|
3321
|
+
in the spec for a single request.
|
|
3322
|
+
Default is None
|
|
3323
|
+
async_req (bool): execute request asynchronously
|
|
3324
|
+
|
|
3325
|
+
Returns:
|
|
3326
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
3327
|
+
If the method is called asynchronously, returns the request
|
|
3328
|
+
thread.
|
|
3329
|
+
"""
|
|
3330
|
+
kwargs['async_req'] = kwargs.get(
|
|
3331
|
+
'async_req', False
|
|
3332
|
+
)
|
|
3333
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3334
|
+
'_return_http_data_only', True
|
|
3335
|
+
)
|
|
3336
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3337
|
+
'_preload_content', True
|
|
3338
|
+
)
|
|
3339
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3340
|
+
'_request_timeout', None
|
|
3341
|
+
)
|
|
3342
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3343
|
+
'_check_input_type', True
|
|
3344
|
+
)
|
|
3345
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3346
|
+
'_check_return_type', True
|
|
3347
|
+
)
|
|
3348
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3349
|
+
'_spec_property_naming', False
|
|
3350
|
+
)
|
|
3351
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3352
|
+
'_content_type')
|
|
3353
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3354
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3355
|
+
kwargs['data_source_id'] = \
|
|
3356
|
+
data_source_id
|
|
3357
|
+
kwargs['data'] = \
|
|
3358
|
+
data
|
|
3359
|
+
kwargs['file'] = \
|
|
3360
|
+
file
|
|
3361
|
+
return self.file_upload_endpoint.call_with_http_info(**kwargs)
|
|
3362
|
+
|
|
3363
|
+
def get_acl(
|
|
3364
|
+
self,
|
|
3365
|
+
data_source_id,
|
|
3366
|
+
document_id,
|
|
3367
|
+
**kwargs
|
|
3368
|
+
):
|
|
3369
|
+
"""Get Acl # noqa: E501
|
|
3370
|
+
|
|
3371
|
+
GET the access control list (ACL) for a document. The ACL determines which access a given user has for a document (Read, Write or None). Args: - data_source_id (str): The ID of the data source which the document resides in. - document_id (str): The ID of the document for which to check the ACL. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - ACL: The access control list requested. # noqa: E501
|
|
3372
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3373
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3374
|
+
|
|
3375
|
+
>>> thread = api.get_acl(data_source_id, document_id, async_req=True)
|
|
3376
|
+
>>> result = thread.get()
|
|
3377
|
+
|
|
3378
|
+
Args:
|
|
3379
|
+
data_source_id (str):
|
|
3380
|
+
document_id (str):
|
|
3381
|
+
|
|
3382
|
+
Keyword Args:
|
|
3383
|
+
_return_http_data_only (bool): response data without head status
|
|
3384
|
+
code and headers. Default is True.
|
|
3385
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3386
|
+
will be returned without reading/decoding response data.
|
|
3387
|
+
Default is True.
|
|
3388
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3389
|
+
one number provided, it will be total request timeout. It can also
|
|
3390
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3391
|
+
Default is None.
|
|
3392
|
+
_check_input_type (bool): specifies if type checking
|
|
3393
|
+
should be done one the data sent to the server.
|
|
3394
|
+
Default is True.
|
|
3395
|
+
_check_return_type (bool): specifies if type checking
|
|
3396
|
+
should be done one the data received from the server.
|
|
3397
|
+
Default is True.
|
|
3398
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3399
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3400
|
+
False if the variable names in the input data
|
|
3401
|
+
are pythonic names, e.g. snake case (default)
|
|
3402
|
+
_content_type (str/None): force body content-type.
|
|
3403
|
+
Default is None and content-type will be predicted by allowed
|
|
3404
|
+
content-types and body.
|
|
3405
|
+
_host_index (int/None): specifies the index of the server
|
|
3406
|
+
that we want to use.
|
|
3407
|
+
Default is read from the configuration.
|
|
3408
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3409
|
+
request; this effectively ignores the authentication
|
|
3410
|
+
in the spec for a single request.
|
|
3411
|
+
Default is None
|
|
3412
|
+
async_req (bool): execute request asynchronously
|
|
3413
|
+
|
|
3414
|
+
Returns:
|
|
3415
|
+
AccessControlList
|
|
3416
|
+
If the method is called asynchronously, returns the request
|
|
3417
|
+
thread.
|
|
3418
|
+
"""
|
|
3419
|
+
kwargs['async_req'] = kwargs.get(
|
|
3420
|
+
'async_req', False
|
|
3421
|
+
)
|
|
3422
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3423
|
+
'_return_http_data_only', True
|
|
3424
|
+
)
|
|
3425
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3426
|
+
'_preload_content', True
|
|
3427
|
+
)
|
|
3428
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3429
|
+
'_request_timeout', None
|
|
3430
|
+
)
|
|
3431
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3432
|
+
'_check_input_type', True
|
|
3433
|
+
)
|
|
3434
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3435
|
+
'_check_return_type', True
|
|
3436
|
+
)
|
|
3437
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3438
|
+
'_spec_property_naming', False
|
|
3439
|
+
)
|
|
3440
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3441
|
+
'_content_type')
|
|
3442
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3443
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3444
|
+
kwargs['data_source_id'] = \
|
|
3445
|
+
data_source_id
|
|
3446
|
+
kwargs['document_id'] = \
|
|
3447
|
+
document_id
|
|
3448
|
+
return self.get_acl_endpoint.call_with_http_info(**kwargs)
|
|
3449
|
+
|
|
3450
|
+
def get_api_healthcheck_get(
|
|
3451
|
+
self,
|
|
3452
|
+
**kwargs
|
|
3453
|
+
):
|
|
3454
|
+
"""Get # noqa: E501
|
|
3455
|
+
|
|
3456
|
+
Get the Health Status Of the Service. This endpoint can be used to check the health status of the service. It always returns a 200 OK response to indicate that the service is up and running. Returns: - string: A string indicating the health status. (\"OK\") # noqa: E501
|
|
3457
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3458
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3459
|
+
|
|
3460
|
+
>>> thread = api.get_api_healthcheck_get(async_req=True)
|
|
3461
|
+
>>> result = thread.get()
|
|
3462
|
+
|
|
3463
|
+
|
|
3464
|
+
Keyword Args:
|
|
3465
|
+
_return_http_data_only (bool): response data without head status
|
|
3466
|
+
code and headers. Default is True.
|
|
3467
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3468
|
+
will be returned without reading/decoding response data.
|
|
3469
|
+
Default is True.
|
|
3470
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3471
|
+
one number provided, it will be total request timeout. It can also
|
|
3472
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3473
|
+
Default is None.
|
|
3474
|
+
_check_input_type (bool): specifies if type checking
|
|
3475
|
+
should be done one the data sent to the server.
|
|
3476
|
+
Default is True.
|
|
3477
|
+
_check_return_type (bool): specifies if type checking
|
|
3478
|
+
should be done one the data received from the server.
|
|
3479
|
+
Default is True.
|
|
3480
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3481
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3482
|
+
False if the variable names in the input data
|
|
3483
|
+
are pythonic names, e.g. snake case (default)
|
|
3484
|
+
_content_type (str/None): force body content-type.
|
|
3485
|
+
Default is None and content-type will be predicted by allowed
|
|
3486
|
+
content-types and body.
|
|
3487
|
+
_host_index (int/None): specifies the index of the server
|
|
3488
|
+
that we want to use.
|
|
3489
|
+
Default is read from the configuration.
|
|
3490
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3491
|
+
request; this effectively ignores the authentication
|
|
3492
|
+
in the spec for a single request.
|
|
3493
|
+
Default is None
|
|
3494
|
+
async_req (bool): execute request asynchronously
|
|
3495
|
+
|
|
3496
|
+
Returns:
|
|
3497
|
+
str
|
|
3498
|
+
If the method is called asynchronously, returns the request
|
|
3499
|
+
thread.
|
|
3500
|
+
"""
|
|
3501
|
+
kwargs['async_req'] = kwargs.get(
|
|
3502
|
+
'async_req', False
|
|
3503
|
+
)
|
|
3504
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3505
|
+
'_return_http_data_only', True
|
|
3506
|
+
)
|
|
3507
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3508
|
+
'_preload_content', True
|
|
3509
|
+
)
|
|
3510
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3511
|
+
'_request_timeout', None
|
|
3512
|
+
)
|
|
3513
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3514
|
+
'_check_input_type', True
|
|
3515
|
+
)
|
|
3516
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3517
|
+
'_check_return_type', True
|
|
3518
|
+
)
|
|
3519
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3520
|
+
'_spec_property_naming', False
|
|
3521
|
+
)
|
|
3522
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3523
|
+
'_content_type')
|
|
3524
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3525
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3526
|
+
return self.get_api_healthcheck_get_endpoint.call_with_http_info(**kwargs)
|
|
3527
|
+
|
|
3528
|
+
def get_lookup(
|
|
3529
|
+
self,
|
|
3530
|
+
application,
|
|
3531
|
+
**kwargs
|
|
3532
|
+
):
|
|
3533
|
+
"""Get Lookup # noqa: E501
|
|
3534
|
+
|
|
3535
|
+
Get The Lookup Table for UI- and Storage Recipes the Provided Application This endpoint fetches the recipe lookup table for the application provided. This lookup table is used to find UI- and Storage recipes given a blueprint. Args: - application (str): The name of the desired application. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: The recipe lookup table for the provided application. # noqa: E501
|
|
3536
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3537
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3538
|
+
|
|
3539
|
+
>>> thread = api.get_lookup(application, async_req=True)
|
|
3540
|
+
>>> result = thread.get()
|
|
3541
|
+
|
|
3542
|
+
Args:
|
|
3543
|
+
application (str):
|
|
3544
|
+
|
|
3545
|
+
Keyword Args:
|
|
3546
|
+
_return_http_data_only (bool): response data without head status
|
|
3547
|
+
code and headers. Default is True.
|
|
3548
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3549
|
+
will be returned without reading/decoding response data.
|
|
3550
|
+
Default is True.
|
|
3551
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3552
|
+
one number provided, it will be total request timeout. It can also
|
|
3553
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3554
|
+
Default is None.
|
|
3555
|
+
_check_input_type (bool): specifies if type checking
|
|
3556
|
+
should be done one the data sent to the server.
|
|
3557
|
+
Default is True.
|
|
3558
|
+
_check_return_type (bool): specifies if type checking
|
|
3559
|
+
should be done one the data received from the server.
|
|
3560
|
+
Default is True.
|
|
3561
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3562
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3563
|
+
False if the variable names in the input data
|
|
3564
|
+
are pythonic names, e.g. snake case (default)
|
|
3565
|
+
_content_type (str/None): force body content-type.
|
|
3566
|
+
Default is None and content-type will be predicted by allowed
|
|
3567
|
+
content-types and body.
|
|
3568
|
+
_host_index (int/None): specifies the index of the server
|
|
3569
|
+
that we want to use.
|
|
3570
|
+
Default is read from the configuration.
|
|
3571
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3572
|
+
request; this effectively ignores the authentication
|
|
3573
|
+
in the spec for a single request.
|
|
3574
|
+
Default is None
|
|
3575
|
+
async_req (bool): execute request asynchronously
|
|
3576
|
+
|
|
3577
|
+
Returns:
|
|
3578
|
+
Lookup
|
|
3579
|
+
If the method is called asynchronously, returns the request
|
|
3580
|
+
thread.
|
|
3581
|
+
"""
|
|
3582
|
+
kwargs['async_req'] = kwargs.get(
|
|
3583
|
+
'async_req', False
|
|
3584
|
+
)
|
|
3585
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3586
|
+
'_return_http_data_only', True
|
|
3587
|
+
)
|
|
3588
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3589
|
+
'_preload_content', True
|
|
3590
|
+
)
|
|
3591
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3592
|
+
'_request_timeout', None
|
|
3593
|
+
)
|
|
3594
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3595
|
+
'_check_input_type', True
|
|
3596
|
+
)
|
|
3597
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3598
|
+
'_check_return_type', True
|
|
3599
|
+
)
|
|
3600
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3601
|
+
'_spec_property_naming', False
|
|
3602
|
+
)
|
|
3603
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3604
|
+
'_content_type')
|
|
3605
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3606
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3607
|
+
kwargs['application'] = \
|
|
3608
|
+
application
|
|
3609
|
+
return self.get_lookup_endpoint.call_with_http_info(**kwargs)
|
|
3610
|
+
|
|
3611
|
+
def instantiate_entity(
|
|
3612
|
+
self,
|
|
3613
|
+
entity,
|
|
3614
|
+
**kwargs
|
|
3615
|
+
):
|
|
3616
|
+
"""Instantiate # noqa: E501
|
|
3617
|
+
|
|
3618
|
+
Returns a default entity of specified type. This entity is not stored in the database. This endpoint creates a default entity of the specified type. A default entity of that type is specified to contain all the required fields with their default values. If no default value is set for the field, then an 'empty' value will be set for that field. For an int that would be 0, and for a string that would be \"\". Optional attributes are not filled in, even if a default value is specified for that optional field. Args: - entity (Entity): A JSON object with only a \"type\" parameter. Any other fields will be ignored. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: A default entity of the specified type. # noqa: E501
|
|
3619
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3620
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3621
|
+
|
|
3622
|
+
>>> thread = api.instantiate_entity(entity, async_req=True)
|
|
3623
|
+
>>> result = thread.get()
|
|
3624
|
+
|
|
3625
|
+
Args:
|
|
3626
|
+
entity (Entity):
|
|
3627
|
+
|
|
3628
|
+
Keyword Args:
|
|
3629
|
+
_return_http_data_only (bool): response data without head status
|
|
3630
|
+
code and headers. Default is True.
|
|
3631
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3632
|
+
will be returned without reading/decoding response data.
|
|
3633
|
+
Default is True.
|
|
3634
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3635
|
+
one number provided, it will be total request timeout. It can also
|
|
3636
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3637
|
+
Default is None.
|
|
3638
|
+
_check_input_type (bool): specifies if type checking
|
|
3639
|
+
should be done one the data sent to the server.
|
|
3640
|
+
Default is True.
|
|
3641
|
+
_check_return_type (bool): specifies if type checking
|
|
3642
|
+
should be done one the data received from the server.
|
|
3643
|
+
Default is True.
|
|
3644
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3645
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3646
|
+
False if the variable names in the input data
|
|
3647
|
+
are pythonic names, e.g. snake case (default)
|
|
3648
|
+
_content_type (str/None): force body content-type.
|
|
3649
|
+
Default is None and content-type will be predicted by allowed
|
|
3650
|
+
content-types and body.
|
|
3651
|
+
_host_index (int/None): specifies the index of the server
|
|
3652
|
+
that we want to use.
|
|
3653
|
+
Default is read from the configuration.
|
|
3654
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3655
|
+
request; this effectively ignores the authentication
|
|
3656
|
+
in the spec for a single request.
|
|
3657
|
+
Default is None
|
|
3658
|
+
async_req (bool): execute request asynchronously
|
|
3659
|
+
|
|
3660
|
+
Returns:
|
|
3661
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
3662
|
+
If the method is called asynchronously, returns the request
|
|
3663
|
+
thread.
|
|
3664
|
+
"""
|
|
3665
|
+
kwargs['async_req'] = kwargs.get(
|
|
3666
|
+
'async_req', False
|
|
3667
|
+
)
|
|
3668
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3669
|
+
'_return_http_data_only', True
|
|
3670
|
+
)
|
|
3671
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3672
|
+
'_preload_content', True
|
|
3673
|
+
)
|
|
3674
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3675
|
+
'_request_timeout', None
|
|
3676
|
+
)
|
|
3677
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3678
|
+
'_check_input_type', True
|
|
3679
|
+
)
|
|
3680
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3681
|
+
'_check_return_type', True
|
|
3682
|
+
)
|
|
3683
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3684
|
+
'_spec_property_naming', False
|
|
3685
|
+
)
|
|
3686
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3687
|
+
'_content_type')
|
|
3688
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3689
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3690
|
+
kwargs['entity'] = \
|
|
3691
|
+
entity
|
|
3692
|
+
return self.instantiate_entity_endpoint.call_with_http_info(**kwargs)
|
|
3693
|
+
|
|
3694
|
+
def meta_by_id(
|
|
3695
|
+
self,
|
|
3696
|
+
data_source_id,
|
|
3697
|
+
document_id,
|
|
3698
|
+
**kwargs
|
|
3699
|
+
):
|
|
3700
|
+
"""Get Meta By Id # noqa: E501
|
|
3701
|
+
|
|
3702
|
+
Get Meta Information About a blob. This endpoint returns meta information for a blob file provided document id and the id of the data source of which it is located. Args: - data_source_id (str): The ID of the data source. - document_id (str): The ID of the document. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: A dictionary containing the meta information about the blob file of the document. # noqa: E501
|
|
3703
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3704
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3705
|
+
|
|
3706
|
+
>>> thread = api.meta_by_id(data_source_id, document_id, async_req=True)
|
|
3707
|
+
>>> result = thread.get()
|
|
3708
|
+
|
|
3709
|
+
Args:
|
|
3710
|
+
data_source_id (str):
|
|
3711
|
+
document_id (str):
|
|
3712
|
+
|
|
3713
|
+
Keyword Args:
|
|
3714
|
+
_return_http_data_only (bool): response data without head status
|
|
3715
|
+
code and headers. Default is True.
|
|
3716
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3717
|
+
will be returned without reading/decoding response data.
|
|
3718
|
+
Default is True.
|
|
3719
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3720
|
+
one number provided, it will be total request timeout. It can also
|
|
3721
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3722
|
+
Default is None.
|
|
3723
|
+
_check_input_type (bool): specifies if type checking
|
|
3724
|
+
should be done one the data sent to the server.
|
|
3725
|
+
Default is True.
|
|
3726
|
+
_check_return_type (bool): specifies if type checking
|
|
3727
|
+
should be done one the data received from the server.
|
|
3728
|
+
Default is True.
|
|
3729
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3730
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3731
|
+
False if the variable names in the input data
|
|
3732
|
+
are pythonic names, e.g. snake case (default)
|
|
3733
|
+
_content_type (str/None): force body content-type.
|
|
3734
|
+
Default is None and content-type will be predicted by allowed
|
|
3735
|
+
content-types and body.
|
|
3736
|
+
_host_index (int/None): specifies the index of the server
|
|
3737
|
+
that we want to use.
|
|
3738
|
+
Default is read from the configuration.
|
|
3739
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3740
|
+
request; this effectively ignores the authentication
|
|
3741
|
+
in the spec for a single request.
|
|
3742
|
+
Default is None
|
|
3743
|
+
async_req (bool): execute request asynchronously
|
|
3744
|
+
|
|
3745
|
+
Returns:
|
|
3746
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
3747
|
+
If the method is called asynchronously, returns the request
|
|
3748
|
+
thread.
|
|
3749
|
+
"""
|
|
3750
|
+
kwargs['async_req'] = kwargs.get(
|
|
3751
|
+
'async_req', False
|
|
3752
|
+
)
|
|
3753
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3754
|
+
'_return_http_data_only', True
|
|
3755
|
+
)
|
|
3756
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3757
|
+
'_preload_content', True
|
|
3758
|
+
)
|
|
3759
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3760
|
+
'_request_timeout', None
|
|
3761
|
+
)
|
|
3762
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3763
|
+
'_check_input_type', True
|
|
3764
|
+
)
|
|
3765
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3766
|
+
'_check_return_type', True
|
|
3767
|
+
)
|
|
3768
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3769
|
+
'_spec_property_naming', False
|
|
3770
|
+
)
|
|
3771
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3772
|
+
'_content_type')
|
|
3773
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3774
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3775
|
+
kwargs['data_source_id'] = \
|
|
3776
|
+
data_source_id
|
|
3777
|
+
kwargs['document_id'] = \
|
|
3778
|
+
document_id
|
|
3779
|
+
return self.meta_by_id_endpoint.call_with_http_info(**kwargs)
|
|
3780
|
+
|
|
3781
|
+
def search(
|
|
3782
|
+
self,
|
|
3783
|
+
**kwargs
|
|
3784
|
+
):
|
|
3785
|
+
"""Search # noqa: E501
|
|
3786
|
+
|
|
3787
|
+
Search for Entities of a Specific Blueprint Type in the Provided Data Sources. This endpoint searches the provided data sources for entities that match the search data object provided. It will return all the entities in database of the type specified, with attributes that match the requirements set in the search query. Args: - data (dict): A dictionary containing a \"type\"-attribute which will be used to search . Other attributes can be used to filter the search. - Example: { \"type\": \"dmss://blueprints/root_package/ValuesBlueprint\", \"attribute_greater_than_example\": \">100\", \"attribute_less_than_example\": \"<11\". \"my_string\": \"de\" # will return entities with attributes of type \"my_string\" that starts with \"de\" } - data_sources (List[str]): Optional list of data source id's of which to search. If left empty it will search all available databases. - sort_by_attribute (str): Optional attribute of which to sort the results. Default is \"name\". - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: The sorted search results. # noqa: E501
|
|
3788
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3789
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3790
|
+
|
|
3791
|
+
>>> thread = api.search(async_req=True)
|
|
3792
|
+
>>> result = thread.get()
|
|
3793
|
+
|
|
3794
|
+
|
|
3795
|
+
Keyword Args:
|
|
3796
|
+
data_sources ([str]): [optional] if omitted the server will use the default value of []
|
|
3797
|
+
sort_by_attribute (str): [optional] if omitted the server will use the default value of "name"
|
|
3798
|
+
body ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional]
|
|
3799
|
+
_return_http_data_only (bool): response data without head status
|
|
3800
|
+
code and headers. Default is True.
|
|
3801
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3802
|
+
will be returned without reading/decoding response data.
|
|
3803
|
+
Default is True.
|
|
3804
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3805
|
+
one number provided, it will be total request timeout. It can also
|
|
3806
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3807
|
+
Default is None.
|
|
3808
|
+
_check_input_type (bool): specifies if type checking
|
|
3809
|
+
should be done one the data sent to the server.
|
|
3810
|
+
Default is True.
|
|
3811
|
+
_check_return_type (bool): specifies if type checking
|
|
3812
|
+
should be done one the data received from the server.
|
|
3813
|
+
Default is True.
|
|
3814
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3815
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3816
|
+
False if the variable names in the input data
|
|
3817
|
+
are pythonic names, e.g. snake case (default)
|
|
3818
|
+
_content_type (str/None): force body content-type.
|
|
3819
|
+
Default is None and content-type will be predicted by allowed
|
|
3820
|
+
content-types and body.
|
|
3821
|
+
_host_index (int/None): specifies the index of the server
|
|
3822
|
+
that we want to use.
|
|
3823
|
+
Default is read from the configuration.
|
|
3824
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3825
|
+
request; this effectively ignores the authentication
|
|
3826
|
+
in the spec for a single request.
|
|
3827
|
+
Default is None
|
|
3828
|
+
async_req (bool): execute request asynchronously
|
|
3829
|
+
|
|
3830
|
+
Returns:
|
|
3831
|
+
{str: (bool, date, datetime, dict, float, int, list, str, none_type)}
|
|
3832
|
+
If the method is called asynchronously, returns the request
|
|
3833
|
+
thread.
|
|
3834
|
+
"""
|
|
3835
|
+
kwargs['async_req'] = kwargs.get(
|
|
3836
|
+
'async_req', False
|
|
3837
|
+
)
|
|
3838
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3839
|
+
'_return_http_data_only', True
|
|
3840
|
+
)
|
|
3841
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3842
|
+
'_preload_content', True
|
|
3843
|
+
)
|
|
3844
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3845
|
+
'_request_timeout', None
|
|
3846
|
+
)
|
|
3847
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3848
|
+
'_check_input_type', True
|
|
3849
|
+
)
|
|
3850
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3851
|
+
'_check_return_type', True
|
|
3852
|
+
)
|
|
3853
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3854
|
+
'_spec_property_naming', False
|
|
3855
|
+
)
|
|
3856
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3857
|
+
'_content_type')
|
|
3858
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3859
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3860
|
+
return self.search_endpoint.call_with_http_info(**kwargs)
|
|
3861
|
+
|
|
3862
|
+
def set_acl(
|
|
3863
|
+
self,
|
|
3864
|
+
data_source_id,
|
|
3865
|
+
document_id,
|
|
3866
|
+
access_control_list,
|
|
3867
|
+
**kwargs
|
|
3868
|
+
):
|
|
3869
|
+
"""Set Acl # noqa: E501
|
|
3870
|
+
|
|
3871
|
+
Update access control list (ACL) for a document. Args: - data_source_id (str): The ID of the data source which the document resides in. - document_id (str): The ID of the document for which to set the ACL. - acl (ACL): An access control list. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - str: \"OK\" (200) # noqa: E501
|
|
3872
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3873
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3874
|
+
|
|
3875
|
+
>>> thread = api.set_acl(data_source_id, document_id, access_control_list, async_req=True)
|
|
3876
|
+
>>> result = thread.get()
|
|
3877
|
+
|
|
3878
|
+
Args:
|
|
3879
|
+
data_source_id (str):
|
|
3880
|
+
document_id (str):
|
|
3881
|
+
access_control_list (AccessControlList):
|
|
3882
|
+
|
|
3883
|
+
Keyword Args:
|
|
3884
|
+
recursively (bool): [optional] if omitted the server will use the default value of True
|
|
3885
|
+
_return_http_data_only (bool): response data without head status
|
|
3886
|
+
code and headers. Default is True.
|
|
3887
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3888
|
+
will be returned without reading/decoding response data.
|
|
3889
|
+
Default is True.
|
|
3890
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3891
|
+
one number provided, it will be total request timeout. It can also
|
|
3892
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3893
|
+
Default is None.
|
|
3894
|
+
_check_input_type (bool): specifies if type checking
|
|
3895
|
+
should be done one the data sent to the server.
|
|
3896
|
+
Default is True.
|
|
3897
|
+
_check_return_type (bool): specifies if type checking
|
|
3898
|
+
should be done one the data received from the server.
|
|
3899
|
+
Default is True.
|
|
3900
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3901
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3902
|
+
False if the variable names in the input data
|
|
3903
|
+
are pythonic names, e.g. snake case (default)
|
|
3904
|
+
_content_type (str/None): force body content-type.
|
|
3905
|
+
Default is None and content-type will be predicted by allowed
|
|
3906
|
+
content-types and body.
|
|
3907
|
+
_host_index (int/None): specifies the index of the server
|
|
3908
|
+
that we want to use.
|
|
3909
|
+
Default is read from the configuration.
|
|
3910
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3911
|
+
request; this effectively ignores the authentication
|
|
3912
|
+
in the spec for a single request.
|
|
3913
|
+
Default is None
|
|
3914
|
+
async_req (bool): execute request asynchronously
|
|
3915
|
+
|
|
3916
|
+
Returns:
|
|
3917
|
+
str
|
|
3918
|
+
If the method is called asynchronously, returns the request
|
|
3919
|
+
thread.
|
|
3920
|
+
"""
|
|
3921
|
+
kwargs['async_req'] = kwargs.get(
|
|
3922
|
+
'async_req', False
|
|
3923
|
+
)
|
|
3924
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3925
|
+
'_return_http_data_only', True
|
|
3926
|
+
)
|
|
3927
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3928
|
+
'_preload_content', True
|
|
3929
|
+
)
|
|
3930
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3931
|
+
'_request_timeout', None
|
|
3932
|
+
)
|
|
3933
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3934
|
+
'_check_input_type', True
|
|
3935
|
+
)
|
|
3936
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3937
|
+
'_check_return_type', True
|
|
3938
|
+
)
|
|
3939
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3940
|
+
'_spec_property_naming', False
|
|
3941
|
+
)
|
|
3942
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3943
|
+
'_content_type')
|
|
3944
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3945
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3946
|
+
kwargs['data_source_id'] = \
|
|
3947
|
+
data_source_id
|
|
3948
|
+
kwargs['document_id'] = \
|
|
3949
|
+
document_id
|
|
3950
|
+
kwargs['access_control_list'] = \
|
|
3951
|
+
access_control_list
|
|
3952
|
+
return self.set_acl_endpoint.call_with_http_info(**kwargs)
|
|
3953
|
+
|
|
3954
|
+
def token_create(
|
|
3955
|
+
self,
|
|
3956
|
+
**kwargs
|
|
3957
|
+
):
|
|
3958
|
+
"""New Personal Access Token # noqa: E501
|
|
3959
|
+
|
|
3960
|
+
Create a Personal Access Token (PAT). This endpoint creates a PAT token for the currently logged in user, stores it in the database and returns it to the user. Args: - scope (WRITE | READ | NONE): Access level for the PAT. - time_to_live (int): Optional parameter specifying the lifespan of the PAT in seconds. Default lifespan is 30 days. Returns: - str: The generated PAT token # noqa: E501
|
|
3961
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3962
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3963
|
+
|
|
3964
|
+
>>> thread = api.token_create(async_req=True)
|
|
3965
|
+
>>> result = thread.get()
|
|
3966
|
+
|
|
3967
|
+
|
|
3968
|
+
Keyword Args:
|
|
3969
|
+
scope (bool, date, datetime, dict, float, int, list, str, none_type): [optional]
|
|
3970
|
+
time_to_live (int): [optional] if omitted the server will use the default value of 2592000
|
|
3971
|
+
_return_http_data_only (bool): response data without head status
|
|
3972
|
+
code and headers. Default is True.
|
|
3973
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3974
|
+
will be returned without reading/decoding response data.
|
|
3975
|
+
Default is True.
|
|
3976
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3977
|
+
one number provided, it will be total request timeout. It can also
|
|
3978
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3979
|
+
Default is None.
|
|
3980
|
+
_check_input_type (bool): specifies if type checking
|
|
3981
|
+
should be done one the data sent to the server.
|
|
3982
|
+
Default is True.
|
|
3983
|
+
_check_return_type (bool): specifies if type checking
|
|
3984
|
+
should be done one the data received from the server.
|
|
3985
|
+
Default is True.
|
|
3986
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3987
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3988
|
+
False if the variable names in the input data
|
|
3989
|
+
are pythonic names, e.g. snake case (default)
|
|
3990
|
+
_content_type (str/None): force body content-type.
|
|
3991
|
+
Default is None and content-type will be predicted by allowed
|
|
3992
|
+
content-types and body.
|
|
3993
|
+
_host_index (int/None): specifies the index of the server
|
|
3994
|
+
that we want to use.
|
|
3995
|
+
Default is read from the configuration.
|
|
3996
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3997
|
+
request; this effectively ignores the authentication
|
|
3998
|
+
in the spec for a single request.
|
|
3999
|
+
Default is None
|
|
4000
|
+
async_req (bool): execute request asynchronously
|
|
4001
|
+
|
|
4002
|
+
Returns:
|
|
4003
|
+
str
|
|
4004
|
+
If the method is called asynchronously, returns the request
|
|
4005
|
+
thread.
|
|
4006
|
+
"""
|
|
4007
|
+
kwargs['async_req'] = kwargs.get(
|
|
4008
|
+
'async_req', False
|
|
4009
|
+
)
|
|
4010
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4011
|
+
'_return_http_data_only', True
|
|
4012
|
+
)
|
|
4013
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4014
|
+
'_preload_content', True
|
|
4015
|
+
)
|
|
4016
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4017
|
+
'_request_timeout', None
|
|
4018
|
+
)
|
|
4019
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4020
|
+
'_check_input_type', True
|
|
4021
|
+
)
|
|
4022
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4023
|
+
'_check_return_type', True
|
|
4024
|
+
)
|
|
4025
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4026
|
+
'_spec_property_naming', False
|
|
4027
|
+
)
|
|
4028
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4029
|
+
'_content_type')
|
|
4030
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4031
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4032
|
+
return self.token_create_endpoint.call_with_http_info(**kwargs)
|
|
4033
|
+
|
|
4034
|
+
def token_delete(
|
|
4035
|
+
self,
|
|
4036
|
+
token_id,
|
|
4037
|
+
**kwargs
|
|
4038
|
+
):
|
|
4039
|
+
"""Revoke Personal Access Token # noqa: E501
|
|
4040
|
+
|
|
4041
|
+
Revoke a Personal Access Token (PAT). This endpoint revokes a PAT token so that it is invalid and can no longer be used to gain access. Args: token_id (str): The ID of the token to be revoked. Returns: str: A string with the message \"OK\" when the token has been revoked. # noqa: E501
|
|
4042
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4043
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4044
|
+
|
|
4045
|
+
>>> thread = api.token_delete(token_id, async_req=True)
|
|
4046
|
+
>>> result = thread.get()
|
|
4047
|
+
|
|
4048
|
+
Args:
|
|
4049
|
+
token_id (str):
|
|
4050
|
+
|
|
4051
|
+
Keyword Args:
|
|
4052
|
+
_return_http_data_only (bool): response data without head status
|
|
4053
|
+
code and headers. Default is True.
|
|
4054
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4055
|
+
will be returned without reading/decoding response data.
|
|
4056
|
+
Default is True.
|
|
4057
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4058
|
+
one number provided, it will be total request timeout. It can also
|
|
4059
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4060
|
+
Default is None.
|
|
4061
|
+
_check_input_type (bool): specifies if type checking
|
|
4062
|
+
should be done one the data sent to the server.
|
|
4063
|
+
Default is True.
|
|
4064
|
+
_check_return_type (bool): specifies if type checking
|
|
4065
|
+
should be done one the data received from the server.
|
|
4066
|
+
Default is True.
|
|
4067
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4068
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4069
|
+
False if the variable names in the input data
|
|
4070
|
+
are pythonic names, e.g. snake case (default)
|
|
4071
|
+
_content_type (str/None): force body content-type.
|
|
4072
|
+
Default is None and content-type will be predicted by allowed
|
|
4073
|
+
content-types and body.
|
|
4074
|
+
_host_index (int/None): specifies the index of the server
|
|
4075
|
+
that we want to use.
|
|
4076
|
+
Default is read from the configuration.
|
|
4077
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4078
|
+
request; this effectively ignores the authentication
|
|
4079
|
+
in the spec for a single request.
|
|
4080
|
+
Default is None
|
|
4081
|
+
async_req (bool): execute request asynchronously
|
|
4082
|
+
|
|
4083
|
+
Returns:
|
|
4084
|
+
str
|
|
4085
|
+
If the method is called asynchronously, returns the request
|
|
4086
|
+
thread.
|
|
4087
|
+
"""
|
|
4088
|
+
kwargs['async_req'] = kwargs.get(
|
|
4089
|
+
'async_req', False
|
|
4090
|
+
)
|
|
4091
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4092
|
+
'_return_http_data_only', True
|
|
4093
|
+
)
|
|
4094
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4095
|
+
'_preload_content', True
|
|
4096
|
+
)
|
|
4097
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4098
|
+
'_request_timeout', None
|
|
4099
|
+
)
|
|
4100
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4101
|
+
'_check_input_type', True
|
|
4102
|
+
)
|
|
4103
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4104
|
+
'_check_return_type', True
|
|
4105
|
+
)
|
|
4106
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4107
|
+
'_spec_property_naming', False
|
|
4108
|
+
)
|
|
4109
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4110
|
+
'_content_type')
|
|
4111
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4112
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4113
|
+
kwargs['token_id'] = \
|
|
4114
|
+
token_id
|
|
4115
|
+
return self.token_delete_endpoint.call_with_http_info(**kwargs)
|
|
4116
|
+
|
|
4117
|
+
def token_list_all(
|
|
4118
|
+
self,
|
|
4119
|
+
**kwargs
|
|
4120
|
+
):
|
|
4121
|
+
"""List All Pats # noqa: E501
|
|
4122
|
+
|
|
4123
|
+
Get All Personal Access Tokens for the Current User. Get a list of all personal access tokens (PATs) for the currently logged in user. Args: user (User): The authenticated user accessing the endpoint. Returns: list: A list of all personal access tokens for the currently logged in user. # noqa: E501
|
|
4124
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4125
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4126
|
+
|
|
4127
|
+
>>> thread = api.token_list_all(async_req=True)
|
|
4128
|
+
>>> result = thread.get()
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
Keyword Args:
|
|
4132
|
+
_return_http_data_only (bool): response data without head status
|
|
4133
|
+
code and headers. Default is True.
|
|
4134
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4135
|
+
will be returned without reading/decoding response data.
|
|
4136
|
+
Default is True.
|
|
4137
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4138
|
+
one number provided, it will be total request timeout. It can also
|
|
4139
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4140
|
+
Default is None.
|
|
4141
|
+
_check_input_type (bool): specifies if type checking
|
|
4142
|
+
should be done one the data sent to the server.
|
|
4143
|
+
Default is True.
|
|
4144
|
+
_check_return_type (bool): specifies if type checking
|
|
4145
|
+
should be done one the data received from the server.
|
|
4146
|
+
Default is True.
|
|
4147
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4148
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4149
|
+
False if the variable names in the input data
|
|
4150
|
+
are pythonic names, e.g. snake case (default)
|
|
4151
|
+
_content_type (str/None): force body content-type.
|
|
4152
|
+
Default is None and content-type will be predicted by allowed
|
|
4153
|
+
content-types and body.
|
|
4154
|
+
_host_index (int/None): specifies the index of the server
|
|
4155
|
+
that we want to use.
|
|
4156
|
+
Default is read from the configuration.
|
|
4157
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4158
|
+
request; this effectively ignores the authentication
|
|
4159
|
+
in the spec for a single request.
|
|
4160
|
+
Default is None
|
|
4161
|
+
async_req (bool): execute request asynchronously
|
|
4162
|
+
|
|
4163
|
+
Returns:
|
|
4164
|
+
[PATData]
|
|
4165
|
+
If the method is called asynchronously, returns the request
|
|
4166
|
+
thread.
|
|
4167
|
+
"""
|
|
4168
|
+
kwargs['async_req'] = kwargs.get(
|
|
4169
|
+
'async_req', False
|
|
4170
|
+
)
|
|
4171
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4172
|
+
'_return_http_data_only', True
|
|
4173
|
+
)
|
|
4174
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4175
|
+
'_preload_content', True
|
|
4176
|
+
)
|
|
4177
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4178
|
+
'_request_timeout', None
|
|
4179
|
+
)
|
|
4180
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4181
|
+
'_check_input_type', True
|
|
4182
|
+
)
|
|
4183
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4184
|
+
'_check_return_type', True
|
|
4185
|
+
)
|
|
4186
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4187
|
+
'_spec_property_naming', False
|
|
4188
|
+
)
|
|
4189
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4190
|
+
'_content_type')
|
|
4191
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4192
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4193
|
+
return self.token_list_all_endpoint.call_with_http_info(**kwargs)
|
|
4194
|
+
|
|
4195
|
+
def validate_entity(
|
|
4196
|
+
self,
|
|
4197
|
+
entity,
|
|
4198
|
+
**kwargs
|
|
4199
|
+
):
|
|
4200
|
+
"""Validate # noqa: E501
|
|
4201
|
+
|
|
4202
|
+
Validate an entity according to its blueprint. This endpoint compares the entity to the specifications of its blueprint. The entity's blueprint is specified as the 'type' parameter. The entity is required to have all attributes that are specified as required in the blueprint, and they must be on the correct format. This endpoint returns a detailed error messages and status code 422 if the entity is invalid. Args: - entity (Entity): a dict object with \"type\" specified. Returns: - str: \"OK\" (200) # noqa: E501
|
|
4203
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4204
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4205
|
+
|
|
4206
|
+
>>> thread = api.validate_entity(entity, async_req=True)
|
|
4207
|
+
>>> result = thread.get()
|
|
4208
|
+
|
|
4209
|
+
Args:
|
|
4210
|
+
entity (Entity):
|
|
4211
|
+
|
|
4212
|
+
Keyword Args:
|
|
4213
|
+
as_type (str): [optional]
|
|
4214
|
+
_return_http_data_only (bool): response data without head status
|
|
4215
|
+
code and headers. Default is True.
|
|
4216
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4217
|
+
will be returned without reading/decoding response data.
|
|
4218
|
+
Default is True.
|
|
4219
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4220
|
+
one number provided, it will be total request timeout. It can also
|
|
4221
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4222
|
+
Default is None.
|
|
4223
|
+
_check_input_type (bool): specifies if type checking
|
|
4224
|
+
should be done one the data sent to the server.
|
|
4225
|
+
Default is True.
|
|
4226
|
+
_check_return_type (bool): specifies if type checking
|
|
4227
|
+
should be done one the data received from the server.
|
|
4228
|
+
Default is True.
|
|
4229
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4230
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4231
|
+
False if the variable names in the input data
|
|
4232
|
+
are pythonic names, e.g. snake case (default)
|
|
4233
|
+
_content_type (str/None): force body content-type.
|
|
4234
|
+
Default is None and content-type will be predicted by allowed
|
|
4235
|
+
content-types and body.
|
|
4236
|
+
_host_index (int/None): specifies the index of the server
|
|
4237
|
+
that we want to use.
|
|
4238
|
+
Default is read from the configuration.
|
|
4239
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4240
|
+
request; this effectively ignores the authentication
|
|
4241
|
+
in the spec for a single request.
|
|
4242
|
+
Default is None
|
|
4243
|
+
async_req (bool): execute request asynchronously
|
|
4244
|
+
|
|
4245
|
+
Returns:
|
|
4246
|
+
bool, date, datetime, dict, float, int, list, str, none_type
|
|
4247
|
+
If the method is called asynchronously, returns the request
|
|
4248
|
+
thread.
|
|
4249
|
+
"""
|
|
4250
|
+
kwargs['async_req'] = kwargs.get(
|
|
4251
|
+
'async_req', False
|
|
4252
|
+
)
|
|
4253
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4254
|
+
'_return_http_data_only', True
|
|
4255
|
+
)
|
|
4256
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4257
|
+
'_preload_content', True
|
|
4258
|
+
)
|
|
4259
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4260
|
+
'_request_timeout', None
|
|
4261
|
+
)
|
|
4262
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4263
|
+
'_check_input_type', True
|
|
4264
|
+
)
|
|
4265
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4266
|
+
'_check_return_type', True
|
|
4267
|
+
)
|
|
4268
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4269
|
+
'_spec_property_naming', False
|
|
4270
|
+
)
|
|
4271
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4272
|
+
'_content_type')
|
|
4273
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4274
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4275
|
+
kwargs['entity'] = \
|
|
4276
|
+
entity
|
|
4277
|
+
return self.validate_entity_endpoint.call_with_http_info(**kwargs)
|
|
4278
|
+
|
|
4279
|
+
def validate_existing_entity(
|
|
4280
|
+
self,
|
|
4281
|
+
address,
|
|
4282
|
+
**kwargs
|
|
4283
|
+
):
|
|
4284
|
+
"""Validate Existing # noqa: E501
|
|
4285
|
+
|
|
4286
|
+
Validate an entity stored in the database according to its blueprint . This endpoint compares the entity to the specifications of its blueprint. The entity's blueprint is specified as the 'type' parameter. The entity is required to have all attributes that are specified as required in the blueprint, and they must be on the correct format. This endpoint returns a detailed error messages and status code 422 if the entity is invalid. Args: - address (str): address path to the entity that is to be validated. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - str: \"OK\" (200) # noqa: E501
|
|
4287
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4288
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4289
|
+
|
|
4290
|
+
>>> thread = api.validate_existing_entity(address, async_req=True)
|
|
4291
|
+
>>> result = thread.get()
|
|
4292
|
+
|
|
4293
|
+
Args:
|
|
4294
|
+
address (str):
|
|
4295
|
+
|
|
4296
|
+
Keyword Args:
|
|
4297
|
+
_return_http_data_only (bool): response data without head status
|
|
4298
|
+
code and headers. Default is True.
|
|
4299
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4300
|
+
will be returned without reading/decoding response data.
|
|
4301
|
+
Default is True.
|
|
4302
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4303
|
+
one number provided, it will be total request timeout. It can also
|
|
4304
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4305
|
+
Default is None.
|
|
4306
|
+
_check_input_type (bool): specifies if type checking
|
|
4307
|
+
should be done one the data sent to the server.
|
|
4308
|
+
Default is True.
|
|
4309
|
+
_check_return_type (bool): specifies if type checking
|
|
4310
|
+
should be done one the data received from the server.
|
|
4311
|
+
Default is True.
|
|
4312
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4313
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4314
|
+
False if the variable names in the input data
|
|
4315
|
+
are pythonic names, e.g. snake case (default)
|
|
4316
|
+
_content_type (str/None): force body content-type.
|
|
4317
|
+
Default is None and content-type will be predicted by allowed
|
|
4318
|
+
content-types and body.
|
|
4319
|
+
_host_index (int/None): specifies the index of the server
|
|
4320
|
+
that we want to use.
|
|
4321
|
+
Default is read from the configuration.
|
|
4322
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4323
|
+
request; this effectively ignores the authentication
|
|
4324
|
+
in the spec for a single request.
|
|
4325
|
+
Default is None
|
|
4326
|
+
async_req (bool): execute request asynchronously
|
|
4327
|
+
|
|
4328
|
+
Returns:
|
|
4329
|
+
bool, date, datetime, dict, float, int, list, str, none_type
|
|
4330
|
+
If the method is called asynchronously, returns the request
|
|
4331
|
+
thread.
|
|
4332
|
+
"""
|
|
4333
|
+
kwargs['async_req'] = kwargs.get(
|
|
4334
|
+
'async_req', False
|
|
4335
|
+
)
|
|
4336
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4337
|
+
'_return_http_data_only', True
|
|
4338
|
+
)
|
|
4339
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4340
|
+
'_preload_content', True
|
|
4341
|
+
)
|
|
4342
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4343
|
+
'_request_timeout', None
|
|
4344
|
+
)
|
|
4345
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4346
|
+
'_check_input_type', True
|
|
4347
|
+
)
|
|
4348
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4349
|
+
'_check_return_type', True
|
|
4350
|
+
)
|
|
4351
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4352
|
+
'_spec_property_naming', False
|
|
4353
|
+
)
|
|
4354
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4355
|
+
'_content_type')
|
|
4356
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4357
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4358
|
+
kwargs['address'] = \
|
|
4359
|
+
address
|
|
4360
|
+
return self.validate_existing_entity_endpoint.call_with_http_info(**kwargs)
|
|
4361
|
+
|
|
4362
|
+
def whoami(
|
|
4363
|
+
self,
|
|
4364
|
+
**kwargs
|
|
4365
|
+
):
|
|
4366
|
+
"""Get Information On Authenticated User # noqa: E501
|
|
4367
|
+
|
|
4368
|
+
Get information about the user who sent the request. If no user is authenticated, a default \"nologin\" user is returned. This endpoint always responds with a status code of 200 (OK). Args: - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key. Returns: - dict: A dictionary containing information about the user who sent the request. # noqa: E501
|
|
4369
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4370
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4371
|
+
|
|
4372
|
+
>>> thread = api.whoami(async_req=True)
|
|
4373
|
+
>>> result = thread.get()
|
|
4374
|
+
|
|
4375
|
+
|
|
4376
|
+
Keyword Args:
|
|
4377
|
+
_return_http_data_only (bool): response data without head status
|
|
4378
|
+
code and headers. Default is True.
|
|
4379
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4380
|
+
will be returned without reading/decoding response data.
|
|
4381
|
+
Default is True.
|
|
4382
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4383
|
+
one number provided, it will be total request timeout. It can also
|
|
4384
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4385
|
+
Default is None.
|
|
4386
|
+
_check_input_type (bool): specifies if type checking
|
|
4387
|
+
should be done one the data sent to the server.
|
|
4388
|
+
Default is True.
|
|
4389
|
+
_check_return_type (bool): specifies if type checking
|
|
4390
|
+
should be done one the data received from the server.
|
|
4391
|
+
Default is True.
|
|
4392
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4393
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4394
|
+
False if the variable names in the input data
|
|
4395
|
+
are pythonic names, e.g. snake case (default)
|
|
4396
|
+
_content_type (str/None): force body content-type.
|
|
4397
|
+
Default is None and content-type will be predicted by allowed
|
|
4398
|
+
content-types and body.
|
|
4399
|
+
_host_index (int/None): specifies the index of the server
|
|
4400
|
+
that we want to use.
|
|
4401
|
+
Default is read from the configuration.
|
|
4402
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4403
|
+
request; this effectively ignores the authentication
|
|
4404
|
+
in the spec for a single request.
|
|
4405
|
+
Default is None
|
|
4406
|
+
async_req (bool): execute request asynchronously
|
|
4407
|
+
|
|
4408
|
+
Returns:
|
|
4409
|
+
bool, date, datetime, dict, float, int, list, str, none_type
|
|
4410
|
+
If the method is called asynchronously, returns the request
|
|
4411
|
+
thread.
|
|
4412
|
+
"""
|
|
4413
|
+
kwargs['async_req'] = kwargs.get(
|
|
4414
|
+
'async_req', False
|
|
4415
|
+
)
|
|
4416
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4417
|
+
'_return_http_data_only', True
|
|
4418
|
+
)
|
|
4419
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4420
|
+
'_preload_content', True
|
|
4421
|
+
)
|
|
4422
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4423
|
+
'_request_timeout', None
|
|
4424
|
+
)
|
|
4425
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4426
|
+
'_check_input_type', True
|
|
4427
|
+
)
|
|
4428
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4429
|
+
'_check_return_type', True
|
|
4430
|
+
)
|
|
4431
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4432
|
+
'_spec_property_naming', False
|
|
4433
|
+
)
|
|
4434
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4435
|
+
'_content_type')
|
|
4436
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4437
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4438
|
+
return self.whoami_endpoint.call_with_http_info(**kwargs)
|
|
4439
|
+
|