@cosmotech/api-ts 3.0.15-dev → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +922 -3333
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +454 -1841
- package/dist/api.js +2701 -5078
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 2.4.11
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -259,78 +259,12 @@ export interface Dataset {
|
|
|
259
259
|
* @memberof Dataset
|
|
260
260
|
*/
|
|
261
261
|
'ownerId'?: string;
|
|
262
|
-
/**
|
|
263
|
-
* the name of the owner
|
|
264
|
-
* @type {string}
|
|
265
|
-
* @memberof Dataset
|
|
266
|
-
*/
|
|
267
|
-
'ownerName'?: string;
|
|
268
262
|
/**
|
|
269
263
|
* the Organization Id related to this Dataset
|
|
270
264
|
* @type {string}
|
|
271
265
|
* @memberof Dataset
|
|
272
266
|
*/
|
|
273
267
|
'organizationId'?: string;
|
|
274
|
-
/**
|
|
275
|
-
* the Dataset id which is the parent of this Dataset
|
|
276
|
-
* @type {string}
|
|
277
|
-
* @memberof Dataset
|
|
278
|
-
*/
|
|
279
|
-
'parentId'?: string;
|
|
280
|
-
/**
|
|
281
|
-
* the twin graph id
|
|
282
|
-
* @type {string}
|
|
283
|
-
* @memberof Dataset
|
|
284
|
-
*/
|
|
285
|
-
'twingraphId'?: string;
|
|
286
|
-
/**
|
|
287
|
-
* is this the main dataset
|
|
288
|
-
* @type {boolean}
|
|
289
|
-
* @memberof Dataset
|
|
290
|
-
*/
|
|
291
|
-
'main'?: boolean;
|
|
292
|
-
/**
|
|
293
|
-
* the Dataset creation date
|
|
294
|
-
* @type {number}
|
|
295
|
-
* @memberof Dataset
|
|
296
|
-
*/
|
|
297
|
-
'creationDate'?: number;
|
|
298
|
-
/**
|
|
299
|
-
* the last time a refresh was done
|
|
300
|
-
* @type {number}
|
|
301
|
-
* @memberof Dataset
|
|
302
|
-
*/
|
|
303
|
-
'refreshDate'?: number;
|
|
304
|
-
/**
|
|
305
|
-
*
|
|
306
|
-
* @type {DatasetSourceType}
|
|
307
|
-
* @memberof Dataset
|
|
308
|
-
*/
|
|
309
|
-
'sourceType'?: DatasetSourceType;
|
|
310
|
-
/**
|
|
311
|
-
*
|
|
312
|
-
* @type {SourceInfo}
|
|
313
|
-
* @memberof Dataset
|
|
314
|
-
*/
|
|
315
|
-
'source'?: SourceInfo;
|
|
316
|
-
/**
|
|
317
|
-
* the Dataset ingestion status
|
|
318
|
-
* @type {string}
|
|
319
|
-
* @memberof Dataset
|
|
320
|
-
*/
|
|
321
|
-
'ingestionStatus'?: DatasetIngestionStatusEnum;
|
|
322
|
-
/**
|
|
323
|
-
* the twincache data status
|
|
324
|
-
* @type {string}
|
|
325
|
-
* @memberof Dataset
|
|
326
|
-
*/
|
|
327
|
-
'twincacheStatus'?: DatasetTwincacheStatusEnum;
|
|
328
|
-
/**
|
|
329
|
-
* the list of queries
|
|
330
|
-
* @type {Array<string>}
|
|
331
|
-
* @memberof Dataset
|
|
332
|
-
*/
|
|
333
|
-
'queries'?: Array<string>;
|
|
334
268
|
/**
|
|
335
269
|
* the list of tags
|
|
336
270
|
* @type {Array<string>}
|
|
@@ -361,43 +295,6 @@ export interface Dataset {
|
|
|
361
295
|
* @memberof Dataset
|
|
362
296
|
*/
|
|
363
297
|
'compatibility'?: Array<DatasetCompatibility>;
|
|
364
|
-
/**
|
|
365
|
-
*
|
|
366
|
-
* @type {DatasetSecurity}
|
|
367
|
-
* @memberof Dataset
|
|
368
|
-
*/
|
|
369
|
-
'security'?: DatasetSecurity;
|
|
370
|
-
}
|
|
371
|
-
export declare const DatasetIngestionStatusEnum: {
|
|
372
|
-
readonly None: "NONE";
|
|
373
|
-
readonly Pending: "PENDING";
|
|
374
|
-
readonly Error: "ERROR";
|
|
375
|
-
readonly Success: "SUCCESS";
|
|
376
|
-
};
|
|
377
|
-
export declare type DatasetIngestionStatusEnum = typeof DatasetIngestionStatusEnum[keyof typeof DatasetIngestionStatusEnum];
|
|
378
|
-
export declare const DatasetTwincacheStatusEnum: {
|
|
379
|
-
readonly Empty: "EMPTY";
|
|
380
|
-
readonly Full: "FULL";
|
|
381
|
-
};
|
|
382
|
-
export declare type DatasetTwincacheStatusEnum = typeof DatasetTwincacheStatusEnum[keyof typeof DatasetTwincacheStatusEnum];
|
|
383
|
-
/**
|
|
384
|
-
* a Dataset access control item
|
|
385
|
-
* @export
|
|
386
|
-
* @interface DatasetAccessControl
|
|
387
|
-
*/
|
|
388
|
-
export interface DatasetAccessControl {
|
|
389
|
-
/**
|
|
390
|
-
* the identity id
|
|
391
|
-
* @type {string}
|
|
392
|
-
* @memberof DatasetAccessControl
|
|
393
|
-
*/
|
|
394
|
-
'id': string;
|
|
395
|
-
/**
|
|
396
|
-
* a role
|
|
397
|
-
* @type {string}
|
|
398
|
-
* @memberof DatasetAccessControl
|
|
399
|
-
*/
|
|
400
|
-
'role': string;
|
|
401
298
|
}
|
|
402
299
|
/**
|
|
403
300
|
* a Dataset compatibility constraint to a Solution version open range
|
|
@@ -484,19 +381,6 @@ export interface DatasetCopyParameters {
|
|
|
484
381
|
[key: string]: object;
|
|
485
382
|
};
|
|
486
383
|
}
|
|
487
|
-
/**
|
|
488
|
-
* the Dataset Role
|
|
489
|
-
* @export
|
|
490
|
-
* @interface DatasetRole
|
|
491
|
-
*/
|
|
492
|
-
export interface DatasetRole {
|
|
493
|
-
/**
|
|
494
|
-
* the Dataset Role
|
|
495
|
-
* @type {string}
|
|
496
|
-
* @memberof DatasetRole
|
|
497
|
-
*/
|
|
498
|
-
'role': string;
|
|
499
|
-
}
|
|
500
384
|
/**
|
|
501
385
|
* the search options
|
|
502
386
|
* @export
|
|
@@ -510,89 +394,6 @@ export interface DatasetSearch {
|
|
|
510
394
|
*/
|
|
511
395
|
'datasetTags': Array<string>;
|
|
512
396
|
}
|
|
513
|
-
/**
|
|
514
|
-
* the dataset security information
|
|
515
|
-
* @export
|
|
516
|
-
* @interface DatasetSecurity
|
|
517
|
-
*/
|
|
518
|
-
export interface DatasetSecurity {
|
|
519
|
-
/**
|
|
520
|
-
* the role by default
|
|
521
|
-
* @type {string}
|
|
522
|
-
* @memberof DatasetSecurity
|
|
523
|
-
*/
|
|
524
|
-
'default': string;
|
|
525
|
-
/**
|
|
526
|
-
* the list which can access this Dataset with detailed access control information
|
|
527
|
-
* @type {Array<DatasetAccessControl>}
|
|
528
|
-
* @memberof DatasetSecurity
|
|
529
|
-
*/
|
|
530
|
-
'accessControlList': Array<DatasetAccessControl>;
|
|
531
|
-
}
|
|
532
|
-
/**
|
|
533
|
-
* the Dataset Source Type
|
|
534
|
-
* @export
|
|
535
|
-
* @enum {string}
|
|
536
|
-
*/
|
|
537
|
-
export declare const DatasetSourceType: {
|
|
538
|
-
readonly Adt: "ADT";
|
|
539
|
-
readonly AzureStorage: "AzureStorage";
|
|
540
|
-
readonly File: "File";
|
|
541
|
-
readonly None: "None";
|
|
542
|
-
readonly Twincache: "Twincache";
|
|
543
|
-
};
|
|
544
|
-
export declare type DatasetSourceType = typeof DatasetSourceType[keyof typeof DatasetSourceType];
|
|
545
|
-
/**
|
|
546
|
-
* a twin graph hash
|
|
547
|
-
* @export
|
|
548
|
-
* @interface DatasetTwinGraphHash
|
|
549
|
-
*/
|
|
550
|
-
export interface DatasetTwinGraphHash {
|
|
551
|
-
/**
|
|
552
|
-
* the hash of the graph
|
|
553
|
-
* @type {string}
|
|
554
|
-
* @memberof DatasetTwinGraphHash
|
|
555
|
-
*/
|
|
556
|
-
'hash'?: string;
|
|
557
|
-
}
|
|
558
|
-
/**
|
|
559
|
-
* a twin graph query in cypher language
|
|
560
|
-
* @export
|
|
561
|
-
* @interface DatasetTwinGraphInfo
|
|
562
|
-
*/
|
|
563
|
-
export interface DatasetTwinGraphInfo {
|
|
564
|
-
/**
|
|
565
|
-
* the import job id
|
|
566
|
-
* @type {string}
|
|
567
|
-
* @memberof DatasetTwinGraphInfo
|
|
568
|
-
*/
|
|
569
|
-
'jobId'?: string;
|
|
570
|
-
/**
|
|
571
|
-
* the Dataset id
|
|
572
|
-
* @type {string}
|
|
573
|
-
* @memberof DatasetTwinGraphInfo
|
|
574
|
-
*/
|
|
575
|
-
'datasetId'?: string;
|
|
576
|
-
/**
|
|
577
|
-
* Twingraph status
|
|
578
|
-
* @type {string}
|
|
579
|
-
* @memberof DatasetTwinGraphInfo
|
|
580
|
-
*/
|
|
581
|
-
'status'?: string;
|
|
582
|
-
}
|
|
583
|
-
/**
|
|
584
|
-
* a twin graph query in cypher language
|
|
585
|
-
* @export
|
|
586
|
-
* @interface DatasetTwinGraphQuery
|
|
587
|
-
*/
|
|
588
|
-
export interface DatasetTwinGraphQuery {
|
|
589
|
-
/**
|
|
590
|
-
* the query in cypher language
|
|
591
|
-
* @type {string}
|
|
592
|
-
* @memberof DatasetTwinGraphQuery
|
|
593
|
-
*/
|
|
594
|
-
'query': string;
|
|
595
|
-
}
|
|
596
397
|
/**
|
|
597
398
|
* Configuration of scenario runs deletion automatic mecanism
|
|
598
399
|
* @export
|
|
@@ -618,44 +419,6 @@ export interface DeleteHistoricalData {
|
|
|
618
419
|
*/
|
|
619
420
|
'timeOut'?: number;
|
|
620
421
|
}
|
|
621
|
-
/**
|
|
622
|
-
*
|
|
623
|
-
* @export
|
|
624
|
-
* @interface FileUploadMetadata
|
|
625
|
-
*/
|
|
626
|
-
export interface FileUploadMetadata {
|
|
627
|
-
/**
|
|
628
|
-
*
|
|
629
|
-
* @type {string}
|
|
630
|
-
* @memberof FileUploadMetadata
|
|
631
|
-
*/
|
|
632
|
-
'name'?: string;
|
|
633
|
-
/**
|
|
634
|
-
*
|
|
635
|
-
* @type {number}
|
|
636
|
-
* @memberof FileUploadMetadata
|
|
637
|
-
*/
|
|
638
|
-
'size'?: number;
|
|
639
|
-
}
|
|
640
|
-
/**
|
|
641
|
-
* files read on upload
|
|
642
|
-
* @export
|
|
643
|
-
* @interface FileUploadValidation
|
|
644
|
-
*/
|
|
645
|
-
export interface FileUploadValidation {
|
|
646
|
-
/**
|
|
647
|
-
* list of filename found on nodes folder
|
|
648
|
-
* @type {Array<FileUploadMetadata>}
|
|
649
|
-
* @memberof FileUploadValidation
|
|
650
|
-
*/
|
|
651
|
-
'nodes'?: Array<FileUploadMetadata>;
|
|
652
|
-
/**
|
|
653
|
-
* list of filename found on edges folder
|
|
654
|
-
* @type {Array<FileUploadMetadata>}
|
|
655
|
-
* @memberof FileUploadValidation
|
|
656
|
-
*/
|
|
657
|
-
'edges'?: Array<FileUploadMetadata>;
|
|
658
|
-
}
|
|
659
422
|
/**
|
|
660
423
|
*
|
|
661
424
|
* @export
|
|
@@ -882,17 +645,8 @@ export interface RunTemplate {
|
|
|
882
645
|
* the Run Template name
|
|
883
646
|
* @type {string}
|
|
884
647
|
* @memberof RunTemplate
|
|
885
|
-
* @deprecated
|
|
886
648
|
*/
|
|
887
649
|
'name'?: string;
|
|
888
|
-
/**
|
|
889
|
-
* a translated label with key as ISO 639-1 code
|
|
890
|
-
* @type {{ [key: string]: string; }}
|
|
891
|
-
* @memberof RunTemplate
|
|
892
|
-
*/
|
|
893
|
-
'labels'?: {
|
|
894
|
-
[key: string]: string;
|
|
895
|
-
};
|
|
896
650
|
/**
|
|
897
651
|
* the Run Template description
|
|
898
652
|
* @type {string}
|
|
@@ -1061,12 +815,6 @@ export interface RunTemplate {
|
|
|
1061
815
|
* @memberof RunTemplate
|
|
1062
816
|
*/
|
|
1063
817
|
'runTemplateSourceDir'?: string;
|
|
1064
|
-
/**
|
|
1065
|
-
*
|
|
1066
|
-
* @type {RunTemplateOrchestrator}
|
|
1067
|
-
* @memberof RunTemplate
|
|
1068
|
-
*/
|
|
1069
|
-
'orchestratorType'?: RunTemplateOrchestrator;
|
|
1070
818
|
/**
|
|
1071
819
|
* an optional duration in seconds in which a workflow is allowed to run
|
|
1072
820
|
* @type {number}
|
|
@@ -1094,16 +842,6 @@ export declare const RunTemplateHandlerId: {
|
|
|
1094
842
|
readonly ScenariodataTransform: "scenariodata_transform";
|
|
1095
843
|
};
|
|
1096
844
|
export declare type RunTemplateHandlerId = typeof RunTemplateHandlerId[keyof typeof RunTemplateHandlerId];
|
|
1097
|
-
/**
|
|
1098
|
-
* the Orchestrator to use for the Run Template
|
|
1099
|
-
* @export
|
|
1100
|
-
* @enum {string}
|
|
1101
|
-
*/
|
|
1102
|
-
export declare const RunTemplateOrchestrator: {
|
|
1103
|
-
readonly ArgoWorkflow: "argoWorkflow";
|
|
1104
|
-
readonly CsmOrc: "csmOrc";
|
|
1105
|
-
};
|
|
1106
|
-
export declare type RunTemplateOrchestrator = typeof RunTemplateOrchestrator[keyof typeof RunTemplateOrchestrator];
|
|
1107
845
|
/**
|
|
1108
846
|
* a Run Template Parameter
|
|
1109
847
|
* @export
|
|
@@ -1703,12 +1441,6 @@ export interface ScenarioRun {
|
|
|
1703
1441
|
* @memberof ScenarioRun
|
|
1704
1442
|
*/
|
|
1705
1443
|
'sdkVersion'?: string;
|
|
1706
|
-
/**
|
|
1707
|
-
* the ScenarioRun creation date
|
|
1708
|
-
* @type {string}
|
|
1709
|
-
* @memberof ScenarioRun
|
|
1710
|
-
*/
|
|
1711
|
-
'createdAt'?: string;
|
|
1712
1444
|
/**
|
|
1713
1445
|
* set to true if the run template does not use any Datawarehouse consumers (AMQP consumers for Azure)
|
|
1714
1446
|
* @type {boolean}
|
|
@@ -1906,46 +1638,6 @@ export interface ScenarioRunLogs {
|
|
|
1906
1638
|
[key: string]: ScenarioRunContainerLogs;
|
|
1907
1639
|
};
|
|
1908
1640
|
}
|
|
1909
|
-
/**
|
|
1910
|
-
* the memory and CPU requested by the pod
|
|
1911
|
-
* @export
|
|
1912
|
-
* @interface ScenarioRunResourceRequested
|
|
1913
|
-
*/
|
|
1914
|
-
export interface ScenarioRunResourceRequested {
|
|
1915
|
-
/**
|
|
1916
|
-
* the cpu requested
|
|
1917
|
-
* @type {number}
|
|
1918
|
-
* @memberof ScenarioRunResourceRequested
|
|
1919
|
-
*/
|
|
1920
|
-
'cpu'?: number;
|
|
1921
|
-
/**
|
|
1922
|
-
* the memory requested
|
|
1923
|
-
* @type {number}
|
|
1924
|
-
* @memberof ScenarioRunResourceRequested
|
|
1925
|
-
*/
|
|
1926
|
-
'memory'?: number;
|
|
1927
|
-
}
|
|
1928
|
-
/**
|
|
1929
|
-
* a ScenarioRunProbeResult with all ScenarioRunResult
|
|
1930
|
-
* @export
|
|
1931
|
-
* @interface ScenarioRunResult
|
|
1932
|
-
*/
|
|
1933
|
-
export interface ScenarioRunResult {
|
|
1934
|
-
/**
|
|
1935
|
-
*
|
|
1936
|
-
* @type {string}
|
|
1937
|
-
* @memberof ScenarioRunResult
|
|
1938
|
-
*/
|
|
1939
|
-
'id'?: string;
|
|
1940
|
-
/**
|
|
1941
|
-
*
|
|
1942
|
-
* @type {Array<{ [key: string]: string; }>}
|
|
1943
|
-
* @memberof ScenarioRunResult
|
|
1944
|
-
*/
|
|
1945
|
-
'results'?: Array<{
|
|
1946
|
-
[key: string]: string;
|
|
1947
|
-
}>;
|
|
1948
|
-
}
|
|
1949
1641
|
/**
|
|
1950
1642
|
* the search options
|
|
1951
1643
|
* @export
|
|
@@ -2170,18 +1862,6 @@ export interface ScenarioRunStatusNode {
|
|
|
2170
1862
|
* @memberof ScenarioRunStatusNode
|
|
2171
1863
|
*/
|
|
2172
1864
|
'containerName'?: string;
|
|
2173
|
-
/**
|
|
2174
|
-
* the list of outbound nodes
|
|
2175
|
-
* @type {Array<string>}
|
|
2176
|
-
* @memberof ScenarioRunStatusNode
|
|
2177
|
-
*/
|
|
2178
|
-
'outboundNodes'?: Array<string>;
|
|
2179
|
-
/**
|
|
2180
|
-
*
|
|
2181
|
-
* @type {ScenarioRunResourceRequested}
|
|
2182
|
-
* @memberof ScenarioRunStatusNode
|
|
2183
|
-
*/
|
|
2184
|
-
'resourcesDuration'?: ScenarioRunResourceRequested;
|
|
2185
1865
|
/**
|
|
2186
1866
|
* estimatedDuration in seconds
|
|
2187
1867
|
* @type {number}
|
|
@@ -2383,63 +2063,6 @@ export interface Solution {
|
|
|
2383
2063
|
* @memberof Solution
|
|
2384
2064
|
*/
|
|
2385
2065
|
'runTemplates'?: Array<RunTemplate>;
|
|
2386
|
-
/**
|
|
2387
|
-
*
|
|
2388
|
-
* @type {SolutionSecurity}
|
|
2389
|
-
* @memberof Solution
|
|
2390
|
-
*/
|
|
2391
|
-
'security'?: SolutionSecurity;
|
|
2392
|
-
}
|
|
2393
|
-
/**
|
|
2394
|
-
* a Solution access control item
|
|
2395
|
-
* @export
|
|
2396
|
-
* @interface SolutionAccessControl
|
|
2397
|
-
*/
|
|
2398
|
-
export interface SolutionAccessControl {
|
|
2399
|
-
/**
|
|
2400
|
-
* the identity id
|
|
2401
|
-
* @type {string}
|
|
2402
|
-
* @memberof SolutionAccessControl
|
|
2403
|
-
*/
|
|
2404
|
-
'id': string;
|
|
2405
|
-
/**
|
|
2406
|
-
* a role
|
|
2407
|
-
* @type {string}
|
|
2408
|
-
* @memberof SolutionAccessControl
|
|
2409
|
-
*/
|
|
2410
|
-
'role': string;
|
|
2411
|
-
}
|
|
2412
|
-
/**
|
|
2413
|
-
* the Solution Role
|
|
2414
|
-
* @export
|
|
2415
|
-
* @interface SolutionRole
|
|
2416
|
-
*/
|
|
2417
|
-
export interface SolutionRole {
|
|
2418
|
-
/**
|
|
2419
|
-
* the Solution Role
|
|
2420
|
-
* @type {string}
|
|
2421
|
-
* @memberof SolutionRole
|
|
2422
|
-
*/
|
|
2423
|
-
'role': string;
|
|
2424
|
-
}
|
|
2425
|
-
/**
|
|
2426
|
-
* the Solution security information
|
|
2427
|
-
* @export
|
|
2428
|
-
* @interface SolutionSecurity
|
|
2429
|
-
*/
|
|
2430
|
-
export interface SolutionSecurity {
|
|
2431
|
-
/**
|
|
2432
|
-
* the role by default
|
|
2433
|
-
* @type {string}
|
|
2434
|
-
* @memberof SolutionSecurity
|
|
2435
|
-
*/
|
|
2436
|
-
'default': string;
|
|
2437
|
-
/**
|
|
2438
|
-
* the list which can access this Solution with detailed access control information
|
|
2439
|
-
* @type {Array<SolutionAccessControl>}
|
|
2440
|
-
* @memberof SolutionSecurity
|
|
2441
|
-
*/
|
|
2442
|
-
'accessControlList': Array<SolutionAccessControl>;
|
|
2443
2066
|
}
|
|
2444
2067
|
/**
|
|
2445
2068
|
* Source job import information
|
|
@@ -2466,55 +2089,29 @@ export interface SourceInfo {
|
|
|
2466
2089
|
*/
|
|
2467
2090
|
'path'?: string;
|
|
2468
2091
|
/**
|
|
2469
|
-
*
|
|
2092
|
+
* the source type containing the files to import
|
|
2470
2093
|
* @type {string}
|
|
2471
2094
|
* @memberof SourceInfo
|
|
2472
2095
|
*/
|
|
2473
|
-
'
|
|
2096
|
+
'type': SourceInfoTypeEnum;
|
|
2474
2097
|
}
|
|
2098
|
+
export declare const SourceInfoTypeEnum: {
|
|
2099
|
+
readonly Adt: "ADT";
|
|
2100
|
+
readonly Storage: "Storage";
|
|
2101
|
+
};
|
|
2102
|
+
export declare type SourceInfoTypeEnum = typeof SourceInfoTypeEnum[keyof typeof SourceInfoTypeEnum];
|
|
2475
2103
|
/**
|
|
2476
|
-
*
|
|
2104
|
+
* Processing result
|
|
2477
2105
|
* @export
|
|
2478
|
-
* @interface
|
|
2106
|
+
* @interface TwinGraphBatchResult
|
|
2479
2107
|
*/
|
|
2480
|
-
export interface
|
|
2108
|
+
export interface TwinGraphBatchResult {
|
|
2481
2109
|
/**
|
|
2482
|
-
*
|
|
2483
|
-
* @type {
|
|
2484
|
-
* @memberof
|
|
2110
|
+
*
|
|
2111
|
+
* @type {number}
|
|
2112
|
+
* @memberof TwinGraphBatchResult
|
|
2485
2113
|
*/
|
|
2486
|
-
'
|
|
2487
|
-
/**
|
|
2488
|
-
* the description of the subdataset
|
|
2489
|
-
* @type {string}
|
|
2490
|
-
* @memberof SubDatasetGraphQuery
|
|
2491
|
-
*/
|
|
2492
|
-
'description'?: string;
|
|
2493
|
-
/**
|
|
2494
|
-
* the query in cypher language
|
|
2495
|
-
* @type {Array<string>}
|
|
2496
|
-
* @memberof SubDatasetGraphQuery
|
|
2497
|
-
*/
|
|
2498
|
-
'queries'?: Array<string>;
|
|
2499
|
-
/**
|
|
2500
|
-
* is this the main dataset
|
|
2501
|
-
* @type {boolean}
|
|
2502
|
-
* @memberof SubDatasetGraphQuery
|
|
2503
|
-
*/
|
|
2504
|
-
'main'?: boolean;
|
|
2505
|
-
}
|
|
2506
|
-
/**
|
|
2507
|
-
* Processing result
|
|
2508
|
-
* @export
|
|
2509
|
-
* @interface TwinGraphBatchResult
|
|
2510
|
-
*/
|
|
2511
|
-
export interface TwinGraphBatchResult {
|
|
2512
|
-
/**
|
|
2513
|
-
*
|
|
2514
|
-
* @type {number}
|
|
2515
|
-
* @memberof TwinGraphBatchResult
|
|
2516
|
-
*/
|
|
2517
|
-
'totalLines': number;
|
|
2114
|
+
'totalLines': number;
|
|
2518
2115
|
/**
|
|
2519
2116
|
*
|
|
2520
2117
|
* @type {number}
|
|
@@ -2541,6 +2138,50 @@ export interface TwinGraphHash {
|
|
|
2541
2138
|
*/
|
|
2542
2139
|
'hash'?: string;
|
|
2543
2140
|
}
|
|
2141
|
+
/**
|
|
2142
|
+
* a twin graph import info
|
|
2143
|
+
* @export
|
|
2144
|
+
* @interface TwinGraphImport
|
|
2145
|
+
*/
|
|
2146
|
+
export interface TwinGraphImport {
|
|
2147
|
+
/**
|
|
2148
|
+
*
|
|
2149
|
+
* @type {SourceInfo}
|
|
2150
|
+
* @memberof TwinGraphImport
|
|
2151
|
+
*/
|
|
2152
|
+
'source': SourceInfo;
|
|
2153
|
+
/**
|
|
2154
|
+
* the graph id to import to
|
|
2155
|
+
* @type {string}
|
|
2156
|
+
* @memberof TwinGraphImport
|
|
2157
|
+
*/
|
|
2158
|
+
'graphId': string;
|
|
2159
|
+
/**
|
|
2160
|
+
* The version of the graph to import to. When not set, the last version before import is upgraded by 1. When set, the targeted graph is replaced
|
|
2161
|
+
* @type {string}
|
|
2162
|
+
* @memberof TwinGraphImport
|
|
2163
|
+
*/
|
|
2164
|
+
'version'?: string;
|
|
2165
|
+
}
|
|
2166
|
+
/**
|
|
2167
|
+
* a twin graph query in cypher language
|
|
2168
|
+
* @export
|
|
2169
|
+
* @interface TwinGraphImportInfo
|
|
2170
|
+
*/
|
|
2171
|
+
export interface TwinGraphImportInfo {
|
|
2172
|
+
/**
|
|
2173
|
+
* the import job id
|
|
2174
|
+
* @type {string}
|
|
2175
|
+
* @memberof TwinGraphImportInfo
|
|
2176
|
+
*/
|
|
2177
|
+
'jobId'?: string;
|
|
2178
|
+
/**
|
|
2179
|
+
* the twin graph name
|
|
2180
|
+
* @type {string}
|
|
2181
|
+
* @memberof TwinGraphImportInfo
|
|
2182
|
+
*/
|
|
2183
|
+
'graphName'?: string;
|
|
2184
|
+
}
|
|
2544
2185
|
/**
|
|
2545
2186
|
* a twin graph query in cypher language
|
|
2546
2187
|
* @export
|
|
@@ -2942,12 +2583,12 @@ export declare const ConnectorApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2942
2583
|
findConnectorById: (connectorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2943
2584
|
/**
|
|
2944
2585
|
*
|
|
2945
|
-
* @summary
|
|
2946
|
-
* @param {
|
|
2586
|
+
* @summary Import existing connector
|
|
2587
|
+
* @param {Connector} connector the Connector to import
|
|
2947
2588
|
* @param {*} [options] Override http request option.
|
|
2948
2589
|
* @throws {RequiredError}
|
|
2949
2590
|
*/
|
|
2950
|
-
|
|
2591
|
+
importConnector: (connector: Connector, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2951
2592
|
/**
|
|
2952
2593
|
*
|
|
2953
2594
|
* @summary Register a new connector
|
|
@@ -2989,12 +2630,12 @@ export declare const ConnectorApiFp: (configuration?: Configuration) => {
|
|
|
2989
2630
|
findConnectorById(connectorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>>;
|
|
2990
2631
|
/**
|
|
2991
2632
|
*
|
|
2992
|
-
* @summary
|
|
2993
|
-
* @param {
|
|
2633
|
+
* @summary Import existing connector
|
|
2634
|
+
* @param {Connector} connector the Connector to import
|
|
2994
2635
|
* @param {*} [options] Override http request option.
|
|
2995
2636
|
* @throws {RequiredError}
|
|
2996
2637
|
*/
|
|
2997
|
-
|
|
2638
|
+
importConnector(connector: Connector, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>>;
|
|
2998
2639
|
/**
|
|
2999
2640
|
*
|
|
3000
2641
|
* @summary Register a new connector
|
|
@@ -3036,12 +2677,12 @@ export declare const ConnectorApiFactory: (configuration?: Configuration, basePa
|
|
|
3036
2677
|
findConnectorById(connectorId: string, options?: any): AxiosPromise<Connector>;
|
|
3037
2678
|
/**
|
|
3038
2679
|
*
|
|
3039
|
-
* @summary
|
|
3040
|
-
* @param {
|
|
2680
|
+
* @summary Import existing connector
|
|
2681
|
+
* @param {Connector} connector the Connector to import
|
|
3041
2682
|
* @param {*} [options] Override http request option.
|
|
3042
2683
|
* @throws {RequiredError}
|
|
3043
2684
|
*/
|
|
3044
|
-
|
|
2685
|
+
importConnector(connector: Connector, options?: any): AxiosPromise<Connector>;
|
|
3045
2686
|
/**
|
|
3046
2687
|
*
|
|
3047
2688
|
* @summary Register a new connector
|
|
@@ -3087,13 +2728,13 @@ export declare class ConnectorApi extends BaseAPI {
|
|
|
3087
2728
|
findConnectorById(connectorId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Connector>>;
|
|
3088
2729
|
/**
|
|
3089
2730
|
*
|
|
3090
|
-
* @summary
|
|
3091
|
-
* @param {
|
|
2731
|
+
* @summary Import existing connector
|
|
2732
|
+
* @param {Connector} connector the Connector to import
|
|
3092
2733
|
* @param {*} [options] Override http request option.
|
|
3093
2734
|
* @throws {RequiredError}
|
|
3094
2735
|
* @memberof ConnectorApi
|
|
3095
2736
|
*/
|
|
3096
|
-
|
|
2737
|
+
importConnector(connector: Connector, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Connector>>;
|
|
3097
2738
|
/**
|
|
3098
2739
|
*
|
|
3099
2740
|
* @summary Register a new connector
|
|
@@ -3118,16 +2759,6 @@ export declare class ConnectorApi extends BaseAPI {
|
|
|
3118
2759
|
* @export
|
|
3119
2760
|
*/
|
|
3120
2761
|
export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3121
|
-
/**
|
|
3122
|
-
*
|
|
3123
|
-
* @summary Add a control access to the Dataset
|
|
3124
|
-
* @param {string} organizationId the Organization identifier
|
|
3125
|
-
* @param {string} datasetId the Dataset identifier
|
|
3126
|
-
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
3127
|
-
* @param {*} [options] Override http request option.
|
|
3128
|
-
* @throws {RequiredError}
|
|
3129
|
-
*/
|
|
3130
|
-
addDatasetAccessControl: (organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3131
2762
|
/**
|
|
3132
2763
|
*
|
|
3133
2764
|
* @summary Add Dataset Compatibility elements.
|
|
@@ -3139,8 +2770,8 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3139
2770
|
*/
|
|
3140
2771
|
addOrReplaceDatasetCompatibilityElements: (organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3141
2772
|
/**
|
|
3142
|
-
*
|
|
3143
|
-
* @summary Copy a Dataset to another Dataset.
|
|
2773
|
+
*
|
|
2774
|
+
* @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
|
|
3144
2775
|
* @param {string} organizationId the Organization identifier
|
|
3145
2776
|
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
3146
2777
|
* @param {*} [options] Override http request option.
|
|
@@ -3156,27 +2787,6 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3156
2787
|
* @throws {RequiredError}
|
|
3157
2788
|
*/
|
|
3158
2789
|
createDataset: (organizationId: string, dataset: Dataset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3159
|
-
/**
|
|
3160
|
-
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
3161
|
-
* @summary Create a sub-dataset from the dataset in parameter
|
|
3162
|
-
* @param {string} organizationId the Organization identifier
|
|
3163
|
-
* @param {string} datasetId the Dataset identifier
|
|
3164
|
-
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
3165
|
-
* @param {*} [options] Override http request option.
|
|
3166
|
-
* @throws {RequiredError}
|
|
3167
|
-
*/
|
|
3168
|
-
createSubDataset: (organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3169
|
-
/**
|
|
3170
|
-
* create new entities in a graph instance
|
|
3171
|
-
* @summary Create new entities in a graph instance
|
|
3172
|
-
* @param {string} organizationId the Organization identifier
|
|
3173
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3174
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3175
|
-
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
3176
|
-
* @param {*} [options] Override http request option.
|
|
3177
|
-
* @throws {RequiredError}
|
|
3178
|
-
*/
|
|
3179
|
-
createTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3180
2790
|
/**
|
|
3181
2791
|
*
|
|
3182
2792
|
* @summary Delete a dataset
|
|
@@ -3186,26 +2796,6 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3186
2796
|
* @throws {RequiredError}
|
|
3187
2797
|
*/
|
|
3188
2798
|
deleteDataset: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3189
|
-
/**
|
|
3190
|
-
* delete entities in a graph instance
|
|
3191
|
-
* @summary Delete entities in a graph instance
|
|
3192
|
-
* @param {string} organizationId the Organization identifier
|
|
3193
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3194
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3195
|
-
* @param {Array<string>} ids the entities to delete
|
|
3196
|
-
* @param {*} [options] Override http request option.
|
|
3197
|
-
* @throws {RequiredError}
|
|
3198
|
-
*/
|
|
3199
|
-
deleteTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3200
|
-
/**
|
|
3201
|
-
* Download the compressed graph reference by the hash in a zip file
|
|
3202
|
-
* @summary Download a graph as a zip file
|
|
3203
|
-
* @param {string} organizationId the Organization identifier
|
|
3204
|
-
* @param {string} hash the Graph download identifier
|
|
3205
|
-
* @param {*} [options] Override http request option.
|
|
3206
|
-
* @throws {RequiredError}
|
|
3207
|
-
*/
|
|
3208
|
-
downloadTwingraph: (organizationId: string, hash: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3209
2799
|
/**
|
|
3210
2800
|
*
|
|
3211
2801
|
* @summary List all Datasets
|
|
@@ -3227,199 +2817,150 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3227
2817
|
findDatasetById: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3228
2818
|
/**
|
|
3229
2819
|
*
|
|
3230
|
-
* @summary
|
|
2820
|
+
* @summary Import a new Dataset
|
|
3231
2821
|
* @param {string} organizationId the Organization identifier
|
|
3232
|
-
* @param {
|
|
3233
|
-
* @param {string} identityId the User identifier
|
|
2822
|
+
* @param {Dataset} dataset the Dataset to import
|
|
3234
2823
|
* @param {*} [options] Override http request option.
|
|
3235
2824
|
* @throws {RequiredError}
|
|
3236
2825
|
*/
|
|
3237
|
-
|
|
2826
|
+
importDataset: (organizationId: string, dataset: Dataset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3238
2827
|
/**
|
|
3239
2828
|
*
|
|
3240
|
-
* @summary
|
|
2829
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
3241
2830
|
* @param {string} organizationId the Organization identifier
|
|
3242
2831
|
* @param {string} datasetId the Dataset identifier
|
|
3243
2832
|
* @param {*} [options] Override http request option.
|
|
3244
2833
|
* @throws {RequiredError}
|
|
3245
2834
|
*/
|
|
3246
|
-
|
|
2835
|
+
removeAllDatasetCompatibilityElements: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3247
2836
|
/**
|
|
3248
2837
|
*
|
|
3249
|
-
* @summary
|
|
3250
|
-
* @param {string} organizationId the Organization identifier
|
|
3251
|
-
* @param {string} datasetId the Dataset identifier
|
|
3252
|
-
* @param {*} [options] Override http request option.
|
|
3253
|
-
* @throws {RequiredError}
|
|
3254
|
-
*/
|
|
3255
|
-
getDatasetSecurityUsers: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3256
|
-
/**
|
|
3257
|
-
* Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
|
|
3258
|
-
* @summary Get the dataset\'s refresh job status
|
|
2838
|
+
* @summary Search Datasets
|
|
3259
2839
|
* @param {string} organizationId the Organization identifier
|
|
3260
|
-
* @param {
|
|
2840
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
2841
|
+
* @param {number} [page] page number to query
|
|
2842
|
+
* @param {number} [size] amount of result by page
|
|
3261
2843
|
* @param {*} [options] Override http request option.
|
|
3262
2844
|
* @throws {RequiredError}
|
|
3263
2845
|
*/
|
|
3264
|
-
|
|
2846
|
+
searchDatasets: (organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3265
2847
|
/**
|
|
3266
|
-
*
|
|
3267
|
-
* @summary
|
|
2848
|
+
*
|
|
2849
|
+
* @summary Update a dataset
|
|
3268
2850
|
* @param {string} organizationId the Organization identifier
|
|
3269
|
-
* @param {string} datasetId the Dataset
|
|
3270
|
-
* @param {
|
|
3271
|
-
* @param {Array<string>} ids the entities to get
|
|
2851
|
+
* @param {string} datasetId the Dataset identifier
|
|
2852
|
+
* @param {Dataset} dataset the new Dataset details.
|
|
3272
2853
|
* @param {*} [options] Override http request option.
|
|
3273
2854
|
* @throws {RequiredError}
|
|
3274
2855
|
*/
|
|
3275
|
-
|
|
2856
|
+
updateDataset: (organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2857
|
+
};
|
|
2858
|
+
/**
|
|
2859
|
+
* DatasetApi - functional programming interface
|
|
2860
|
+
* @export
|
|
2861
|
+
*/
|
|
2862
|
+
export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
3276
2863
|
/**
|
|
3277
|
-
*
|
|
3278
|
-
* @summary
|
|
2864
|
+
*
|
|
2865
|
+
* @summary Add Dataset Compatibility elements.
|
|
3279
2866
|
* @param {string} organizationId the Organization identifier
|
|
3280
2867
|
* @param {string} datasetId the Dataset identifier
|
|
2868
|
+
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
3281
2869
|
* @param {*} [options] Override http request option.
|
|
3282
2870
|
* @throws {RequiredError}
|
|
3283
2871
|
*/
|
|
3284
|
-
|
|
2872
|
+
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DatasetCompatibility>>>;
|
|
3285
2873
|
/**
|
|
3286
2874
|
*
|
|
3287
|
-
* @summary
|
|
2875
|
+
* @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
|
|
3288
2876
|
* @param {string} organizationId the Organization identifier
|
|
3289
|
-
* @param {
|
|
2877
|
+
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
3290
2878
|
* @param {*} [options] Override http request option.
|
|
3291
2879
|
* @throws {RequiredError}
|
|
3292
2880
|
*/
|
|
3293
|
-
|
|
2881
|
+
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetCopyParameters>>;
|
|
3294
2882
|
/**
|
|
3295
2883
|
*
|
|
3296
|
-
* @summary
|
|
2884
|
+
* @summary Create a new Dataset
|
|
3297
2885
|
* @param {string} organizationId the Organization identifier
|
|
3298
|
-
* @param {
|
|
3299
|
-
* @param {string} identityId the User identifier
|
|
2886
|
+
* @param {Dataset} dataset the Dataset to create
|
|
3300
2887
|
* @param {*} [options] Override http request option.
|
|
3301
2888
|
* @throws {RequiredError}
|
|
3302
2889
|
*/
|
|
3303
|
-
|
|
2890
|
+
createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3304
2891
|
/**
|
|
3305
|
-
*
|
|
3306
|
-
* @summary
|
|
2892
|
+
*
|
|
2893
|
+
* @summary Delete a dataset
|
|
3307
2894
|
* @param {string} organizationId the Organization identifier
|
|
3308
2895
|
* @param {string} datasetId the Dataset identifier
|
|
3309
2896
|
* @param {*} [options] Override http request option.
|
|
3310
2897
|
* @throws {RequiredError}
|
|
3311
2898
|
*/
|
|
3312
|
-
|
|
2899
|
+
deleteDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3313
2900
|
/**
|
|
3314
2901
|
*
|
|
3315
|
-
* @summary
|
|
2902
|
+
* @summary List all Datasets
|
|
3316
2903
|
* @param {string} organizationId the Organization identifier
|
|
3317
|
-
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3318
2904
|
* @param {number} [page] page number to query
|
|
3319
2905
|
* @param {number} [size] amount of result by page
|
|
3320
2906
|
* @param {*} [options] Override http request option.
|
|
3321
2907
|
* @throws {RequiredError}
|
|
3322
2908
|
*/
|
|
3323
|
-
|
|
2909
|
+
findAllDatasets(organizationId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
3324
2910
|
/**
|
|
3325
2911
|
*
|
|
3326
|
-
* @summary
|
|
3327
|
-
* @param {string} organizationId the Organization identifier
|
|
3328
|
-
* @param {string} datasetId the Dataset identifier
|
|
3329
|
-
* @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
|
|
3330
|
-
* @param {*} [options] Override http request option.
|
|
3331
|
-
* @throws {RequiredError}
|
|
3332
|
-
*/
|
|
3333
|
-
setDatasetDefaultSecurity: (organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3334
|
-
/**
|
|
3335
|
-
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
3336
|
-
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
3337
|
-
* @param {string} organizationId the Organization identifier
|
|
3338
|
-
* @param {string} datasetId the Graph Identifier
|
|
3339
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3340
|
-
* @param {*} [options] Override http request option.
|
|
3341
|
-
* @throws {RequiredError}
|
|
3342
|
-
*/
|
|
3343
|
-
twingraphBatchQuery: (organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3344
|
-
/**
|
|
3345
|
-
* Async batch update by loading a CSV file on a graph instance
|
|
3346
|
-
* @summary Async batch update by loading a CSV file on a graph instance
|
|
3347
|
-
* @param {string} organizationId the Organization identifier
|
|
3348
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3349
|
-
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
3350
|
-
* @param {any} body
|
|
3351
|
-
* @param {*} [options] Override http request option.
|
|
3352
|
-
* @throws {RequiredError}
|
|
3353
|
-
*/
|
|
3354
|
-
twingraphBatchUpdate: (organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3355
|
-
/**
|
|
3356
|
-
* Run a query on a graph instance and return the result as a json
|
|
3357
|
-
* @summary Return the result of a query made on the graph instance as a json
|
|
2912
|
+
* @summary Get the details of a Dataset
|
|
3358
2913
|
* @param {string} organizationId the Organization identifier
|
|
3359
2914
|
* @param {string} datasetId the Dataset identifier
|
|
3360
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3361
2915
|
* @param {*} [options] Override http request option.
|
|
3362
2916
|
* @throws {RequiredError}
|
|
3363
2917
|
*/
|
|
3364
|
-
|
|
2918
|
+
findDatasetById(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3365
2919
|
/**
|
|
3366
2920
|
*
|
|
3367
|
-
* @summary
|
|
2921
|
+
* @summary Import a new Dataset
|
|
3368
2922
|
* @param {string} organizationId the Organization identifier
|
|
3369
|
-
* @param {
|
|
3370
|
-
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
2923
|
+
* @param {Dataset} dataset the Dataset to import
|
|
3371
2924
|
* @param {*} [options] Override http request option.
|
|
3372
2925
|
* @throws {RequiredError}
|
|
3373
2926
|
*/
|
|
3374
|
-
|
|
2927
|
+
importDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3375
2928
|
/**
|
|
3376
2929
|
*
|
|
3377
|
-
* @summary
|
|
2930
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
3378
2931
|
* @param {string} organizationId the Organization identifier
|
|
3379
2932
|
* @param {string} datasetId the Dataset identifier
|
|
3380
|
-
* @param {string} identityId the User identifier
|
|
3381
|
-
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
3382
2933
|
* @param {*} [options] Override http request option.
|
|
3383
2934
|
* @throws {RequiredError}
|
|
3384
2935
|
*/
|
|
3385
|
-
|
|
2936
|
+
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3386
2937
|
/**
|
|
3387
|
-
*
|
|
3388
|
-
* @summary
|
|
2938
|
+
*
|
|
2939
|
+
* @summary Search Datasets
|
|
3389
2940
|
* @param {string} organizationId the Organization identifier
|
|
3390
|
-
* @param {
|
|
3391
|
-
* @param {
|
|
3392
|
-
* @param {
|
|
2941
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
2942
|
+
* @param {number} [page] page number to query
|
|
2943
|
+
* @param {number} [size] amount of result by page
|
|
3393
2944
|
* @param {*} [options] Override http request option.
|
|
3394
2945
|
* @throws {RequiredError}
|
|
3395
2946
|
*/
|
|
3396
|
-
|
|
2947
|
+
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
3397
2948
|
/**
|
|
3398
|
-
*
|
|
3399
|
-
* @summary
|
|
2949
|
+
*
|
|
2950
|
+
* @summary Update a dataset
|
|
3400
2951
|
* @param {string} organizationId the Organization identifier
|
|
3401
2952
|
* @param {string} datasetId the Dataset identifier
|
|
3402
|
-
* @param {
|
|
2953
|
+
* @param {Dataset} dataset the new Dataset details.
|
|
3403
2954
|
* @param {*} [options] Override http request option.
|
|
3404
2955
|
* @throws {RequiredError}
|
|
3405
2956
|
*/
|
|
3406
|
-
|
|
2957
|
+
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3407
2958
|
};
|
|
3408
2959
|
/**
|
|
3409
|
-
* DatasetApi -
|
|
2960
|
+
* DatasetApi - factory interface
|
|
3410
2961
|
* @export
|
|
3411
2962
|
*/
|
|
3412
|
-
export declare const
|
|
3413
|
-
/**
|
|
3414
|
-
*
|
|
3415
|
-
* @summary Add a control access to the Dataset
|
|
3416
|
-
* @param {string} organizationId the Organization identifier
|
|
3417
|
-
* @param {string} datasetId the Dataset identifier
|
|
3418
|
-
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
3419
|
-
* @param {*} [options] Override http request option.
|
|
3420
|
-
* @throws {RequiredError}
|
|
3421
|
-
*/
|
|
3422
|
-
addDatasetAccessControl(organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
2963
|
+
export declare const DatasetApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3423
2964
|
/**
|
|
3424
2965
|
*
|
|
3425
2966
|
* @summary Add Dataset Compatibility elements.
|
|
@@ -3429,16 +2970,16 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
3429
2970
|
* @param {*} [options] Override http request option.
|
|
3430
2971
|
* @throws {RequiredError}
|
|
3431
2972
|
*/
|
|
3432
|
-
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?:
|
|
2973
|
+
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: any): AxiosPromise<Array<DatasetCompatibility>>;
|
|
3433
2974
|
/**
|
|
3434
|
-
*
|
|
3435
|
-
* @summary Copy a Dataset to another Dataset.
|
|
2975
|
+
*
|
|
2976
|
+
* @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
|
|
3436
2977
|
* @param {string} organizationId the Organization identifier
|
|
3437
2978
|
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
3438
2979
|
* @param {*} [options] Override http request option.
|
|
3439
2980
|
* @throws {RequiredError}
|
|
3440
2981
|
*/
|
|
3441
|
-
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?:
|
|
2982
|
+
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: any): AxiosPromise<DatasetCopyParameters>;
|
|
3442
2983
|
/**
|
|
3443
2984
|
*
|
|
3444
2985
|
* @summary Create a new Dataset
|
|
@@ -3447,28 +2988,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
3447
2988
|
* @param {*} [options] Override http request option.
|
|
3448
2989
|
* @throws {RequiredError}
|
|
3449
2990
|
*/
|
|
3450
|
-
createDataset(organizationId: string, dataset: Dataset, options?:
|
|
3451
|
-
/**
|
|
3452
|
-
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
3453
|
-
* @summary Create a sub-dataset from the dataset in parameter
|
|
3454
|
-
* @param {string} organizationId the Organization identifier
|
|
3455
|
-
* @param {string} datasetId the Dataset identifier
|
|
3456
|
-
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
3457
|
-
* @param {*} [options] Override http request option.
|
|
3458
|
-
* @throws {RequiredError}
|
|
3459
|
-
*/
|
|
3460
|
-
createSubDataset(organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3461
|
-
/**
|
|
3462
|
-
* create new entities in a graph instance
|
|
3463
|
-
* @summary Create new entities in a graph instance
|
|
3464
|
-
* @param {string} organizationId the Organization identifier
|
|
3465
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3466
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3467
|
-
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
3468
|
-
* @param {*} [options] Override http request option.
|
|
3469
|
-
* @throws {RequiredError}
|
|
3470
|
-
*/
|
|
3471
|
-
createTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
2991
|
+
createDataset(organizationId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
3472
2992
|
/**
|
|
3473
2993
|
*
|
|
3474
2994
|
* @summary Delete a dataset
|
|
@@ -3477,27 +2997,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
3477
2997
|
* @param {*} [options] Override http request option.
|
|
3478
2998
|
* @throws {RequiredError}
|
|
3479
2999
|
*/
|
|
3480
|
-
deleteDataset(organizationId: string, datasetId: string, options?:
|
|
3481
|
-
/**
|
|
3482
|
-
* delete entities in a graph instance
|
|
3483
|
-
* @summary Delete entities in a graph instance
|
|
3484
|
-
* @param {string} organizationId the Organization identifier
|
|
3485
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3486
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3487
|
-
* @param {Array<string>} ids the entities to delete
|
|
3488
|
-
* @param {*} [options] Override http request option.
|
|
3489
|
-
* @throws {RequiredError}
|
|
3490
|
-
*/
|
|
3491
|
-
deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3492
|
-
/**
|
|
3493
|
-
* Download the compressed graph reference by the hash in a zip file
|
|
3494
|
-
* @summary Download a graph as a zip file
|
|
3495
|
-
* @param {string} organizationId the Organization identifier
|
|
3496
|
-
* @param {string} hash the Graph download identifier
|
|
3497
|
-
* @param {*} [options] Override http request option.
|
|
3498
|
-
* @throws {RequiredError}
|
|
3499
|
-
*/
|
|
3500
|
-
downloadTwingraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
3000
|
+
deleteDataset(organizationId: string, datasetId: string, options?: any): AxiosPromise<void>;
|
|
3501
3001
|
/**
|
|
3502
3002
|
*
|
|
3503
3003
|
* @summary List all Datasets
|
|
@@ -3507,7 +3007,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
3507
3007
|
* @param {*} [options] Override http request option.
|
|
3508
3008
|
* @throws {RequiredError}
|
|
3509
3009
|
*/
|
|
3510
|
-
findAllDatasets(organizationId: string, page?: number, size?: number, options?:
|
|
3010
|
+
findAllDatasets(organizationId: string, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
|
|
3511
3011
|
/**
|
|
3512
3012
|
*
|
|
3513
3013
|
* @summary Get the details of a Dataset
|
|
@@ -3516,801 +3016,159 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
3516
3016
|
* @param {*} [options] Override http request option.
|
|
3517
3017
|
* @throws {RequiredError}
|
|
3518
3018
|
*/
|
|
3519
|
-
findDatasetById(organizationId: string, datasetId: string, options?:
|
|
3520
|
-
/**
|
|
3521
|
-
*
|
|
3522
|
-
* @summary Get a control access for the Dataset
|
|
3523
|
-
* @param {string} organizationId the Organization identifier
|
|
3524
|
-
* @param {string} datasetId the Dataset identifier
|
|
3525
|
-
* @param {string} identityId the User identifier
|
|
3526
|
-
* @param {*} [options] Override http request option.
|
|
3527
|
-
* @throws {RequiredError}
|
|
3528
|
-
*/
|
|
3529
|
-
getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
3019
|
+
findDatasetById(organizationId: string, datasetId: string, options?: any): AxiosPromise<Dataset>;
|
|
3530
3020
|
/**
|
|
3531
3021
|
*
|
|
3532
|
-
* @summary
|
|
3022
|
+
* @summary Import a new Dataset
|
|
3533
3023
|
* @param {string} organizationId the Organization identifier
|
|
3534
|
-
* @param {
|
|
3024
|
+
* @param {Dataset} dataset the Dataset to import
|
|
3535
3025
|
* @param {*} [options] Override http request option.
|
|
3536
3026
|
* @throws {RequiredError}
|
|
3537
3027
|
*/
|
|
3538
|
-
|
|
3028
|
+
importDataset(organizationId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
3539
3029
|
/**
|
|
3540
3030
|
*
|
|
3541
|
-
* @summary
|
|
3542
|
-
* @param {string} organizationId the Organization identifier
|
|
3543
|
-
* @param {string} datasetId the Dataset identifier
|
|
3544
|
-
* @param {*} [options] Override http request option.
|
|
3545
|
-
* @throws {RequiredError}
|
|
3546
|
-
*/
|
|
3547
|
-
getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
3548
|
-
/**
|
|
3549
|
-
* Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
|
|
3550
|
-
* @summary Get the dataset\'s refresh job status
|
|
3551
|
-
* @param {string} organizationId the Organization identifier
|
|
3552
|
-
* @param {string} datasetId the dataset identifier
|
|
3553
|
-
* @param {*} [options] Override http request option.
|
|
3554
|
-
* @throws {RequiredError}
|
|
3555
|
-
*/
|
|
3556
|
-
getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3557
|
-
/**
|
|
3558
|
-
* get entities in a graph instance
|
|
3559
|
-
* @summary Get entities in a graph instance
|
|
3560
|
-
* @param {string} organizationId the Organization identifier
|
|
3561
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3562
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3563
|
-
* @param {Array<string>} ids the entities to get
|
|
3564
|
-
* @param {*} [options] Override http request option.
|
|
3565
|
-
* @throws {RequiredError}
|
|
3566
|
-
*/
|
|
3567
|
-
getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3568
|
-
/**
|
|
3569
|
-
* Refresh dataset from parent source. At date, sources can be: dataset (refresh from another dataset) Azure Digital twin Azure storage Local File (import a new file) During refresh, datas are overwritten
|
|
3570
|
-
* @summary Refresh data on dataset from dataset\'s source
|
|
3571
|
-
* @param {string} organizationId the Organization identifier
|
|
3572
|
-
* @param {string} datasetId the Dataset identifier
|
|
3573
|
-
* @param {*} [options] Override http request option.
|
|
3574
|
-
* @throws {RequiredError}
|
|
3575
|
-
*/
|
|
3576
|
-
refreshDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetTwinGraphInfo>>;
|
|
3577
|
-
/**
|
|
3578
|
-
*
|
|
3579
|
-
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
3580
|
-
* @param {string} organizationId the Organization identifier
|
|
3581
|
-
* @param {string} datasetId the Dataset identifier
|
|
3582
|
-
* @param {*} [options] Override http request option.
|
|
3583
|
-
* @throws {RequiredError}
|
|
3584
|
-
*/
|
|
3585
|
-
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3586
|
-
/**
|
|
3587
|
-
*
|
|
3588
|
-
* @summary Remove the specified access from the given Dataset
|
|
3589
|
-
* @param {string} organizationId the Organization identifier
|
|
3590
|
-
* @param {string} datasetId the Dataset identifier
|
|
3591
|
-
* @param {string} identityId the User identifier
|
|
3592
|
-
* @param {*} [options] Override http request option.
|
|
3593
|
-
* @throws {RequiredError}
|
|
3594
|
-
*/
|
|
3595
|
-
removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3596
|
-
/**
|
|
3597
|
-
* Rollback the twingraph on a dataset after a failed refresh
|
|
3598
|
-
* @summary Rollback the dataset after a failed refresh
|
|
3599
|
-
* @param {string} organizationId the Organization identifier
|
|
3600
|
-
* @param {string} datasetId the Dataset identifier
|
|
3601
|
-
* @param {*} [options] Override http request option.
|
|
3602
|
-
* @throws {RequiredError}
|
|
3603
|
-
*/
|
|
3604
|
-
rollbackRefresh(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3605
|
-
/**
|
|
3606
|
-
*
|
|
3607
|
-
* @summary Search Datasets by tags
|
|
3608
|
-
* @param {string} organizationId the Organization identifier
|
|
3609
|
-
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3610
|
-
* @param {number} [page] page number to query
|
|
3611
|
-
* @param {number} [size] amount of result by page
|
|
3612
|
-
* @param {*} [options] Override http request option.
|
|
3613
|
-
* @throws {RequiredError}
|
|
3614
|
-
*/
|
|
3615
|
-
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
3616
|
-
/**
|
|
3617
|
-
*
|
|
3618
|
-
* @summary Set the Dataset default security
|
|
3619
|
-
* @param {string} organizationId the Organization identifier
|
|
3620
|
-
* @param {string} datasetId the Dataset identifier
|
|
3621
|
-
* @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
|
|
3622
|
-
* @param {*} [options] Override http request option.
|
|
3623
|
-
* @throws {RequiredError}
|
|
3624
|
-
*/
|
|
3625
|
-
setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>>;
|
|
3626
|
-
/**
|
|
3627
|
-
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
3628
|
-
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
3629
|
-
* @param {string} organizationId the Organization identifier
|
|
3630
|
-
* @param {string} datasetId the Graph Identifier
|
|
3631
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3632
|
-
* @param {*} [options] Override http request option.
|
|
3633
|
-
* @throws {RequiredError}
|
|
3634
|
-
*/
|
|
3635
|
-
twingraphBatchQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetTwinGraphHash>>;
|
|
3636
|
-
/**
|
|
3637
|
-
* Async batch update by loading a CSV file on a graph instance
|
|
3638
|
-
* @summary Async batch update by loading a CSV file on a graph instance
|
|
3639
|
-
* @param {string} organizationId the Organization identifier
|
|
3640
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3641
|
-
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
3642
|
-
* @param {any} body
|
|
3643
|
-
* @param {*} [options] Override http request option.
|
|
3644
|
-
* @throws {RequiredError}
|
|
3645
|
-
*/
|
|
3646
|
-
twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>>;
|
|
3647
|
-
/**
|
|
3648
|
-
* Run a query on a graph instance and return the result as a json
|
|
3649
|
-
* @summary Return the result of a query made on the graph instance as a json
|
|
3650
|
-
* @param {string} organizationId the Organization identifier
|
|
3651
|
-
* @param {string} datasetId the Dataset identifier
|
|
3652
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3653
|
-
* @param {*} [options] Override http request option.
|
|
3654
|
-
* @throws {RequiredError}
|
|
3655
|
-
*/
|
|
3656
|
-
twingraphQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3657
|
-
/**
|
|
3658
|
-
*
|
|
3659
|
-
* @summary Update a dataset
|
|
3660
|
-
* @param {string} organizationId the Organization identifier
|
|
3661
|
-
* @param {string} datasetId the Dataset identifier
|
|
3662
|
-
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
3663
|
-
* @param {*} [options] Override http request option.
|
|
3664
|
-
* @throws {RequiredError}
|
|
3665
|
-
*/
|
|
3666
|
-
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3667
|
-
/**
|
|
3668
|
-
*
|
|
3669
|
-
* @summary Update the specified access to User for a Dataset
|
|
3670
|
-
* @param {string} organizationId the Organization identifier
|
|
3671
|
-
* @param {string} datasetId the Dataset identifier
|
|
3672
|
-
* @param {string} identityId the User identifier
|
|
3673
|
-
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
3674
|
-
* @param {*} [options] Override http request option.
|
|
3675
|
-
* @throws {RequiredError}
|
|
3676
|
-
*/
|
|
3677
|
-
updateDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
3678
|
-
/**
|
|
3679
|
-
* update entities in a graph instance
|
|
3680
|
-
* @summary Update entities in a graph instance
|
|
3681
|
-
* @param {string} organizationId the Organization identifier
|
|
3682
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3683
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3684
|
-
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
3685
|
-
* @param {*} [options] Override http request option.
|
|
3686
|
-
* @throws {RequiredError}
|
|
3687
|
-
*/
|
|
3688
|
-
updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3689
|
-
/**
|
|
3690
|
-
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'id\'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * id those colomns represent * The source of the edge * The target of the edge * The id of the edge All following columns content are up to you.
|
|
3691
|
-
* @summary Upload data from zip file to dataset\'s twingraph
|
|
3692
|
-
* @param {string} organizationId the Organization identifier
|
|
3693
|
-
* @param {string} datasetId the Dataset identifier
|
|
3694
|
-
* @param {any} body
|
|
3695
|
-
* @param {*} [options] Override http request option.
|
|
3696
|
-
* @throws {RequiredError}
|
|
3697
|
-
*/
|
|
3698
|
-
uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileUploadValidation>>;
|
|
3699
|
-
};
|
|
3700
|
-
/**
|
|
3701
|
-
* DatasetApi - factory interface
|
|
3702
|
-
* @export
|
|
3703
|
-
*/
|
|
3704
|
-
export declare const DatasetApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3705
|
-
/**
|
|
3706
|
-
*
|
|
3707
|
-
* @summary Add a control access to the Dataset
|
|
3708
|
-
* @param {string} organizationId the Organization identifier
|
|
3709
|
-
* @param {string} datasetId the Dataset identifier
|
|
3710
|
-
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
3711
|
-
* @param {*} [options] Override http request option.
|
|
3712
|
-
* @throws {RequiredError}
|
|
3713
|
-
*/
|
|
3714
|
-
addDatasetAccessControl(organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: any): AxiosPromise<DatasetAccessControl>;
|
|
3715
|
-
/**
|
|
3716
|
-
*
|
|
3717
|
-
* @summary Add Dataset Compatibility elements.
|
|
3718
|
-
* @param {string} organizationId the Organization identifier
|
|
3719
|
-
* @param {string} datasetId the Dataset identifier
|
|
3720
|
-
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
3721
|
-
* @param {*} [options] Override http request option.
|
|
3722
|
-
* @throws {RequiredError}
|
|
3723
|
-
*/
|
|
3724
|
-
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: any): AxiosPromise<Array<DatasetCompatibility>>;
|
|
3725
|
-
/**
|
|
3726
|
-
* Not implemented!
|
|
3727
|
-
* @summary Copy a Dataset to another Dataset.
|
|
3728
|
-
* @param {string} organizationId the Organization identifier
|
|
3729
|
-
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
3730
|
-
* @param {*} [options] Override http request option.
|
|
3731
|
-
* @throws {RequiredError}
|
|
3732
|
-
*/
|
|
3733
|
-
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: any): AxiosPromise<DatasetCopyParameters>;
|
|
3734
|
-
/**
|
|
3735
|
-
*
|
|
3736
|
-
* @summary Create a new Dataset
|
|
3737
|
-
* @param {string} organizationId the Organization identifier
|
|
3738
|
-
* @param {Dataset} dataset the Dataset to create
|
|
3739
|
-
* @param {*} [options] Override http request option.
|
|
3740
|
-
* @throws {RequiredError}
|
|
3741
|
-
*/
|
|
3742
|
-
createDataset(organizationId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
3743
|
-
/**
|
|
3744
|
-
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
3745
|
-
* @summary Create a sub-dataset from the dataset in parameter
|
|
3746
|
-
* @param {string} organizationId the Organization identifier
|
|
3747
|
-
* @param {string} datasetId the Dataset identifier
|
|
3748
|
-
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
3749
|
-
* @param {*} [options] Override http request option.
|
|
3750
|
-
* @throws {RequiredError}
|
|
3751
|
-
*/
|
|
3752
|
-
createSubDataset(organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: any): AxiosPromise<Dataset>;
|
|
3753
|
-
/**
|
|
3754
|
-
* create new entities in a graph instance
|
|
3755
|
-
* @summary Create new entities in a graph instance
|
|
3756
|
-
* @param {string} organizationId the Organization identifier
|
|
3757
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3758
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3759
|
-
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
3760
|
-
* @param {*} [options] Override http request option.
|
|
3761
|
-
* @throws {RequiredError}
|
|
3762
|
-
*/
|
|
3763
|
-
createTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
3764
|
-
/**
|
|
3765
|
-
*
|
|
3766
|
-
* @summary Delete a dataset
|
|
3767
|
-
* @param {string} organizationId the Organization identifier
|
|
3768
|
-
* @param {string} datasetId the Dataset identifier
|
|
3769
|
-
* @param {*} [options] Override http request option.
|
|
3770
|
-
* @throws {RequiredError}
|
|
3771
|
-
*/
|
|
3772
|
-
deleteDataset(organizationId: string, datasetId: string, options?: any): AxiosPromise<void>;
|
|
3773
|
-
/**
|
|
3774
|
-
* delete entities in a graph instance
|
|
3775
|
-
* @summary Delete entities in a graph instance
|
|
3776
|
-
* @param {string} organizationId the Organization identifier
|
|
3777
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3778
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3779
|
-
* @param {Array<string>} ids the entities to delete
|
|
3780
|
-
* @param {*} [options] Override http request option.
|
|
3781
|
-
* @throws {RequiredError}
|
|
3782
|
-
*/
|
|
3783
|
-
deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
|
|
3784
|
-
/**
|
|
3785
|
-
* Download the compressed graph reference by the hash in a zip file
|
|
3786
|
-
* @summary Download a graph as a zip file
|
|
3787
|
-
* @param {string} organizationId the Organization identifier
|
|
3788
|
-
* @param {string} hash the Graph download identifier
|
|
3789
|
-
* @param {*} [options] Override http request option.
|
|
3790
|
-
* @throws {RequiredError}
|
|
3791
|
-
*/
|
|
3792
|
-
downloadTwingraph(organizationId: string, hash: string, options?: any): AxiosPromise<any>;
|
|
3793
|
-
/**
|
|
3794
|
-
*
|
|
3795
|
-
* @summary List all Datasets
|
|
3796
|
-
* @param {string} organizationId the Organization identifier
|
|
3797
|
-
* @param {number} [page] page number to query
|
|
3798
|
-
* @param {number} [size] amount of result by page
|
|
3799
|
-
* @param {*} [options] Override http request option.
|
|
3800
|
-
* @throws {RequiredError}
|
|
3801
|
-
*/
|
|
3802
|
-
findAllDatasets(organizationId: string, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
|
|
3803
|
-
/**
|
|
3804
|
-
*
|
|
3805
|
-
* @summary Get the details of a Dataset
|
|
3806
|
-
* @param {string} organizationId the Organization identifier
|
|
3807
|
-
* @param {string} datasetId the Dataset identifier
|
|
3808
|
-
* @param {*} [options] Override http request option.
|
|
3809
|
-
* @throws {RequiredError}
|
|
3810
|
-
*/
|
|
3811
|
-
findDatasetById(organizationId: string, datasetId: string, options?: any): AxiosPromise<Dataset>;
|
|
3812
|
-
/**
|
|
3813
|
-
*
|
|
3814
|
-
* @summary Get a control access for the Dataset
|
|
3815
|
-
* @param {string} organizationId the Organization identifier
|
|
3816
|
-
* @param {string} datasetId the Dataset identifier
|
|
3817
|
-
* @param {string} identityId the User identifier
|
|
3818
|
-
* @param {*} [options] Override http request option.
|
|
3819
|
-
* @throws {RequiredError}
|
|
3820
|
-
*/
|
|
3821
|
-
getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<DatasetAccessControl>;
|
|
3822
|
-
/**
|
|
3823
|
-
*
|
|
3824
|
-
* @summary Get the Dataset security information
|
|
3825
|
-
* @param {string} organizationId the Organization identifier
|
|
3826
|
-
* @param {string} datasetId the Dataset identifier
|
|
3827
|
-
* @param {*} [options] Override http request option.
|
|
3828
|
-
* @throws {RequiredError}
|
|
3829
|
-
*/
|
|
3830
|
-
getDatasetSecurity(organizationId: string, datasetId: string, options?: any): AxiosPromise<DatasetSecurity>;
|
|
3831
|
-
/**
|
|
3832
|
-
*
|
|
3833
|
-
* @summary Get the Dataset security users list
|
|
3834
|
-
* @param {string} organizationId the Organization identifier
|
|
3835
|
-
* @param {string} datasetId the Dataset identifier
|
|
3836
|
-
* @param {*} [options] Override http request option.
|
|
3837
|
-
* @throws {RequiredError}
|
|
3838
|
-
*/
|
|
3839
|
-
getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: any): AxiosPromise<Array<string>>;
|
|
3840
|
-
/**
|
|
3841
|
-
* Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
|
|
3842
|
-
* @summary Get the dataset\'s refresh job status
|
|
3843
|
-
* @param {string} organizationId the Organization identifier
|
|
3844
|
-
* @param {string} datasetId the dataset identifier
|
|
3845
|
-
* @param {*} [options] Override http request option.
|
|
3846
|
-
* @throws {RequiredError}
|
|
3847
|
-
*/
|
|
3848
|
-
getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: any): AxiosPromise<string>;
|
|
3849
|
-
/**
|
|
3850
|
-
* get entities in a graph instance
|
|
3851
|
-
* @summary Get entities in a graph instance
|
|
3852
|
-
* @param {string} organizationId the Organization identifier
|
|
3853
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3854
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3855
|
-
* @param {Array<string>} ids the entities to get
|
|
3856
|
-
* @param {*} [options] Override http request option.
|
|
3857
|
-
* @throws {RequiredError}
|
|
3858
|
-
*/
|
|
3859
|
-
getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
|
|
3860
|
-
/**
|
|
3861
|
-
* Refresh dataset from parent source. At date, sources can be: dataset (refresh from another dataset) Azure Digital twin Azure storage Local File (import a new file) During refresh, datas are overwritten
|
|
3862
|
-
* @summary Refresh data on dataset from dataset\'s source
|
|
3863
|
-
* @param {string} organizationId the Organization identifier
|
|
3864
|
-
* @param {string} datasetId the Dataset identifier
|
|
3865
|
-
* @param {*} [options] Override http request option.
|
|
3866
|
-
* @throws {RequiredError}
|
|
3867
|
-
*/
|
|
3868
|
-
refreshDataset(organizationId: string, datasetId: string, options?: any): AxiosPromise<DatasetTwinGraphInfo>;
|
|
3869
|
-
/**
|
|
3870
|
-
*
|
|
3871
|
-
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
3872
|
-
* @param {string} organizationId the Organization identifier
|
|
3873
|
-
* @param {string} datasetId the Dataset identifier
|
|
3874
|
-
* @param {*} [options] Override http request option.
|
|
3875
|
-
* @throws {RequiredError}
|
|
3876
|
-
*/
|
|
3877
|
-
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: any): AxiosPromise<void>;
|
|
3878
|
-
/**
|
|
3879
|
-
*
|
|
3880
|
-
* @summary Remove the specified access from the given Dataset
|
|
3881
|
-
* @param {string} organizationId the Organization identifier
|
|
3882
|
-
* @param {string} datasetId the Dataset identifier
|
|
3883
|
-
* @param {string} identityId the User identifier
|
|
3884
|
-
* @param {*} [options] Override http request option.
|
|
3885
|
-
* @throws {RequiredError}
|
|
3886
|
-
*/
|
|
3887
|
-
removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<void>;
|
|
3888
|
-
/**
|
|
3889
|
-
* Rollback the twingraph on a dataset after a failed refresh
|
|
3890
|
-
* @summary Rollback the dataset after a failed refresh
|
|
3891
|
-
* @param {string} organizationId the Organization identifier
|
|
3892
|
-
* @param {string} datasetId the Dataset identifier
|
|
3893
|
-
* @param {*} [options] Override http request option.
|
|
3894
|
-
* @throws {RequiredError}
|
|
3895
|
-
*/
|
|
3896
|
-
rollbackRefresh(organizationId: string, datasetId: string, options?: any): AxiosPromise<string>;
|
|
3897
|
-
/**
|
|
3898
|
-
*
|
|
3899
|
-
* @summary Search Datasets by tags
|
|
3900
|
-
* @param {string} organizationId the Organization identifier
|
|
3901
|
-
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3902
|
-
* @param {number} [page] page number to query
|
|
3903
|
-
* @param {number} [size] amount of result by page
|
|
3904
|
-
* @param {*} [options] Override http request option.
|
|
3905
|
-
* @throws {RequiredError}
|
|
3906
|
-
*/
|
|
3907
|
-
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
|
|
3908
|
-
/**
|
|
3909
|
-
*
|
|
3910
|
-
* @summary Set the Dataset default security
|
|
3911
|
-
* @param {string} organizationId the Organization identifier
|
|
3912
|
-
* @param {string} datasetId the Dataset identifier
|
|
3913
|
-
* @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
|
|
3914
|
-
* @param {*} [options] Override http request option.
|
|
3915
|
-
* @throws {RequiredError}
|
|
3916
|
-
*/
|
|
3917
|
-
setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: any): AxiosPromise<DatasetSecurity>;
|
|
3918
|
-
/**
|
|
3919
|
-
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
3920
|
-
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
3921
|
-
* @param {string} organizationId the Organization identifier
|
|
3922
|
-
* @param {string} datasetId the Graph Identifier
|
|
3923
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3924
|
-
* @param {*} [options] Override http request option.
|
|
3925
|
-
* @throws {RequiredError}
|
|
3926
|
-
*/
|
|
3927
|
-
twingraphBatchQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: any): AxiosPromise<DatasetTwinGraphHash>;
|
|
3928
|
-
/**
|
|
3929
|
-
* Async batch update by loading a CSV file on a graph instance
|
|
3930
|
-
* @summary Async batch update by loading a CSV file on a graph instance
|
|
3931
|
-
* @param {string} organizationId the Organization identifier
|
|
3932
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3933
|
-
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
3934
|
-
* @param {any} body
|
|
3935
|
-
* @param {*} [options] Override http request option.
|
|
3936
|
-
* @throws {RequiredError}
|
|
3937
|
-
*/
|
|
3938
|
-
twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult>;
|
|
3939
|
-
/**
|
|
3940
|
-
* Run a query on a graph instance and return the result as a json
|
|
3941
|
-
* @summary Return the result of a query made on the graph instance as a json
|
|
3942
|
-
* @param {string} organizationId the Organization identifier
|
|
3943
|
-
* @param {string} datasetId the Dataset identifier
|
|
3944
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3945
|
-
* @param {*} [options] Override http request option.
|
|
3946
|
-
* @throws {RequiredError}
|
|
3947
|
-
*/
|
|
3948
|
-
twingraphQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: any): AxiosPromise<string>;
|
|
3949
|
-
/**
|
|
3950
|
-
*
|
|
3951
|
-
* @summary Update a dataset
|
|
3952
|
-
* @param {string} organizationId the Organization identifier
|
|
3953
|
-
* @param {string} datasetId the Dataset identifier
|
|
3954
|
-
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
3955
|
-
* @param {*} [options] Override http request option.
|
|
3956
|
-
* @throws {RequiredError}
|
|
3957
|
-
*/
|
|
3958
|
-
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
3959
|
-
/**
|
|
3960
|
-
*
|
|
3961
|
-
* @summary Update the specified access to User for a Dataset
|
|
3962
|
-
* @param {string} organizationId the Organization identifier
|
|
3963
|
-
* @param {string} datasetId the Dataset identifier
|
|
3964
|
-
* @param {string} identityId the User identifier
|
|
3965
|
-
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
3966
|
-
* @param {*} [options] Override http request option.
|
|
3967
|
-
* @throws {RequiredError}
|
|
3968
|
-
*/
|
|
3969
|
-
updateDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: any): AxiosPromise<DatasetAccessControl>;
|
|
3970
|
-
/**
|
|
3971
|
-
* update entities in a graph instance
|
|
3972
|
-
* @summary Update entities in a graph instance
|
|
3973
|
-
* @param {string} organizationId the Organization identifier
|
|
3974
|
-
* @param {string} datasetId the Dataset Identifier
|
|
3975
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
3976
|
-
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
3977
|
-
* @param {*} [options] Override http request option.
|
|
3978
|
-
* @throws {RequiredError}
|
|
3979
|
-
*/
|
|
3980
|
-
updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
3981
|
-
/**
|
|
3982
|
-
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'id\'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * id those colomns represent * The source of the edge * The target of the edge * The id of the edge All following columns content are up to you.
|
|
3983
|
-
* @summary Upload data from zip file to dataset\'s twingraph
|
|
3984
|
-
* @param {string} organizationId the Organization identifier
|
|
3985
|
-
* @param {string} datasetId the Dataset identifier
|
|
3986
|
-
* @param {any} body
|
|
3987
|
-
* @param {*} [options] Override http request option.
|
|
3988
|
-
* @throws {RequiredError}
|
|
3989
|
-
*/
|
|
3990
|
-
uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: any): AxiosPromise<FileUploadValidation>;
|
|
3991
|
-
};
|
|
3992
|
-
/**
|
|
3993
|
-
* DatasetApi - object-oriented interface
|
|
3994
|
-
* @export
|
|
3995
|
-
* @class DatasetApi
|
|
3996
|
-
* @extends {BaseAPI}
|
|
3997
|
-
*/
|
|
3998
|
-
export declare class DatasetApi extends BaseAPI {
|
|
3999
|
-
/**
|
|
4000
|
-
*
|
|
4001
|
-
* @summary Add a control access to the Dataset
|
|
4002
|
-
* @param {string} organizationId the Organization identifier
|
|
4003
|
-
* @param {string} datasetId the Dataset identifier
|
|
4004
|
-
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
4005
|
-
* @param {*} [options] Override http request option.
|
|
4006
|
-
* @throws {RequiredError}
|
|
4007
|
-
* @memberof DatasetApi
|
|
4008
|
-
*/
|
|
4009
|
-
addDatasetAccessControl(organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl>>;
|
|
4010
|
-
/**
|
|
4011
|
-
*
|
|
4012
|
-
* @summary Add Dataset Compatibility elements.
|
|
4013
|
-
* @param {string} organizationId the Organization identifier
|
|
4014
|
-
* @param {string} datasetId the Dataset identifier
|
|
4015
|
-
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
4016
|
-
* @param {*} [options] Override http request option.
|
|
4017
|
-
* @throws {RequiredError}
|
|
4018
|
-
* @memberof DatasetApi
|
|
4019
|
-
*/
|
|
4020
|
-
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCompatibility[]>>;
|
|
4021
|
-
/**
|
|
4022
|
-
* Not implemented!
|
|
4023
|
-
* @summary Copy a Dataset to another Dataset.
|
|
4024
|
-
* @param {string} organizationId the Organization identifier
|
|
4025
|
-
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
4026
|
-
* @param {*} [options] Override http request option.
|
|
4027
|
-
* @throws {RequiredError}
|
|
4028
|
-
* @memberof DatasetApi
|
|
4029
|
-
*/
|
|
4030
|
-
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCopyParameters>>;
|
|
4031
|
-
/**
|
|
4032
|
-
*
|
|
4033
|
-
* @summary Create a new Dataset
|
|
4034
|
-
* @param {string} organizationId the Organization identifier
|
|
4035
|
-
* @param {Dataset} dataset the Dataset to create
|
|
4036
|
-
* @param {*} [options] Override http request option.
|
|
4037
|
-
* @throws {RequiredError}
|
|
4038
|
-
* @memberof DatasetApi
|
|
4039
|
-
*/
|
|
4040
|
-
createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4041
|
-
/**
|
|
4042
|
-
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
4043
|
-
* @summary Create a sub-dataset from the dataset in parameter
|
|
4044
|
-
* @param {string} organizationId the Organization identifier
|
|
4045
|
-
* @param {string} datasetId the Dataset identifier
|
|
4046
|
-
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
4047
|
-
* @param {*} [options] Override http request option.
|
|
4048
|
-
* @throws {RequiredError}
|
|
4049
|
-
* @memberof DatasetApi
|
|
4050
|
-
*/
|
|
4051
|
-
createSubDataset(organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4052
|
-
/**
|
|
4053
|
-
* create new entities in a graph instance
|
|
4054
|
-
* @summary Create new entities in a graph instance
|
|
4055
|
-
* @param {string} organizationId the Organization identifier
|
|
4056
|
-
* @param {string} datasetId the Dataset Identifier
|
|
4057
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
4058
|
-
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
4059
|
-
* @param {*} [options] Override http request option.
|
|
4060
|
-
* @throws {RequiredError}
|
|
4061
|
-
* @memberof DatasetApi
|
|
4062
|
-
*/
|
|
4063
|
-
createTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
4064
|
-
/**
|
|
4065
|
-
*
|
|
4066
|
-
* @summary Delete a dataset
|
|
4067
|
-
* @param {string} organizationId the Organization identifier
|
|
4068
|
-
* @param {string} datasetId the Dataset identifier
|
|
4069
|
-
* @param {*} [options] Override http request option.
|
|
4070
|
-
* @throws {RequiredError}
|
|
4071
|
-
* @memberof DatasetApi
|
|
4072
|
-
*/
|
|
4073
|
-
deleteDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4074
|
-
/**
|
|
4075
|
-
* delete entities in a graph instance
|
|
4076
|
-
* @summary Delete entities in a graph instance
|
|
4077
|
-
* @param {string} organizationId the Organization identifier
|
|
4078
|
-
* @param {string} datasetId the Dataset Identifier
|
|
4079
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
4080
|
-
* @param {Array<string>} ids the entities to delete
|
|
4081
|
-
* @param {*} [options] Override http request option.
|
|
4082
|
-
* @throws {RequiredError}
|
|
4083
|
-
* @memberof DatasetApi
|
|
4084
|
-
*/
|
|
4085
|
-
deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4086
|
-
/**
|
|
4087
|
-
* Download the compressed graph reference by the hash in a zip file
|
|
4088
|
-
* @summary Download a graph as a zip file
|
|
4089
|
-
* @param {string} organizationId the Organization identifier
|
|
4090
|
-
* @param {string} hash the Graph download identifier
|
|
4091
|
-
* @param {*} [options] Override http request option.
|
|
4092
|
-
* @throws {RequiredError}
|
|
4093
|
-
* @memberof DatasetApi
|
|
4094
|
-
*/
|
|
4095
|
-
downloadTwingraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any>>;
|
|
4096
|
-
/**
|
|
4097
|
-
*
|
|
4098
|
-
* @summary List all Datasets
|
|
4099
|
-
* @param {string} organizationId the Organization identifier
|
|
4100
|
-
* @param {number} [page] page number to query
|
|
4101
|
-
* @param {number} [size] amount of result by page
|
|
4102
|
-
* @param {*} [options] Override http request option.
|
|
4103
|
-
* @throws {RequiredError}
|
|
4104
|
-
* @memberof DatasetApi
|
|
4105
|
-
*/
|
|
4106
|
-
findAllDatasets(organizationId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[]>>;
|
|
4107
|
-
/**
|
|
4108
|
-
*
|
|
4109
|
-
* @summary Get the details of a Dataset
|
|
4110
|
-
* @param {string} organizationId the Organization identifier
|
|
4111
|
-
* @param {string} datasetId the Dataset identifier
|
|
4112
|
-
* @param {*} [options] Override http request option.
|
|
4113
|
-
* @throws {RequiredError}
|
|
4114
|
-
* @memberof DatasetApi
|
|
4115
|
-
*/
|
|
4116
|
-
findDatasetById(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4117
|
-
/**
|
|
4118
|
-
*
|
|
4119
|
-
* @summary Get a control access for the Dataset
|
|
4120
|
-
* @param {string} organizationId the Organization identifier
|
|
4121
|
-
* @param {string} datasetId the Dataset identifier
|
|
4122
|
-
* @param {string} identityId the User identifier
|
|
4123
|
-
* @param {*} [options] Override http request option.
|
|
4124
|
-
* @throws {RequiredError}
|
|
4125
|
-
* @memberof DatasetApi
|
|
4126
|
-
*/
|
|
4127
|
-
getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl>>;
|
|
4128
|
-
/**
|
|
4129
|
-
*
|
|
4130
|
-
* @summary Get the Dataset security information
|
|
4131
|
-
* @param {string} organizationId the Organization identifier
|
|
4132
|
-
* @param {string} datasetId the Dataset identifier
|
|
4133
|
-
* @param {*} [options] Override http request option.
|
|
4134
|
-
* @throws {RequiredError}
|
|
4135
|
-
* @memberof DatasetApi
|
|
4136
|
-
*/
|
|
4137
|
-
getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetSecurity>>;
|
|
4138
|
-
/**
|
|
4139
|
-
*
|
|
4140
|
-
* @summary Get the Dataset security users list
|
|
4141
|
-
* @param {string} organizationId the Organization identifier
|
|
4142
|
-
* @param {string} datasetId the Dataset identifier
|
|
4143
|
-
* @param {*} [options] Override http request option.
|
|
4144
|
-
* @throws {RequiredError}
|
|
4145
|
-
* @memberof DatasetApi
|
|
4146
|
-
*/
|
|
4147
|
-
getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
4148
|
-
/**
|
|
4149
|
-
* Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
|
|
4150
|
-
* @summary Get the dataset\'s refresh job status
|
|
4151
|
-
* @param {string} organizationId the Organization identifier
|
|
4152
|
-
* @param {string} datasetId the dataset identifier
|
|
4153
|
-
* @param {*} [options] Override http request option.
|
|
4154
|
-
* @throws {RequiredError}
|
|
4155
|
-
* @memberof DatasetApi
|
|
4156
|
-
*/
|
|
4157
|
-
getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
4158
|
-
/**
|
|
4159
|
-
* get entities in a graph instance
|
|
4160
|
-
* @summary Get entities in a graph instance
|
|
4161
|
-
* @param {string} organizationId the Organization identifier
|
|
4162
|
-
* @param {string} datasetId the Dataset Identifier
|
|
4163
|
-
* @param {'node' | 'relationship'} type the entity model type
|
|
4164
|
-
* @param {Array<string>} ids the entities to get
|
|
4165
|
-
* @param {*} [options] Override http request option.
|
|
4166
|
-
* @throws {RequiredError}
|
|
4167
|
-
* @memberof DatasetApi
|
|
4168
|
-
*/
|
|
4169
|
-
getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
4170
|
-
/**
|
|
4171
|
-
* Refresh dataset from parent source. At date, sources can be: dataset (refresh from another dataset) Azure Digital twin Azure storage Local File (import a new file) During refresh, datas are overwritten
|
|
4172
|
-
* @summary Refresh data on dataset from dataset\'s source
|
|
3031
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
4173
3032
|
* @param {string} organizationId the Organization identifier
|
|
4174
3033
|
* @param {string} datasetId the Dataset identifier
|
|
4175
3034
|
* @param {*} [options] Override http request option.
|
|
4176
3035
|
* @throws {RequiredError}
|
|
4177
|
-
* @memberof DatasetApi
|
|
4178
3036
|
*/
|
|
4179
|
-
|
|
3037
|
+
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: any): AxiosPromise<void>;
|
|
4180
3038
|
/**
|
|
4181
3039
|
*
|
|
4182
|
-
* @summary
|
|
3040
|
+
* @summary Search Datasets
|
|
4183
3041
|
* @param {string} organizationId the Organization identifier
|
|
4184
|
-
* @param {
|
|
3042
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3043
|
+
* @param {number} [page] page number to query
|
|
3044
|
+
* @param {number} [size] amount of result by page
|
|
4185
3045
|
* @param {*} [options] Override http request option.
|
|
4186
3046
|
* @throws {RequiredError}
|
|
4187
|
-
* @memberof DatasetApi
|
|
4188
3047
|
*/
|
|
4189
|
-
|
|
3048
|
+
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
|
|
4190
3049
|
/**
|
|
4191
3050
|
*
|
|
4192
|
-
* @summary
|
|
3051
|
+
* @summary Update a dataset
|
|
4193
3052
|
* @param {string} organizationId the Organization identifier
|
|
4194
3053
|
* @param {string} datasetId the Dataset identifier
|
|
4195
|
-
* @param {
|
|
3054
|
+
* @param {Dataset} dataset the new Dataset details.
|
|
4196
3055
|
* @param {*} [options] Override http request option.
|
|
4197
3056
|
* @throws {RequiredError}
|
|
4198
|
-
* @memberof DatasetApi
|
|
4199
3057
|
*/
|
|
4200
|
-
|
|
3058
|
+
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
3059
|
+
};
|
|
3060
|
+
/**
|
|
3061
|
+
* DatasetApi - object-oriented interface
|
|
3062
|
+
* @export
|
|
3063
|
+
* @class DatasetApi
|
|
3064
|
+
* @extends {BaseAPI}
|
|
3065
|
+
*/
|
|
3066
|
+
export declare class DatasetApi extends BaseAPI {
|
|
4201
3067
|
/**
|
|
4202
|
-
*
|
|
4203
|
-
* @summary
|
|
3068
|
+
*
|
|
3069
|
+
* @summary Add Dataset Compatibility elements.
|
|
4204
3070
|
* @param {string} organizationId the Organization identifier
|
|
4205
3071
|
* @param {string} datasetId the Dataset identifier
|
|
3072
|
+
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
4206
3073
|
* @param {*} [options] Override http request option.
|
|
4207
3074
|
* @throws {RequiredError}
|
|
4208
3075
|
* @memberof DatasetApi
|
|
4209
3076
|
*/
|
|
4210
|
-
|
|
3077
|
+
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCompatibility[]>>;
|
|
4211
3078
|
/**
|
|
4212
3079
|
*
|
|
4213
|
-
* @summary
|
|
3080
|
+
* @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
|
|
4214
3081
|
* @param {string} organizationId the Organization identifier
|
|
4215
|
-
* @param {
|
|
4216
|
-
* @param {number} [page] page number to query
|
|
4217
|
-
* @param {number} [size] amount of result by page
|
|
3082
|
+
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
4218
3083
|
* @param {*} [options] Override http request option.
|
|
4219
3084
|
* @throws {RequiredError}
|
|
4220
3085
|
* @memberof DatasetApi
|
|
4221
3086
|
*/
|
|
4222
|
-
|
|
3087
|
+
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCopyParameters>>;
|
|
4223
3088
|
/**
|
|
4224
3089
|
*
|
|
4225
|
-
* @summary
|
|
3090
|
+
* @summary Create a new Dataset
|
|
4226
3091
|
* @param {string} organizationId the Organization identifier
|
|
4227
|
-
* @param {
|
|
4228
|
-
* @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
|
|
3092
|
+
* @param {Dataset} dataset the Dataset to create
|
|
4229
3093
|
* @param {*} [options] Override http request option.
|
|
4230
3094
|
* @throws {RequiredError}
|
|
4231
3095
|
* @memberof DatasetApi
|
|
4232
3096
|
*/
|
|
4233
|
-
|
|
3097
|
+
createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4234
3098
|
/**
|
|
4235
|
-
*
|
|
4236
|
-
* @summary
|
|
3099
|
+
*
|
|
3100
|
+
* @summary Delete a dataset
|
|
4237
3101
|
* @param {string} organizationId the Organization identifier
|
|
4238
|
-
* @param {string} datasetId the
|
|
4239
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3102
|
+
* @param {string} datasetId the Dataset identifier
|
|
4240
3103
|
* @param {*} [options] Override http request option.
|
|
4241
3104
|
* @throws {RequiredError}
|
|
4242
3105
|
* @memberof DatasetApi
|
|
4243
3106
|
*/
|
|
4244
|
-
|
|
3107
|
+
deleteDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4245
3108
|
/**
|
|
4246
|
-
*
|
|
4247
|
-
* @summary
|
|
3109
|
+
*
|
|
3110
|
+
* @summary List all Datasets
|
|
4248
3111
|
* @param {string} organizationId the Organization identifier
|
|
4249
|
-
* @param {
|
|
4250
|
-
* @param {
|
|
4251
|
-
* @param {any} body
|
|
3112
|
+
* @param {number} [page] page number to query
|
|
3113
|
+
* @param {number} [size] amount of result by page
|
|
4252
3114
|
* @param {*} [options] Override http request option.
|
|
4253
3115
|
* @throws {RequiredError}
|
|
4254
3116
|
* @memberof DatasetApi
|
|
4255
3117
|
*/
|
|
4256
|
-
|
|
3118
|
+
findAllDatasets(organizationId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[]>>;
|
|
4257
3119
|
/**
|
|
4258
|
-
*
|
|
4259
|
-
* @summary
|
|
3120
|
+
*
|
|
3121
|
+
* @summary Get the details of a Dataset
|
|
4260
3122
|
* @param {string} organizationId the Organization identifier
|
|
4261
3123
|
* @param {string} datasetId the Dataset identifier
|
|
4262
|
-
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
4263
3124
|
* @param {*} [options] Override http request option.
|
|
4264
3125
|
* @throws {RequiredError}
|
|
4265
3126
|
* @memberof DatasetApi
|
|
4266
3127
|
*/
|
|
4267
|
-
|
|
3128
|
+
findDatasetById(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4268
3129
|
/**
|
|
4269
3130
|
*
|
|
4270
|
-
* @summary
|
|
3131
|
+
* @summary Import a new Dataset
|
|
4271
3132
|
* @param {string} organizationId the Organization identifier
|
|
4272
|
-
* @param {
|
|
4273
|
-
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
3133
|
+
* @param {Dataset} dataset the Dataset to import
|
|
4274
3134
|
* @param {*} [options] Override http request option.
|
|
4275
3135
|
* @throws {RequiredError}
|
|
4276
3136
|
* @memberof DatasetApi
|
|
4277
3137
|
*/
|
|
4278
|
-
|
|
3138
|
+
importDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4279
3139
|
/**
|
|
4280
3140
|
*
|
|
4281
|
-
* @summary
|
|
3141
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
4282
3142
|
* @param {string} organizationId the Organization identifier
|
|
4283
3143
|
* @param {string} datasetId the Dataset identifier
|
|
4284
|
-
* @param {string} identityId the User identifier
|
|
4285
|
-
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
4286
3144
|
* @param {*} [options] Override http request option.
|
|
4287
3145
|
* @throws {RequiredError}
|
|
4288
3146
|
* @memberof DatasetApi
|
|
4289
3147
|
*/
|
|
4290
|
-
|
|
3148
|
+
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4291
3149
|
/**
|
|
4292
|
-
*
|
|
4293
|
-
* @summary
|
|
3150
|
+
*
|
|
3151
|
+
* @summary Search Datasets
|
|
4294
3152
|
* @param {string} organizationId the Organization identifier
|
|
4295
|
-
* @param {
|
|
4296
|
-
* @param {
|
|
4297
|
-
* @param {
|
|
3153
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3154
|
+
* @param {number} [page] page number to query
|
|
3155
|
+
* @param {number} [size] amount of result by page
|
|
4298
3156
|
* @param {*} [options] Override http request option.
|
|
4299
3157
|
* @throws {RequiredError}
|
|
4300
3158
|
* @memberof DatasetApi
|
|
4301
3159
|
*/
|
|
4302
|
-
|
|
3160
|
+
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[]>>;
|
|
4303
3161
|
/**
|
|
4304
|
-
*
|
|
4305
|
-
* @summary
|
|
3162
|
+
*
|
|
3163
|
+
* @summary Update a dataset
|
|
4306
3164
|
* @param {string} organizationId the Organization identifier
|
|
4307
3165
|
* @param {string} datasetId the Dataset identifier
|
|
4308
|
-
* @param {
|
|
3166
|
+
* @param {Dataset} dataset the new Dataset details.
|
|
4309
3167
|
* @param {*} [options] Override http request option.
|
|
4310
3168
|
* @throws {RequiredError}
|
|
4311
3169
|
* @memberof DatasetApi
|
|
4312
3170
|
*/
|
|
4313
|
-
|
|
3171
|
+
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4314
3172
|
}
|
|
4315
3173
|
/**
|
|
4316
3174
|
* OrganizationApi - axios parameter creator
|
|
@@ -4384,6 +3242,14 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
4384
3242
|
* @throws {RequiredError}
|
|
4385
3243
|
*/
|
|
4386
3244
|
getOrganizationSecurityUsers: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3245
|
+
/**
|
|
3246
|
+
*
|
|
3247
|
+
* @summary Import an organization
|
|
3248
|
+
* @param {Organization} organization the Organization to import
|
|
3249
|
+
* @param {*} [options] Override http request option.
|
|
3250
|
+
* @throws {RequiredError}
|
|
3251
|
+
*/
|
|
3252
|
+
importOrganization: (organization: Organization, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4387
3253
|
/**
|
|
4388
3254
|
*
|
|
4389
3255
|
* @summary Register a new organization
|
|
@@ -4405,7 +3271,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
4405
3271
|
*
|
|
4406
3272
|
* @summary Set the Organization default security
|
|
4407
3273
|
* @param {string} organizationId the Organization identifier
|
|
4408
|
-
* @param {OrganizationRole} organizationRole
|
|
3274
|
+
* @param {OrganizationRole} organizationRole the new Organization default security.
|
|
4409
3275
|
* @param {*} [options] Override http request option.
|
|
4410
3276
|
* @throws {RequiredError}
|
|
4411
3277
|
*/
|
|
@@ -4422,7 +3288,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
4422
3288
|
*
|
|
4423
3289
|
* @summary Update an Organization
|
|
4424
3290
|
* @param {string} organizationId the Organization identifier
|
|
4425
|
-
* @param {Organization} organization the new Organization details
|
|
3291
|
+
* @param {Organization} organization the new Organization details
|
|
4426
3292
|
* @param {*} [options] Override http request option.
|
|
4427
3293
|
* @throws {RequiredError}
|
|
4428
3294
|
*/
|
|
@@ -4539,6 +3405,14 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
4539
3405
|
* @throws {RequiredError}
|
|
4540
3406
|
*/
|
|
4541
3407
|
getOrganizationSecurityUsers(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
3408
|
+
/**
|
|
3409
|
+
*
|
|
3410
|
+
* @summary Import an organization
|
|
3411
|
+
* @param {Organization} organization the Organization to import
|
|
3412
|
+
* @param {*} [options] Override http request option.
|
|
3413
|
+
* @throws {RequiredError}
|
|
3414
|
+
*/
|
|
3415
|
+
importOrganization(organization: Organization, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>;
|
|
4542
3416
|
/**
|
|
4543
3417
|
*
|
|
4544
3418
|
* @summary Register a new organization
|
|
@@ -4560,7 +3434,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
4560
3434
|
*
|
|
4561
3435
|
* @summary Set the Organization default security
|
|
4562
3436
|
* @param {string} organizationId the Organization identifier
|
|
4563
|
-
* @param {OrganizationRole} organizationRole
|
|
3437
|
+
* @param {OrganizationRole} organizationRole the new Organization default security.
|
|
4564
3438
|
* @param {*} [options] Override http request option.
|
|
4565
3439
|
* @throws {RequiredError}
|
|
4566
3440
|
*/
|
|
@@ -4577,7 +3451,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
4577
3451
|
*
|
|
4578
3452
|
* @summary Update an Organization
|
|
4579
3453
|
* @param {string} organizationId the Organization identifier
|
|
4580
|
-
* @param {Organization} organization the new Organization details
|
|
3454
|
+
* @param {Organization} organization the new Organization details
|
|
4581
3455
|
* @param {*} [options] Override http request option.
|
|
4582
3456
|
* @throws {RequiredError}
|
|
4583
3457
|
*/
|
|
@@ -4696,6 +3570,14 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
4696
3570
|
* @throws {RequiredError}
|
|
4697
3571
|
*/
|
|
4698
3572
|
getOrganizationSecurityUsers(organizationId: string, options?: any): AxiosPromise<Array<string>>;
|
|
3573
|
+
/**
|
|
3574
|
+
*
|
|
3575
|
+
* @summary Import an organization
|
|
3576
|
+
* @param {Organization} organization the Organization to import
|
|
3577
|
+
* @param {*} [options] Override http request option.
|
|
3578
|
+
* @throws {RequiredError}
|
|
3579
|
+
*/
|
|
3580
|
+
importOrganization(organization: Organization, options?: any): AxiosPromise<Organization>;
|
|
4699
3581
|
/**
|
|
4700
3582
|
*
|
|
4701
3583
|
* @summary Register a new organization
|
|
@@ -4717,7 +3599,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
4717
3599
|
*
|
|
4718
3600
|
* @summary Set the Organization default security
|
|
4719
3601
|
* @param {string} organizationId the Organization identifier
|
|
4720
|
-
* @param {OrganizationRole} organizationRole
|
|
3602
|
+
* @param {OrganizationRole} organizationRole the new Organization default security.
|
|
4721
3603
|
* @param {*} [options] Override http request option.
|
|
4722
3604
|
* @throws {RequiredError}
|
|
4723
3605
|
*/
|
|
@@ -4734,7 +3616,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
4734
3616
|
*
|
|
4735
3617
|
* @summary Update an Organization
|
|
4736
3618
|
* @param {string} organizationId the Organization identifier
|
|
4737
|
-
* @param {Organization} organization the new Organization details
|
|
3619
|
+
* @param {Organization} organization the new Organization details
|
|
4738
3620
|
* @param {*} [options] Override http request option.
|
|
4739
3621
|
* @throws {RequiredError}
|
|
4740
3622
|
*/
|
|
@@ -4863,6 +3745,15 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
4863
3745
|
* @memberof OrganizationApi
|
|
4864
3746
|
*/
|
|
4865
3747
|
getOrganizationSecurityUsers(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
3748
|
+
/**
|
|
3749
|
+
*
|
|
3750
|
+
* @summary Import an organization
|
|
3751
|
+
* @param {Organization} organization the Organization to import
|
|
3752
|
+
* @param {*} [options] Override http request option.
|
|
3753
|
+
* @throws {RequiredError}
|
|
3754
|
+
* @memberof OrganizationApi
|
|
3755
|
+
*/
|
|
3756
|
+
importOrganization(organization: Organization, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization>>;
|
|
4866
3757
|
/**
|
|
4867
3758
|
*
|
|
4868
3759
|
* @summary Register a new organization
|
|
@@ -4886,7 +3777,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
4886
3777
|
*
|
|
4887
3778
|
* @summary Set the Organization default security
|
|
4888
3779
|
* @param {string} organizationId the Organization identifier
|
|
4889
|
-
* @param {OrganizationRole} organizationRole
|
|
3780
|
+
* @param {OrganizationRole} organizationRole the new Organization default security.
|
|
4890
3781
|
* @param {*} [options] Override http request option.
|
|
4891
3782
|
* @throws {RequiredError}
|
|
4892
3783
|
* @memberof OrganizationApi
|
|
@@ -4905,7 +3796,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
4905
3796
|
*
|
|
4906
3797
|
* @summary Update an Organization
|
|
4907
3798
|
* @param {string} organizationId the Organization identifier
|
|
4908
|
-
* @param {Organization} organization the new Organization details
|
|
3799
|
+
* @param {Organization} organization the new Organization details
|
|
4909
3800
|
* @param {*} [options] Override http request option.
|
|
4910
3801
|
* @throws {RequiredError}
|
|
4911
3802
|
* @memberof OrganizationApi
|
|
@@ -5020,10 +3911,11 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5020
3911
|
* @param {string} organizationId the Organization identifier
|
|
5021
3912
|
* @param {string} workspaceId the Workspace identifier
|
|
5022
3913
|
* @param {string} scenarioId the Scenario identifier
|
|
3914
|
+
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
5023
3915
|
* @param {*} [options] Override http request option.
|
|
5024
3916
|
* @throws {RequiredError}
|
|
5025
3917
|
*/
|
|
5026
|
-
deleteScenario: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3918
|
+
deleteScenario: (organizationId: string, workspaceId: string, scenarioId: string, waitRelationshipPropagation?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5027
3919
|
/**
|
|
5028
3920
|
*
|
|
5029
3921
|
* @summary Download Scenario data
|
|
@@ -5094,12 +3986,11 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5094
3986
|
* @summary Get the Scenario permission by given role
|
|
5095
3987
|
* @param {string} organizationId the Organization identifier
|
|
5096
3988
|
* @param {string} workspaceId the Workspace identifier
|
|
5097
|
-
* @param {string} scenarioId the Scenario identifier
|
|
5098
3989
|
* @param {string} role the Role
|
|
5099
3990
|
* @param {*} [options] Override http request option.
|
|
5100
3991
|
* @throws {RequiredError}
|
|
5101
3992
|
*/
|
|
5102
|
-
getScenarioPermissions: (organizationId: string, workspaceId: string,
|
|
3993
|
+
getScenarioPermissions: (organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5103
3994
|
/**
|
|
5104
3995
|
*
|
|
5105
3996
|
* @summary Get the Scenario security information
|
|
@@ -5139,6 +4030,16 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5139
4030
|
* @throws {RequiredError}
|
|
5140
4031
|
*/
|
|
5141
4032
|
getScenariosTree: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4033
|
+
/**
|
|
4034
|
+
*
|
|
4035
|
+
* @summary Import Scenario
|
|
4036
|
+
* @param {string} organizationId the Organization identifier
|
|
4037
|
+
* @param {string} workspaceId the Workspace identifier
|
|
4038
|
+
* @param {Scenario} scenario the Scenario to import
|
|
4039
|
+
* @param {*} [options] Override http request option.
|
|
4040
|
+
* @throws {RequiredError}
|
|
4041
|
+
*/
|
|
4042
|
+
importScenario: (organizationId: string, workspaceId: string, scenario: Scenario, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5142
4043
|
/**
|
|
5143
4044
|
*
|
|
5144
4045
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -5166,7 +4067,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5166
4067
|
* @param {string} organizationId the Organization identifier
|
|
5167
4068
|
* @param {string} workspaceId the Workspace identifier
|
|
5168
4069
|
* @param {string} scenarioId the Scenario identifier
|
|
5169
|
-
* @param {ScenarioRole} scenarioRole
|
|
4070
|
+
* @param {ScenarioRole} scenarioRole the new Scenario default security.
|
|
5170
4071
|
* @param {*} [options] Override http request option.
|
|
5171
4072
|
* @throws {RequiredError}
|
|
5172
4073
|
*/
|
|
@@ -5177,7 +4078,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5177
4078
|
* @param {string} organizationId the Organization identifier
|
|
5178
4079
|
* @param {string} workspaceId the Workspace identifier
|
|
5179
4080
|
* @param {string} scenarioId the Scenario identifier
|
|
5180
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
4081
|
+
* @param {Scenario} scenario the new Scenario details.
|
|
5181
4082
|
* @param {*} [options] Override http request option.
|
|
5182
4083
|
* @throws {RequiredError}
|
|
5183
4084
|
*/
|
|
@@ -5258,10 +4159,11 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
5258
4159
|
* @param {string} organizationId the Organization identifier
|
|
5259
4160
|
* @param {string} workspaceId the Workspace identifier
|
|
5260
4161
|
* @param {string} scenarioId the Scenario identifier
|
|
4162
|
+
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
5261
4163
|
* @param {*} [options] Override http request option.
|
|
5262
4164
|
* @throws {RequiredError}
|
|
5263
4165
|
*/
|
|
5264
|
-
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4166
|
+
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, waitRelationshipPropagation?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5265
4167
|
/**
|
|
5266
4168
|
*
|
|
5267
4169
|
* @summary Download Scenario data
|
|
@@ -5332,12 +4234,11 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
5332
4234
|
* @summary Get the Scenario permission by given role
|
|
5333
4235
|
* @param {string} organizationId the Organization identifier
|
|
5334
4236
|
* @param {string} workspaceId the Workspace identifier
|
|
5335
|
-
* @param {string} scenarioId the Scenario identifier
|
|
5336
4237
|
* @param {string} role the Role
|
|
5337
4238
|
* @param {*} [options] Override http request option.
|
|
5338
4239
|
* @throws {RequiredError}
|
|
5339
4240
|
*/
|
|
5340
|
-
getScenarioPermissions(organizationId: string, workspaceId: string,
|
|
4241
|
+
getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5341
4242
|
/**
|
|
5342
4243
|
*
|
|
5343
4244
|
* @summary Get the Scenario security information
|
|
@@ -5377,6 +4278,16 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
5377
4278
|
* @throws {RequiredError}
|
|
5378
4279
|
*/
|
|
5379
4280
|
getScenariosTree(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Scenario>>>;
|
|
4281
|
+
/**
|
|
4282
|
+
*
|
|
4283
|
+
* @summary Import Scenario
|
|
4284
|
+
* @param {string} organizationId the Organization identifier
|
|
4285
|
+
* @param {string} workspaceId the Workspace identifier
|
|
4286
|
+
* @param {Scenario} scenario the Scenario to import
|
|
4287
|
+
* @param {*} [options] Override http request option.
|
|
4288
|
+
* @throws {RequiredError}
|
|
4289
|
+
*/
|
|
4290
|
+
importScenario(organizationId: string, workspaceId: string, scenario: Scenario, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scenario>>;
|
|
5380
4291
|
/**
|
|
5381
4292
|
*
|
|
5382
4293
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -5404,7 +4315,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
5404
4315
|
* @param {string} organizationId the Organization identifier
|
|
5405
4316
|
* @param {string} workspaceId the Workspace identifier
|
|
5406
4317
|
* @param {string} scenarioId the Scenario identifier
|
|
5407
|
-
* @param {ScenarioRole} scenarioRole
|
|
4318
|
+
* @param {ScenarioRole} scenarioRole the new Scenario default security.
|
|
5408
4319
|
* @param {*} [options] Override http request option.
|
|
5409
4320
|
* @throws {RequiredError}
|
|
5410
4321
|
*/
|
|
@@ -5415,7 +4326,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
5415
4326
|
* @param {string} organizationId the Organization identifier
|
|
5416
4327
|
* @param {string} workspaceId the Workspace identifier
|
|
5417
4328
|
* @param {string} scenarioId the Scenario identifier
|
|
5418
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
4329
|
+
* @param {Scenario} scenario the new Scenario details.
|
|
5419
4330
|
* @param {*} [options] Override http request option.
|
|
5420
4331
|
* @throws {RequiredError}
|
|
5421
4332
|
*/
|
|
@@ -5496,10 +4407,11 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
5496
4407
|
* @param {string} organizationId the Organization identifier
|
|
5497
4408
|
* @param {string} workspaceId the Workspace identifier
|
|
5498
4409
|
* @param {string} scenarioId the Scenario identifier
|
|
4410
|
+
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
5499
4411
|
* @param {*} [options] Override http request option.
|
|
5500
4412
|
* @throws {RequiredError}
|
|
5501
4413
|
*/
|
|
5502
|
-
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<void>;
|
|
4414
|
+
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, waitRelationshipPropagation?: boolean, options?: any): AxiosPromise<void>;
|
|
5503
4415
|
/**
|
|
5504
4416
|
*
|
|
5505
4417
|
* @summary Download Scenario data
|
|
@@ -5570,12 +4482,11 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
5570
4482
|
* @summary Get the Scenario permission by given role
|
|
5571
4483
|
* @param {string} organizationId the Organization identifier
|
|
5572
4484
|
* @param {string} workspaceId the Workspace identifier
|
|
5573
|
-
* @param {string} scenarioId the Scenario identifier
|
|
5574
4485
|
* @param {string} role the Role
|
|
5575
4486
|
* @param {*} [options] Override http request option.
|
|
5576
4487
|
* @throws {RequiredError}
|
|
5577
4488
|
*/
|
|
5578
|
-
getScenarioPermissions(organizationId: string, workspaceId: string,
|
|
4489
|
+
getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: any): AxiosPromise<Array<string>>;
|
|
5579
4490
|
/**
|
|
5580
4491
|
*
|
|
5581
4492
|
* @summary Get the Scenario security information
|
|
@@ -5615,6 +4526,16 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
5615
4526
|
* @throws {RequiredError}
|
|
5616
4527
|
*/
|
|
5617
4528
|
getScenariosTree(organizationId: string, workspaceId: string, options?: any): AxiosPromise<Array<Scenario>>;
|
|
4529
|
+
/**
|
|
4530
|
+
*
|
|
4531
|
+
* @summary Import Scenario
|
|
4532
|
+
* @param {string} organizationId the Organization identifier
|
|
4533
|
+
* @param {string} workspaceId the Workspace identifier
|
|
4534
|
+
* @param {Scenario} scenario the Scenario to import
|
|
4535
|
+
* @param {*} [options] Override http request option.
|
|
4536
|
+
* @throws {RequiredError}
|
|
4537
|
+
*/
|
|
4538
|
+
importScenario(organizationId: string, workspaceId: string, scenario: Scenario, options?: any): AxiosPromise<Scenario>;
|
|
5618
4539
|
/**
|
|
5619
4540
|
*
|
|
5620
4541
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -5642,7 +4563,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
5642
4563
|
* @param {string} organizationId the Organization identifier
|
|
5643
4564
|
* @param {string} workspaceId the Workspace identifier
|
|
5644
4565
|
* @param {string} scenarioId the Scenario identifier
|
|
5645
|
-
* @param {ScenarioRole} scenarioRole
|
|
4566
|
+
* @param {ScenarioRole} scenarioRole the new Scenario default security.
|
|
5646
4567
|
* @param {*} [options] Override http request option.
|
|
5647
4568
|
* @throws {RequiredError}
|
|
5648
4569
|
*/
|
|
@@ -5653,7 +4574,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
5653
4574
|
* @param {string} organizationId the Organization identifier
|
|
5654
4575
|
* @param {string} workspaceId the Workspace identifier
|
|
5655
4576
|
* @param {string} scenarioId the Scenario identifier
|
|
5656
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
4577
|
+
* @param {Scenario} scenario the new Scenario details.
|
|
5657
4578
|
* @param {*} [options] Override http request option.
|
|
5658
4579
|
* @throws {RequiredError}
|
|
5659
4580
|
*/
|
|
@@ -5741,11 +4662,12 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
5741
4662
|
* @param {string} organizationId the Organization identifier
|
|
5742
4663
|
* @param {string} workspaceId the Workspace identifier
|
|
5743
4664
|
* @param {string} scenarioId the Scenario identifier
|
|
4665
|
+
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
5744
4666
|
* @param {*} [options] Override http request option.
|
|
5745
4667
|
* @throws {RequiredError}
|
|
5746
4668
|
* @memberof ScenarioApi
|
|
5747
4669
|
*/
|
|
5748
|
-
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4670
|
+
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, waitRelationshipPropagation?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
5749
4671
|
/**
|
|
5750
4672
|
*
|
|
5751
4673
|
* @summary Download Scenario data
|
|
@@ -5822,13 +4744,12 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
5822
4744
|
* @summary Get the Scenario permission by given role
|
|
5823
4745
|
* @param {string} organizationId the Organization identifier
|
|
5824
4746
|
* @param {string} workspaceId the Workspace identifier
|
|
5825
|
-
* @param {string} scenarioId the Scenario identifier
|
|
5826
4747
|
* @param {string} role the Role
|
|
5827
4748
|
* @param {*} [options] Override http request option.
|
|
5828
4749
|
* @throws {RequiredError}
|
|
5829
4750
|
* @memberof ScenarioApi
|
|
5830
4751
|
*/
|
|
5831
|
-
getScenarioPermissions(organizationId: string, workspaceId: string,
|
|
4752
|
+
getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
5832
4753
|
/**
|
|
5833
4754
|
*
|
|
5834
4755
|
* @summary Get the Scenario security information
|
|
@@ -5872,6 +4793,17 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
5872
4793
|
* @memberof ScenarioApi
|
|
5873
4794
|
*/
|
|
5874
4795
|
getScenariosTree(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scenario[]>>;
|
|
4796
|
+
/**
|
|
4797
|
+
*
|
|
4798
|
+
* @summary Import Scenario
|
|
4799
|
+
* @param {string} organizationId the Organization identifier
|
|
4800
|
+
* @param {string} workspaceId the Workspace identifier
|
|
4801
|
+
* @param {Scenario} scenario the Scenario to import
|
|
4802
|
+
* @param {*} [options] Override http request option.
|
|
4803
|
+
* @throws {RequiredError}
|
|
4804
|
+
* @memberof ScenarioApi
|
|
4805
|
+
*/
|
|
4806
|
+
importScenario(organizationId: string, workspaceId: string, scenario: Scenario, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scenario>>;
|
|
5875
4807
|
/**
|
|
5876
4808
|
*
|
|
5877
4809
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -5901,7 +4833,7 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
5901
4833
|
* @param {string} organizationId the Organization identifier
|
|
5902
4834
|
* @param {string} workspaceId the Workspace identifier
|
|
5903
4835
|
* @param {string} scenarioId the Scenario identifier
|
|
5904
|
-
* @param {ScenarioRole} scenarioRole
|
|
4836
|
+
* @param {ScenarioRole} scenarioRole the new Scenario default security.
|
|
5905
4837
|
* @param {*} [options] Override http request option.
|
|
5906
4838
|
* @throws {RequiredError}
|
|
5907
4839
|
* @memberof ScenarioApi
|
|
@@ -5913,7 +4845,7 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
5913
4845
|
* @param {string} organizationId the Organization identifier
|
|
5914
4846
|
* @param {string} workspaceId the Workspace identifier
|
|
5915
4847
|
* @param {string} scenarioId the Scenario identifier
|
|
5916
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
4848
|
+
* @param {Scenario} scenario the new Scenario details.
|
|
5917
4849
|
* @param {*} [options] Override http request option.
|
|
5918
4850
|
* @throws {RequiredError}
|
|
5919
4851
|
* @memberof ScenarioApi
|
|
@@ -6036,6 +4968,17 @@ export declare const ScenariorunApiAxiosParamCreator: (configuration?: Configura
|
|
|
6036
4968
|
* @throws {RequiredError}
|
|
6037
4969
|
*/
|
|
6038
4970
|
getWorkspaceScenarioRuns: (organizationId: string, workspaceId: string, page?: number, size?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4971
|
+
/**
|
|
4972
|
+
*
|
|
4973
|
+
* @summary import a ScenarioRun for the Scenario
|
|
4974
|
+
* @param {string} organizationId the Organization identifier
|
|
4975
|
+
* @param {string} workspaceId the Workspace identifier
|
|
4976
|
+
* @param {string} scenarioId the Scenario identifier
|
|
4977
|
+
* @param {ScenarioRun} scenarioRun the ScenarioRun to import
|
|
4978
|
+
* @param {*} [options] Override http request option.
|
|
4979
|
+
* @throws {RequiredError}
|
|
4980
|
+
*/
|
|
4981
|
+
importScenarioRun: (organizationId: string, workspaceId: string, scenarioId: string, scenarioRun: ScenarioRun, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6039
4982
|
/**
|
|
6040
4983
|
*
|
|
6041
4984
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -6179,6 +5122,17 @@ export declare const ScenariorunApiFp: (configuration?: Configuration) => {
|
|
|
6179
5122
|
* @throws {RequiredError}
|
|
6180
5123
|
*/
|
|
6181
5124
|
getWorkspaceScenarioRuns(organizationId: string, workspaceId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScenarioRun>>>;
|
|
5125
|
+
/**
|
|
5126
|
+
*
|
|
5127
|
+
* @summary import a ScenarioRun for the Scenario
|
|
5128
|
+
* @param {string} organizationId the Organization identifier
|
|
5129
|
+
* @param {string} workspaceId the Workspace identifier
|
|
5130
|
+
* @param {string} scenarioId the Scenario identifier
|
|
5131
|
+
* @param {ScenarioRun} scenarioRun the ScenarioRun to import
|
|
5132
|
+
* @param {*} [options] Override http request option.
|
|
5133
|
+
* @throws {RequiredError}
|
|
5134
|
+
*/
|
|
5135
|
+
importScenarioRun(organizationId: string, workspaceId: string, scenarioId: string, scenarioRun: ScenarioRun, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioRun>>;
|
|
6182
5136
|
/**
|
|
6183
5137
|
*
|
|
6184
5138
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -6322,6 +5276,17 @@ export declare const ScenariorunApiFactory: (configuration?: Configuration, base
|
|
|
6322
5276
|
* @throws {RequiredError}
|
|
6323
5277
|
*/
|
|
6324
5278
|
getWorkspaceScenarioRuns(organizationId: string, workspaceId: string, page?: number, size?: number, options?: any): AxiosPromise<Array<ScenarioRun>>;
|
|
5279
|
+
/**
|
|
5280
|
+
*
|
|
5281
|
+
* @summary import a ScenarioRun for the Scenario
|
|
5282
|
+
* @param {string} organizationId the Organization identifier
|
|
5283
|
+
* @param {string} workspaceId the Workspace identifier
|
|
5284
|
+
* @param {string} scenarioId the Scenario identifier
|
|
5285
|
+
* @param {ScenarioRun} scenarioRun the ScenarioRun to import
|
|
5286
|
+
* @param {*} [options] Override http request option.
|
|
5287
|
+
* @throws {RequiredError}
|
|
5288
|
+
*/
|
|
5289
|
+
importScenarioRun(organizationId: string, workspaceId: string, scenarioId: string, scenarioRun: ScenarioRun, options?: any): AxiosPromise<ScenarioRun>;
|
|
6325
5290
|
/**
|
|
6326
5291
|
*
|
|
6327
5292
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -6479,183 +5444,59 @@ export declare class ScenariorunApi extends BaseAPI {
|
|
|
6479
5444
|
getWorkspaceScenarioRuns(organizationId: string, workspaceId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun[]>>;
|
|
6480
5445
|
/**
|
|
6481
5446
|
*
|
|
6482
|
-
* @summary
|
|
5447
|
+
* @summary import a ScenarioRun for the Scenario
|
|
6483
5448
|
* @param {string} organizationId the Organization identifier
|
|
6484
5449
|
* @param {string} workspaceId the Workspace identifier
|
|
6485
5450
|
* @param {string} scenarioId the Scenario identifier
|
|
5451
|
+
* @param {ScenarioRun} scenarioRun the ScenarioRun to import
|
|
6486
5452
|
* @param {*} [options] Override http request option.
|
|
6487
5453
|
* @throws {RequiredError}
|
|
6488
5454
|
* @memberof ScenariorunApi
|
|
6489
5455
|
*/
|
|
6490
|
-
|
|
6491
|
-
/**
|
|
6492
|
-
*
|
|
6493
|
-
* @summary Search ScenarioRuns
|
|
6494
|
-
* @param {string} organizationId the Organization identifier
|
|
6495
|
-
* @param {ScenarioRunSearch} scenarioRunSearch the ScenarioRun search parameters
|
|
6496
|
-
* @param {number} [page] page number to query
|
|
6497
|
-
* @param {number} [size] amount of result by page
|
|
6498
|
-
* @param {*} [options] Override http request option.
|
|
6499
|
-
* @throws {RequiredError}
|
|
6500
|
-
* @memberof ScenariorunApi
|
|
6501
|
-
*/
|
|
6502
|
-
searchScenarioRuns(organizationId: string, scenarioRunSearch: ScenarioRunSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun[]>>;
|
|
6503
|
-
/**
|
|
6504
|
-
*
|
|
6505
|
-
* @summary Start a new scenariorun with raw containers definition
|
|
6506
|
-
* @param {string} organizationId the Organization identifier
|
|
6507
|
-
* @param {ScenarioRunStartContainers} scenarioRunStartContainers the raw containers definition
|
|
6508
|
-
* @param {*} [options] Override http request option.
|
|
6509
|
-
* @throws {RequiredError}
|
|
6510
|
-
* @memberof ScenariorunApi
|
|
6511
|
-
*/
|
|
6512
|
-
startScenarioRunContainers(organizationId: string, scenarioRunStartContainers: ScenarioRunStartContainers, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun>>;
|
|
6513
|
-
/**
|
|
6514
|
-
*
|
|
6515
|
-
* @summary stop a ScenarioRun for the Scenario
|
|
6516
|
-
* @param {string} organizationId the Organization identifier
|
|
6517
|
-
* @param {string} scenariorunId the scenariorun identifier
|
|
6518
|
-
* @param {*} [options] Override http request option.
|
|
6519
|
-
* @throws {RequiredError}
|
|
6520
|
-
* @memberof ScenariorunApi
|
|
6521
|
-
*/
|
|
6522
|
-
stopScenarioRun(organizationId: string, scenariorunId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunStatus>>;
|
|
6523
|
-
}
|
|
6524
|
-
/**
|
|
6525
|
-
* ScenariorunresultApi - axios parameter creator
|
|
6526
|
-
* @export
|
|
6527
|
-
*/
|
|
6528
|
-
export declare const ScenariorunresultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6529
|
-
/**
|
|
6530
|
-
*
|
|
6531
|
-
* @summary Get a ScenarioRunResult in the Organization
|
|
6532
|
-
* @param {string} organizationId the Organization identifier
|
|
6533
|
-
* @param {string} workspaceId the Workspace identifier
|
|
6534
|
-
* @param {string} scenarioId the Scenario identifier
|
|
6535
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6536
|
-
* @param {string} probeId the Probe identifier
|
|
6537
|
-
* @param {*} [options] Override http request option.
|
|
6538
|
-
* @throws {RequiredError}
|
|
6539
|
-
*/
|
|
6540
|
-
getScenarioRunResult: (organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6541
|
-
/**
|
|
6542
|
-
*
|
|
6543
|
-
* @summary Create a new ScenarioRunResult in the Organization
|
|
6544
|
-
* @param {string} organizationId the Organization identifier
|
|
6545
|
-
* @param {string} workspaceId the Workspace identifier
|
|
6546
|
-
* @param {string} scenarioId the Scenario identifier
|
|
6547
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6548
|
-
* @param {string} probeId the Probe identifier
|
|
6549
|
-
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
6550
|
-
* @param {*} [options] Override http request option.
|
|
6551
|
-
* @throws {RequiredError}
|
|
6552
|
-
*/
|
|
6553
|
-
sendScenarioRunResult: (organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6554
|
-
[key: string]: string;
|
|
6555
|
-
}, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6556
|
-
};
|
|
6557
|
-
/**
|
|
6558
|
-
* ScenariorunresultApi - functional programming interface
|
|
6559
|
-
* @export
|
|
6560
|
-
*/
|
|
6561
|
-
export declare const ScenariorunresultApiFp: (configuration?: Configuration) => {
|
|
6562
|
-
/**
|
|
6563
|
-
*
|
|
6564
|
-
* @summary Get a ScenarioRunResult in the Organization
|
|
6565
|
-
* @param {string} organizationId the Organization identifier
|
|
6566
|
-
* @param {string} workspaceId the Workspace identifier
|
|
6567
|
-
* @param {string} scenarioId the Scenario identifier
|
|
6568
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6569
|
-
* @param {string} probeId the Probe identifier
|
|
6570
|
-
* @param {*} [options] Override http request option.
|
|
6571
|
-
* @throws {RequiredError}
|
|
6572
|
-
*/
|
|
6573
|
-
getScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioRunResult>>;
|
|
6574
|
-
/**
|
|
6575
|
-
*
|
|
6576
|
-
* @summary Create a new ScenarioRunResult in the Organization
|
|
6577
|
-
* @param {string} organizationId the Organization identifier
|
|
6578
|
-
* @param {string} workspaceId the Workspace identifier
|
|
6579
|
-
* @param {string} scenarioId the Scenario identifier
|
|
6580
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6581
|
-
* @param {string} probeId the Probe identifier
|
|
6582
|
-
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
6583
|
-
* @param {*} [options] Override http request option.
|
|
6584
|
-
* @throws {RequiredError}
|
|
6585
|
-
*/
|
|
6586
|
-
sendScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6587
|
-
[key: string]: string;
|
|
6588
|
-
}, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioRunResult>>;
|
|
6589
|
-
};
|
|
6590
|
-
/**
|
|
6591
|
-
* ScenariorunresultApi - factory interface
|
|
6592
|
-
* @export
|
|
6593
|
-
*/
|
|
6594
|
-
export declare const ScenariorunresultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5456
|
+
importScenarioRun(organizationId: string, workspaceId: string, scenarioId: string, scenarioRun: ScenarioRun, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun>>;
|
|
6595
5457
|
/**
|
|
6596
5458
|
*
|
|
6597
|
-
* @summary
|
|
5459
|
+
* @summary run a ScenarioRun for the Scenario
|
|
6598
5460
|
* @param {string} organizationId the Organization identifier
|
|
6599
5461
|
* @param {string} workspaceId the Workspace identifier
|
|
6600
5462
|
* @param {string} scenarioId the Scenario identifier
|
|
6601
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6602
|
-
* @param {string} probeId the Probe identifier
|
|
6603
5463
|
* @param {*} [options] Override http request option.
|
|
6604
5464
|
* @throws {RequiredError}
|
|
5465
|
+
* @memberof ScenariorunApi
|
|
6605
5466
|
*/
|
|
6606
|
-
|
|
5467
|
+
runScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun>>;
|
|
6607
5468
|
/**
|
|
6608
5469
|
*
|
|
6609
|
-
* @summary
|
|
5470
|
+
* @summary Search ScenarioRuns
|
|
6610
5471
|
* @param {string} organizationId the Organization identifier
|
|
6611
|
-
* @param {
|
|
6612
|
-
* @param {
|
|
6613
|
-
* @param {
|
|
6614
|
-
* @param {
|
|
6615
|
-
* @
|
|
6616
|
-
* @
|
|
6617
|
-
|
|
6618
|
-
|
|
6619
|
-
sendScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6620
|
-
[key: string]: string;
|
|
6621
|
-
}, options?: any): AxiosPromise<ScenarioRunResult>;
|
|
6622
|
-
};
|
|
6623
|
-
/**
|
|
6624
|
-
* ScenariorunresultApi - object-oriented interface
|
|
6625
|
-
* @export
|
|
6626
|
-
* @class ScenariorunresultApi
|
|
6627
|
-
* @extends {BaseAPI}
|
|
6628
|
-
*/
|
|
6629
|
-
export declare class ScenariorunresultApi extends BaseAPI {
|
|
5472
|
+
* @param {ScenarioRunSearch} scenarioRunSearch the ScenarioRun search parameters
|
|
5473
|
+
* @param {number} [page] page number to query
|
|
5474
|
+
* @param {number} [size] amount of result by page
|
|
5475
|
+
* @param {*} [options] Override http request option.
|
|
5476
|
+
* @throws {RequiredError}
|
|
5477
|
+
* @memberof ScenariorunApi
|
|
5478
|
+
*/
|
|
5479
|
+
searchScenarioRuns(organizationId: string, scenarioRunSearch: ScenarioRunSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun[]>>;
|
|
6630
5480
|
/**
|
|
6631
5481
|
*
|
|
6632
|
-
* @summary
|
|
5482
|
+
* @summary Start a new scenariorun with raw containers definition
|
|
6633
5483
|
* @param {string} organizationId the Organization identifier
|
|
6634
|
-
* @param {
|
|
6635
|
-
* @param {string} scenarioId the Scenario identifier
|
|
6636
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6637
|
-
* @param {string} probeId the Probe identifier
|
|
5484
|
+
* @param {ScenarioRunStartContainers} scenarioRunStartContainers the raw containers definition
|
|
6638
5485
|
* @param {*} [options] Override http request option.
|
|
6639
5486
|
* @throws {RequiredError}
|
|
6640
|
-
* @memberof
|
|
5487
|
+
* @memberof ScenariorunApi
|
|
6641
5488
|
*/
|
|
6642
|
-
|
|
5489
|
+
startScenarioRunContainers(organizationId: string, scenarioRunStartContainers: ScenarioRunStartContainers, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun>>;
|
|
6643
5490
|
/**
|
|
6644
5491
|
*
|
|
6645
|
-
* @summary
|
|
5492
|
+
* @summary stop a ScenarioRun for the Scenario
|
|
6646
5493
|
* @param {string} organizationId the Organization identifier
|
|
6647
|
-
* @param {string}
|
|
6648
|
-
* @param {string} scenarioId the Scenario identifier
|
|
6649
|
-
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6650
|
-
* @param {string} probeId the Probe identifier
|
|
6651
|
-
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
5494
|
+
* @param {string} scenariorunId the scenariorun identifier
|
|
6652
5495
|
* @param {*} [options] Override http request option.
|
|
6653
5496
|
* @throws {RequiredError}
|
|
6654
|
-
* @memberof
|
|
5497
|
+
* @memberof ScenariorunApi
|
|
6655
5498
|
*/
|
|
6656
|
-
|
|
6657
|
-
[key: string]: string;
|
|
6658
|
-
}, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunResult>>;
|
|
5499
|
+
stopScenarioRun(organizationId: string, scenariorunId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunStatus>>;
|
|
6659
5500
|
}
|
|
6660
5501
|
/**
|
|
6661
5502
|
* SolutionApi - axios parameter creator
|
|
@@ -6692,16 +5533,6 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6692
5533
|
* @throws {RequiredError}
|
|
6693
5534
|
*/
|
|
6694
5535
|
addOrReplaceRunTemplates: (organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6695
|
-
/**
|
|
6696
|
-
*
|
|
6697
|
-
* @summary Add a control access to the Solution
|
|
6698
|
-
* @param {string} organizationId the Organization identifier
|
|
6699
|
-
* @param {string} solutionId the Solution identifier
|
|
6700
|
-
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
6701
|
-
* @param {*} [options] Override http request option.
|
|
6702
|
-
* @throws {RequiredError}
|
|
6703
|
-
*/
|
|
6704
|
-
addSolutionAccessControl: (organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6705
5536
|
/**
|
|
6706
5537
|
*
|
|
6707
5538
|
* @summary Register a new solution
|
|
@@ -6762,32 +5593,13 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6762
5593
|
findSolutionById: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6763
5594
|
/**
|
|
6764
5595
|
*
|
|
6765
|
-
* @summary
|
|
6766
|
-
* @param {string} organizationId the Organization identifier
|
|
6767
|
-
* @param {string} solutionId the Solution identifier
|
|
6768
|
-
* @param {string} identityId the User identifier
|
|
6769
|
-
* @param {*} [options] Override http request option.
|
|
6770
|
-
* @throws {RequiredError}
|
|
6771
|
-
*/
|
|
6772
|
-
getSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6773
|
-
/**
|
|
6774
|
-
*
|
|
6775
|
-
* @summary Get the Solution security information
|
|
6776
|
-
* @param {string} organizationId the Organization identifier
|
|
6777
|
-
* @param {string} solutionId the Solution identifier
|
|
6778
|
-
* @param {*} [options] Override http request option.
|
|
6779
|
-
* @throws {RequiredError}
|
|
6780
|
-
*/
|
|
6781
|
-
getSolutionSecurity: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6782
|
-
/**
|
|
6783
|
-
*
|
|
6784
|
-
* @summary Get the Solution security users list
|
|
5596
|
+
* @summary Import a solution
|
|
6785
5597
|
* @param {string} organizationId the Organization identifier
|
|
6786
|
-
* @param {
|
|
5598
|
+
* @param {Solution} solution the Solution to import
|
|
6787
5599
|
* @param {*} [options] Override http request option.
|
|
6788
5600
|
* @throws {RequiredError}
|
|
6789
5601
|
*/
|
|
6790
|
-
|
|
5602
|
+
importSolution: (organizationId: string, solution: Solution, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6791
5603
|
/**
|
|
6792
5604
|
*
|
|
6793
5605
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -6815,47 +5627,16 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
6815
5627
|
* @throws {RequiredError}
|
|
6816
5628
|
*/
|
|
6817
5629
|
removeAllSolutionParameters: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6818
|
-
/**
|
|
6819
|
-
*
|
|
6820
|
-
* @summary Remove the specified access from the given Organization Solution
|
|
6821
|
-
* @param {string} organizationId the Organization identifier
|
|
6822
|
-
* @param {string} solutionId the Solution identifier
|
|
6823
|
-
* @param {string} identityId the User identifier
|
|
6824
|
-
* @param {*} [options] Override http request option.
|
|
6825
|
-
* @throws {RequiredError}
|
|
6826
|
-
*/
|
|
6827
|
-
removeSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6828
|
-
/**
|
|
6829
|
-
*
|
|
6830
|
-
* @summary Set the Solution default security
|
|
6831
|
-
* @param {string} organizationId the Organization identifier
|
|
6832
|
-
* @param {string} solutionId the Solution identifier
|
|
6833
|
-
* @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
|
|
6834
|
-
* @param {*} [options] Override http request option.
|
|
6835
|
-
* @throws {RequiredError}
|
|
6836
|
-
*/
|
|
6837
|
-
setSolutionDefaultSecurity: (organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6838
5630
|
/**
|
|
6839
5631
|
*
|
|
6840
5632
|
* @summary Update a solution
|
|
6841
5633
|
* @param {string} organizationId the Organization identifier
|
|
6842
5634
|
* @param {string} solutionId the Solution identifier
|
|
6843
|
-
* @param {Solution} solution the new Solution details.
|
|
5635
|
+
* @param {Solution} solution the new Solution details.
|
|
6844
5636
|
* @param {*} [options] Override http request option.
|
|
6845
5637
|
* @throws {RequiredError}
|
|
6846
5638
|
*/
|
|
6847
5639
|
updateSolution: (organizationId: string, solutionId: string, solution: Solution, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6848
|
-
/**
|
|
6849
|
-
*
|
|
6850
|
-
* @summary Update the specified access to User for a Solution
|
|
6851
|
-
* @param {string} organizationId the Organization identifier
|
|
6852
|
-
* @param {string} solutionId the Solution identifier
|
|
6853
|
-
* @param {string} identityId the User identifier
|
|
6854
|
-
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
6855
|
-
* @param {*} [options] Override http request option.
|
|
6856
|
-
* @throws {RequiredError}
|
|
6857
|
-
*/
|
|
6858
|
-
updateSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6859
5640
|
/**
|
|
6860
5641
|
*
|
|
6861
5642
|
* @summary Update the specified Solution Run Template
|
|
@@ -6916,16 +5697,6 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
6916
5697
|
* @throws {RequiredError}
|
|
6917
5698
|
*/
|
|
6918
5699
|
addOrReplaceRunTemplates(organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunTemplate>>>;
|
|
6919
|
-
/**
|
|
6920
|
-
*
|
|
6921
|
-
* @summary Add a control access to the Solution
|
|
6922
|
-
* @param {string} organizationId the Organization identifier
|
|
6923
|
-
* @param {string} solutionId the Solution identifier
|
|
6924
|
-
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
6925
|
-
* @param {*} [options] Override http request option.
|
|
6926
|
-
* @throws {RequiredError}
|
|
6927
|
-
*/
|
|
6928
|
-
addSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
|
|
6929
5700
|
/**
|
|
6930
5701
|
*
|
|
6931
5702
|
* @summary Register a new solution
|
|
@@ -6986,32 +5757,13 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
6986
5757
|
findSolutionById(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Solution>>;
|
|
6987
5758
|
/**
|
|
6988
5759
|
*
|
|
6989
|
-
* @summary
|
|
6990
|
-
* @param {string} organizationId the Organization identifier
|
|
6991
|
-
* @param {string} solutionId the Solution identifier
|
|
6992
|
-
* @param {string} identityId the User identifier
|
|
6993
|
-
* @param {*} [options] Override http request option.
|
|
6994
|
-
* @throws {RequiredError}
|
|
6995
|
-
*/
|
|
6996
|
-
getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
|
|
6997
|
-
/**
|
|
6998
|
-
*
|
|
6999
|
-
* @summary Get the Solution security information
|
|
7000
|
-
* @param {string} organizationId the Organization identifier
|
|
7001
|
-
* @param {string} solutionId the Solution identifier
|
|
7002
|
-
* @param {*} [options] Override http request option.
|
|
7003
|
-
* @throws {RequiredError}
|
|
7004
|
-
*/
|
|
7005
|
-
getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>>;
|
|
7006
|
-
/**
|
|
7007
|
-
*
|
|
7008
|
-
* @summary Get the Solution security users list
|
|
5760
|
+
* @summary Import a solution
|
|
7009
5761
|
* @param {string} organizationId the Organization identifier
|
|
7010
|
-
* @param {
|
|
5762
|
+
* @param {Solution} solution the Solution to import
|
|
7011
5763
|
* @param {*} [options] Override http request option.
|
|
7012
5764
|
* @throws {RequiredError}
|
|
7013
5765
|
*/
|
|
7014
|
-
|
|
5766
|
+
importSolution(organizationId: string, solution: Solution, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Solution>>;
|
|
7015
5767
|
/**
|
|
7016
5768
|
*
|
|
7017
5769
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -7039,47 +5791,16 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
7039
5791
|
* @throws {RequiredError}
|
|
7040
5792
|
*/
|
|
7041
5793
|
removeAllSolutionParameters(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7042
|
-
/**
|
|
7043
|
-
*
|
|
7044
|
-
* @summary Remove the specified access from the given Organization Solution
|
|
7045
|
-
* @param {string} organizationId the Organization identifier
|
|
7046
|
-
* @param {string} solutionId the Solution identifier
|
|
7047
|
-
* @param {string} identityId the User identifier
|
|
7048
|
-
* @param {*} [options] Override http request option.
|
|
7049
|
-
* @throws {RequiredError}
|
|
7050
|
-
*/
|
|
7051
|
-
removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7052
|
-
/**
|
|
7053
|
-
*
|
|
7054
|
-
* @summary Set the Solution default security
|
|
7055
|
-
* @param {string} organizationId the Organization identifier
|
|
7056
|
-
* @param {string} solutionId the Solution identifier
|
|
7057
|
-
* @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
|
|
7058
|
-
* @param {*} [options] Override http request option.
|
|
7059
|
-
* @throws {RequiredError}
|
|
7060
|
-
*/
|
|
7061
|
-
setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>>;
|
|
7062
5794
|
/**
|
|
7063
5795
|
*
|
|
7064
5796
|
* @summary Update a solution
|
|
7065
5797
|
* @param {string} organizationId the Organization identifier
|
|
7066
5798
|
* @param {string} solutionId the Solution identifier
|
|
7067
|
-
* @param {Solution} solution the new Solution details.
|
|
5799
|
+
* @param {Solution} solution the new Solution details.
|
|
7068
5800
|
* @param {*} [options] Override http request option.
|
|
7069
5801
|
* @throws {RequiredError}
|
|
7070
5802
|
*/
|
|
7071
5803
|
updateSolution(organizationId: string, solutionId: string, solution: Solution, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Solution>>;
|
|
7072
|
-
/**
|
|
7073
|
-
*
|
|
7074
|
-
* @summary Update the specified access to User for a Solution
|
|
7075
|
-
* @param {string} organizationId the Organization identifier
|
|
7076
|
-
* @param {string} solutionId the Solution identifier
|
|
7077
|
-
* @param {string} identityId the User identifier
|
|
7078
|
-
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
7079
|
-
* @param {*} [options] Override http request option.
|
|
7080
|
-
* @throws {RequiredError}
|
|
7081
|
-
*/
|
|
7082
|
-
updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
|
|
7083
5804
|
/**
|
|
7084
5805
|
*
|
|
7085
5806
|
* @summary Update the specified Solution Run Template
|
|
@@ -7140,16 +5861,6 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
7140
5861
|
* @throws {RequiredError}
|
|
7141
5862
|
*/
|
|
7142
5863
|
addOrReplaceRunTemplates(organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: any): AxiosPromise<Array<RunTemplate>>;
|
|
7143
|
-
/**
|
|
7144
|
-
*
|
|
7145
|
-
* @summary Add a control access to the Solution
|
|
7146
|
-
* @param {string} organizationId the Organization identifier
|
|
7147
|
-
* @param {string} solutionId the Solution identifier
|
|
7148
|
-
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
7149
|
-
* @param {*} [options] Override http request option.
|
|
7150
|
-
* @throws {RequiredError}
|
|
7151
|
-
*/
|
|
7152
|
-
addSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: any): AxiosPromise<SolutionAccessControl>;
|
|
7153
5864
|
/**
|
|
7154
5865
|
*
|
|
7155
5866
|
* @summary Register a new solution
|
|
@@ -7210,32 +5921,13 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
7210
5921
|
findSolutionById(organizationId: string, solutionId: string, options?: any): AxiosPromise<Solution>;
|
|
7211
5922
|
/**
|
|
7212
5923
|
*
|
|
7213
|
-
* @summary
|
|
7214
|
-
* @param {string} organizationId the Organization identifier
|
|
7215
|
-
* @param {string} solutionId the Solution identifier
|
|
7216
|
-
* @param {string} identityId the User identifier
|
|
7217
|
-
* @param {*} [options] Override http request option.
|
|
7218
|
-
* @throws {RequiredError}
|
|
7219
|
-
*/
|
|
7220
|
-
getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<SolutionAccessControl>;
|
|
7221
|
-
/**
|
|
7222
|
-
*
|
|
7223
|
-
* @summary Get the Solution security information
|
|
7224
|
-
* @param {string} organizationId the Organization identifier
|
|
7225
|
-
* @param {string} solutionId the Solution identifier
|
|
7226
|
-
* @param {*} [options] Override http request option.
|
|
7227
|
-
* @throws {RequiredError}
|
|
7228
|
-
*/
|
|
7229
|
-
getSolutionSecurity(organizationId: string, solutionId: string, options?: any): AxiosPromise<SolutionSecurity>;
|
|
7230
|
-
/**
|
|
7231
|
-
*
|
|
7232
|
-
* @summary Get the Solution security users list
|
|
5924
|
+
* @summary Import a solution
|
|
7233
5925
|
* @param {string} organizationId the Organization identifier
|
|
7234
|
-
* @param {
|
|
5926
|
+
* @param {Solution} solution the Solution to import
|
|
7235
5927
|
* @param {*} [options] Override http request option.
|
|
7236
5928
|
* @throws {RequiredError}
|
|
7237
5929
|
*/
|
|
7238
|
-
|
|
5930
|
+
importSolution(organizationId: string, solution: Solution, options?: any): AxiosPromise<Solution>;
|
|
7239
5931
|
/**
|
|
7240
5932
|
*
|
|
7241
5933
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -7263,47 +5955,16 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
7263
5955
|
* @throws {RequiredError}
|
|
7264
5956
|
*/
|
|
7265
5957
|
removeAllSolutionParameters(organizationId: string, solutionId: string, options?: any): AxiosPromise<void>;
|
|
7266
|
-
/**
|
|
7267
|
-
*
|
|
7268
|
-
* @summary Remove the specified access from the given Organization Solution
|
|
7269
|
-
* @param {string} organizationId the Organization identifier
|
|
7270
|
-
* @param {string} solutionId the Solution identifier
|
|
7271
|
-
* @param {string} identityId the User identifier
|
|
7272
|
-
* @param {*} [options] Override http request option.
|
|
7273
|
-
* @throws {RequiredError}
|
|
7274
|
-
*/
|
|
7275
|
-
removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<void>;
|
|
7276
|
-
/**
|
|
7277
|
-
*
|
|
7278
|
-
* @summary Set the Solution default security
|
|
7279
|
-
* @param {string} organizationId the Organization identifier
|
|
7280
|
-
* @param {string} solutionId the Solution identifier
|
|
7281
|
-
* @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
|
|
7282
|
-
* @param {*} [options] Override http request option.
|
|
7283
|
-
* @throws {RequiredError}
|
|
7284
|
-
*/
|
|
7285
|
-
setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: any): AxiosPromise<SolutionSecurity>;
|
|
7286
5958
|
/**
|
|
7287
5959
|
*
|
|
7288
5960
|
* @summary Update a solution
|
|
7289
5961
|
* @param {string} organizationId the Organization identifier
|
|
7290
5962
|
* @param {string} solutionId the Solution identifier
|
|
7291
|
-
* @param {Solution} solution the new Solution details.
|
|
5963
|
+
* @param {Solution} solution the new Solution details.
|
|
7292
5964
|
* @param {*} [options] Override http request option.
|
|
7293
5965
|
* @throws {RequiredError}
|
|
7294
5966
|
*/
|
|
7295
5967
|
updateSolution(organizationId: string, solutionId: string, solution: Solution, options?: any): AxiosPromise<Solution>;
|
|
7296
|
-
/**
|
|
7297
|
-
*
|
|
7298
|
-
* @summary Update the specified access to User for a Solution
|
|
7299
|
-
* @param {string} organizationId the Organization identifier
|
|
7300
|
-
* @param {string} solutionId the Solution identifier
|
|
7301
|
-
* @param {string} identityId the User identifier
|
|
7302
|
-
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
7303
|
-
* @param {*} [options] Override http request option.
|
|
7304
|
-
* @throws {RequiredError}
|
|
7305
|
-
*/
|
|
7306
|
-
updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: any): AxiosPromise<SolutionAccessControl>;
|
|
7307
5968
|
/**
|
|
7308
5969
|
*
|
|
7309
5970
|
* @summary Update the specified Solution Run Template
|
|
@@ -7369,17 +6030,6 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
7369
6030
|
* @memberof SolutionApi
|
|
7370
6031
|
*/
|
|
7371
6032
|
addOrReplaceRunTemplates(organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate[]>>;
|
|
7372
|
-
/**
|
|
7373
|
-
*
|
|
7374
|
-
* @summary Add a control access to the Solution
|
|
7375
|
-
* @param {string} organizationId the Organization identifier
|
|
7376
|
-
* @param {string} solutionId the Solution identifier
|
|
7377
|
-
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
7378
|
-
* @param {*} [options] Override http request option.
|
|
7379
|
-
* @throws {RequiredError}
|
|
7380
|
-
* @memberof SolutionApi
|
|
7381
|
-
*/
|
|
7382
|
-
addSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
|
|
7383
6033
|
/**
|
|
7384
6034
|
*
|
|
7385
6035
|
* @summary Register a new solution
|
|
@@ -7446,35 +6096,14 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
7446
6096
|
findSolutionById(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution>>;
|
|
7447
6097
|
/**
|
|
7448
6098
|
*
|
|
7449
|
-
* @summary
|
|
7450
|
-
* @param {string} organizationId the Organization identifier
|
|
7451
|
-
* @param {string} solutionId the Solution identifier
|
|
7452
|
-
* @param {string} identityId the User identifier
|
|
7453
|
-
* @param {*} [options] Override http request option.
|
|
7454
|
-
* @throws {RequiredError}
|
|
7455
|
-
* @memberof SolutionApi
|
|
7456
|
-
*/
|
|
7457
|
-
getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
|
|
7458
|
-
/**
|
|
7459
|
-
*
|
|
7460
|
-
* @summary Get the Solution security information
|
|
7461
|
-
* @param {string} organizationId the Organization identifier
|
|
7462
|
-
* @param {string} solutionId the Solution identifier
|
|
7463
|
-
* @param {*} [options] Override http request option.
|
|
7464
|
-
* @throws {RequiredError}
|
|
7465
|
-
* @memberof SolutionApi
|
|
7466
|
-
*/
|
|
7467
|
-
getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity>>;
|
|
7468
|
-
/**
|
|
7469
|
-
*
|
|
7470
|
-
* @summary Get the Solution security users list
|
|
6099
|
+
* @summary Import a solution
|
|
7471
6100
|
* @param {string} organizationId the Organization identifier
|
|
7472
|
-
* @param {
|
|
6101
|
+
* @param {Solution} solution the Solution to import
|
|
7473
6102
|
* @param {*} [options] Override http request option.
|
|
7474
6103
|
* @throws {RequiredError}
|
|
7475
6104
|
* @memberof SolutionApi
|
|
7476
6105
|
*/
|
|
7477
|
-
|
|
6106
|
+
importSolution(organizationId: string, solution: Solution, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution>>;
|
|
7478
6107
|
/**
|
|
7479
6108
|
*
|
|
7480
6109
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -7505,51 +6134,17 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
7505
6134
|
* @memberof SolutionApi
|
|
7506
6135
|
*/
|
|
7507
6136
|
removeAllSolutionParameters(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
7508
|
-
/**
|
|
7509
|
-
*
|
|
7510
|
-
* @summary Remove the specified access from the given Organization Solution
|
|
7511
|
-
* @param {string} organizationId the Organization identifier
|
|
7512
|
-
* @param {string} solutionId the Solution identifier
|
|
7513
|
-
* @param {string} identityId the User identifier
|
|
7514
|
-
* @param {*} [options] Override http request option.
|
|
7515
|
-
* @throws {RequiredError}
|
|
7516
|
-
* @memberof SolutionApi
|
|
7517
|
-
*/
|
|
7518
|
-
removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
7519
|
-
/**
|
|
7520
|
-
*
|
|
7521
|
-
* @summary Set the Solution default security
|
|
7522
|
-
* @param {string} organizationId the Organization identifier
|
|
7523
|
-
* @param {string} solutionId the Solution identifier
|
|
7524
|
-
* @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
|
|
7525
|
-
* @param {*} [options] Override http request option.
|
|
7526
|
-
* @throws {RequiredError}
|
|
7527
|
-
* @memberof SolutionApi
|
|
7528
|
-
*/
|
|
7529
|
-
setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity>>;
|
|
7530
6137
|
/**
|
|
7531
6138
|
*
|
|
7532
6139
|
* @summary Update a solution
|
|
7533
6140
|
* @param {string} organizationId the Organization identifier
|
|
7534
6141
|
* @param {string} solutionId the Solution identifier
|
|
7535
|
-
* @param {Solution} solution the new Solution details.
|
|
6142
|
+
* @param {Solution} solution the new Solution details.
|
|
7536
6143
|
* @param {*} [options] Override http request option.
|
|
7537
6144
|
* @throws {RequiredError}
|
|
7538
6145
|
* @memberof SolutionApi
|
|
7539
6146
|
*/
|
|
7540
6147
|
updateSolution(organizationId: string, solutionId: string, solution: Solution, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution>>;
|
|
7541
|
-
/**
|
|
7542
|
-
*
|
|
7543
|
-
* @summary Update the specified access to User for a Solution
|
|
7544
|
-
* @param {string} organizationId the Organization identifier
|
|
7545
|
-
* @param {string} solutionId the Solution identifier
|
|
7546
|
-
* @param {string} identityId the User identifier
|
|
7547
|
-
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
7548
|
-
* @param {*} [options] Override http request option.
|
|
7549
|
-
* @throws {RequiredError}
|
|
7550
|
-
* @memberof SolutionApi
|
|
7551
|
-
*/
|
|
7552
|
-
updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
|
|
7553
6148
|
/**
|
|
7554
6149
|
*
|
|
7555
6150
|
* @summary Update the specified Solution Run Template
|
|
@@ -7588,7 +6183,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7588
6183
|
* @param {string} organizationId the Organization identifier
|
|
7589
6184
|
* @param {string} graphId the Graph Identifier
|
|
7590
6185
|
* @param {*} [options] Override http request option.
|
|
7591
|
-
* @deprecated
|
|
7592
6186
|
* @throws {RequiredError}
|
|
7593
6187
|
*/
|
|
7594
6188
|
_delete: (organizationId: string, graphId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7599,7 +6193,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7599
6193
|
* @param {string} graphId the Graph Identifier
|
|
7600
6194
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
7601
6195
|
* @param {*} [options] Override http request option.
|
|
7602
|
-
* @deprecated
|
|
7603
6196
|
* @throws {RequiredError}
|
|
7604
6197
|
*/
|
|
7605
6198
|
batchQuery: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7611,7 +6204,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7611
6204
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
7612
6205
|
* @param {any} body
|
|
7613
6206
|
* @param {*} [options] Override http request option.
|
|
7614
|
-
* @deprecated
|
|
7615
6207
|
* @throws {RequiredError}
|
|
7616
6208
|
*/
|
|
7617
6209
|
batchUploadUpdate: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7623,18 +6215,16 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7623
6215
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7624
6216
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
7625
6217
|
* @param {*} [options] Override http request option.
|
|
7626
|
-
* @deprecated
|
|
7627
6218
|
* @throws {RequiredError}
|
|
7628
6219
|
*/
|
|
7629
6220
|
createEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7630
6221
|
/**
|
|
7631
|
-
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'
|
|
6222
|
+
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * Id those colomns represent * The source of the edge * The target of the edge * The Id of the edge All following columns content are up to you.
|
|
7632
6223
|
* @summary Create a new graph
|
|
7633
6224
|
* @param {string} organizationId the Organization identifier
|
|
7634
6225
|
* @param {string} graphId the Graph Identifier
|
|
7635
6226
|
* @param {any} [body]
|
|
7636
6227
|
* @param {*} [options] Override http request option.
|
|
7637
|
-
* @deprecated
|
|
7638
6228
|
* @throws {RequiredError}
|
|
7639
6229
|
*/
|
|
7640
6230
|
createGraph: (organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7646,7 +6236,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7646
6236
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7647
6237
|
* @param {Array<string>} ids the entities to delete
|
|
7648
6238
|
* @param {*} [options] Override http request option.
|
|
7649
|
-
* @deprecated
|
|
7650
6239
|
* @throws {RequiredError}
|
|
7651
6240
|
*/
|
|
7652
6241
|
deleteEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7656,7 +6245,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7656
6245
|
* @param {string} organizationId the Organization identifier
|
|
7657
6246
|
* @param {string} hash the Graph download identifier
|
|
7658
6247
|
* @param {*} [options] Override http request option.
|
|
7659
|
-
* @deprecated
|
|
7660
6248
|
* @throws {RequiredError}
|
|
7661
6249
|
*/
|
|
7662
6250
|
downloadGraph: (organizationId: string, hash: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7665,7 +6253,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7665
6253
|
* @summary Return the list of all graphs stored in the organization
|
|
7666
6254
|
* @param {string} organizationId the Organization identifier
|
|
7667
6255
|
* @param {*} [options] Override http request option.
|
|
7668
|
-
* @deprecated
|
|
7669
6256
|
* @throws {RequiredError}
|
|
7670
6257
|
*/
|
|
7671
6258
|
findAllTwingraphs: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7677,7 +6264,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7677
6264
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7678
6265
|
* @param {Array<string>} ids the entities to get
|
|
7679
6266
|
* @param {*} [options] Override http request option.
|
|
7680
|
-
* @deprecated
|
|
7681
6267
|
* @throws {RequiredError}
|
|
7682
6268
|
*/
|
|
7683
6269
|
getEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7687,17 +6273,24 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7687
6273
|
* @param {string} organizationId the Organization identifier
|
|
7688
6274
|
* @param {string} graphId the Graph Identifier
|
|
7689
6275
|
* @param {*} [options] Override http request option.
|
|
7690
|
-
* @deprecated
|
|
7691
6276
|
* @throws {RequiredError}
|
|
7692
6277
|
*/
|
|
7693
6278
|
getGraphMetaData: (organizationId: string, graphId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6279
|
+
/**
|
|
6280
|
+
* Import a new version of a twin graph
|
|
6281
|
+
* @summary Import a new version of a twin graph
|
|
6282
|
+
* @param {string} organizationId the Organization identifier
|
|
6283
|
+
* @param {TwinGraphImport} twinGraphImport the graph to import
|
|
6284
|
+
* @param {*} [options] Override http request option.
|
|
6285
|
+
* @throws {RequiredError}
|
|
6286
|
+
*/
|
|
6287
|
+
importGraph: (organizationId: string, twinGraphImport: TwinGraphImport, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7694
6288
|
/**
|
|
7695
6289
|
* Get the status of a job
|
|
7696
6290
|
* @summary Get the status of a job
|
|
7697
6291
|
* @param {string} organizationId the Organization identifier
|
|
7698
6292
|
* @param {string} jobId the job identifier
|
|
7699
6293
|
* @param {*} [options] Override http request option.
|
|
7700
|
-
* @deprecated
|
|
7701
6294
|
* @throws {RequiredError}
|
|
7702
6295
|
*/
|
|
7703
6296
|
jobStatus: (organizationId: string, jobId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7708,7 +6301,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7708
6301
|
* @param {string} graphId the Graph Identifier
|
|
7709
6302
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
7710
6303
|
* @param {*} [options] Override http request option.
|
|
7711
|
-
* @deprecated
|
|
7712
6304
|
* @throws {RequiredError}
|
|
7713
6305
|
*/
|
|
7714
6306
|
query: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7720,7 +6312,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7720
6312
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7721
6313
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
7722
6314
|
* @param {*} [options] Override http request option.
|
|
7723
|
-
* @deprecated
|
|
7724
6315
|
* @throws {RequiredError}
|
|
7725
6316
|
*/
|
|
7726
6317
|
updateEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -7731,7 +6322,6 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7731
6322
|
* @param {string} graphId the Graph Identifier
|
|
7732
6323
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
7733
6324
|
* @param {*} [options] Override http request option.
|
|
7734
|
-
* @deprecated
|
|
7735
6325
|
* @throws {RequiredError}
|
|
7736
6326
|
*/
|
|
7737
6327
|
updateGraphMetaData: (organizationId: string, graphId: string, requestBody: {
|
|
@@ -7749,7 +6339,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7749
6339
|
* @param {string} organizationId the Organization identifier
|
|
7750
6340
|
* @param {string} graphId the Graph Identifier
|
|
7751
6341
|
* @param {*} [options] Override http request option.
|
|
7752
|
-
* @deprecated
|
|
7753
6342
|
* @throws {RequiredError}
|
|
7754
6343
|
*/
|
|
7755
6344
|
_delete(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
@@ -7760,7 +6349,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7760
6349
|
* @param {string} graphId the Graph Identifier
|
|
7761
6350
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
7762
6351
|
* @param {*} [options] Override http request option.
|
|
7763
|
-
* @deprecated
|
|
7764
6352
|
* @throws {RequiredError}
|
|
7765
6353
|
*/
|
|
7766
6354
|
batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphHash>>;
|
|
@@ -7772,7 +6360,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7772
6360
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
7773
6361
|
* @param {any} body
|
|
7774
6362
|
* @param {*} [options] Override http request option.
|
|
7775
|
-
* @deprecated
|
|
7776
6363
|
* @throws {RequiredError}
|
|
7777
6364
|
*/
|
|
7778
6365
|
batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>>;
|
|
@@ -7784,18 +6371,16 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7784
6371
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7785
6372
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
7786
6373
|
* @param {*} [options] Override http request option.
|
|
7787
|
-
* @deprecated
|
|
7788
6374
|
* @throws {RequiredError}
|
|
7789
6375
|
*/
|
|
7790
6376
|
createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
7791
6377
|
/**
|
|
7792
|
-
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'
|
|
6378
|
+
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * Id those colomns represent * The source of the edge * The target of the edge * The Id of the edge All following columns content are up to you.
|
|
7793
6379
|
* @summary Create a new graph
|
|
7794
6380
|
* @param {string} organizationId the Organization identifier
|
|
7795
6381
|
* @param {string} graphId the Graph Identifier
|
|
7796
6382
|
* @param {any} [body]
|
|
7797
6383
|
* @param {*} [options] Override http request option.
|
|
7798
|
-
* @deprecated
|
|
7799
6384
|
* @throws {RequiredError}
|
|
7800
6385
|
*/
|
|
7801
6386
|
createGraph(organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
@@ -7807,7 +6392,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7807
6392
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7808
6393
|
* @param {Array<string>} ids the entities to delete
|
|
7809
6394
|
* @param {*} [options] Override http request option.
|
|
7810
|
-
* @deprecated
|
|
7811
6395
|
* @throws {RequiredError}
|
|
7812
6396
|
*/
|
|
7813
6397
|
deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
@@ -7817,7 +6401,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7817
6401
|
* @param {string} organizationId the Organization identifier
|
|
7818
6402
|
* @param {string} hash the Graph download identifier
|
|
7819
6403
|
* @param {*} [options] Override http request option.
|
|
7820
|
-
* @deprecated
|
|
7821
6404
|
* @throws {RequiredError}
|
|
7822
6405
|
*/
|
|
7823
6406
|
downloadGraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
@@ -7826,7 +6409,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7826
6409
|
* @summary Return the list of all graphs stored in the organization
|
|
7827
6410
|
* @param {string} organizationId the Organization identifier
|
|
7828
6411
|
* @param {*} [options] Override http request option.
|
|
7829
|
-
* @deprecated
|
|
7830
6412
|
* @throws {RequiredError}
|
|
7831
6413
|
*/
|
|
7832
6414
|
findAllTwingraphs(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
@@ -7838,7 +6420,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7838
6420
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7839
6421
|
* @param {Array<string>} ids the entities to get
|
|
7840
6422
|
* @param {*} [options] Override http request option.
|
|
7841
|
-
* @deprecated
|
|
7842
6423
|
* @throws {RequiredError}
|
|
7843
6424
|
*/
|
|
7844
6425
|
getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
@@ -7848,17 +6429,24 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7848
6429
|
* @param {string} organizationId the Organization identifier
|
|
7849
6430
|
* @param {string} graphId the Graph Identifier
|
|
7850
6431
|
* @param {*} [options] Override http request option.
|
|
7851
|
-
* @deprecated
|
|
7852
6432
|
* @throws {RequiredError}
|
|
7853
6433
|
*/
|
|
7854
6434
|
getGraphMetaData(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
6435
|
+
/**
|
|
6436
|
+
* Import a new version of a twin graph
|
|
6437
|
+
* @summary Import a new version of a twin graph
|
|
6438
|
+
* @param {string} organizationId the Organization identifier
|
|
6439
|
+
* @param {TwinGraphImport} twinGraphImport the graph to import
|
|
6440
|
+
* @param {*} [options] Override http request option.
|
|
6441
|
+
* @throws {RequiredError}
|
|
6442
|
+
*/
|
|
6443
|
+
importGraph(organizationId: string, twinGraphImport: TwinGraphImport, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphImportInfo>>;
|
|
7855
6444
|
/**
|
|
7856
6445
|
* Get the status of a job
|
|
7857
6446
|
* @summary Get the status of a job
|
|
7858
6447
|
* @param {string} organizationId the Organization identifier
|
|
7859
6448
|
* @param {string} jobId the job identifier
|
|
7860
6449
|
* @param {*} [options] Override http request option.
|
|
7861
|
-
* @deprecated
|
|
7862
6450
|
* @throws {RequiredError}
|
|
7863
6451
|
*/
|
|
7864
6452
|
jobStatus(organizationId: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
@@ -7869,7 +6457,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7869
6457
|
* @param {string} graphId the Graph Identifier
|
|
7870
6458
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
7871
6459
|
* @param {*} [options] Override http request option.
|
|
7872
|
-
* @deprecated
|
|
7873
6460
|
* @throws {RequiredError}
|
|
7874
6461
|
*/
|
|
7875
6462
|
query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
@@ -7881,7 +6468,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7881
6468
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7882
6469
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
7883
6470
|
* @param {*} [options] Override http request option.
|
|
7884
|
-
* @deprecated
|
|
7885
6471
|
* @throws {RequiredError}
|
|
7886
6472
|
*/
|
|
7887
6473
|
updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
@@ -7892,7 +6478,6 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
7892
6478
|
* @param {string} graphId the Graph Identifier
|
|
7893
6479
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
7894
6480
|
* @param {*} [options] Override http request option.
|
|
7895
|
-
* @deprecated
|
|
7896
6481
|
* @throws {RequiredError}
|
|
7897
6482
|
*/
|
|
7898
6483
|
updateGraphMetaData(organizationId: string, graphId: string, requestBody: {
|
|
@@ -7910,7 +6495,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7910
6495
|
* @param {string} organizationId the Organization identifier
|
|
7911
6496
|
* @param {string} graphId the Graph Identifier
|
|
7912
6497
|
* @param {*} [options] Override http request option.
|
|
7913
|
-
* @deprecated
|
|
7914
6498
|
* @throws {RequiredError}
|
|
7915
6499
|
*/
|
|
7916
6500
|
_delete(organizationId: string, graphId: string, options?: any): AxiosPromise<void>;
|
|
@@ -7921,7 +6505,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7921
6505
|
* @param {string} graphId the Graph Identifier
|
|
7922
6506
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
7923
6507
|
* @param {*} [options] Override http request option.
|
|
7924
|
-
* @deprecated
|
|
7925
6508
|
* @throws {RequiredError}
|
|
7926
6509
|
*/
|
|
7927
6510
|
batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<TwinGraphHash>;
|
|
@@ -7933,7 +6516,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7933
6516
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
7934
6517
|
* @param {any} body
|
|
7935
6518
|
* @param {*} [options] Override http request option.
|
|
7936
|
-
* @deprecated
|
|
7937
6519
|
* @throws {RequiredError}
|
|
7938
6520
|
*/
|
|
7939
6521
|
batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult>;
|
|
@@ -7945,18 +6527,16 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7945
6527
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7946
6528
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
7947
6529
|
* @param {*} [options] Override http request option.
|
|
7948
|
-
* @deprecated
|
|
7949
6530
|
* @throws {RequiredError}
|
|
7950
6531
|
*/
|
|
7951
6532
|
createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
7952
6533
|
/**
|
|
7953
|
-
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'
|
|
6534
|
+
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * Id those colomns represent * The source of the edge * The target of the edge * The Id of the edge All following columns content are up to you.
|
|
7954
6535
|
* @summary Create a new graph
|
|
7955
6536
|
* @param {string} organizationId the Organization identifier
|
|
7956
6537
|
* @param {string} graphId the Graph Identifier
|
|
7957
6538
|
* @param {any} [body]
|
|
7958
6539
|
* @param {*} [options] Override http request option.
|
|
7959
|
-
* @deprecated
|
|
7960
6540
|
* @throws {RequiredError}
|
|
7961
6541
|
*/
|
|
7962
6542
|
createGraph(organizationId: string, graphId: string, body?: any, options?: any): AxiosPromise<void>;
|
|
@@ -7968,7 +6548,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7968
6548
|
* @param {'node' | 'relationship'} type the entity model type
|
|
7969
6549
|
* @param {Array<string>} ids the entities to delete
|
|
7970
6550
|
* @param {*} [options] Override http request option.
|
|
7971
|
-
* @deprecated
|
|
7972
6551
|
* @throws {RequiredError}
|
|
7973
6552
|
*/
|
|
7974
6553
|
deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
|
|
@@ -7978,7 +6557,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7978
6557
|
* @param {string} organizationId the Organization identifier
|
|
7979
6558
|
* @param {string} hash the Graph download identifier
|
|
7980
6559
|
* @param {*} [options] Override http request option.
|
|
7981
|
-
* @deprecated
|
|
7982
6560
|
* @throws {RequiredError}
|
|
7983
6561
|
*/
|
|
7984
6562
|
downloadGraph(organizationId: string, hash: string, options?: any): AxiosPromise<any>;
|
|
@@ -7987,7 +6565,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7987
6565
|
* @summary Return the list of all graphs stored in the organization
|
|
7988
6566
|
* @param {string} organizationId the Organization identifier
|
|
7989
6567
|
* @param {*} [options] Override http request option.
|
|
7990
|
-
* @deprecated
|
|
7991
6568
|
* @throws {RequiredError}
|
|
7992
6569
|
*/
|
|
7993
6570
|
findAllTwingraphs(organizationId: string, options?: any): AxiosPromise<Array<string>>;
|
|
@@ -7999,7 +6576,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
7999
6576
|
* @param {'node' | 'relationship'} type the entity model type
|
|
8000
6577
|
* @param {Array<string>} ids the entities to get
|
|
8001
6578
|
* @param {*} [options] Override http request option.
|
|
8002
|
-
* @deprecated
|
|
8003
6579
|
* @throws {RequiredError}
|
|
8004
6580
|
*/
|
|
8005
6581
|
getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
|
|
@@ -8009,17 +6585,24 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
8009
6585
|
* @param {string} organizationId the Organization identifier
|
|
8010
6586
|
* @param {string} graphId the Graph Identifier
|
|
8011
6587
|
* @param {*} [options] Override http request option.
|
|
8012
|
-
* @deprecated
|
|
8013
6588
|
* @throws {RequiredError}
|
|
8014
6589
|
*/
|
|
8015
6590
|
getGraphMetaData(organizationId: string, graphId: string, options?: any): AxiosPromise<object>;
|
|
6591
|
+
/**
|
|
6592
|
+
* Import a new version of a twin graph
|
|
6593
|
+
* @summary Import a new version of a twin graph
|
|
6594
|
+
* @param {string} organizationId the Organization identifier
|
|
6595
|
+
* @param {TwinGraphImport} twinGraphImport the graph to import
|
|
6596
|
+
* @param {*} [options] Override http request option.
|
|
6597
|
+
* @throws {RequiredError}
|
|
6598
|
+
*/
|
|
6599
|
+
importGraph(organizationId: string, twinGraphImport: TwinGraphImport, options?: any): AxiosPromise<TwinGraphImportInfo>;
|
|
8016
6600
|
/**
|
|
8017
6601
|
* Get the status of a job
|
|
8018
6602
|
* @summary Get the status of a job
|
|
8019
6603
|
* @param {string} organizationId the Organization identifier
|
|
8020
6604
|
* @param {string} jobId the job identifier
|
|
8021
6605
|
* @param {*} [options] Override http request option.
|
|
8022
|
-
* @deprecated
|
|
8023
6606
|
* @throws {RequiredError}
|
|
8024
6607
|
*/
|
|
8025
6608
|
jobStatus(organizationId: string, jobId: string, options?: any): AxiosPromise<string>;
|
|
@@ -8030,7 +6613,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
8030
6613
|
* @param {string} graphId the Graph Identifier
|
|
8031
6614
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
8032
6615
|
* @param {*} [options] Override http request option.
|
|
8033
|
-
* @deprecated
|
|
8034
6616
|
* @throws {RequiredError}
|
|
8035
6617
|
*/
|
|
8036
6618
|
query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<string>;
|
|
@@ -8042,7 +6624,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
8042
6624
|
* @param {'node' | 'relationship'} type the entity model type
|
|
8043
6625
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
8044
6626
|
* @param {*} [options] Override http request option.
|
|
8045
|
-
* @deprecated
|
|
8046
6627
|
* @throws {RequiredError}
|
|
8047
6628
|
*/
|
|
8048
6629
|
updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
@@ -8053,7 +6634,6 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
8053
6634
|
* @param {string} graphId the Graph Identifier
|
|
8054
6635
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
8055
6636
|
* @param {*} [options] Override http request option.
|
|
8056
|
-
* @deprecated
|
|
8057
6637
|
* @throws {RequiredError}
|
|
8058
6638
|
*/
|
|
8059
6639
|
updateGraphMetaData(organizationId: string, graphId: string, requestBody: {
|
|
@@ -8073,7 +6653,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8073
6653
|
* @param {string} organizationId the Organization identifier
|
|
8074
6654
|
* @param {string} graphId the Graph Identifier
|
|
8075
6655
|
* @param {*} [options] Override http request option.
|
|
8076
|
-
* @deprecated
|
|
8077
6656
|
* @throws {RequiredError}
|
|
8078
6657
|
* @memberof TwingraphApi
|
|
8079
6658
|
*/
|
|
@@ -8085,7 +6664,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8085
6664
|
* @param {string} graphId the Graph Identifier
|
|
8086
6665
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
8087
6666
|
* @param {*} [options] Override http request option.
|
|
8088
|
-
* @deprecated
|
|
8089
6667
|
* @throws {RequiredError}
|
|
8090
6668
|
* @memberof TwingraphApi
|
|
8091
6669
|
*/
|
|
@@ -8098,7 +6676,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8098
6676
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
8099
6677
|
* @param {any} body
|
|
8100
6678
|
* @param {*} [options] Override http request option.
|
|
8101
|
-
* @deprecated
|
|
8102
6679
|
* @throws {RequiredError}
|
|
8103
6680
|
* @memberof TwingraphApi
|
|
8104
6681
|
*/
|
|
@@ -8111,19 +6688,17 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8111
6688
|
* @param {'node' | 'relationship'} type the entity model type
|
|
8112
6689
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
8113
6690
|
* @param {*} [options] Override http request option.
|
|
8114
|
-
* @deprecated
|
|
8115
6691
|
* @throws {RequiredError}
|
|
8116
6692
|
* @memberof TwingraphApi
|
|
8117
6693
|
*/
|
|
8118
6694
|
createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
8119
6695
|
/**
|
|
8120
|
-
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'
|
|
6696
|
+
* To create a new graph from flat files, you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes. .zip hierarchy: *main_folder/Nodes *main_folder/Edges In each folder you can place one or multiple csv files containing your Nodes or Edges data. Your csv files must follow the following header (column name) requirements: The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string The Edges CSVs require three columns named, in order, * source * target * Id those colomns represent * The source of the edge * The target of the edge * The Id of the edge All following columns content are up to you.
|
|
8121
6697
|
* @summary Create a new graph
|
|
8122
6698
|
* @param {string} organizationId the Organization identifier
|
|
8123
6699
|
* @param {string} graphId the Graph Identifier
|
|
8124
6700
|
* @param {any} [body]
|
|
8125
6701
|
* @param {*} [options] Override http request option.
|
|
8126
|
-
* @deprecated
|
|
8127
6702
|
* @throws {RequiredError}
|
|
8128
6703
|
* @memberof TwingraphApi
|
|
8129
6704
|
*/
|
|
@@ -8136,7 +6711,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8136
6711
|
* @param {'node' | 'relationship'} type the entity model type
|
|
8137
6712
|
* @param {Array<string>} ids the entities to delete
|
|
8138
6713
|
* @param {*} [options] Override http request option.
|
|
8139
|
-
* @deprecated
|
|
8140
6714
|
* @throws {RequiredError}
|
|
8141
6715
|
* @memberof TwingraphApi
|
|
8142
6716
|
*/
|
|
@@ -8147,7 +6721,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8147
6721
|
* @param {string} organizationId the Organization identifier
|
|
8148
6722
|
* @param {string} hash the Graph download identifier
|
|
8149
6723
|
* @param {*} [options] Override http request option.
|
|
8150
|
-
* @deprecated
|
|
8151
6724
|
* @throws {RequiredError}
|
|
8152
6725
|
* @memberof TwingraphApi
|
|
8153
6726
|
*/
|
|
@@ -8157,7 +6730,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8157
6730
|
* @summary Return the list of all graphs stored in the organization
|
|
8158
6731
|
* @param {string} organizationId the Organization identifier
|
|
8159
6732
|
* @param {*} [options] Override http request option.
|
|
8160
|
-
* @deprecated
|
|
8161
6733
|
* @throws {RequiredError}
|
|
8162
6734
|
* @memberof TwingraphApi
|
|
8163
6735
|
*/
|
|
@@ -8170,7 +6742,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8170
6742
|
* @param {'node' | 'relationship'} type the entity model type
|
|
8171
6743
|
* @param {Array<string>} ids the entities to get
|
|
8172
6744
|
* @param {*} [options] Override http request option.
|
|
8173
|
-
* @deprecated
|
|
8174
6745
|
* @throws {RequiredError}
|
|
8175
6746
|
* @memberof TwingraphApi
|
|
8176
6747
|
*/
|
|
@@ -8181,18 +6752,26 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8181
6752
|
* @param {string} organizationId the Organization identifier
|
|
8182
6753
|
* @param {string} graphId the Graph Identifier
|
|
8183
6754
|
* @param {*} [options] Override http request option.
|
|
8184
|
-
* @deprecated
|
|
8185
6755
|
* @throws {RequiredError}
|
|
8186
6756
|
* @memberof TwingraphApi
|
|
8187
6757
|
*/
|
|
8188
6758
|
getGraphMetaData(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object>>;
|
|
6759
|
+
/**
|
|
6760
|
+
* Import a new version of a twin graph
|
|
6761
|
+
* @summary Import a new version of a twin graph
|
|
6762
|
+
* @param {string} organizationId the Organization identifier
|
|
6763
|
+
* @param {TwinGraphImport} twinGraphImport the graph to import
|
|
6764
|
+
* @param {*} [options] Override http request option.
|
|
6765
|
+
* @throws {RequiredError}
|
|
6766
|
+
* @memberof TwingraphApi
|
|
6767
|
+
*/
|
|
6768
|
+
importGraph(organizationId: string, twinGraphImport: TwinGraphImport, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TwinGraphImportInfo>>;
|
|
8189
6769
|
/**
|
|
8190
6770
|
* Get the status of a job
|
|
8191
6771
|
* @summary Get the status of a job
|
|
8192
6772
|
* @param {string} organizationId the Organization identifier
|
|
8193
6773
|
* @param {string} jobId the job identifier
|
|
8194
6774
|
* @param {*} [options] Override http request option.
|
|
8195
|
-
* @deprecated
|
|
8196
6775
|
* @throws {RequiredError}
|
|
8197
6776
|
* @memberof TwingraphApi
|
|
8198
6777
|
*/
|
|
@@ -8204,7 +6783,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8204
6783
|
* @param {string} graphId the Graph Identifier
|
|
8205
6784
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
8206
6785
|
* @param {*} [options] Override http request option.
|
|
8207
|
-
* @deprecated
|
|
8208
6786
|
* @throws {RequiredError}
|
|
8209
6787
|
* @memberof TwingraphApi
|
|
8210
6788
|
*/
|
|
@@ -8217,7 +6795,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8217
6795
|
* @param {'node' | 'relationship'} type the entity model type
|
|
8218
6796
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
8219
6797
|
* @param {*} [options] Override http request option.
|
|
8220
|
-
* @deprecated
|
|
8221
6798
|
* @throws {RequiredError}
|
|
8222
6799
|
* @memberof TwingraphApi
|
|
8223
6800
|
*/
|
|
@@ -8229,7 +6806,6 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
8229
6806
|
* @param {string} graphId the Graph Identifier
|
|
8230
6807
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
8231
6808
|
* @param {*} [options] Override http request option.
|
|
8232
|
-
* @deprecated
|
|
8233
6809
|
* @throws {RequiredError}
|
|
8234
6810
|
* @memberof TwingraphApi
|
|
8235
6811
|
*/
|
|
@@ -8746,6 +7322,15 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
8746
7322
|
* @throws {RequiredError}
|
|
8747
7323
|
*/
|
|
8748
7324
|
getWorkspaceSecurityUsers: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7325
|
+
/**
|
|
7326
|
+
*
|
|
7327
|
+
* @summary Import a workspace
|
|
7328
|
+
* @param {string} organizationId the Organization identifier
|
|
7329
|
+
* @param {Workspace} workspace the Workspace to import
|
|
7330
|
+
* @param {*} [options] Override http request option.
|
|
7331
|
+
* @throws {RequiredError}
|
|
7332
|
+
*/
|
|
7333
|
+
importWorkspace: (organizationId: string, workspace: Workspace, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8749
7334
|
/**
|
|
8750
7335
|
*
|
|
8751
7336
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -8761,7 +7346,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
8761
7346
|
* @summary Set the Workspace default security
|
|
8762
7347
|
* @param {string} organizationId the Organization identifier
|
|
8763
7348
|
* @param {string} workspaceId the Workspace identifier
|
|
8764
|
-
* @param {WorkspaceRole} workspaceRole
|
|
7349
|
+
* @param {WorkspaceRole} workspaceRole the new Workspace default security.
|
|
8765
7350
|
* @param {*} [options] Override http request option.
|
|
8766
7351
|
* @throws {RequiredError}
|
|
8767
7352
|
*/
|
|
@@ -8771,7 +7356,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
8771
7356
|
* @summary Update a workspace
|
|
8772
7357
|
* @param {string} organizationId the Organization identifier
|
|
8773
7358
|
* @param {string} workspaceId the Workspace identifier
|
|
8774
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
7359
|
+
* @param {Workspace} workspace The new Workspace details.
|
|
8775
7360
|
* @param {*} [options] Override http request option.
|
|
8776
7361
|
* @throws {RequiredError}
|
|
8777
7362
|
*/
|
|
@@ -8938,6 +7523,15 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
8938
7523
|
* @throws {RequiredError}
|
|
8939
7524
|
*/
|
|
8940
7525
|
getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
7526
|
+
/**
|
|
7527
|
+
*
|
|
7528
|
+
* @summary Import a workspace
|
|
7529
|
+
* @param {string} organizationId the Organization identifier
|
|
7530
|
+
* @param {Workspace} workspace the Workspace to import
|
|
7531
|
+
* @param {*} [options] Override http request option.
|
|
7532
|
+
* @throws {RequiredError}
|
|
7533
|
+
*/
|
|
7534
|
+
importWorkspace(organizationId: string, workspace: Workspace, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
|
|
8941
7535
|
/**
|
|
8942
7536
|
*
|
|
8943
7537
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -8953,7 +7547,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
8953
7547
|
* @summary Set the Workspace default security
|
|
8954
7548
|
* @param {string} organizationId the Organization identifier
|
|
8955
7549
|
* @param {string} workspaceId the Workspace identifier
|
|
8956
|
-
* @param {WorkspaceRole} workspaceRole
|
|
7550
|
+
* @param {WorkspaceRole} workspaceRole the new Workspace default security.
|
|
8957
7551
|
* @param {*} [options] Override http request option.
|
|
8958
7552
|
* @throws {RequiredError}
|
|
8959
7553
|
*/
|
|
@@ -8963,7 +7557,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
8963
7557
|
* @summary Update a workspace
|
|
8964
7558
|
* @param {string} organizationId the Organization identifier
|
|
8965
7559
|
* @param {string} workspaceId the Workspace identifier
|
|
8966
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
7560
|
+
* @param {Workspace} workspace The new Workspace details.
|
|
8967
7561
|
* @param {*} [options] Override http request option.
|
|
8968
7562
|
* @throws {RequiredError}
|
|
8969
7563
|
*/
|
|
@@ -9130,6 +7724,15 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
9130
7724
|
* @throws {RequiredError}
|
|
9131
7725
|
*/
|
|
9132
7726
|
getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: any): AxiosPromise<Array<string>>;
|
|
7727
|
+
/**
|
|
7728
|
+
*
|
|
7729
|
+
* @summary Import a workspace
|
|
7730
|
+
* @param {string} organizationId the Organization identifier
|
|
7731
|
+
* @param {Workspace} workspace the Workspace to import
|
|
7732
|
+
* @param {*} [options] Override http request option.
|
|
7733
|
+
* @throws {RequiredError}
|
|
7734
|
+
*/
|
|
7735
|
+
importWorkspace(organizationId: string, workspace: Workspace, options?: any): AxiosPromise<Workspace>;
|
|
9133
7736
|
/**
|
|
9134
7737
|
*
|
|
9135
7738
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -9145,7 +7748,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
9145
7748
|
* @summary Set the Workspace default security
|
|
9146
7749
|
* @param {string} organizationId the Organization identifier
|
|
9147
7750
|
* @param {string} workspaceId the Workspace identifier
|
|
9148
|
-
* @param {WorkspaceRole} workspaceRole
|
|
7751
|
+
* @param {WorkspaceRole} workspaceRole the new Workspace default security.
|
|
9149
7752
|
* @param {*} [options] Override http request option.
|
|
9150
7753
|
* @throws {RequiredError}
|
|
9151
7754
|
*/
|
|
@@ -9155,7 +7758,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
9155
7758
|
* @summary Update a workspace
|
|
9156
7759
|
* @param {string} organizationId the Organization identifier
|
|
9157
7760
|
* @param {string} workspaceId the Workspace identifier
|
|
9158
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
7761
|
+
* @param {Workspace} workspace The new Workspace details.
|
|
9159
7762
|
* @param {*} [options] Override http request option.
|
|
9160
7763
|
* @throws {RequiredError}
|
|
9161
7764
|
*/
|
|
@@ -9338,6 +7941,16 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
9338
7941
|
* @memberof WorkspaceApi
|
|
9339
7942
|
*/
|
|
9340
7943
|
getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
7944
|
+
/**
|
|
7945
|
+
*
|
|
7946
|
+
* @summary Import a workspace
|
|
7947
|
+
* @param {string} organizationId the Organization identifier
|
|
7948
|
+
* @param {Workspace} workspace the Workspace to import
|
|
7949
|
+
* @param {*} [options] Override http request option.
|
|
7950
|
+
* @throws {RequiredError}
|
|
7951
|
+
* @memberof WorkspaceApi
|
|
7952
|
+
*/
|
|
7953
|
+
importWorkspace(organizationId: string, workspace: Workspace, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace>>;
|
|
9341
7954
|
/**
|
|
9342
7955
|
*
|
|
9343
7956
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -9354,7 +7967,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
9354
7967
|
* @summary Set the Workspace default security
|
|
9355
7968
|
* @param {string} organizationId the Organization identifier
|
|
9356
7969
|
* @param {string} workspaceId the Workspace identifier
|
|
9357
|
-
* @param {WorkspaceRole} workspaceRole
|
|
7970
|
+
* @param {WorkspaceRole} workspaceRole the new Workspace default security.
|
|
9358
7971
|
* @param {*} [options] Override http request option.
|
|
9359
7972
|
* @throws {RequiredError}
|
|
9360
7973
|
* @memberof WorkspaceApi
|
|
@@ -9365,7 +7978,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
9365
7978
|
* @summary Update a workspace
|
|
9366
7979
|
* @param {string} organizationId the Organization identifier
|
|
9367
7980
|
* @param {string} workspaceId the Workspace identifier
|
|
9368
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
7981
|
+
* @param {Workspace} workspace The new Workspace details.
|
|
9369
7982
|
* @param {*} [options] Override http request option.
|
|
9370
7983
|
* @throws {RequiredError}
|
|
9371
7984
|
* @memberof WorkspaceApi
|