@cosmotech/api-ts 2.4.2 → 3.0.1-SNAPSHOT
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 +3699 -928
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2023 -464
- package/dist/api.js +5294 -2529
- 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: 3.0.1-SNAPSHOT
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -259,12 +259,84 @@ 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;
|
|
262
268
|
/**
|
|
263
269
|
* the Organization Id related to this Dataset
|
|
264
270
|
* @type {string}
|
|
265
271
|
* @memberof Dataset
|
|
266
272
|
*/
|
|
267
273
|
'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
|
+
* list of workspace linked to this dataset
|
|
282
|
+
* @type {Array<string>}
|
|
283
|
+
* @memberof Dataset
|
|
284
|
+
*/
|
|
285
|
+
'linkedWorkspaceIdList'?: Array<string>;
|
|
286
|
+
/**
|
|
287
|
+
* the twin graph id
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof Dataset
|
|
290
|
+
*/
|
|
291
|
+
'twingraphId'?: string;
|
|
292
|
+
/**
|
|
293
|
+
* is this the main dataset
|
|
294
|
+
* @type {boolean}
|
|
295
|
+
* @memberof Dataset
|
|
296
|
+
*/
|
|
297
|
+
'main'?: boolean;
|
|
298
|
+
/**
|
|
299
|
+
* the Dataset creation date
|
|
300
|
+
* @type {number}
|
|
301
|
+
* @memberof Dataset
|
|
302
|
+
*/
|
|
303
|
+
'creationDate'?: number;
|
|
304
|
+
/**
|
|
305
|
+
* the last time a refresh was done
|
|
306
|
+
* @type {number}
|
|
307
|
+
* @memberof Dataset
|
|
308
|
+
*/
|
|
309
|
+
'refreshDate'?: number;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @type {DatasetSourceType}
|
|
313
|
+
* @memberof Dataset
|
|
314
|
+
*/
|
|
315
|
+
'sourceType'?: DatasetSourceType;
|
|
316
|
+
/**
|
|
317
|
+
*
|
|
318
|
+
* @type {SourceInfo}
|
|
319
|
+
* @memberof Dataset
|
|
320
|
+
*/
|
|
321
|
+
'source'?: SourceInfo;
|
|
322
|
+
/**
|
|
323
|
+
* the Dataset ingestion status
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof Dataset
|
|
326
|
+
*/
|
|
327
|
+
'ingestionStatus'?: DatasetIngestionStatusEnum;
|
|
328
|
+
/**
|
|
329
|
+
* the twincache data status
|
|
330
|
+
* @type {string}
|
|
331
|
+
* @memberof Dataset
|
|
332
|
+
*/
|
|
333
|
+
'twincacheStatus'?: DatasetTwincacheStatusEnum;
|
|
334
|
+
/**
|
|
335
|
+
* the list of queries
|
|
336
|
+
* @type {Array<string>}
|
|
337
|
+
* @memberof Dataset
|
|
338
|
+
*/
|
|
339
|
+
'queries'?: Array<string>;
|
|
268
340
|
/**
|
|
269
341
|
* the list of tags
|
|
270
342
|
* @type {Array<string>}
|
|
@@ -295,6 +367,43 @@ export interface Dataset {
|
|
|
295
367
|
* @memberof Dataset
|
|
296
368
|
*/
|
|
297
369
|
'compatibility'?: Array<DatasetCompatibility>;
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @type {DatasetSecurity}
|
|
373
|
+
* @memberof Dataset
|
|
374
|
+
*/
|
|
375
|
+
'security'?: DatasetSecurity;
|
|
376
|
+
}
|
|
377
|
+
export declare const DatasetIngestionStatusEnum: {
|
|
378
|
+
readonly None: "NONE";
|
|
379
|
+
readonly Pending: "PENDING";
|
|
380
|
+
readonly Error: "ERROR";
|
|
381
|
+
readonly Success: "SUCCESS";
|
|
382
|
+
};
|
|
383
|
+
export declare type DatasetIngestionStatusEnum = typeof DatasetIngestionStatusEnum[keyof typeof DatasetIngestionStatusEnum];
|
|
384
|
+
export declare const DatasetTwincacheStatusEnum: {
|
|
385
|
+
readonly Empty: "EMPTY";
|
|
386
|
+
readonly Full: "FULL";
|
|
387
|
+
};
|
|
388
|
+
export declare type DatasetTwincacheStatusEnum = typeof DatasetTwincacheStatusEnum[keyof typeof DatasetTwincacheStatusEnum];
|
|
389
|
+
/**
|
|
390
|
+
* a Dataset access control item
|
|
391
|
+
* @export
|
|
392
|
+
* @interface DatasetAccessControl
|
|
393
|
+
*/
|
|
394
|
+
export interface DatasetAccessControl {
|
|
395
|
+
/**
|
|
396
|
+
* the identity id
|
|
397
|
+
* @type {string}
|
|
398
|
+
* @memberof DatasetAccessControl
|
|
399
|
+
*/
|
|
400
|
+
'id': string;
|
|
401
|
+
/**
|
|
402
|
+
* a role
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof DatasetAccessControl
|
|
405
|
+
*/
|
|
406
|
+
'role': string;
|
|
298
407
|
}
|
|
299
408
|
/**
|
|
300
409
|
* a Dataset compatibility constraint to a Solution version open range
|
|
@@ -381,6 +490,19 @@ export interface DatasetCopyParameters {
|
|
|
381
490
|
[key: string]: object;
|
|
382
491
|
};
|
|
383
492
|
}
|
|
493
|
+
/**
|
|
494
|
+
* the Dataset Role
|
|
495
|
+
* @export
|
|
496
|
+
* @interface DatasetRole
|
|
497
|
+
*/
|
|
498
|
+
export interface DatasetRole {
|
|
499
|
+
/**
|
|
500
|
+
* the Dataset Role
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof DatasetRole
|
|
503
|
+
*/
|
|
504
|
+
'role': string;
|
|
505
|
+
}
|
|
384
506
|
/**
|
|
385
507
|
* the search options
|
|
386
508
|
* @export
|
|
@@ -394,6 +516,89 @@ export interface DatasetSearch {
|
|
|
394
516
|
*/
|
|
395
517
|
'datasetTags': Array<string>;
|
|
396
518
|
}
|
|
519
|
+
/**
|
|
520
|
+
* the dataset security information
|
|
521
|
+
* @export
|
|
522
|
+
* @interface DatasetSecurity
|
|
523
|
+
*/
|
|
524
|
+
export interface DatasetSecurity {
|
|
525
|
+
/**
|
|
526
|
+
* the role by default
|
|
527
|
+
* @type {string}
|
|
528
|
+
* @memberof DatasetSecurity
|
|
529
|
+
*/
|
|
530
|
+
'default': string;
|
|
531
|
+
/**
|
|
532
|
+
* the list which can access this Dataset with detailed access control information
|
|
533
|
+
* @type {Array<DatasetAccessControl>}
|
|
534
|
+
* @memberof DatasetSecurity
|
|
535
|
+
*/
|
|
536
|
+
'accessControlList': Array<DatasetAccessControl>;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* the Dataset Source Type
|
|
540
|
+
* @export
|
|
541
|
+
* @enum {string}
|
|
542
|
+
*/
|
|
543
|
+
export declare const DatasetSourceType: {
|
|
544
|
+
readonly Adt: "ADT";
|
|
545
|
+
readonly AzureStorage: "AzureStorage";
|
|
546
|
+
readonly File: "File";
|
|
547
|
+
readonly None: "None";
|
|
548
|
+
readonly Twincache: "Twincache";
|
|
549
|
+
};
|
|
550
|
+
export declare type DatasetSourceType = typeof DatasetSourceType[keyof typeof DatasetSourceType];
|
|
551
|
+
/**
|
|
552
|
+
* a twin graph hash
|
|
553
|
+
* @export
|
|
554
|
+
* @interface DatasetTwinGraphHash
|
|
555
|
+
*/
|
|
556
|
+
export interface DatasetTwinGraphHash {
|
|
557
|
+
/**
|
|
558
|
+
* the hash of the graph
|
|
559
|
+
* @type {string}
|
|
560
|
+
* @memberof DatasetTwinGraphHash
|
|
561
|
+
*/
|
|
562
|
+
'hash'?: string;
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* a twin graph query in cypher language
|
|
566
|
+
* @export
|
|
567
|
+
* @interface DatasetTwinGraphInfo
|
|
568
|
+
*/
|
|
569
|
+
export interface DatasetTwinGraphInfo {
|
|
570
|
+
/**
|
|
571
|
+
* the import job id
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof DatasetTwinGraphInfo
|
|
574
|
+
*/
|
|
575
|
+
'jobId'?: string;
|
|
576
|
+
/**
|
|
577
|
+
* the Dataset id
|
|
578
|
+
* @type {string}
|
|
579
|
+
* @memberof DatasetTwinGraphInfo
|
|
580
|
+
*/
|
|
581
|
+
'datasetId'?: string;
|
|
582
|
+
/**
|
|
583
|
+
* Twingraph status
|
|
584
|
+
* @type {string}
|
|
585
|
+
* @memberof DatasetTwinGraphInfo
|
|
586
|
+
*/
|
|
587
|
+
'status'?: string;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* a twin graph query in cypher language
|
|
591
|
+
* @export
|
|
592
|
+
* @interface DatasetTwinGraphQuery
|
|
593
|
+
*/
|
|
594
|
+
export interface DatasetTwinGraphQuery {
|
|
595
|
+
/**
|
|
596
|
+
* the query in cypher language
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof DatasetTwinGraphQuery
|
|
599
|
+
*/
|
|
600
|
+
'query': string;
|
|
601
|
+
}
|
|
397
602
|
/**
|
|
398
603
|
* Configuration of scenario runs deletion automatic mecanism
|
|
399
604
|
* @export
|
|
@@ -419,6 +624,44 @@ export interface DeleteHistoricalData {
|
|
|
419
624
|
*/
|
|
420
625
|
'timeOut'?: number;
|
|
421
626
|
}
|
|
627
|
+
/**
|
|
628
|
+
*
|
|
629
|
+
* @export
|
|
630
|
+
* @interface FileUploadMetadata
|
|
631
|
+
*/
|
|
632
|
+
export interface FileUploadMetadata {
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
* @type {string}
|
|
636
|
+
* @memberof FileUploadMetadata
|
|
637
|
+
*/
|
|
638
|
+
'name'?: string;
|
|
639
|
+
/**
|
|
640
|
+
*
|
|
641
|
+
* @type {number}
|
|
642
|
+
* @memberof FileUploadMetadata
|
|
643
|
+
*/
|
|
644
|
+
'size'?: number;
|
|
645
|
+
}
|
|
646
|
+
/**
|
|
647
|
+
* files read on upload
|
|
648
|
+
* @export
|
|
649
|
+
* @interface FileUploadValidation
|
|
650
|
+
*/
|
|
651
|
+
export interface FileUploadValidation {
|
|
652
|
+
/**
|
|
653
|
+
* list of filename found on nodes folder
|
|
654
|
+
* @type {Array<FileUploadMetadata>}
|
|
655
|
+
* @memberof FileUploadValidation
|
|
656
|
+
*/
|
|
657
|
+
'nodes'?: Array<FileUploadMetadata>;
|
|
658
|
+
/**
|
|
659
|
+
* list of filename found on edges folder
|
|
660
|
+
* @type {Array<FileUploadMetadata>}
|
|
661
|
+
* @memberof FileUploadValidation
|
|
662
|
+
*/
|
|
663
|
+
'edges'?: Array<FileUploadMetadata>;
|
|
664
|
+
}
|
|
422
665
|
/**
|
|
423
666
|
*
|
|
424
667
|
* @export
|
|
@@ -645,8 +888,17 @@ export interface RunTemplate {
|
|
|
645
888
|
* the Run Template name
|
|
646
889
|
* @type {string}
|
|
647
890
|
* @memberof RunTemplate
|
|
891
|
+
* @deprecated
|
|
648
892
|
*/
|
|
649
893
|
'name'?: string;
|
|
894
|
+
/**
|
|
895
|
+
* a translated label with key as ISO 639-1 code
|
|
896
|
+
* @type {{ [key: string]: string; }}
|
|
897
|
+
* @memberof RunTemplate
|
|
898
|
+
*/
|
|
899
|
+
'labels'?: {
|
|
900
|
+
[key: string]: string;
|
|
901
|
+
};
|
|
650
902
|
/**
|
|
651
903
|
* the Run Template description
|
|
652
904
|
* @type {string}
|
|
@@ -815,6 +1067,12 @@ export interface RunTemplate {
|
|
|
815
1067
|
* @memberof RunTemplate
|
|
816
1068
|
*/
|
|
817
1069
|
'runTemplateSourceDir'?: string;
|
|
1070
|
+
/**
|
|
1071
|
+
*
|
|
1072
|
+
* @type {RunTemplateOrchestrator}
|
|
1073
|
+
* @memberof RunTemplate
|
|
1074
|
+
*/
|
|
1075
|
+
'orchestratorType'?: RunTemplateOrchestrator;
|
|
818
1076
|
/**
|
|
819
1077
|
* an optional duration in seconds in which a workflow is allowed to run
|
|
820
1078
|
* @type {number}
|
|
@@ -842,6 +1100,16 @@ export declare const RunTemplateHandlerId: {
|
|
|
842
1100
|
readonly ScenariodataTransform: "scenariodata_transform";
|
|
843
1101
|
};
|
|
844
1102
|
export declare type RunTemplateHandlerId = typeof RunTemplateHandlerId[keyof typeof RunTemplateHandlerId];
|
|
1103
|
+
/**
|
|
1104
|
+
* the Orchestrator to use for the Run Template
|
|
1105
|
+
* @export
|
|
1106
|
+
* @enum {string}
|
|
1107
|
+
*/
|
|
1108
|
+
export declare const RunTemplateOrchestrator: {
|
|
1109
|
+
readonly ArgoWorkflow: "argoWorkflow";
|
|
1110
|
+
readonly CsmOrc: "csmOrc";
|
|
1111
|
+
};
|
|
1112
|
+
export declare type RunTemplateOrchestrator = typeof RunTemplateOrchestrator[keyof typeof RunTemplateOrchestrator];
|
|
845
1113
|
/**
|
|
846
1114
|
* a Run Template Parameter
|
|
847
1115
|
* @export
|
|
@@ -1441,6 +1709,12 @@ export interface ScenarioRun {
|
|
|
1441
1709
|
* @memberof ScenarioRun
|
|
1442
1710
|
*/
|
|
1443
1711
|
'sdkVersion'?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* the ScenarioRun creation date
|
|
1714
|
+
* @type {string}
|
|
1715
|
+
* @memberof ScenarioRun
|
|
1716
|
+
*/
|
|
1717
|
+
'createdAt'?: string;
|
|
1444
1718
|
/**
|
|
1445
1719
|
* set to true if the run template does not use any Datawarehouse consumers (AMQP consumers for Azure)
|
|
1446
1720
|
* @type {boolean}
|
|
@@ -1638,6 +1912,46 @@ export interface ScenarioRunLogs {
|
|
|
1638
1912
|
[key: string]: ScenarioRunContainerLogs;
|
|
1639
1913
|
};
|
|
1640
1914
|
}
|
|
1915
|
+
/**
|
|
1916
|
+
* the memory and CPU requested by the pod
|
|
1917
|
+
* @export
|
|
1918
|
+
* @interface ScenarioRunResourceRequested
|
|
1919
|
+
*/
|
|
1920
|
+
export interface ScenarioRunResourceRequested {
|
|
1921
|
+
/**
|
|
1922
|
+
* the cpu requested
|
|
1923
|
+
* @type {number}
|
|
1924
|
+
* @memberof ScenarioRunResourceRequested
|
|
1925
|
+
*/
|
|
1926
|
+
'cpu'?: number;
|
|
1927
|
+
/**
|
|
1928
|
+
* the memory requested
|
|
1929
|
+
* @type {number}
|
|
1930
|
+
* @memberof ScenarioRunResourceRequested
|
|
1931
|
+
*/
|
|
1932
|
+
'memory'?: number;
|
|
1933
|
+
}
|
|
1934
|
+
/**
|
|
1935
|
+
* a ScenarioRunProbeResult with all ScenarioRunResult
|
|
1936
|
+
* @export
|
|
1937
|
+
* @interface ScenarioRunResult
|
|
1938
|
+
*/
|
|
1939
|
+
export interface ScenarioRunResult {
|
|
1940
|
+
/**
|
|
1941
|
+
*
|
|
1942
|
+
* @type {string}
|
|
1943
|
+
* @memberof ScenarioRunResult
|
|
1944
|
+
*/
|
|
1945
|
+
'id'?: string;
|
|
1946
|
+
/**
|
|
1947
|
+
*
|
|
1948
|
+
* @type {Array<{ [key: string]: string; }>}
|
|
1949
|
+
* @memberof ScenarioRunResult
|
|
1950
|
+
*/
|
|
1951
|
+
'results'?: Array<{
|
|
1952
|
+
[key: string]: string;
|
|
1953
|
+
}>;
|
|
1954
|
+
}
|
|
1641
1955
|
/**
|
|
1642
1956
|
* the search options
|
|
1643
1957
|
* @export
|
|
@@ -1862,6 +2176,18 @@ export interface ScenarioRunStatusNode {
|
|
|
1862
2176
|
* @memberof ScenarioRunStatusNode
|
|
1863
2177
|
*/
|
|
1864
2178
|
'containerName'?: string;
|
|
2179
|
+
/**
|
|
2180
|
+
* the list of outbound nodes
|
|
2181
|
+
* @type {Array<string>}
|
|
2182
|
+
* @memberof ScenarioRunStatusNode
|
|
2183
|
+
*/
|
|
2184
|
+
'outboundNodes'?: Array<string>;
|
|
2185
|
+
/**
|
|
2186
|
+
*
|
|
2187
|
+
* @type {ScenarioRunResourceRequested}
|
|
2188
|
+
* @memberof ScenarioRunStatusNode
|
|
2189
|
+
*/
|
|
2190
|
+
'resourcesDuration'?: ScenarioRunResourceRequested;
|
|
1865
2191
|
/**
|
|
1866
2192
|
* estimatedDuration in seconds
|
|
1867
2193
|
* @type {number}
|
|
@@ -2009,6 +2335,12 @@ export interface Solution {
|
|
|
2009
2335
|
* @memberof Solution
|
|
2010
2336
|
*/
|
|
2011
2337
|
'repository'?: string;
|
|
2338
|
+
/**
|
|
2339
|
+
* set to true if the runtemplate wants to always pull the image
|
|
2340
|
+
* @type {boolean}
|
|
2341
|
+
* @memberof Solution
|
|
2342
|
+
*/
|
|
2343
|
+
'alwaysPull'?: boolean;
|
|
2012
2344
|
/**
|
|
2013
2345
|
* the main Cosmo Tech simulator name used in standard Run Template
|
|
2014
2346
|
* @type {string}
|
|
@@ -2063,6 +2395,63 @@ export interface Solution {
|
|
|
2063
2395
|
* @memberof Solution
|
|
2064
2396
|
*/
|
|
2065
2397
|
'runTemplates'?: Array<RunTemplate>;
|
|
2398
|
+
/**
|
|
2399
|
+
*
|
|
2400
|
+
* @type {SolutionSecurity}
|
|
2401
|
+
* @memberof Solution
|
|
2402
|
+
*/
|
|
2403
|
+
'security'?: SolutionSecurity;
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* a Solution access control item
|
|
2407
|
+
* @export
|
|
2408
|
+
* @interface SolutionAccessControl
|
|
2409
|
+
*/
|
|
2410
|
+
export interface SolutionAccessControl {
|
|
2411
|
+
/**
|
|
2412
|
+
* the identity id
|
|
2413
|
+
* @type {string}
|
|
2414
|
+
* @memberof SolutionAccessControl
|
|
2415
|
+
*/
|
|
2416
|
+
'id': string;
|
|
2417
|
+
/**
|
|
2418
|
+
* a role
|
|
2419
|
+
* @type {string}
|
|
2420
|
+
* @memberof SolutionAccessControl
|
|
2421
|
+
*/
|
|
2422
|
+
'role': string;
|
|
2423
|
+
}
|
|
2424
|
+
/**
|
|
2425
|
+
* the Solution Role
|
|
2426
|
+
* @export
|
|
2427
|
+
* @interface SolutionRole
|
|
2428
|
+
*/
|
|
2429
|
+
export interface SolutionRole {
|
|
2430
|
+
/**
|
|
2431
|
+
* the Solution Role
|
|
2432
|
+
* @type {string}
|
|
2433
|
+
* @memberof SolutionRole
|
|
2434
|
+
*/
|
|
2435
|
+
'role': string;
|
|
2436
|
+
}
|
|
2437
|
+
/**
|
|
2438
|
+
* the Solution security information
|
|
2439
|
+
* @export
|
|
2440
|
+
* @interface SolutionSecurity
|
|
2441
|
+
*/
|
|
2442
|
+
export interface SolutionSecurity {
|
|
2443
|
+
/**
|
|
2444
|
+
* the role by default
|
|
2445
|
+
* @type {string}
|
|
2446
|
+
* @memberof SolutionSecurity
|
|
2447
|
+
*/
|
|
2448
|
+
'default': string;
|
|
2449
|
+
/**
|
|
2450
|
+
* the list which can access this Solution with detailed access control information
|
|
2451
|
+
* @type {Array<SolutionAccessControl>}
|
|
2452
|
+
* @memberof SolutionSecurity
|
|
2453
|
+
*/
|
|
2454
|
+
'accessControlList': Array<SolutionAccessControl>;
|
|
2066
2455
|
}
|
|
2067
2456
|
/**
|
|
2068
2457
|
* Source job import information
|
|
@@ -2089,21 +2478,47 @@ export interface SourceInfo {
|
|
|
2089
2478
|
*/
|
|
2090
2479
|
'path'?: string;
|
|
2091
2480
|
/**
|
|
2092
|
-
*
|
|
2481
|
+
* indicate the last import jobId
|
|
2093
2482
|
* @type {string}
|
|
2094
2483
|
* @memberof SourceInfo
|
|
2095
2484
|
*/
|
|
2096
|
-
'
|
|
2485
|
+
'jobId'?: string;
|
|
2097
2486
|
}
|
|
2098
|
-
export declare const SourceInfoTypeEnum: {
|
|
2099
|
-
readonly Adt: "ADT";
|
|
2100
|
-
readonly Storage: "Storage";
|
|
2101
|
-
};
|
|
2102
|
-
export declare type SourceInfoTypeEnum = typeof SourceInfoTypeEnum[keyof typeof SourceInfoTypeEnum];
|
|
2103
2487
|
/**
|
|
2104
|
-
*
|
|
2488
|
+
* a twin graph query in cypher language
|
|
2105
2489
|
* @export
|
|
2106
|
-
* @interface
|
|
2490
|
+
* @interface SubDatasetGraphQuery
|
|
2491
|
+
*/
|
|
2492
|
+
export interface SubDatasetGraphQuery {
|
|
2493
|
+
/**
|
|
2494
|
+
* the name of the subdataset
|
|
2495
|
+
* @type {string}
|
|
2496
|
+
* @memberof SubDatasetGraphQuery
|
|
2497
|
+
*/
|
|
2498
|
+
'name'?: string;
|
|
2499
|
+
/**
|
|
2500
|
+
* the description of the subdataset
|
|
2501
|
+
* @type {string}
|
|
2502
|
+
* @memberof SubDatasetGraphQuery
|
|
2503
|
+
*/
|
|
2504
|
+
'description'?: string;
|
|
2505
|
+
/**
|
|
2506
|
+
* the query in cypher language
|
|
2507
|
+
* @type {Array<string>}
|
|
2508
|
+
* @memberof SubDatasetGraphQuery
|
|
2509
|
+
*/
|
|
2510
|
+
'queries'?: Array<string>;
|
|
2511
|
+
/**
|
|
2512
|
+
* is this the main dataset
|
|
2513
|
+
* @type {boolean}
|
|
2514
|
+
* @memberof SubDatasetGraphQuery
|
|
2515
|
+
*/
|
|
2516
|
+
'main'?: boolean;
|
|
2517
|
+
}
|
|
2518
|
+
/**
|
|
2519
|
+
* Processing result
|
|
2520
|
+
* @export
|
|
2521
|
+
* @interface TwinGraphBatchResult
|
|
2107
2522
|
*/
|
|
2108
2523
|
export interface TwinGraphBatchResult {
|
|
2109
2524
|
/**
|
|
@@ -2138,50 +2553,6 @@ export interface TwinGraphHash {
|
|
|
2138
2553
|
*/
|
|
2139
2554
|
'hash'?: string;
|
|
2140
2555
|
}
|
|
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
|
-
}
|
|
2185
2556
|
/**
|
|
2186
2557
|
* a twin graph query in cypher language
|
|
2187
2558
|
* @export
|
|
@@ -2324,13 +2695,13 @@ export declare type ValidatorRunStateEnum = typeof ValidatorRunStateEnum[keyof t
|
|
|
2324
2695
|
*/
|
|
2325
2696
|
export interface Workspace {
|
|
2326
2697
|
/**
|
|
2327
|
-
*
|
|
2698
|
+
* Workspace unique identifier generated by the API
|
|
2328
2699
|
* @type {string}
|
|
2329
2700
|
* @memberof Workspace
|
|
2330
2701
|
*/
|
|
2331
2702
|
'id'?: string;
|
|
2332
2703
|
/**
|
|
2333
|
-
*
|
|
2704
|
+
* Organization unique identifier under which the workspace resides
|
|
2334
2705
|
* @type {string}
|
|
2335
2706
|
* @memberof Workspace
|
|
2336
2707
|
*/
|
|
@@ -2342,7 +2713,7 @@ export interface Workspace {
|
|
|
2342
2713
|
*/
|
|
2343
2714
|
'key': string;
|
|
2344
2715
|
/**
|
|
2345
|
-
* the
|
|
2716
|
+
* Workspace name. This name is display in the sample webApp
|
|
2346
2717
|
* @type {string}
|
|
2347
2718
|
* @memberof Workspace
|
|
2348
2719
|
*/
|
|
@@ -2353,6 +2724,12 @@ export interface Workspace {
|
|
|
2353
2724
|
* @memberof Workspace
|
|
2354
2725
|
*/
|
|
2355
2726
|
'description'?: string;
|
|
2727
|
+
/**
|
|
2728
|
+
* list of dataset linked to this dataset
|
|
2729
|
+
* @type {Array<string>}
|
|
2730
|
+
* @memberof Workspace
|
|
2731
|
+
*/
|
|
2732
|
+
'linkedDatasetIdList'?: Array<string>;
|
|
2356
2733
|
/**
|
|
2357
2734
|
* the Workspace version MAJOR.MINOR.PATCH.
|
|
2358
2735
|
* @type {string}
|
|
@@ -2366,7 +2743,7 @@ export interface Workspace {
|
|
|
2366
2743
|
*/
|
|
2367
2744
|
'tags'?: Array<string>;
|
|
2368
2745
|
/**
|
|
2369
|
-
* the user id which own this workspace
|
|
2746
|
+
* the user id which own this workspace. set by the API from Authentification service receved id
|
|
2370
2747
|
* @type {string}
|
|
2371
2748
|
* @memberof Workspace
|
|
2372
2749
|
*/
|
|
@@ -2419,6 +2796,12 @@ export interface Workspace {
|
|
|
2419
2796
|
* @memberof Workspace
|
|
2420
2797
|
*/
|
|
2421
2798
|
'sendScenarioMetadataToEventHub'?: boolean;
|
|
2799
|
+
/**
|
|
2800
|
+
* Activate the copy of dataset on scenario creation, meaning that each scenario created in this workspace will make this copy. when false, scenario use directly the dataset specified.
|
|
2801
|
+
* @type {boolean}
|
|
2802
|
+
* @memberof Workspace
|
|
2803
|
+
*/
|
|
2804
|
+
'datasetCopy'?: boolean;
|
|
2422
2805
|
/**
|
|
2423
2806
|
*
|
|
2424
2807
|
* @type {WorkspaceSecurity}
|
|
@@ -2583,12 +2966,12 @@ export declare const ConnectorApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2583
2966
|
findConnectorById: (connectorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2584
2967
|
/**
|
|
2585
2968
|
*
|
|
2586
|
-
* @summary
|
|
2587
|
-
* @param {
|
|
2969
|
+
* @summary Get the details of a connector
|
|
2970
|
+
* @param {string} connectorName the Connector name
|
|
2588
2971
|
* @param {*} [options] Override http request option.
|
|
2589
2972
|
* @throws {RequiredError}
|
|
2590
2973
|
*/
|
|
2591
|
-
|
|
2974
|
+
findConnectorByName: (connectorName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2592
2975
|
/**
|
|
2593
2976
|
*
|
|
2594
2977
|
* @summary Register a new connector
|
|
@@ -2630,12 +3013,12 @@ export declare const ConnectorApiFp: (configuration?: Configuration) => {
|
|
|
2630
3013
|
findConnectorById(connectorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>>;
|
|
2631
3014
|
/**
|
|
2632
3015
|
*
|
|
2633
|
-
* @summary
|
|
2634
|
-
* @param {
|
|
3016
|
+
* @summary Get the details of a connector
|
|
3017
|
+
* @param {string} connectorName the Connector name
|
|
2635
3018
|
* @param {*} [options] Override http request option.
|
|
2636
3019
|
* @throws {RequiredError}
|
|
2637
3020
|
*/
|
|
2638
|
-
|
|
3021
|
+
findConnectorByName(connectorName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>>;
|
|
2639
3022
|
/**
|
|
2640
3023
|
*
|
|
2641
3024
|
* @summary Register a new connector
|
|
@@ -2677,12 +3060,12 @@ export declare const ConnectorApiFactory: (configuration?: Configuration, basePa
|
|
|
2677
3060
|
findConnectorById(connectorId: string, options?: any): AxiosPromise<Connector>;
|
|
2678
3061
|
/**
|
|
2679
3062
|
*
|
|
2680
|
-
* @summary
|
|
2681
|
-
* @param {
|
|
3063
|
+
* @summary Get the details of a connector
|
|
3064
|
+
* @param {string} connectorName the Connector name
|
|
2682
3065
|
* @param {*} [options] Override http request option.
|
|
2683
3066
|
* @throws {RequiredError}
|
|
2684
3067
|
*/
|
|
2685
|
-
|
|
3068
|
+
findConnectorByName(connectorName: string, options?: any): AxiosPromise<Connector>;
|
|
2686
3069
|
/**
|
|
2687
3070
|
*
|
|
2688
3071
|
* @summary Register a new connector
|
|
@@ -2728,13 +3111,13 @@ export declare class ConnectorApi extends BaseAPI {
|
|
|
2728
3111
|
findConnectorById(connectorId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Connector>>;
|
|
2729
3112
|
/**
|
|
2730
3113
|
*
|
|
2731
|
-
* @summary
|
|
2732
|
-
* @param {
|
|
3114
|
+
* @summary Get the details of a connector
|
|
3115
|
+
* @param {string} connectorName the Connector name
|
|
2733
3116
|
* @param {*} [options] Override http request option.
|
|
2734
3117
|
* @throws {RequiredError}
|
|
2735
3118
|
* @memberof ConnectorApi
|
|
2736
3119
|
*/
|
|
2737
|
-
|
|
3120
|
+
findConnectorByName(connectorName: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Connector>>;
|
|
2738
3121
|
/**
|
|
2739
3122
|
*
|
|
2740
3123
|
* @summary Register a new connector
|
|
@@ -2759,6 +3142,16 @@ export declare class ConnectorApi extends BaseAPI {
|
|
|
2759
3142
|
* @export
|
|
2760
3143
|
*/
|
|
2761
3144
|
export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3145
|
+
/**
|
|
3146
|
+
*
|
|
3147
|
+
* @summary Add a control access to the Dataset
|
|
3148
|
+
* @param {string} organizationId the Organization identifier
|
|
3149
|
+
* @param {string} datasetId the Dataset identifier
|
|
3150
|
+
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
3151
|
+
* @param {*} [options] Override http request option.
|
|
3152
|
+
* @throws {RequiredError}
|
|
3153
|
+
*/
|
|
3154
|
+
addDatasetAccessControl: (organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2762
3155
|
/**
|
|
2763
3156
|
*
|
|
2764
3157
|
* @summary Add Dataset Compatibility elements.
|
|
@@ -2770,8 +3163,8 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2770
3163
|
*/
|
|
2771
3164
|
addOrReplaceDatasetCompatibilityElements: (organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2772
3165
|
/**
|
|
2773
|
-
*
|
|
2774
|
-
* @summary Copy a Dataset to another Dataset.
|
|
3166
|
+
* Not implemented!
|
|
3167
|
+
* @summary Copy a Dataset to another Dataset.
|
|
2775
3168
|
* @param {string} organizationId the Organization identifier
|
|
2776
3169
|
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
2777
3170
|
* @param {*} [options] Override http request option.
|
|
@@ -2787,6 +3180,27 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2787
3180
|
* @throws {RequiredError}
|
|
2788
3181
|
*/
|
|
2789
3182
|
createDataset: (organizationId: string, dataset: Dataset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3183
|
+
/**
|
|
3184
|
+
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
3185
|
+
* @summary Create a sub-dataset from the dataset in parameter
|
|
3186
|
+
* @param {string} organizationId the Organization identifier
|
|
3187
|
+
* @param {string} datasetId the Dataset identifier
|
|
3188
|
+
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
3189
|
+
* @param {*} [options] Override http request option.
|
|
3190
|
+
* @throws {RequiredError}
|
|
3191
|
+
*/
|
|
3192
|
+
createSubDataset: (organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3193
|
+
/**
|
|
3194
|
+
* create new entities in a graph instance
|
|
3195
|
+
* @summary Create new entities in a graph instance
|
|
3196
|
+
* @param {string} organizationId the Organization identifier
|
|
3197
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3198
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3199
|
+
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
3200
|
+
* @param {*} [options] Override http request option.
|
|
3201
|
+
* @throws {RequiredError}
|
|
3202
|
+
*/
|
|
3203
|
+
createTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2790
3204
|
/**
|
|
2791
3205
|
*
|
|
2792
3206
|
* @summary Delete a dataset
|
|
@@ -2796,6 +3210,26 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2796
3210
|
* @throws {RequiredError}
|
|
2797
3211
|
*/
|
|
2798
3212
|
deleteDataset: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3213
|
+
/**
|
|
3214
|
+
* delete entities in a graph instance
|
|
3215
|
+
* @summary Delete entities in a graph instance
|
|
3216
|
+
* @param {string} organizationId the Organization identifier
|
|
3217
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3218
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3219
|
+
* @param {Array<string>} ids the entities to delete
|
|
3220
|
+
* @param {*} [options] Override http request option.
|
|
3221
|
+
* @throws {RequiredError}
|
|
3222
|
+
*/
|
|
3223
|
+
deleteTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3224
|
+
/**
|
|
3225
|
+
* Download the compressed graph reference by the hash in a zip file
|
|
3226
|
+
* @summary Download a graph as a zip file
|
|
3227
|
+
* @param {string} organizationId the Organization identifier
|
|
3228
|
+
* @param {string} hash the Graph download identifier
|
|
3229
|
+
* @param {*} [options] Override http request option.
|
|
3230
|
+
* @throws {RequiredError}
|
|
3231
|
+
*/
|
|
3232
|
+
downloadTwingraph: (organizationId: string, hash: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2799
3233
|
/**
|
|
2800
3234
|
*
|
|
2801
3235
|
* @summary List all Datasets
|
|
@@ -2817,150 +3251,217 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2817
3251
|
findDatasetById: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2818
3252
|
/**
|
|
2819
3253
|
*
|
|
2820
|
-
* @summary
|
|
3254
|
+
* @summary Get a control access for the Dataset
|
|
2821
3255
|
* @param {string} organizationId the Organization identifier
|
|
2822
|
-
* @param {
|
|
3256
|
+
* @param {string} datasetId the Dataset identifier
|
|
3257
|
+
* @param {string} identityId the User identifier
|
|
2823
3258
|
* @param {*} [options] Override http request option.
|
|
2824
3259
|
* @throws {RequiredError}
|
|
2825
3260
|
*/
|
|
2826
|
-
|
|
3261
|
+
getDatasetAccessControl: (organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2827
3262
|
/**
|
|
2828
3263
|
*
|
|
2829
|
-
* @summary
|
|
3264
|
+
* @summary Get the Dataset security information
|
|
2830
3265
|
* @param {string} organizationId the Organization identifier
|
|
2831
3266
|
* @param {string} datasetId the Dataset identifier
|
|
2832
3267
|
* @param {*} [options] Override http request option.
|
|
2833
3268
|
* @throws {RequiredError}
|
|
2834
3269
|
*/
|
|
2835
|
-
|
|
3270
|
+
getDatasetSecurity: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2836
3271
|
/**
|
|
2837
3272
|
*
|
|
2838
|
-
* @summary
|
|
3273
|
+
* @summary Get the Dataset security users list
|
|
2839
3274
|
* @param {string} organizationId the Organization identifier
|
|
2840
|
-
* @param {
|
|
2841
|
-
* @param {number} [page] page number to query
|
|
2842
|
-
* @param {number} [size] amount of result by page
|
|
3275
|
+
* @param {string} datasetId the Dataset identifier
|
|
2843
3276
|
* @param {*} [options] Override http request option.
|
|
2844
3277
|
* @throws {RequiredError}
|
|
2845
3278
|
*/
|
|
2846
|
-
|
|
3279
|
+
getDatasetSecurityUsers: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3280
|
+
/**
|
|
3281
|
+
* 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
|
|
3282
|
+
* @summary Get the dataset\'s refresh job status
|
|
3283
|
+
* @param {string} organizationId the Organization identifier
|
|
3284
|
+
* @param {string} datasetId the dataset identifier
|
|
3285
|
+
* @param {*} [options] Override http request option.
|
|
3286
|
+
* @throws {RequiredError}
|
|
3287
|
+
*/
|
|
3288
|
+
getDatasetTwingraphStatus: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3289
|
+
/**
|
|
3290
|
+
* get entities in a graph instance
|
|
3291
|
+
* @summary Get entities in a graph instance
|
|
3292
|
+
* @param {string} organizationId the Organization identifier
|
|
3293
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3294
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3295
|
+
* @param {Array<string>} ids the entities to get
|
|
3296
|
+
* @param {*} [options] Override http request option.
|
|
3297
|
+
* @throws {RequiredError}
|
|
3298
|
+
*/
|
|
3299
|
+
getTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2847
3300
|
/**
|
|
2848
3301
|
*
|
|
2849
|
-
* @summary Update a dataset
|
|
2850
3302
|
* @param {string} organizationId the Organization identifier
|
|
2851
3303
|
* @param {string} datasetId the Dataset identifier
|
|
2852
|
-
* @param {
|
|
3304
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
2853
3305
|
* @param {*} [options] Override http request option.
|
|
2854
3306
|
* @throws {RequiredError}
|
|
2855
3307
|
*/
|
|
2856
|
-
|
|
2857
|
-
};
|
|
2858
|
-
/**
|
|
2859
|
-
* DatasetApi - functional programming interface
|
|
2860
|
-
* @export
|
|
2861
|
-
*/
|
|
2862
|
-
export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
3308
|
+
linkWorkspace: (organizationId: string, datasetId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2863
3309
|
/**
|
|
2864
|
-
*
|
|
2865
|
-
* @summary
|
|
3310
|
+
* 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
|
|
3311
|
+
* @summary Refresh data on dataset from dataset\'s source
|
|
2866
3312
|
* @param {string} organizationId the Organization identifier
|
|
2867
3313
|
* @param {string} datasetId the Dataset identifier
|
|
2868
|
-
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
2869
3314
|
* @param {*} [options] Override http request option.
|
|
2870
3315
|
* @throws {RequiredError}
|
|
2871
3316
|
*/
|
|
2872
|
-
|
|
3317
|
+
refreshDataset: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2873
3318
|
/**
|
|
2874
3319
|
*
|
|
2875
|
-
* @summary
|
|
3320
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
2876
3321
|
* @param {string} organizationId the Organization identifier
|
|
2877
|
-
* @param {
|
|
3322
|
+
* @param {string} datasetId the Dataset identifier
|
|
2878
3323
|
* @param {*} [options] Override http request option.
|
|
2879
3324
|
* @throws {RequiredError}
|
|
2880
3325
|
*/
|
|
2881
|
-
|
|
3326
|
+
removeAllDatasetCompatibilityElements: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2882
3327
|
/**
|
|
2883
3328
|
*
|
|
2884
|
-
* @summary
|
|
3329
|
+
* @summary Remove the specified access from the given Dataset
|
|
2885
3330
|
* @param {string} organizationId the Organization identifier
|
|
2886
|
-
* @param {
|
|
3331
|
+
* @param {string} datasetId the Dataset identifier
|
|
3332
|
+
* @param {string} identityId the User identifier
|
|
2887
3333
|
* @param {*} [options] Override http request option.
|
|
2888
3334
|
* @throws {RequiredError}
|
|
2889
3335
|
*/
|
|
2890
|
-
|
|
3336
|
+
removeDatasetAccessControl: (organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2891
3337
|
/**
|
|
2892
|
-
*
|
|
2893
|
-
* @summary
|
|
3338
|
+
* Rollback the twingraph on a dataset after a failed refresh
|
|
3339
|
+
* @summary Rollback the dataset after a failed refresh
|
|
2894
3340
|
* @param {string} organizationId the Organization identifier
|
|
2895
3341
|
* @param {string} datasetId the Dataset identifier
|
|
2896
3342
|
* @param {*} [options] Override http request option.
|
|
2897
3343
|
* @throws {RequiredError}
|
|
2898
3344
|
*/
|
|
2899
|
-
|
|
3345
|
+
rollbackRefresh: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2900
3346
|
/**
|
|
2901
3347
|
*
|
|
2902
|
-
* @summary
|
|
3348
|
+
* @summary Search Datasets by tags
|
|
2903
3349
|
* @param {string} organizationId the Organization identifier
|
|
3350
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
2904
3351
|
* @param {number} [page] page number to query
|
|
2905
3352
|
* @param {number} [size] amount of result by page
|
|
2906
3353
|
* @param {*} [options] Override http request option.
|
|
2907
3354
|
* @throws {RequiredError}
|
|
2908
3355
|
*/
|
|
2909
|
-
|
|
3356
|
+
searchDatasets: (organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2910
3357
|
/**
|
|
2911
3358
|
*
|
|
2912
|
-
* @summary
|
|
3359
|
+
* @summary Set the Dataset default security
|
|
2913
3360
|
* @param {string} organizationId the Organization identifier
|
|
2914
3361
|
* @param {string} datasetId the Dataset identifier
|
|
3362
|
+
* @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.
|
|
2915
3363
|
* @param {*} [options] Override http request option.
|
|
2916
3364
|
* @throws {RequiredError}
|
|
2917
3365
|
*/
|
|
2918
|
-
|
|
3366
|
+
setDatasetDefaultSecurity: (organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2919
3367
|
/**
|
|
2920
|
-
*
|
|
2921
|
-
* @summary
|
|
3368
|
+
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
3369
|
+
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
2922
3370
|
* @param {string} organizationId the Organization identifier
|
|
2923
|
-
* @param {
|
|
3371
|
+
* @param {string} datasetId the Graph Identifier
|
|
3372
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
2924
3373
|
* @param {*} [options] Override http request option.
|
|
2925
3374
|
* @throws {RequiredError}
|
|
2926
3375
|
*/
|
|
2927
|
-
|
|
3376
|
+
twingraphBatchQuery: (organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2928
3377
|
/**
|
|
2929
|
-
*
|
|
2930
|
-
* @summary
|
|
3378
|
+
* Async batch update by loading a CSV file on a graph instance
|
|
3379
|
+
* @summary Async batch update by loading a CSV file on a graph instance
|
|
3380
|
+
* @param {string} organizationId the Organization identifier
|
|
3381
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3382
|
+
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
3383
|
+
* @param {any} body
|
|
3384
|
+
* @param {*} [options] Override http request option.
|
|
3385
|
+
* @throws {RequiredError}
|
|
3386
|
+
*/
|
|
3387
|
+
twingraphBatchUpdate: (organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3388
|
+
/**
|
|
3389
|
+
* Run a query on a graph instance and return the result as a json
|
|
3390
|
+
* @summary Return the result of a query made on the graph instance as a json
|
|
2931
3391
|
* @param {string} organizationId the Organization identifier
|
|
2932
3392
|
* @param {string} datasetId the Dataset identifier
|
|
3393
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
2933
3394
|
* @param {*} [options] Override http request option.
|
|
2934
3395
|
* @throws {RequiredError}
|
|
2935
3396
|
*/
|
|
2936
|
-
|
|
3397
|
+
twingraphQuery: (organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2937
3398
|
/**
|
|
2938
3399
|
*
|
|
2939
|
-
* @summary Search Datasets
|
|
2940
3400
|
* @param {string} organizationId the Organization identifier
|
|
2941
|
-
* @param {
|
|
2942
|
-
* @param {
|
|
2943
|
-
* @param {number} [size] amount of result by page
|
|
3401
|
+
* @param {string} datasetId the Dataset identifier
|
|
3402
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
2944
3403
|
* @param {*} [options] Override http request option.
|
|
2945
3404
|
* @throws {RequiredError}
|
|
2946
3405
|
*/
|
|
2947
|
-
|
|
3406
|
+
unlinkWorkspace: (organizationId: string, datasetId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2948
3407
|
/**
|
|
2949
3408
|
*
|
|
2950
3409
|
* @summary Update a dataset
|
|
2951
3410
|
* @param {string} organizationId the Organization identifier
|
|
2952
3411
|
* @param {string} datasetId the Dataset identifier
|
|
2953
|
-
* @param {Dataset} dataset the new Dataset details.
|
|
3412
|
+
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
2954
3413
|
* @param {*} [options] Override http request option.
|
|
2955
3414
|
* @throws {RequiredError}
|
|
2956
3415
|
*/
|
|
2957
|
-
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig)
|
|
3416
|
+
updateDataset: (organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3417
|
+
/**
|
|
3418
|
+
*
|
|
3419
|
+
* @summary Update the specified access to User for a Dataset
|
|
3420
|
+
* @param {string} organizationId the Organization identifier
|
|
3421
|
+
* @param {string} datasetId the Dataset identifier
|
|
3422
|
+
* @param {string} identityId the User identifier
|
|
3423
|
+
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
3424
|
+
* @param {*} [options] Override http request option.
|
|
3425
|
+
* @throws {RequiredError}
|
|
3426
|
+
*/
|
|
3427
|
+
updateDatasetAccessControl: (organizationId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3428
|
+
/**
|
|
3429
|
+
* update entities in a graph instance
|
|
3430
|
+
* @summary Update entities in a graph instance
|
|
3431
|
+
* @param {string} organizationId the Organization identifier
|
|
3432
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3433
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3434
|
+
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
3435
|
+
* @param {*} [options] Override http request option.
|
|
3436
|
+
* @throws {RequiredError}
|
|
3437
|
+
*/
|
|
3438
|
+
updateTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3439
|
+
/**
|
|
3440
|
+
* 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.
|
|
3441
|
+
* @summary Upload data from zip file to dataset\'s twingraph
|
|
3442
|
+
* @param {string} organizationId the Organization identifier
|
|
3443
|
+
* @param {string} datasetId the Dataset identifier
|
|
3444
|
+
* @param {any} body
|
|
3445
|
+
* @param {*} [options] Override http request option.
|
|
3446
|
+
* @throws {RequiredError}
|
|
3447
|
+
*/
|
|
3448
|
+
uploadTwingraph: (organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2958
3449
|
};
|
|
2959
3450
|
/**
|
|
2960
|
-
* DatasetApi -
|
|
3451
|
+
* DatasetApi - functional programming interface
|
|
2961
3452
|
* @export
|
|
2962
3453
|
*/
|
|
2963
|
-
export declare const
|
|
3454
|
+
export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
3455
|
+
/**
|
|
3456
|
+
*
|
|
3457
|
+
* @summary Add a control access to the Dataset
|
|
3458
|
+
* @param {string} organizationId the Organization identifier
|
|
3459
|
+
* @param {string} datasetId the Dataset identifier
|
|
3460
|
+
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
3461
|
+
* @param {*} [options] Override http request option.
|
|
3462
|
+
* @throws {RequiredError}
|
|
3463
|
+
*/
|
|
3464
|
+
addDatasetAccessControl(organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
2964
3465
|
/**
|
|
2965
3466
|
*
|
|
2966
3467
|
* @summary Add Dataset Compatibility elements.
|
|
@@ -2970,16 +3471,16 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2970
3471
|
* @param {*} [options] Override http request option.
|
|
2971
3472
|
* @throws {RequiredError}
|
|
2972
3473
|
*/
|
|
2973
|
-
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?:
|
|
3474
|
+
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DatasetCompatibility>>>;
|
|
2974
3475
|
/**
|
|
2975
|
-
*
|
|
2976
|
-
* @summary Copy a Dataset to another Dataset.
|
|
3476
|
+
* Not implemented!
|
|
3477
|
+
* @summary Copy a Dataset to another Dataset.
|
|
2977
3478
|
* @param {string} organizationId the Organization identifier
|
|
2978
3479
|
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
2979
3480
|
* @param {*} [options] Override http request option.
|
|
2980
3481
|
* @throws {RequiredError}
|
|
2981
3482
|
*/
|
|
2982
|
-
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?:
|
|
3483
|
+
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetCopyParameters>>;
|
|
2983
3484
|
/**
|
|
2984
3485
|
*
|
|
2985
3486
|
* @summary Create a new Dataset
|
|
@@ -2988,7 +3489,28 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2988
3489
|
* @param {*} [options] Override http request option.
|
|
2989
3490
|
* @throws {RequiredError}
|
|
2990
3491
|
*/
|
|
2991
|
-
createDataset(organizationId: string, dataset: Dataset, options?:
|
|
3492
|
+
createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3493
|
+
/**
|
|
3494
|
+
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
3495
|
+
* @summary Create a sub-dataset from the dataset in parameter
|
|
3496
|
+
* @param {string} organizationId the Organization identifier
|
|
3497
|
+
* @param {string} datasetId the Dataset identifier
|
|
3498
|
+
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
3499
|
+
* @param {*} [options] Override http request option.
|
|
3500
|
+
* @throws {RequiredError}
|
|
3501
|
+
*/
|
|
3502
|
+
createSubDataset(organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3503
|
+
/**
|
|
3504
|
+
* create new entities in a graph instance
|
|
3505
|
+
* @summary Create new entities in a graph instance
|
|
3506
|
+
* @param {string} organizationId the Organization identifier
|
|
3507
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3508
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3509
|
+
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
3510
|
+
* @param {*} [options] Override http request option.
|
|
3511
|
+
* @throws {RequiredError}
|
|
3512
|
+
*/
|
|
3513
|
+
createTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
2992
3514
|
/**
|
|
2993
3515
|
*
|
|
2994
3516
|
* @summary Delete a dataset
|
|
@@ -2997,7 +3519,27 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2997
3519
|
* @param {*} [options] Override http request option.
|
|
2998
3520
|
* @throws {RequiredError}
|
|
2999
3521
|
*/
|
|
3000
|
-
deleteDataset(organizationId: string, datasetId: string, options?:
|
|
3522
|
+
deleteDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3523
|
+
/**
|
|
3524
|
+
* delete entities in a graph instance
|
|
3525
|
+
* @summary Delete entities in a graph instance
|
|
3526
|
+
* @param {string} organizationId the Organization identifier
|
|
3527
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3528
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3529
|
+
* @param {Array<string>} ids the entities to delete
|
|
3530
|
+
* @param {*} [options] Override http request option.
|
|
3531
|
+
* @throws {RequiredError}
|
|
3532
|
+
*/
|
|
3533
|
+
deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3534
|
+
/**
|
|
3535
|
+
* Download the compressed graph reference by the hash in a zip file
|
|
3536
|
+
* @summary Download a graph as a zip file
|
|
3537
|
+
* @param {string} organizationId the Organization identifier
|
|
3538
|
+
* @param {string} hash the Graph download identifier
|
|
3539
|
+
* @param {*} [options] Override http request option.
|
|
3540
|
+
* @throws {RequiredError}
|
|
3541
|
+
*/
|
|
3542
|
+
downloadTwingraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
3001
3543
|
/**
|
|
3002
3544
|
*
|
|
3003
3545
|
* @summary List all Datasets
|
|
@@ -3007,7 +3549,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
3007
3549
|
* @param {*} [options] Override http request option.
|
|
3008
3550
|
* @throws {RequiredError}
|
|
3009
3551
|
*/
|
|
3010
|
-
findAllDatasets(organizationId: string, page?: number, size?: number, options?:
|
|
3552
|
+
findAllDatasets(organizationId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
3011
3553
|
/**
|
|
3012
3554
|
*
|
|
3013
3555
|
* @summary Get the details of a Dataset
|
|
@@ -3016,16 +3558,713 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
3016
3558
|
* @param {*} [options] Override http request option.
|
|
3017
3559
|
* @throws {RequiredError}
|
|
3018
3560
|
*/
|
|
3019
|
-
findDatasetById(organizationId: string, datasetId: string, options?:
|
|
3561
|
+
findDatasetById(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3562
|
+
/**
|
|
3563
|
+
*
|
|
3564
|
+
* @summary Get a control access for the Dataset
|
|
3565
|
+
* @param {string} organizationId the Organization identifier
|
|
3566
|
+
* @param {string} datasetId the Dataset identifier
|
|
3567
|
+
* @param {string} identityId the User identifier
|
|
3568
|
+
* @param {*} [options] Override http request option.
|
|
3569
|
+
* @throws {RequiredError}
|
|
3570
|
+
*/
|
|
3571
|
+
getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
3572
|
+
/**
|
|
3573
|
+
*
|
|
3574
|
+
* @summary Get the Dataset security information
|
|
3575
|
+
* @param {string} organizationId the Organization identifier
|
|
3576
|
+
* @param {string} datasetId the Dataset identifier
|
|
3577
|
+
* @param {*} [options] Override http request option.
|
|
3578
|
+
* @throws {RequiredError}
|
|
3579
|
+
*/
|
|
3580
|
+
getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>>;
|
|
3581
|
+
/**
|
|
3582
|
+
*
|
|
3583
|
+
* @summary Get the Dataset security users list
|
|
3584
|
+
* @param {string} organizationId the Organization identifier
|
|
3585
|
+
* @param {string} datasetId the Dataset identifier
|
|
3586
|
+
* @param {*} [options] Override http request option.
|
|
3587
|
+
* @throws {RequiredError}
|
|
3588
|
+
*/
|
|
3589
|
+
getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* 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
|
|
3592
|
+
* @summary Get the dataset\'s refresh job status
|
|
3593
|
+
* @param {string} organizationId the Organization identifier
|
|
3594
|
+
* @param {string} datasetId the dataset identifier
|
|
3595
|
+
* @param {*} [options] Override http request option.
|
|
3596
|
+
* @throws {RequiredError}
|
|
3597
|
+
*/
|
|
3598
|
+
getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3599
|
+
/**
|
|
3600
|
+
* get entities in a graph instance
|
|
3601
|
+
* @summary Get entities in a graph instance
|
|
3602
|
+
* @param {string} organizationId the Organization identifier
|
|
3603
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3604
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3605
|
+
* @param {Array<string>} ids the entities to get
|
|
3606
|
+
* @param {*} [options] Override http request option.
|
|
3607
|
+
* @throws {RequiredError}
|
|
3608
|
+
*/
|
|
3609
|
+
getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3610
|
+
/**
|
|
3611
|
+
*
|
|
3612
|
+
* @param {string} organizationId the Organization identifier
|
|
3613
|
+
* @param {string} datasetId the Dataset identifier
|
|
3614
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
3615
|
+
* @param {*} [options] Override http request option.
|
|
3616
|
+
* @throws {RequiredError}
|
|
3617
|
+
*/
|
|
3618
|
+
linkWorkspace(organizationId: string, datasetId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3619
|
+
/**
|
|
3620
|
+
* 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
|
|
3621
|
+
* @summary Refresh data on dataset from dataset\'s source
|
|
3622
|
+
* @param {string} organizationId the Organization identifier
|
|
3623
|
+
* @param {string} datasetId the Dataset identifier
|
|
3624
|
+
* @param {*} [options] Override http request option.
|
|
3625
|
+
* @throws {RequiredError}
|
|
3626
|
+
*/
|
|
3627
|
+
refreshDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetTwinGraphInfo>>;
|
|
3628
|
+
/**
|
|
3629
|
+
*
|
|
3630
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
3631
|
+
* @param {string} organizationId the Organization identifier
|
|
3632
|
+
* @param {string} datasetId the Dataset identifier
|
|
3633
|
+
* @param {*} [options] Override http request option.
|
|
3634
|
+
* @throws {RequiredError}
|
|
3635
|
+
*/
|
|
3636
|
+
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3637
|
+
/**
|
|
3638
|
+
*
|
|
3639
|
+
* @summary Remove the specified access from the given Dataset
|
|
3640
|
+
* @param {string} organizationId the Organization identifier
|
|
3641
|
+
* @param {string} datasetId the Dataset identifier
|
|
3642
|
+
* @param {string} identityId the User identifier
|
|
3643
|
+
* @param {*} [options] Override http request option.
|
|
3644
|
+
* @throws {RequiredError}
|
|
3645
|
+
*/
|
|
3646
|
+
removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3647
|
+
/**
|
|
3648
|
+
* Rollback the twingraph on a dataset after a failed refresh
|
|
3649
|
+
* @summary Rollback the dataset after a failed refresh
|
|
3650
|
+
* @param {string} organizationId the Organization identifier
|
|
3651
|
+
* @param {string} datasetId the Dataset identifier
|
|
3652
|
+
* @param {*} [options] Override http request option.
|
|
3653
|
+
* @throws {RequiredError}
|
|
3654
|
+
*/
|
|
3655
|
+
rollbackRefresh(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3656
|
+
/**
|
|
3657
|
+
*
|
|
3658
|
+
* @summary Search Datasets by tags
|
|
3659
|
+
* @param {string} organizationId the Organization identifier
|
|
3660
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3661
|
+
* @param {number} [page] page number to query
|
|
3662
|
+
* @param {number} [size] amount of result by page
|
|
3663
|
+
* @param {*} [options] Override http request option.
|
|
3664
|
+
* @throws {RequiredError}
|
|
3665
|
+
*/
|
|
3666
|
+
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
3667
|
+
/**
|
|
3668
|
+
*
|
|
3669
|
+
* @summary Set the Dataset default security
|
|
3670
|
+
* @param {string} organizationId the Organization identifier
|
|
3671
|
+
* @param {string} datasetId the Dataset identifier
|
|
3672
|
+
* @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.
|
|
3673
|
+
* @param {*} [options] Override http request option.
|
|
3674
|
+
* @throws {RequiredError}
|
|
3675
|
+
*/
|
|
3676
|
+
setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>>;
|
|
3677
|
+
/**
|
|
3678
|
+
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
3679
|
+
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
3680
|
+
* @param {string} organizationId the Organization identifier
|
|
3681
|
+
* @param {string} datasetId the Graph Identifier
|
|
3682
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3683
|
+
* @param {*} [options] Override http request option.
|
|
3684
|
+
* @throws {RequiredError}
|
|
3685
|
+
*/
|
|
3686
|
+
twingraphBatchQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetTwinGraphHash>>;
|
|
3687
|
+
/**
|
|
3688
|
+
* Async batch update by loading a CSV file on a graph instance
|
|
3689
|
+
* @summary Async batch update by loading a CSV file on a graph instance
|
|
3690
|
+
* @param {string} organizationId the Organization identifier
|
|
3691
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3692
|
+
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
3693
|
+
* @param {any} body
|
|
3694
|
+
* @param {*} [options] Override http request option.
|
|
3695
|
+
* @throws {RequiredError}
|
|
3696
|
+
*/
|
|
3697
|
+
twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>>;
|
|
3698
|
+
/**
|
|
3699
|
+
* Run a query on a graph instance and return the result as a json
|
|
3700
|
+
* @summary Return the result of a query made on the graph instance as a json
|
|
3701
|
+
* @param {string} organizationId the Organization identifier
|
|
3702
|
+
* @param {string} datasetId the Dataset identifier
|
|
3703
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3704
|
+
* @param {*} [options] Override http request option.
|
|
3705
|
+
* @throws {RequiredError}
|
|
3706
|
+
*/
|
|
3707
|
+
twingraphQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3708
|
+
/**
|
|
3709
|
+
*
|
|
3710
|
+
* @param {string} organizationId the Organization identifier
|
|
3711
|
+
* @param {string} datasetId the Dataset identifier
|
|
3712
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
3713
|
+
* @param {*} [options] Override http request option.
|
|
3714
|
+
* @throws {RequiredError}
|
|
3715
|
+
*/
|
|
3716
|
+
unlinkWorkspace(organizationId: string, datasetId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3717
|
+
/**
|
|
3718
|
+
*
|
|
3719
|
+
* @summary Update a dataset
|
|
3720
|
+
* @param {string} organizationId the Organization identifier
|
|
3721
|
+
* @param {string} datasetId the Dataset identifier
|
|
3722
|
+
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
3723
|
+
* @param {*} [options] Override http request option.
|
|
3724
|
+
* @throws {RequiredError}
|
|
3725
|
+
*/
|
|
3726
|
+
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
|
|
3727
|
+
/**
|
|
3728
|
+
*
|
|
3729
|
+
* @summary Update the specified access to User for a Dataset
|
|
3730
|
+
* @param {string} organizationId the Organization identifier
|
|
3731
|
+
* @param {string} datasetId the Dataset identifier
|
|
3732
|
+
* @param {string} identityId the User identifier
|
|
3733
|
+
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
3734
|
+
* @param {*} [options] Override http request option.
|
|
3735
|
+
* @throws {RequiredError}
|
|
3736
|
+
*/
|
|
3737
|
+
updateDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
3738
|
+
/**
|
|
3739
|
+
* update entities in a graph instance
|
|
3740
|
+
* @summary Update entities in a graph instance
|
|
3741
|
+
* @param {string} organizationId the Organization identifier
|
|
3742
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3743
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3744
|
+
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
3745
|
+
* @param {*} [options] Override http request option.
|
|
3746
|
+
* @throws {RequiredError}
|
|
3747
|
+
*/
|
|
3748
|
+
updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3749
|
+
/**
|
|
3750
|
+
* 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.
|
|
3751
|
+
* @summary Upload data from zip file to dataset\'s twingraph
|
|
3752
|
+
* @param {string} organizationId the Organization identifier
|
|
3753
|
+
* @param {string} datasetId the Dataset identifier
|
|
3754
|
+
* @param {any} body
|
|
3755
|
+
* @param {*} [options] Override http request option.
|
|
3756
|
+
* @throws {RequiredError}
|
|
3757
|
+
*/
|
|
3758
|
+
uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileUploadValidation>>;
|
|
3759
|
+
};
|
|
3760
|
+
/**
|
|
3761
|
+
* DatasetApi - factory interface
|
|
3762
|
+
* @export
|
|
3763
|
+
*/
|
|
3764
|
+
export declare const DatasetApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3765
|
+
/**
|
|
3766
|
+
*
|
|
3767
|
+
* @summary Add a control access to the Dataset
|
|
3768
|
+
* @param {string} organizationId the Organization identifier
|
|
3769
|
+
* @param {string} datasetId the Dataset identifier
|
|
3770
|
+
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
3771
|
+
* @param {*} [options] Override http request option.
|
|
3772
|
+
* @throws {RequiredError}
|
|
3773
|
+
*/
|
|
3774
|
+
addDatasetAccessControl(organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: any): AxiosPromise<DatasetAccessControl>;
|
|
3775
|
+
/**
|
|
3776
|
+
*
|
|
3777
|
+
* @summary Add Dataset Compatibility elements.
|
|
3778
|
+
* @param {string} organizationId the Organization identifier
|
|
3779
|
+
* @param {string} datasetId the Dataset identifier
|
|
3780
|
+
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
3781
|
+
* @param {*} [options] Override http request option.
|
|
3782
|
+
* @throws {RequiredError}
|
|
3783
|
+
*/
|
|
3784
|
+
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: any): AxiosPromise<Array<DatasetCompatibility>>;
|
|
3785
|
+
/**
|
|
3786
|
+
* Not implemented!
|
|
3787
|
+
* @summary Copy a Dataset to another Dataset.
|
|
3788
|
+
* @param {string} organizationId the Organization identifier
|
|
3789
|
+
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
3790
|
+
* @param {*} [options] Override http request option.
|
|
3791
|
+
* @throws {RequiredError}
|
|
3792
|
+
*/
|
|
3793
|
+
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: any): AxiosPromise<DatasetCopyParameters>;
|
|
3794
|
+
/**
|
|
3795
|
+
*
|
|
3796
|
+
* @summary Create a new Dataset
|
|
3797
|
+
* @param {string} organizationId the Organization identifier
|
|
3798
|
+
* @param {Dataset} dataset the Dataset to create
|
|
3799
|
+
* @param {*} [options] Override http request option.
|
|
3800
|
+
* @throws {RequiredError}
|
|
3801
|
+
*/
|
|
3802
|
+
createDataset(organizationId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
3803
|
+
/**
|
|
3804
|
+
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
3805
|
+
* @summary Create a sub-dataset from the dataset in parameter
|
|
3806
|
+
* @param {string} organizationId the Organization identifier
|
|
3807
|
+
* @param {string} datasetId the Dataset identifier
|
|
3808
|
+
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
3809
|
+
* @param {*} [options] Override http request option.
|
|
3810
|
+
* @throws {RequiredError}
|
|
3811
|
+
*/
|
|
3812
|
+
createSubDataset(organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: any): AxiosPromise<Dataset>;
|
|
3813
|
+
/**
|
|
3814
|
+
* create new entities in a graph instance
|
|
3815
|
+
* @summary Create new entities in a graph instance
|
|
3816
|
+
* @param {string} organizationId the Organization identifier
|
|
3817
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3818
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3819
|
+
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
3820
|
+
* @param {*} [options] Override http request option.
|
|
3821
|
+
* @throws {RequiredError}
|
|
3822
|
+
*/
|
|
3823
|
+
createTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
3824
|
+
/**
|
|
3825
|
+
*
|
|
3826
|
+
* @summary Delete a dataset
|
|
3827
|
+
* @param {string} organizationId the Organization identifier
|
|
3828
|
+
* @param {string} datasetId the Dataset identifier
|
|
3829
|
+
* @param {*} [options] Override http request option.
|
|
3830
|
+
* @throws {RequiredError}
|
|
3831
|
+
*/
|
|
3832
|
+
deleteDataset(organizationId: string, datasetId: string, options?: any): AxiosPromise<void>;
|
|
3833
|
+
/**
|
|
3834
|
+
* delete entities in a graph instance
|
|
3835
|
+
* @summary Delete entities in a graph instance
|
|
3836
|
+
* @param {string} organizationId the Organization identifier
|
|
3837
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3838
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3839
|
+
* @param {Array<string>} ids the entities to delete
|
|
3840
|
+
* @param {*} [options] Override http request option.
|
|
3841
|
+
* @throws {RequiredError}
|
|
3842
|
+
*/
|
|
3843
|
+
deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
|
|
3844
|
+
/**
|
|
3845
|
+
* Download the compressed graph reference by the hash in a zip file
|
|
3846
|
+
* @summary Download a graph as a zip file
|
|
3847
|
+
* @param {string} organizationId the Organization identifier
|
|
3848
|
+
* @param {string} hash the Graph download identifier
|
|
3849
|
+
* @param {*} [options] Override http request option.
|
|
3850
|
+
* @throws {RequiredError}
|
|
3851
|
+
*/
|
|
3852
|
+
downloadTwingraph(organizationId: string, hash: string, options?: any): AxiosPromise<any>;
|
|
3853
|
+
/**
|
|
3854
|
+
*
|
|
3855
|
+
* @summary List all Datasets
|
|
3856
|
+
* @param {string} organizationId the Organization identifier
|
|
3857
|
+
* @param {number} [page] page number to query
|
|
3858
|
+
* @param {number} [size] amount of result by page
|
|
3859
|
+
* @param {*} [options] Override http request option.
|
|
3860
|
+
* @throws {RequiredError}
|
|
3861
|
+
*/
|
|
3862
|
+
findAllDatasets(organizationId: string, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
|
|
3863
|
+
/**
|
|
3864
|
+
*
|
|
3865
|
+
* @summary Get the details of a Dataset
|
|
3866
|
+
* @param {string} organizationId the Organization identifier
|
|
3867
|
+
* @param {string} datasetId the Dataset identifier
|
|
3868
|
+
* @param {*} [options] Override http request option.
|
|
3869
|
+
* @throws {RequiredError}
|
|
3870
|
+
*/
|
|
3871
|
+
findDatasetById(organizationId: string, datasetId: string, options?: any): AxiosPromise<Dataset>;
|
|
3872
|
+
/**
|
|
3873
|
+
*
|
|
3874
|
+
* @summary Get a control access for the Dataset
|
|
3875
|
+
* @param {string} organizationId the Organization identifier
|
|
3876
|
+
* @param {string} datasetId the Dataset identifier
|
|
3877
|
+
* @param {string} identityId the User identifier
|
|
3878
|
+
* @param {*} [options] Override http request option.
|
|
3879
|
+
* @throws {RequiredError}
|
|
3880
|
+
*/
|
|
3881
|
+
getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<DatasetAccessControl>;
|
|
3882
|
+
/**
|
|
3883
|
+
*
|
|
3884
|
+
* @summary Get the Dataset security information
|
|
3885
|
+
* @param {string} organizationId the Organization identifier
|
|
3886
|
+
* @param {string} datasetId the Dataset identifier
|
|
3887
|
+
* @param {*} [options] Override http request option.
|
|
3888
|
+
* @throws {RequiredError}
|
|
3889
|
+
*/
|
|
3890
|
+
getDatasetSecurity(organizationId: string, datasetId: string, options?: any): AxiosPromise<DatasetSecurity>;
|
|
3891
|
+
/**
|
|
3892
|
+
*
|
|
3893
|
+
* @summary Get the Dataset security users list
|
|
3894
|
+
* @param {string} organizationId the Organization identifier
|
|
3895
|
+
* @param {string} datasetId the Dataset identifier
|
|
3896
|
+
* @param {*} [options] Override http request option.
|
|
3897
|
+
* @throws {RequiredError}
|
|
3898
|
+
*/
|
|
3899
|
+
getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: any): AxiosPromise<Array<string>>;
|
|
3900
|
+
/**
|
|
3901
|
+
* 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
|
|
3902
|
+
* @summary Get the dataset\'s refresh job status
|
|
3903
|
+
* @param {string} organizationId the Organization identifier
|
|
3904
|
+
* @param {string} datasetId the dataset identifier
|
|
3905
|
+
* @param {*} [options] Override http request option.
|
|
3906
|
+
* @throws {RequiredError}
|
|
3907
|
+
*/
|
|
3908
|
+
getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: any): AxiosPromise<string>;
|
|
3909
|
+
/**
|
|
3910
|
+
* get entities in a graph instance
|
|
3911
|
+
* @summary Get entities in a graph instance
|
|
3912
|
+
* @param {string} organizationId the Organization identifier
|
|
3913
|
+
* @param {string} datasetId the Dataset Identifier
|
|
3914
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
3915
|
+
* @param {Array<string>} ids the entities to get
|
|
3916
|
+
* @param {*} [options] Override http request option.
|
|
3917
|
+
* @throws {RequiredError}
|
|
3918
|
+
*/
|
|
3919
|
+
getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
|
|
3920
|
+
/**
|
|
3921
|
+
*
|
|
3922
|
+
* @param {string} organizationId the Organization identifier
|
|
3923
|
+
* @param {string} datasetId the Dataset identifier
|
|
3924
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
3925
|
+
* @param {*} [options] Override http request option.
|
|
3926
|
+
* @throws {RequiredError}
|
|
3927
|
+
*/
|
|
3928
|
+
linkWorkspace(organizationId: string, datasetId: string, workspaceId: string, options?: any): AxiosPromise<Dataset>;
|
|
3929
|
+
/**
|
|
3930
|
+
* 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
|
|
3931
|
+
* @summary Refresh data on dataset from dataset\'s source
|
|
3932
|
+
* @param {string} organizationId the Organization identifier
|
|
3933
|
+
* @param {string} datasetId the Dataset identifier
|
|
3934
|
+
* @param {*} [options] Override http request option.
|
|
3935
|
+
* @throws {RequiredError}
|
|
3936
|
+
*/
|
|
3937
|
+
refreshDataset(organizationId: string, datasetId: string, options?: any): AxiosPromise<DatasetTwinGraphInfo>;
|
|
3938
|
+
/**
|
|
3939
|
+
*
|
|
3940
|
+
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
3941
|
+
* @param {string} organizationId the Organization identifier
|
|
3942
|
+
* @param {string} datasetId the Dataset identifier
|
|
3943
|
+
* @param {*} [options] Override http request option.
|
|
3944
|
+
* @throws {RequiredError}
|
|
3945
|
+
*/
|
|
3946
|
+
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: any): AxiosPromise<void>;
|
|
3947
|
+
/**
|
|
3948
|
+
*
|
|
3949
|
+
* @summary Remove the specified access from the given Dataset
|
|
3950
|
+
* @param {string} organizationId the Organization identifier
|
|
3951
|
+
* @param {string} datasetId the Dataset identifier
|
|
3952
|
+
* @param {string} identityId the User identifier
|
|
3953
|
+
* @param {*} [options] Override http request option.
|
|
3954
|
+
* @throws {RequiredError}
|
|
3955
|
+
*/
|
|
3956
|
+
removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<void>;
|
|
3957
|
+
/**
|
|
3958
|
+
* Rollback the twingraph on a dataset after a failed refresh
|
|
3959
|
+
* @summary Rollback the dataset after a failed refresh
|
|
3960
|
+
* @param {string} organizationId the Organization identifier
|
|
3961
|
+
* @param {string} datasetId the Dataset identifier
|
|
3962
|
+
* @param {*} [options] Override http request option.
|
|
3963
|
+
* @throws {RequiredError}
|
|
3964
|
+
*/
|
|
3965
|
+
rollbackRefresh(organizationId: string, datasetId: string, options?: any): AxiosPromise<string>;
|
|
3966
|
+
/**
|
|
3967
|
+
*
|
|
3968
|
+
* @summary Search Datasets by tags
|
|
3969
|
+
* @param {string} organizationId the Organization identifier
|
|
3970
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
3971
|
+
* @param {number} [page] page number to query
|
|
3972
|
+
* @param {number} [size] amount of result by page
|
|
3973
|
+
* @param {*} [options] Override http request option.
|
|
3974
|
+
* @throws {RequiredError}
|
|
3975
|
+
*/
|
|
3976
|
+
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
|
|
3977
|
+
/**
|
|
3978
|
+
*
|
|
3979
|
+
* @summary Set the Dataset default security
|
|
3980
|
+
* @param {string} organizationId the Organization identifier
|
|
3981
|
+
* @param {string} datasetId the Dataset identifier
|
|
3982
|
+
* @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.
|
|
3983
|
+
* @param {*} [options] Override http request option.
|
|
3984
|
+
* @throws {RequiredError}
|
|
3985
|
+
*/
|
|
3986
|
+
setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: any): AxiosPromise<DatasetSecurity>;
|
|
3987
|
+
/**
|
|
3988
|
+
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
3989
|
+
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
3990
|
+
* @param {string} organizationId the Organization identifier
|
|
3991
|
+
* @param {string} datasetId the Graph Identifier
|
|
3992
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3993
|
+
* @param {*} [options] Override http request option.
|
|
3994
|
+
* @throws {RequiredError}
|
|
3995
|
+
*/
|
|
3996
|
+
twingraphBatchQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: any): AxiosPromise<DatasetTwinGraphHash>;
|
|
3997
|
+
/**
|
|
3998
|
+
* Async batch update by loading a CSV file on a graph instance
|
|
3999
|
+
* @summary Async batch update by loading a CSV file on a graph instance
|
|
4000
|
+
* @param {string} organizationId the Organization identifier
|
|
4001
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4002
|
+
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
4003
|
+
* @param {any} body
|
|
4004
|
+
* @param {*} [options] Override http request option.
|
|
4005
|
+
* @throws {RequiredError}
|
|
4006
|
+
*/
|
|
4007
|
+
twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult>;
|
|
4008
|
+
/**
|
|
4009
|
+
* Run a query on a graph instance and return the result as a json
|
|
4010
|
+
* @summary Return the result of a query made on the graph instance as a json
|
|
4011
|
+
* @param {string} organizationId the Organization identifier
|
|
4012
|
+
* @param {string} datasetId the Dataset identifier
|
|
4013
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
4014
|
+
* @param {*} [options] Override http request option.
|
|
4015
|
+
* @throws {RequiredError}
|
|
4016
|
+
*/
|
|
4017
|
+
twingraphQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: any): AxiosPromise<string>;
|
|
4018
|
+
/**
|
|
4019
|
+
*
|
|
4020
|
+
* @param {string} organizationId the Organization identifier
|
|
4021
|
+
* @param {string} datasetId the Dataset identifier
|
|
4022
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
4023
|
+
* @param {*} [options] Override http request option.
|
|
4024
|
+
* @throws {RequiredError}
|
|
4025
|
+
*/
|
|
4026
|
+
unlinkWorkspace(organizationId: string, datasetId: string, workspaceId: string, options?: any): AxiosPromise<Dataset>;
|
|
4027
|
+
/**
|
|
4028
|
+
*
|
|
4029
|
+
* @summary Update a dataset
|
|
4030
|
+
* @param {string} organizationId the Organization identifier
|
|
4031
|
+
* @param {string} datasetId the Dataset identifier
|
|
4032
|
+
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
4033
|
+
* @param {*} [options] Override http request option.
|
|
4034
|
+
* @throws {RequiredError}
|
|
4035
|
+
*/
|
|
4036
|
+
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
|
|
4037
|
+
/**
|
|
4038
|
+
*
|
|
4039
|
+
* @summary Update the specified access to User for a Dataset
|
|
4040
|
+
* @param {string} organizationId the Organization identifier
|
|
4041
|
+
* @param {string} datasetId the Dataset identifier
|
|
4042
|
+
* @param {string} identityId the User identifier
|
|
4043
|
+
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
4044
|
+
* @param {*} [options] Override http request option.
|
|
4045
|
+
* @throws {RequiredError}
|
|
4046
|
+
*/
|
|
4047
|
+
updateDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: any): AxiosPromise<DatasetAccessControl>;
|
|
4048
|
+
/**
|
|
4049
|
+
* update entities in a graph instance
|
|
4050
|
+
* @summary Update entities in a graph instance
|
|
4051
|
+
* @param {string} organizationId the Organization identifier
|
|
4052
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4053
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
4054
|
+
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
4055
|
+
* @param {*} [options] Override http request option.
|
|
4056
|
+
* @throws {RequiredError}
|
|
4057
|
+
*/
|
|
4058
|
+
updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
4059
|
+
/**
|
|
4060
|
+
* 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.
|
|
4061
|
+
* @summary Upload data from zip file to dataset\'s twingraph
|
|
4062
|
+
* @param {string} organizationId the Organization identifier
|
|
4063
|
+
* @param {string} datasetId the Dataset identifier
|
|
4064
|
+
* @param {any} body
|
|
4065
|
+
* @param {*} [options] Override http request option.
|
|
4066
|
+
* @throws {RequiredError}
|
|
4067
|
+
*/
|
|
4068
|
+
uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: any): AxiosPromise<FileUploadValidation>;
|
|
4069
|
+
};
|
|
4070
|
+
/**
|
|
4071
|
+
* DatasetApi - object-oriented interface
|
|
4072
|
+
* @export
|
|
4073
|
+
* @class DatasetApi
|
|
4074
|
+
* @extends {BaseAPI}
|
|
4075
|
+
*/
|
|
4076
|
+
export declare class DatasetApi extends BaseAPI {
|
|
4077
|
+
/**
|
|
4078
|
+
*
|
|
4079
|
+
* @summary Add a control access to the Dataset
|
|
4080
|
+
* @param {string} organizationId the Organization identifier
|
|
4081
|
+
* @param {string} datasetId the Dataset identifier
|
|
4082
|
+
* @param {DatasetAccessControl} datasetAccessControl the new Dataset security access to add.
|
|
4083
|
+
* @param {*} [options] Override http request option.
|
|
4084
|
+
* @throws {RequiredError}
|
|
4085
|
+
* @memberof DatasetApi
|
|
4086
|
+
*/
|
|
4087
|
+
addDatasetAccessControl(organizationId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl>>;
|
|
4088
|
+
/**
|
|
4089
|
+
*
|
|
4090
|
+
* @summary Add Dataset Compatibility elements.
|
|
4091
|
+
* @param {string} organizationId the Organization identifier
|
|
4092
|
+
* @param {string} datasetId the Dataset identifier
|
|
4093
|
+
* @param {Array<DatasetCompatibility>} datasetCompatibility the Dataset Compatibility elements
|
|
4094
|
+
* @param {*} [options] Override http request option.
|
|
4095
|
+
* @throws {RequiredError}
|
|
4096
|
+
* @memberof DatasetApi
|
|
4097
|
+
*/
|
|
4098
|
+
addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCompatibility[]>>;
|
|
4099
|
+
/**
|
|
4100
|
+
* Not implemented!
|
|
4101
|
+
* @summary Copy a Dataset to another Dataset.
|
|
4102
|
+
* @param {string} organizationId the Organization identifier
|
|
4103
|
+
* @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
|
|
4104
|
+
* @param {*} [options] Override http request option.
|
|
4105
|
+
* @throws {RequiredError}
|
|
4106
|
+
* @memberof DatasetApi
|
|
4107
|
+
*/
|
|
4108
|
+
copyDataset(organizationId: string, datasetCopyParameters: DatasetCopyParameters, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCopyParameters>>;
|
|
4109
|
+
/**
|
|
4110
|
+
*
|
|
4111
|
+
* @summary Create a new Dataset
|
|
4112
|
+
* @param {string} organizationId the Organization identifier
|
|
4113
|
+
* @param {Dataset} dataset the Dataset to create
|
|
4114
|
+
* @param {*} [options] Override http request option.
|
|
4115
|
+
* @throws {RequiredError}
|
|
4116
|
+
* @memberof DatasetApi
|
|
4117
|
+
*/
|
|
4118
|
+
createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4119
|
+
/**
|
|
4120
|
+
* Create a copy of the dataset using the results of the list of queries given in parameter.
|
|
4121
|
+
* @summary Create a sub-dataset from the dataset in parameter
|
|
4122
|
+
* @param {string} organizationId the Organization identifier
|
|
4123
|
+
* @param {string} datasetId the Dataset identifier
|
|
4124
|
+
* @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
|
|
4125
|
+
* @param {*} [options] Override http request option.
|
|
4126
|
+
* @throws {RequiredError}
|
|
4127
|
+
* @memberof DatasetApi
|
|
4128
|
+
*/
|
|
4129
|
+
createSubDataset(organizationId: string, datasetId: string, subDatasetGraphQuery: SubDatasetGraphQuery, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4130
|
+
/**
|
|
4131
|
+
* create new entities in a graph instance
|
|
4132
|
+
* @summary Create new entities in a graph instance
|
|
4133
|
+
* @param {string} organizationId the Organization identifier
|
|
4134
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4135
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
4136
|
+
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
4137
|
+
* @param {*} [options] Override http request option.
|
|
4138
|
+
* @throws {RequiredError}
|
|
4139
|
+
* @memberof DatasetApi
|
|
4140
|
+
*/
|
|
4141
|
+
createTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
4142
|
+
/**
|
|
4143
|
+
*
|
|
4144
|
+
* @summary Delete a dataset
|
|
4145
|
+
* @param {string} organizationId the Organization identifier
|
|
4146
|
+
* @param {string} datasetId the Dataset identifier
|
|
4147
|
+
* @param {*} [options] Override http request option.
|
|
4148
|
+
* @throws {RequiredError}
|
|
4149
|
+
* @memberof DatasetApi
|
|
4150
|
+
*/
|
|
4151
|
+
deleteDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4152
|
+
/**
|
|
4153
|
+
* delete entities in a graph instance
|
|
4154
|
+
* @summary Delete entities in a graph instance
|
|
4155
|
+
* @param {string} organizationId the Organization identifier
|
|
4156
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4157
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
4158
|
+
* @param {Array<string>} ids the entities to delete
|
|
4159
|
+
* @param {*} [options] Override http request option.
|
|
4160
|
+
* @throws {RequiredError}
|
|
4161
|
+
* @memberof DatasetApi
|
|
4162
|
+
*/
|
|
4163
|
+
deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4164
|
+
/**
|
|
4165
|
+
* Download the compressed graph reference by the hash in a zip file
|
|
4166
|
+
* @summary Download a graph as a zip file
|
|
4167
|
+
* @param {string} organizationId the Organization identifier
|
|
4168
|
+
* @param {string} hash the Graph download identifier
|
|
4169
|
+
* @param {*} [options] Override http request option.
|
|
4170
|
+
* @throws {RequiredError}
|
|
4171
|
+
* @memberof DatasetApi
|
|
4172
|
+
*/
|
|
4173
|
+
downloadTwingraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any>>;
|
|
4174
|
+
/**
|
|
4175
|
+
*
|
|
4176
|
+
* @summary List all Datasets
|
|
4177
|
+
* @param {string} organizationId the Organization identifier
|
|
4178
|
+
* @param {number} [page] page number to query
|
|
4179
|
+
* @param {number} [size] amount of result by page
|
|
4180
|
+
* @param {*} [options] Override http request option.
|
|
4181
|
+
* @throws {RequiredError}
|
|
4182
|
+
* @memberof DatasetApi
|
|
4183
|
+
*/
|
|
4184
|
+
findAllDatasets(organizationId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[]>>;
|
|
4185
|
+
/**
|
|
4186
|
+
*
|
|
4187
|
+
* @summary Get the details of a Dataset
|
|
4188
|
+
* @param {string} organizationId the Organization identifier
|
|
4189
|
+
* @param {string} datasetId the Dataset identifier
|
|
4190
|
+
* @param {*} [options] Override http request option.
|
|
4191
|
+
* @throws {RequiredError}
|
|
4192
|
+
* @memberof DatasetApi
|
|
4193
|
+
*/
|
|
4194
|
+
findDatasetById(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
4195
|
+
/**
|
|
4196
|
+
*
|
|
4197
|
+
* @summary Get a control access for the Dataset
|
|
4198
|
+
* @param {string} organizationId the Organization identifier
|
|
4199
|
+
* @param {string} datasetId the Dataset identifier
|
|
4200
|
+
* @param {string} identityId the User identifier
|
|
4201
|
+
* @param {*} [options] Override http request option.
|
|
4202
|
+
* @throws {RequiredError}
|
|
4203
|
+
* @memberof DatasetApi
|
|
4204
|
+
*/
|
|
4205
|
+
getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl>>;
|
|
4206
|
+
/**
|
|
4207
|
+
*
|
|
4208
|
+
* @summary Get the Dataset security information
|
|
4209
|
+
* @param {string} organizationId the Organization identifier
|
|
4210
|
+
* @param {string} datasetId the Dataset identifier
|
|
4211
|
+
* @param {*} [options] Override http request option.
|
|
4212
|
+
* @throws {RequiredError}
|
|
4213
|
+
* @memberof DatasetApi
|
|
4214
|
+
*/
|
|
4215
|
+
getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetSecurity>>;
|
|
4216
|
+
/**
|
|
4217
|
+
*
|
|
4218
|
+
* @summary Get the Dataset security users list
|
|
4219
|
+
* @param {string} organizationId the Organization identifier
|
|
4220
|
+
* @param {string} datasetId the Dataset identifier
|
|
4221
|
+
* @param {*} [options] Override http request option.
|
|
4222
|
+
* @throws {RequiredError}
|
|
4223
|
+
* @memberof DatasetApi
|
|
4224
|
+
*/
|
|
4225
|
+
getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
4226
|
+
/**
|
|
4227
|
+
* 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
|
|
4228
|
+
* @summary Get the dataset\'s refresh job status
|
|
4229
|
+
* @param {string} organizationId the Organization identifier
|
|
4230
|
+
* @param {string} datasetId the dataset identifier
|
|
4231
|
+
* @param {*} [options] Override http request option.
|
|
4232
|
+
* @throws {RequiredError}
|
|
4233
|
+
* @memberof DatasetApi
|
|
4234
|
+
*/
|
|
4235
|
+
getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
4236
|
+
/**
|
|
4237
|
+
* get entities in a graph instance
|
|
4238
|
+
* @summary Get entities in a graph instance
|
|
4239
|
+
* @param {string} organizationId the Organization identifier
|
|
4240
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4241
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
4242
|
+
* @param {Array<string>} ids the entities to get
|
|
4243
|
+
* @param {*} [options] Override http request option.
|
|
4244
|
+
* @throws {RequiredError}
|
|
4245
|
+
* @memberof DatasetApi
|
|
4246
|
+
*/
|
|
4247
|
+
getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
4248
|
+
/**
|
|
4249
|
+
*
|
|
4250
|
+
* @param {string} organizationId the Organization identifier
|
|
4251
|
+
* @param {string} datasetId the Dataset identifier
|
|
4252
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
4253
|
+
* @param {*} [options] Override http request option.
|
|
4254
|
+
* @throws {RequiredError}
|
|
4255
|
+
* @memberof DatasetApi
|
|
4256
|
+
*/
|
|
4257
|
+
linkWorkspace(organizationId: string, datasetId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
3020
4258
|
/**
|
|
3021
|
-
*
|
|
3022
|
-
* @summary
|
|
4259
|
+
* 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
|
|
4260
|
+
* @summary Refresh data on dataset from dataset\'s source
|
|
3023
4261
|
* @param {string} organizationId the Organization identifier
|
|
3024
|
-
* @param {
|
|
4262
|
+
* @param {string} datasetId the Dataset identifier
|
|
3025
4263
|
* @param {*} [options] Override http request option.
|
|
3026
4264
|
* @throws {RequiredError}
|
|
4265
|
+
* @memberof DatasetApi
|
|
3027
4266
|
*/
|
|
3028
|
-
|
|
4267
|
+
refreshDataset(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetTwinGraphInfo>>;
|
|
3029
4268
|
/**
|
|
3030
4269
|
*
|
|
3031
4270
|
* @summary Remove all Dataset Compatibility elements from the Dataset specified
|
|
@@ -3033,142 +4272,143 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
3033
4272
|
* @param {string} datasetId the Dataset identifier
|
|
3034
4273
|
* @param {*} [options] Override http request option.
|
|
3035
4274
|
* @throws {RequiredError}
|
|
4275
|
+
* @memberof DatasetApi
|
|
3036
4276
|
*/
|
|
3037
|
-
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?:
|
|
4277
|
+
removeAllDatasetCompatibilityElements(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
3038
4278
|
/**
|
|
3039
4279
|
*
|
|
3040
|
-
* @summary
|
|
4280
|
+
* @summary Remove the specified access from the given Dataset
|
|
3041
4281
|
* @param {string} organizationId the Organization identifier
|
|
3042
|
-
* @param {
|
|
3043
|
-
* @param {
|
|
3044
|
-
* @param {number} [size] amount of result by page
|
|
4282
|
+
* @param {string} datasetId the Dataset identifier
|
|
4283
|
+
* @param {string} identityId the User identifier
|
|
3045
4284
|
* @param {*} [options] Override http request option.
|
|
3046
4285
|
* @throws {RequiredError}
|
|
4286
|
+
* @memberof DatasetApi
|
|
3047
4287
|
*/
|
|
3048
|
-
|
|
4288
|
+
removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
3049
4289
|
/**
|
|
3050
|
-
*
|
|
3051
|
-
* @summary
|
|
4290
|
+
* Rollback the twingraph on a dataset after a failed refresh
|
|
4291
|
+
* @summary Rollback the dataset after a failed refresh
|
|
3052
4292
|
* @param {string} organizationId the Organization identifier
|
|
3053
4293
|
* @param {string} datasetId the Dataset identifier
|
|
3054
|
-
* @param {Dataset} dataset the new Dataset details.
|
|
3055
4294
|
* @param {*} [options] Override http request option.
|
|
3056
4295
|
* @throws {RequiredError}
|
|
4296
|
+
* @memberof DatasetApi
|
|
3057
4297
|
*/
|
|
3058
|
-
|
|
3059
|
-
};
|
|
3060
|
-
/**
|
|
3061
|
-
* DatasetApi - object-oriented interface
|
|
3062
|
-
* @export
|
|
3063
|
-
* @class DatasetApi
|
|
3064
|
-
* @extends {BaseAPI}
|
|
3065
|
-
*/
|
|
3066
|
-
export declare class DatasetApi extends BaseAPI {
|
|
4298
|
+
rollbackRefresh(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
3067
4299
|
/**
|
|
3068
4300
|
*
|
|
3069
|
-
* @summary
|
|
4301
|
+
* @summary Search Datasets by tags
|
|
3070
4302
|
* @param {string} organizationId the Organization identifier
|
|
3071
|
-
* @param {
|
|
3072
|
-
* @param {
|
|
4303
|
+
* @param {DatasetSearch} datasetSearch the Dataset search parameters
|
|
4304
|
+
* @param {number} [page] page number to query
|
|
4305
|
+
* @param {number} [size] amount of result by page
|
|
3073
4306
|
* @param {*} [options] Override http request option.
|
|
3074
4307
|
* @throws {RequiredError}
|
|
3075
4308
|
* @memberof DatasetApi
|
|
3076
4309
|
*/
|
|
3077
|
-
|
|
4310
|
+
searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[]>>;
|
|
3078
4311
|
/**
|
|
3079
4312
|
*
|
|
3080
|
-
* @summary
|
|
4313
|
+
* @summary Set the Dataset default security
|
|
3081
4314
|
* @param {string} organizationId the Organization identifier
|
|
3082
|
-
* @param {
|
|
4315
|
+
* @param {string} datasetId the Dataset identifier
|
|
4316
|
+
* @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.
|
|
3083
4317
|
* @param {*} [options] Override http request option.
|
|
3084
4318
|
* @throws {RequiredError}
|
|
3085
4319
|
* @memberof DatasetApi
|
|
3086
4320
|
*/
|
|
3087
|
-
|
|
4321
|
+
setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetSecurity>>;
|
|
3088
4322
|
/**
|
|
3089
|
-
*
|
|
3090
|
-
* @summary
|
|
4323
|
+
* Run a query on a graph instance and return the result as a zip file in async mode
|
|
4324
|
+
* @summary Run a query on a graph instance and return the result as a zip file in async mode
|
|
3091
4325
|
* @param {string} organizationId the Organization identifier
|
|
3092
|
-
* @param {
|
|
4326
|
+
* @param {string} datasetId the Graph Identifier
|
|
4327
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3093
4328
|
* @param {*} [options] Override http request option.
|
|
3094
4329
|
* @throws {RequiredError}
|
|
3095
4330
|
* @memberof DatasetApi
|
|
3096
4331
|
*/
|
|
3097
|
-
|
|
4332
|
+
twingraphBatchQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetTwinGraphHash>>;
|
|
3098
4333
|
/**
|
|
3099
|
-
*
|
|
3100
|
-
* @summary
|
|
4334
|
+
* Async batch update by loading a CSV file on a graph instance
|
|
4335
|
+
* @summary Async batch update by loading a CSV file on a graph instance
|
|
3101
4336
|
* @param {string} organizationId the Organization identifier
|
|
3102
|
-
* @param {string} datasetId the Dataset
|
|
4337
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4338
|
+
* @param {DatasetTwinGraphQuery} twinGraphQuery
|
|
4339
|
+
* @param {any} body
|
|
3103
4340
|
* @param {*} [options] Override http request option.
|
|
3104
4341
|
* @throws {RequiredError}
|
|
3105
4342
|
* @memberof DatasetApi
|
|
3106
4343
|
*/
|
|
3107
|
-
|
|
4344
|
+
twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TwinGraphBatchResult>>;
|
|
3108
4345
|
/**
|
|
3109
|
-
*
|
|
3110
|
-
* @summary
|
|
4346
|
+
* Run a query on a graph instance and return the result as a json
|
|
4347
|
+
* @summary Return the result of a query made on the graph instance as a json
|
|
3111
4348
|
* @param {string} organizationId the Organization identifier
|
|
3112
|
-
* @param {
|
|
3113
|
-
* @param {
|
|
4349
|
+
* @param {string} datasetId the Dataset identifier
|
|
4350
|
+
* @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
|
|
3114
4351
|
* @param {*} [options] Override http request option.
|
|
3115
4352
|
* @throws {RequiredError}
|
|
3116
4353
|
* @memberof DatasetApi
|
|
3117
4354
|
*/
|
|
3118
|
-
|
|
4355
|
+
twingraphQuery(organizationId: string, datasetId: string, datasetTwinGraphQuery: DatasetTwinGraphQuery, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
3119
4356
|
/**
|
|
3120
4357
|
*
|
|
3121
|
-
* @summary Get the details of a Dataset
|
|
3122
4358
|
* @param {string} organizationId the Organization identifier
|
|
3123
4359
|
* @param {string} datasetId the Dataset identifier
|
|
4360
|
+
* @param {string} workspaceId workspace id to be linked to
|
|
3124
4361
|
* @param {*} [options] Override http request option.
|
|
3125
4362
|
* @throws {RequiredError}
|
|
3126
4363
|
* @memberof DatasetApi
|
|
3127
4364
|
*/
|
|
3128
|
-
|
|
4365
|
+
unlinkWorkspace(organizationId: string, datasetId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
3129
4366
|
/**
|
|
3130
4367
|
*
|
|
3131
|
-
* @summary
|
|
4368
|
+
* @summary Update a dataset
|
|
3132
4369
|
* @param {string} organizationId the Organization identifier
|
|
3133
|
-
* @param {
|
|
4370
|
+
* @param {string} datasetId the Dataset identifier
|
|
4371
|
+
* @param {Dataset} dataset the new Dataset details. This endpoint can\'t be used to update security
|
|
3134
4372
|
* @param {*} [options] Override http request option.
|
|
3135
4373
|
* @throws {RequiredError}
|
|
3136
4374
|
* @memberof DatasetApi
|
|
3137
4375
|
*/
|
|
3138
|
-
|
|
4376
|
+
updateDataset(organizationId: string, datasetId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
|
|
3139
4377
|
/**
|
|
3140
4378
|
*
|
|
3141
|
-
* @summary
|
|
4379
|
+
* @summary Update the specified access to User for a Dataset
|
|
3142
4380
|
* @param {string} organizationId the Organization identifier
|
|
3143
4381
|
* @param {string} datasetId the Dataset identifier
|
|
4382
|
+
* @param {string} identityId the User identifier
|
|
4383
|
+
* @param {DatasetRole} datasetRole The new Dataset Access Control
|
|
3144
4384
|
* @param {*} [options] Override http request option.
|
|
3145
4385
|
* @throws {RequiredError}
|
|
3146
4386
|
* @memberof DatasetApi
|
|
3147
4387
|
*/
|
|
3148
|
-
|
|
4388
|
+
updateDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl>>;
|
|
3149
4389
|
/**
|
|
3150
|
-
*
|
|
3151
|
-
* @summary
|
|
4390
|
+
* update entities in a graph instance
|
|
4391
|
+
* @summary Update entities in a graph instance
|
|
3152
4392
|
* @param {string} organizationId the Organization identifier
|
|
3153
|
-
* @param {
|
|
3154
|
-
* @param {
|
|
3155
|
-
* @param {
|
|
4393
|
+
* @param {string} datasetId the Dataset Identifier
|
|
4394
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
4395
|
+
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
3156
4396
|
* @param {*} [options] Override http request option.
|
|
3157
4397
|
* @throws {RequiredError}
|
|
3158
4398
|
* @memberof DatasetApi
|
|
3159
4399
|
*/
|
|
3160
|
-
|
|
4400
|
+
updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
3161
4401
|
/**
|
|
3162
|
-
*
|
|
3163
|
-
* @summary
|
|
4402
|
+
* 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.
|
|
4403
|
+
* @summary Upload data from zip file to dataset\'s twingraph
|
|
3164
4404
|
* @param {string} organizationId the Organization identifier
|
|
3165
4405
|
* @param {string} datasetId the Dataset identifier
|
|
3166
|
-
* @param {
|
|
4406
|
+
* @param {any} body
|
|
3167
4407
|
* @param {*} [options] Override http request option.
|
|
3168
4408
|
* @throws {RequiredError}
|
|
3169
4409
|
* @memberof DatasetApi
|
|
3170
4410
|
*/
|
|
3171
|
-
|
|
4411
|
+
uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileUploadValidation>>;
|
|
3172
4412
|
}
|
|
3173
4413
|
/**
|
|
3174
4414
|
* OrganizationApi - axios parameter creator
|
|
@@ -3242,14 +4482,6 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
3242
4482
|
* @throws {RequiredError}
|
|
3243
4483
|
*/
|
|
3244
4484
|
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>;
|
|
3253
4485
|
/**
|
|
3254
4486
|
*
|
|
3255
4487
|
* @summary Register a new organization
|
|
@@ -3271,7 +4503,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
3271
4503
|
*
|
|
3272
4504
|
* @summary Set the Organization default security
|
|
3273
4505
|
* @param {string} organizationId the Organization identifier
|
|
3274
|
-
* @param {OrganizationRole} organizationRole the
|
|
4506
|
+
* @param {OrganizationRole} organizationRole This change the organization 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 organization.
|
|
3275
4507
|
* @param {*} [options] Override http request option.
|
|
3276
4508
|
* @throws {RequiredError}
|
|
3277
4509
|
*/
|
|
@@ -3288,7 +4520,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
3288
4520
|
*
|
|
3289
4521
|
* @summary Update an Organization
|
|
3290
4522
|
* @param {string} organizationId the Organization identifier
|
|
3291
|
-
* @param {Organization} organization the new Organization details
|
|
4523
|
+
* @param {Organization} organization the new Organization details. This endpoint can\'t be used to update security
|
|
3292
4524
|
* @param {*} [options] Override http request option.
|
|
3293
4525
|
* @throws {RequiredError}
|
|
3294
4526
|
*/
|
|
@@ -3405,14 +4637,6 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
3405
4637
|
* @throws {RequiredError}
|
|
3406
4638
|
*/
|
|
3407
4639
|
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>>;
|
|
3416
4640
|
/**
|
|
3417
4641
|
*
|
|
3418
4642
|
* @summary Register a new organization
|
|
@@ -3434,7 +4658,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
3434
4658
|
*
|
|
3435
4659
|
* @summary Set the Organization default security
|
|
3436
4660
|
* @param {string} organizationId the Organization identifier
|
|
3437
|
-
* @param {OrganizationRole} organizationRole the
|
|
4661
|
+
* @param {OrganizationRole} organizationRole This change the organization 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 organization.
|
|
3438
4662
|
* @param {*} [options] Override http request option.
|
|
3439
4663
|
* @throws {RequiredError}
|
|
3440
4664
|
*/
|
|
@@ -3451,7 +4675,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
3451
4675
|
*
|
|
3452
4676
|
* @summary Update an Organization
|
|
3453
4677
|
* @param {string} organizationId the Organization identifier
|
|
3454
|
-
* @param {Organization} organization the new Organization details
|
|
4678
|
+
* @param {Organization} organization the new Organization details. This endpoint can\'t be used to update security
|
|
3455
4679
|
* @param {*} [options] Override http request option.
|
|
3456
4680
|
* @throws {RequiredError}
|
|
3457
4681
|
*/
|
|
@@ -3570,14 +4794,6 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3570
4794
|
* @throws {RequiredError}
|
|
3571
4795
|
*/
|
|
3572
4796
|
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>;
|
|
3581
4797
|
/**
|
|
3582
4798
|
*
|
|
3583
4799
|
* @summary Register a new organization
|
|
@@ -3599,7 +4815,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3599
4815
|
*
|
|
3600
4816
|
* @summary Set the Organization default security
|
|
3601
4817
|
* @param {string} organizationId the Organization identifier
|
|
3602
|
-
* @param {OrganizationRole} organizationRole the
|
|
4818
|
+
* @param {OrganizationRole} organizationRole This change the organization 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 organization.
|
|
3603
4819
|
* @param {*} [options] Override http request option.
|
|
3604
4820
|
* @throws {RequiredError}
|
|
3605
4821
|
*/
|
|
@@ -3616,7 +4832,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3616
4832
|
*
|
|
3617
4833
|
* @summary Update an Organization
|
|
3618
4834
|
* @param {string} organizationId the Organization identifier
|
|
3619
|
-
* @param {Organization} organization the new Organization details
|
|
4835
|
+
* @param {Organization} organization the new Organization details. This endpoint can\'t be used to update security
|
|
3620
4836
|
* @param {*} [options] Override http request option.
|
|
3621
4837
|
* @throws {RequiredError}
|
|
3622
4838
|
*/
|
|
@@ -3745,15 +4961,6 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
3745
4961
|
* @memberof OrganizationApi
|
|
3746
4962
|
*/
|
|
3747
4963
|
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>>;
|
|
3757
4964
|
/**
|
|
3758
4965
|
*
|
|
3759
4966
|
* @summary Register a new organization
|
|
@@ -3777,7 +4984,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
3777
4984
|
*
|
|
3778
4985
|
* @summary Set the Organization default security
|
|
3779
4986
|
* @param {string} organizationId the Organization identifier
|
|
3780
|
-
* @param {OrganizationRole} organizationRole the
|
|
4987
|
+
* @param {OrganizationRole} organizationRole This change the organization 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 organization.
|
|
3781
4988
|
* @param {*} [options] Override http request option.
|
|
3782
4989
|
* @throws {RequiredError}
|
|
3783
4990
|
* @memberof OrganizationApi
|
|
@@ -3796,7 +5003,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
3796
5003
|
*
|
|
3797
5004
|
* @summary Update an Organization
|
|
3798
5005
|
* @param {string} organizationId the Organization identifier
|
|
3799
|
-
* @param {Organization} organization the new Organization details
|
|
5006
|
+
* @param {Organization} organization the new Organization details. This endpoint can\'t be used to update security
|
|
3800
5007
|
* @param {*} [options] Override http request option.
|
|
3801
5008
|
* @throws {RequiredError}
|
|
3802
5009
|
* @memberof OrganizationApi
|
|
@@ -3911,11 +5118,10 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3911
5118
|
* @param {string} organizationId the Organization identifier
|
|
3912
5119
|
* @param {string} workspaceId the Workspace identifier
|
|
3913
5120
|
* @param {string} scenarioId the Scenario identifier
|
|
3914
|
-
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
3915
5121
|
* @param {*} [options] Override http request option.
|
|
3916
5122
|
* @throws {RequiredError}
|
|
3917
5123
|
*/
|
|
3918
|
-
deleteScenario: (organizationId: string, workspaceId: string, scenarioId: string,
|
|
5124
|
+
deleteScenario: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3919
5125
|
/**
|
|
3920
5126
|
*
|
|
3921
5127
|
* @summary Download Scenario data
|
|
@@ -3986,11 +5192,12 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3986
5192
|
* @summary Get the Scenario permission by given role
|
|
3987
5193
|
* @param {string} organizationId the Organization identifier
|
|
3988
5194
|
* @param {string} workspaceId the Workspace identifier
|
|
5195
|
+
* @param {string} scenarioId the Scenario identifier
|
|
3989
5196
|
* @param {string} role the Role
|
|
3990
5197
|
* @param {*} [options] Override http request option.
|
|
3991
5198
|
* @throws {RequiredError}
|
|
3992
5199
|
*/
|
|
3993
|
-
getScenarioPermissions: (organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5200
|
+
getScenarioPermissions: (organizationId: string, workspaceId: string, scenarioId: string, role: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3994
5201
|
/**
|
|
3995
5202
|
*
|
|
3996
5203
|
* @summary Get the Scenario security information
|
|
@@ -4030,16 +5237,6 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4030
5237
|
* @throws {RequiredError}
|
|
4031
5238
|
*/
|
|
4032
5239
|
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>;
|
|
4043
5240
|
/**
|
|
4044
5241
|
*
|
|
4045
5242
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -4067,7 +5264,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4067
5264
|
* @param {string} organizationId the Organization identifier
|
|
4068
5265
|
* @param {string} workspaceId the Workspace identifier
|
|
4069
5266
|
* @param {string} scenarioId the Scenario identifier
|
|
4070
|
-
* @param {ScenarioRole} scenarioRole the
|
|
5267
|
+
* @param {ScenarioRole} scenarioRole This change the scenario 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 scenario.
|
|
4071
5268
|
* @param {*} [options] Override http request option.
|
|
4072
5269
|
* @throws {RequiredError}
|
|
4073
5270
|
*/
|
|
@@ -4078,7 +5275,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4078
5275
|
* @param {string} organizationId the Organization identifier
|
|
4079
5276
|
* @param {string} workspaceId the Workspace identifier
|
|
4080
5277
|
* @param {string} scenarioId the Scenario identifier
|
|
4081
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
5278
|
+
* @param {Scenario} scenario the new Scenario details. This endpoint can\'t be used to update security
|
|
4082
5279
|
* @param {*} [options] Override http request option.
|
|
4083
5280
|
* @throws {RequiredError}
|
|
4084
5281
|
*/
|
|
@@ -4159,11 +5356,10 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
4159
5356
|
* @param {string} organizationId the Organization identifier
|
|
4160
5357
|
* @param {string} workspaceId the Workspace identifier
|
|
4161
5358
|
* @param {string} scenarioId the Scenario identifier
|
|
4162
|
-
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
4163
5359
|
* @param {*} [options] Override http request option.
|
|
4164
5360
|
* @throws {RequiredError}
|
|
4165
5361
|
*/
|
|
4166
|
-
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string,
|
|
5362
|
+
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4167
5363
|
/**
|
|
4168
5364
|
*
|
|
4169
5365
|
* @summary Download Scenario data
|
|
@@ -4234,11 +5430,12 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
4234
5430
|
* @summary Get the Scenario permission by given role
|
|
4235
5431
|
* @param {string} organizationId the Organization identifier
|
|
4236
5432
|
* @param {string} workspaceId the Workspace identifier
|
|
5433
|
+
* @param {string} scenarioId the Scenario identifier
|
|
4237
5434
|
* @param {string} role the Role
|
|
4238
5435
|
* @param {*} [options] Override http request option.
|
|
4239
5436
|
* @throws {RequiredError}
|
|
4240
5437
|
*/
|
|
4241
|
-
getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5438
|
+
getScenarioPermissions(organizationId: string, workspaceId: string, scenarioId: string, role: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
4242
5439
|
/**
|
|
4243
5440
|
*
|
|
4244
5441
|
* @summary Get the Scenario security information
|
|
@@ -4278,16 +5475,6 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
4278
5475
|
* @throws {RequiredError}
|
|
4279
5476
|
*/
|
|
4280
5477
|
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>>;
|
|
4291
5478
|
/**
|
|
4292
5479
|
*
|
|
4293
5480
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -4315,7 +5502,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
4315
5502
|
* @param {string} organizationId the Organization identifier
|
|
4316
5503
|
* @param {string} workspaceId the Workspace identifier
|
|
4317
5504
|
* @param {string} scenarioId the Scenario identifier
|
|
4318
|
-
* @param {ScenarioRole} scenarioRole the
|
|
5505
|
+
* @param {ScenarioRole} scenarioRole This change the scenario 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 scenario.
|
|
4319
5506
|
* @param {*} [options] Override http request option.
|
|
4320
5507
|
* @throws {RequiredError}
|
|
4321
5508
|
*/
|
|
@@ -4326,7 +5513,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
|
|
|
4326
5513
|
* @param {string} organizationId the Organization identifier
|
|
4327
5514
|
* @param {string} workspaceId the Workspace identifier
|
|
4328
5515
|
* @param {string} scenarioId the Scenario identifier
|
|
4329
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
5516
|
+
* @param {Scenario} scenario the new Scenario details. This endpoint can\'t be used to update security
|
|
4330
5517
|
* @param {*} [options] Override http request option.
|
|
4331
5518
|
* @throws {RequiredError}
|
|
4332
5519
|
*/
|
|
@@ -4407,11 +5594,10 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
4407
5594
|
* @param {string} organizationId the Organization identifier
|
|
4408
5595
|
* @param {string} workspaceId the Workspace identifier
|
|
4409
5596
|
* @param {string} scenarioId the Scenario identifier
|
|
4410
|
-
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
4411
5597
|
* @param {*} [options] Override http request option.
|
|
4412
5598
|
* @throws {RequiredError}
|
|
4413
5599
|
*/
|
|
4414
|
-
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string,
|
|
5600
|
+
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<void>;
|
|
4415
5601
|
/**
|
|
4416
5602
|
*
|
|
4417
5603
|
* @summary Download Scenario data
|
|
@@ -4482,11 +5668,12 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
4482
5668
|
* @summary Get the Scenario permission by given role
|
|
4483
5669
|
* @param {string} organizationId the Organization identifier
|
|
4484
5670
|
* @param {string} workspaceId the Workspace identifier
|
|
5671
|
+
* @param {string} scenarioId the Scenario identifier
|
|
4485
5672
|
* @param {string} role the Role
|
|
4486
5673
|
* @param {*} [options] Override http request option.
|
|
4487
5674
|
* @throws {RequiredError}
|
|
4488
5675
|
*/
|
|
4489
|
-
getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: any): AxiosPromise<Array<string>>;
|
|
5676
|
+
getScenarioPermissions(organizationId: string, workspaceId: string, scenarioId: string, role: string, options?: any): AxiosPromise<Array<string>>;
|
|
4490
5677
|
/**
|
|
4491
5678
|
*
|
|
4492
5679
|
* @summary Get the Scenario security information
|
|
@@ -4526,16 +5713,6 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
4526
5713
|
* @throws {RequiredError}
|
|
4527
5714
|
*/
|
|
4528
5715
|
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>;
|
|
4539
5716
|
/**
|
|
4540
5717
|
*
|
|
4541
5718
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -4563,7 +5740,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
4563
5740
|
* @param {string} organizationId the Organization identifier
|
|
4564
5741
|
* @param {string} workspaceId the Workspace identifier
|
|
4565
5742
|
* @param {string} scenarioId the Scenario identifier
|
|
4566
|
-
* @param {ScenarioRole} scenarioRole the
|
|
5743
|
+
* @param {ScenarioRole} scenarioRole This change the scenario 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 scenario.
|
|
4567
5744
|
* @param {*} [options] Override http request option.
|
|
4568
5745
|
* @throws {RequiredError}
|
|
4569
5746
|
*/
|
|
@@ -4574,7 +5751,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
|
|
|
4574
5751
|
* @param {string} organizationId the Organization identifier
|
|
4575
5752
|
* @param {string} workspaceId the Workspace identifier
|
|
4576
5753
|
* @param {string} scenarioId the Scenario identifier
|
|
4577
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
5754
|
+
* @param {Scenario} scenario the new Scenario details. This endpoint can\'t be used to update security
|
|
4578
5755
|
* @param {*} [options] Override http request option.
|
|
4579
5756
|
* @throws {RequiredError}
|
|
4580
5757
|
*/
|
|
@@ -4662,12 +5839,11 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
4662
5839
|
* @param {string} organizationId the Organization identifier
|
|
4663
5840
|
* @param {string} workspaceId the Workspace identifier
|
|
4664
5841
|
* @param {string} scenarioId the Scenario identifier
|
|
4665
|
-
* @param {boolean} [waitRelationshipPropagation] whether to wait until child scenarios are effectively updated
|
|
4666
5842
|
* @param {*} [options] Override http request option.
|
|
4667
5843
|
* @throws {RequiredError}
|
|
4668
5844
|
* @memberof ScenarioApi
|
|
4669
5845
|
*/
|
|
4670
|
-
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string,
|
|
5846
|
+
deleteScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
4671
5847
|
/**
|
|
4672
5848
|
*
|
|
4673
5849
|
* @summary Download Scenario data
|
|
@@ -4744,12 +5920,13 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
4744
5920
|
* @summary Get the Scenario permission by given role
|
|
4745
5921
|
* @param {string} organizationId the Organization identifier
|
|
4746
5922
|
* @param {string} workspaceId the Workspace identifier
|
|
5923
|
+
* @param {string} scenarioId the Scenario identifier
|
|
4747
5924
|
* @param {string} role the Role
|
|
4748
5925
|
* @param {*} [options] Override http request option.
|
|
4749
5926
|
* @throws {RequiredError}
|
|
4750
5927
|
* @memberof ScenarioApi
|
|
4751
5928
|
*/
|
|
4752
|
-
getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
5929
|
+
getScenarioPermissions(organizationId: string, workspaceId: string, scenarioId: string, role: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
4753
5930
|
/**
|
|
4754
5931
|
*
|
|
4755
5932
|
* @summary Get the Scenario security information
|
|
@@ -4793,17 +5970,6 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
4793
5970
|
* @memberof ScenarioApi
|
|
4794
5971
|
*/
|
|
4795
5972
|
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>>;
|
|
4807
5973
|
/**
|
|
4808
5974
|
*
|
|
4809
5975
|
* @summary Remove all Parameter Values from the Scenario specified
|
|
@@ -4833,7 +5999,7 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
4833
5999
|
* @param {string} organizationId the Organization identifier
|
|
4834
6000
|
* @param {string} workspaceId the Workspace identifier
|
|
4835
6001
|
* @param {string} scenarioId the Scenario identifier
|
|
4836
|
-
* @param {ScenarioRole} scenarioRole the
|
|
6002
|
+
* @param {ScenarioRole} scenarioRole This change the scenario 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 scenario.
|
|
4837
6003
|
* @param {*} [options] Override http request option.
|
|
4838
6004
|
* @throws {RequiredError}
|
|
4839
6005
|
* @memberof ScenarioApi
|
|
@@ -4845,7 +6011,7 @@ export declare class ScenarioApi extends BaseAPI {
|
|
|
4845
6011
|
* @param {string} organizationId the Organization identifier
|
|
4846
6012
|
* @param {string} workspaceId the Workspace identifier
|
|
4847
6013
|
* @param {string} scenarioId the Scenario identifier
|
|
4848
|
-
* @param {Scenario} scenario the new Scenario details.
|
|
6014
|
+
* @param {Scenario} scenario the new Scenario details. This endpoint can\'t be used to update security
|
|
4849
6015
|
* @param {*} [options] Override http request option.
|
|
4850
6016
|
* @throws {RequiredError}
|
|
4851
6017
|
* @memberof ScenarioApi
|
|
@@ -4968,17 +6134,6 @@ export declare const ScenariorunApiAxiosParamCreator: (configuration?: Configura
|
|
|
4968
6134
|
* @throws {RequiredError}
|
|
4969
6135
|
*/
|
|
4970
6136
|
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>;
|
|
4982
6137
|
/**
|
|
4983
6138
|
*
|
|
4984
6139
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -5122,17 +6277,6 @@ export declare const ScenariorunApiFp: (configuration?: Configuration) => {
|
|
|
5122
6277
|
* @throws {RequiredError}
|
|
5123
6278
|
*/
|
|
5124
6279
|
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>>;
|
|
5136
6280
|
/**
|
|
5137
6281
|
*
|
|
5138
6282
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -5276,17 +6420,6 @@ export declare const ScenariorunApiFactory: (configuration?: Configuration, base
|
|
|
5276
6420
|
* @throws {RequiredError}
|
|
5277
6421
|
*/
|
|
5278
6422
|
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>;
|
|
5290
6423
|
/**
|
|
5291
6424
|
*
|
|
5292
6425
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -5442,18 +6575,6 @@ export declare class ScenariorunApi extends BaseAPI {
|
|
|
5442
6575
|
* @memberof ScenariorunApi
|
|
5443
6576
|
*/
|
|
5444
6577
|
getWorkspaceScenarioRuns(organizationId: string, workspaceId: string, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun[]>>;
|
|
5445
|
-
/**
|
|
5446
|
-
*
|
|
5447
|
-
* @summary import a ScenarioRun for the Scenario
|
|
5448
|
-
* @param {string} organizationId the Organization identifier
|
|
5449
|
-
* @param {string} workspaceId the Workspace identifier
|
|
5450
|
-
* @param {string} scenarioId the Scenario identifier
|
|
5451
|
-
* @param {ScenarioRun} scenarioRun the ScenarioRun to import
|
|
5452
|
-
* @param {*} [options] Override http request option.
|
|
5453
|
-
* @throws {RequiredError}
|
|
5454
|
-
* @memberof ScenariorunApi
|
|
5455
|
-
*/
|
|
5456
|
-
importScenarioRun(organizationId: string, workspaceId: string, scenarioId: string, scenarioRun: ScenarioRun, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun>>;
|
|
5457
6578
|
/**
|
|
5458
6579
|
*
|
|
5459
6580
|
* @summary run a ScenarioRun for the Scenario
|
|
@@ -5484,19 +6605,155 @@ export declare class ScenariorunApi extends BaseAPI {
|
|
|
5484
6605
|
* @param {ScenarioRunStartContainers} scenarioRunStartContainers the raw containers definition
|
|
5485
6606
|
* @param {*} [options] Override http request option.
|
|
5486
6607
|
* @throws {RequiredError}
|
|
5487
|
-
* @memberof ScenariorunApi
|
|
6608
|
+
* @memberof ScenariorunApi
|
|
6609
|
+
*/
|
|
6610
|
+
startScenarioRunContainers(organizationId: string, scenarioRunStartContainers: ScenarioRunStartContainers, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRun>>;
|
|
6611
|
+
/**
|
|
6612
|
+
*
|
|
6613
|
+
* @summary stop a ScenarioRun for the Scenario
|
|
6614
|
+
* @param {string} organizationId the Organization identifier
|
|
6615
|
+
* @param {string} scenariorunId the scenariorun identifier
|
|
6616
|
+
* @param {*} [options] Override http request option.
|
|
6617
|
+
* @throws {RequiredError}
|
|
6618
|
+
* @memberof ScenariorunApi
|
|
6619
|
+
*/
|
|
6620
|
+
stopScenarioRun(organizationId: string, scenariorunId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunStatus>>;
|
|
6621
|
+
}
|
|
6622
|
+
/**
|
|
6623
|
+
* ScenariorunresultApi - axios parameter creator
|
|
6624
|
+
* @export
|
|
6625
|
+
*/
|
|
6626
|
+
export declare const ScenariorunresultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6627
|
+
/**
|
|
6628
|
+
*
|
|
6629
|
+
* @summary Get a ScenarioRunResult in the Organization
|
|
6630
|
+
* @param {string} organizationId the Organization identifier
|
|
6631
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6632
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6633
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6634
|
+
* @param {string} probeId the Probe identifier
|
|
6635
|
+
* @param {*} [options] Override http request option.
|
|
6636
|
+
* @throws {RequiredError}
|
|
6637
|
+
*/
|
|
6638
|
+
getScenarioRunResult: (organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6639
|
+
/**
|
|
6640
|
+
*
|
|
6641
|
+
* @summary Create a new ScenarioRunResult in the Organization
|
|
6642
|
+
* @param {string} organizationId the Organization identifier
|
|
6643
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6644
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6645
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6646
|
+
* @param {string} probeId the Probe identifier
|
|
6647
|
+
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
6648
|
+
* @param {*} [options] Override http request option.
|
|
6649
|
+
* @throws {RequiredError}
|
|
6650
|
+
*/
|
|
6651
|
+
sendScenarioRunResult: (organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6652
|
+
[key: string]: string;
|
|
6653
|
+
}, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6654
|
+
};
|
|
6655
|
+
/**
|
|
6656
|
+
* ScenariorunresultApi - functional programming interface
|
|
6657
|
+
* @export
|
|
6658
|
+
*/
|
|
6659
|
+
export declare const ScenariorunresultApiFp: (configuration?: Configuration) => {
|
|
6660
|
+
/**
|
|
6661
|
+
*
|
|
6662
|
+
* @summary Get a ScenarioRunResult in the Organization
|
|
6663
|
+
* @param {string} organizationId the Organization identifier
|
|
6664
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6665
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6666
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6667
|
+
* @param {string} probeId the Probe identifier
|
|
6668
|
+
* @param {*} [options] Override http request option.
|
|
6669
|
+
* @throws {RequiredError}
|
|
6670
|
+
*/
|
|
6671
|
+
getScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioRunResult>>;
|
|
6672
|
+
/**
|
|
6673
|
+
*
|
|
6674
|
+
* @summary Create a new ScenarioRunResult in the Organization
|
|
6675
|
+
* @param {string} organizationId the Organization identifier
|
|
6676
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6677
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6678
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6679
|
+
* @param {string} probeId the Probe identifier
|
|
6680
|
+
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
6681
|
+
* @param {*} [options] Override http request option.
|
|
6682
|
+
* @throws {RequiredError}
|
|
6683
|
+
*/
|
|
6684
|
+
sendScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6685
|
+
[key: string]: string;
|
|
6686
|
+
}, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioRunResult>>;
|
|
6687
|
+
};
|
|
6688
|
+
/**
|
|
6689
|
+
* ScenariorunresultApi - factory interface
|
|
6690
|
+
* @export
|
|
6691
|
+
*/
|
|
6692
|
+
export declare const ScenariorunresultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6693
|
+
/**
|
|
6694
|
+
*
|
|
6695
|
+
* @summary Get a ScenarioRunResult in the Organization
|
|
6696
|
+
* @param {string} organizationId the Organization identifier
|
|
6697
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6698
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6699
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6700
|
+
* @param {string} probeId the Probe identifier
|
|
6701
|
+
* @param {*} [options] Override http request option.
|
|
6702
|
+
* @throws {RequiredError}
|
|
6703
|
+
*/
|
|
6704
|
+
getScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, options?: any): AxiosPromise<ScenarioRunResult>;
|
|
6705
|
+
/**
|
|
6706
|
+
*
|
|
6707
|
+
* @summary Create a new ScenarioRunResult in the Organization
|
|
6708
|
+
* @param {string} organizationId the Organization identifier
|
|
6709
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6710
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6711
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6712
|
+
* @param {string} probeId the Probe identifier
|
|
6713
|
+
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
6714
|
+
* @param {*} [options] Override http request option.
|
|
6715
|
+
* @throws {RequiredError}
|
|
6716
|
+
*/
|
|
6717
|
+
sendScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6718
|
+
[key: string]: string;
|
|
6719
|
+
}, options?: any): AxiosPromise<ScenarioRunResult>;
|
|
6720
|
+
};
|
|
6721
|
+
/**
|
|
6722
|
+
* ScenariorunresultApi - object-oriented interface
|
|
6723
|
+
* @export
|
|
6724
|
+
* @class ScenariorunresultApi
|
|
6725
|
+
* @extends {BaseAPI}
|
|
6726
|
+
*/
|
|
6727
|
+
export declare class ScenariorunresultApi extends BaseAPI {
|
|
6728
|
+
/**
|
|
6729
|
+
*
|
|
6730
|
+
* @summary Get a ScenarioRunResult in the Organization
|
|
6731
|
+
* @param {string} organizationId the Organization identifier
|
|
6732
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6733
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6734
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6735
|
+
* @param {string} probeId the Probe identifier
|
|
6736
|
+
* @param {*} [options] Override http request option.
|
|
6737
|
+
* @throws {RequiredError}
|
|
6738
|
+
* @memberof ScenariorunresultApi
|
|
5488
6739
|
*/
|
|
5489
|
-
|
|
6740
|
+
getScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunResult>>;
|
|
5490
6741
|
/**
|
|
5491
6742
|
*
|
|
5492
|
-
* @summary
|
|
6743
|
+
* @summary Create a new ScenarioRunResult in the Organization
|
|
5493
6744
|
* @param {string} organizationId the Organization identifier
|
|
5494
|
-
* @param {string}
|
|
6745
|
+
* @param {string} workspaceId the Workspace identifier
|
|
6746
|
+
* @param {string} scenarioId the Scenario identifier
|
|
6747
|
+
* @param {string} scenariorunId the ScenarioRun identifier
|
|
6748
|
+
* @param {string} probeId the Probe identifier
|
|
6749
|
+
* @param {{ [key: string]: string; }} requestBody the ScenarioRunResult to register
|
|
5495
6750
|
* @param {*} [options] Override http request option.
|
|
5496
6751
|
* @throws {RequiredError}
|
|
5497
|
-
* @memberof
|
|
6752
|
+
* @memberof ScenariorunresultApi
|
|
5498
6753
|
*/
|
|
5499
|
-
|
|
6754
|
+
sendScenarioRunResult(organizationId: string, workspaceId: string, scenarioId: string, scenariorunId: string, probeId: string, requestBody: {
|
|
6755
|
+
[key: string]: string;
|
|
6756
|
+
}, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunResult>>;
|
|
5500
6757
|
}
|
|
5501
6758
|
/**
|
|
5502
6759
|
* SolutionApi - axios parameter creator
|
|
@@ -5533,6 +6790,16 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5533
6790
|
* @throws {RequiredError}
|
|
5534
6791
|
*/
|
|
5535
6792
|
addOrReplaceRunTemplates: (organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6793
|
+
/**
|
|
6794
|
+
*
|
|
6795
|
+
* @summary Add a control access to the Solution
|
|
6796
|
+
* @param {string} organizationId the Organization identifier
|
|
6797
|
+
* @param {string} solutionId the Solution identifier
|
|
6798
|
+
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
6799
|
+
* @param {*} [options] Override http request option.
|
|
6800
|
+
* @throws {RequiredError}
|
|
6801
|
+
*/
|
|
6802
|
+
addSolutionAccessControl: (organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5536
6803
|
/**
|
|
5537
6804
|
*
|
|
5538
6805
|
* @summary Register a new solution
|
|
@@ -5593,13 +6860,32 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5593
6860
|
findSolutionById: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5594
6861
|
/**
|
|
5595
6862
|
*
|
|
5596
|
-
* @summary
|
|
6863
|
+
* @summary Get a control access for the Solution
|
|
6864
|
+
* @param {string} organizationId the Organization identifier
|
|
6865
|
+
* @param {string} solutionId the Solution identifier
|
|
6866
|
+
* @param {string} identityId the User identifier
|
|
6867
|
+
* @param {*} [options] Override http request option.
|
|
6868
|
+
* @throws {RequiredError}
|
|
6869
|
+
*/
|
|
6870
|
+
getSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6871
|
+
/**
|
|
6872
|
+
*
|
|
6873
|
+
* @summary Get the Solution security information
|
|
6874
|
+
* @param {string} organizationId the Organization identifier
|
|
6875
|
+
* @param {string} solutionId the Solution identifier
|
|
6876
|
+
* @param {*} [options] Override http request option.
|
|
6877
|
+
* @throws {RequiredError}
|
|
6878
|
+
*/
|
|
6879
|
+
getSolutionSecurity: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6880
|
+
/**
|
|
6881
|
+
*
|
|
6882
|
+
* @summary Get the Solution security users list
|
|
5597
6883
|
* @param {string} organizationId the Organization identifier
|
|
5598
|
-
* @param {
|
|
6884
|
+
* @param {string} solutionId the Solution identifier
|
|
5599
6885
|
* @param {*} [options] Override http request option.
|
|
5600
6886
|
* @throws {RequiredError}
|
|
5601
6887
|
*/
|
|
5602
|
-
|
|
6888
|
+
getSolutionSecurityUsers: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5603
6889
|
/**
|
|
5604
6890
|
*
|
|
5605
6891
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -5627,16 +6913,47 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5627
6913
|
* @throws {RequiredError}
|
|
5628
6914
|
*/
|
|
5629
6915
|
removeAllSolutionParameters: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6916
|
+
/**
|
|
6917
|
+
*
|
|
6918
|
+
* @summary Remove the specified access from the given Organization Solution
|
|
6919
|
+
* @param {string} organizationId the Organization identifier
|
|
6920
|
+
* @param {string} solutionId the Solution identifier
|
|
6921
|
+
* @param {string} identityId the User identifier
|
|
6922
|
+
* @param {*} [options] Override http request option.
|
|
6923
|
+
* @throws {RequiredError}
|
|
6924
|
+
*/
|
|
6925
|
+
removeSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6926
|
+
/**
|
|
6927
|
+
*
|
|
6928
|
+
* @summary Set the Solution default security
|
|
6929
|
+
* @param {string} organizationId the Organization identifier
|
|
6930
|
+
* @param {string} solutionId the Solution identifier
|
|
6931
|
+
* @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.
|
|
6932
|
+
* @param {*} [options] Override http request option.
|
|
6933
|
+
* @throws {RequiredError}
|
|
6934
|
+
*/
|
|
6935
|
+
setSolutionDefaultSecurity: (organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5630
6936
|
/**
|
|
5631
6937
|
*
|
|
5632
6938
|
* @summary Update a solution
|
|
5633
6939
|
* @param {string} organizationId the Organization identifier
|
|
5634
6940
|
* @param {string} solutionId the Solution identifier
|
|
5635
|
-
* @param {Solution} solution the new Solution details.
|
|
6941
|
+
* @param {Solution} solution the new Solution details. This endpoint can\'t be used to update security
|
|
5636
6942
|
* @param {*} [options] Override http request option.
|
|
5637
6943
|
* @throws {RequiredError}
|
|
5638
6944
|
*/
|
|
5639
6945
|
updateSolution: (organizationId: string, solutionId: string, solution: Solution, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6946
|
+
/**
|
|
6947
|
+
*
|
|
6948
|
+
* @summary Update the specified access to User for a Solution
|
|
6949
|
+
* @param {string} organizationId the Organization identifier
|
|
6950
|
+
* @param {string} solutionId the Solution identifier
|
|
6951
|
+
* @param {string} identityId the User identifier
|
|
6952
|
+
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
6953
|
+
* @param {*} [options] Override http request option.
|
|
6954
|
+
* @throws {RequiredError}
|
|
6955
|
+
*/
|
|
6956
|
+
updateSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5640
6957
|
/**
|
|
5641
6958
|
*
|
|
5642
6959
|
* @summary Update the specified Solution Run Template
|
|
@@ -5697,6 +7014,16 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
5697
7014
|
* @throws {RequiredError}
|
|
5698
7015
|
*/
|
|
5699
7016
|
addOrReplaceRunTemplates(organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunTemplate>>>;
|
|
7017
|
+
/**
|
|
7018
|
+
*
|
|
7019
|
+
* @summary Add a control access to the Solution
|
|
7020
|
+
* @param {string} organizationId the Organization identifier
|
|
7021
|
+
* @param {string} solutionId the Solution identifier
|
|
7022
|
+
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
7023
|
+
* @param {*} [options] Override http request option.
|
|
7024
|
+
* @throws {RequiredError}
|
|
7025
|
+
*/
|
|
7026
|
+
addSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
|
|
5700
7027
|
/**
|
|
5701
7028
|
*
|
|
5702
7029
|
* @summary Register a new solution
|
|
@@ -5735,7 +7062,7 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
5735
7062
|
* @param {*} [options] Override http request option.
|
|
5736
7063
|
* @throws {RequiredError}
|
|
5737
7064
|
*/
|
|
5738
|
-
downloadRunTemplateHandler(organizationId: string, solutionId: string, runTemplateId: string, handlerId: RunTemplateHandlerId, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7065
|
+
downloadRunTemplateHandler(organizationId: string, solutionId: string, runTemplateId: string, handlerId: RunTemplateHandlerId, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5739
7066
|
/**
|
|
5740
7067
|
*
|
|
5741
7068
|
* @summary List all Solutions
|
|
@@ -5757,13 +7084,32 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
5757
7084
|
findSolutionById(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Solution>>;
|
|
5758
7085
|
/**
|
|
5759
7086
|
*
|
|
5760
|
-
* @summary
|
|
7087
|
+
* @summary Get a control access for the Solution
|
|
7088
|
+
* @param {string} organizationId the Organization identifier
|
|
7089
|
+
* @param {string} solutionId the Solution identifier
|
|
7090
|
+
* @param {string} identityId the User identifier
|
|
7091
|
+
* @param {*} [options] Override http request option.
|
|
7092
|
+
* @throws {RequiredError}
|
|
7093
|
+
*/
|
|
7094
|
+
getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
|
|
7095
|
+
/**
|
|
7096
|
+
*
|
|
7097
|
+
* @summary Get the Solution security information
|
|
7098
|
+
* @param {string} organizationId the Organization identifier
|
|
7099
|
+
* @param {string} solutionId the Solution identifier
|
|
7100
|
+
* @param {*} [options] Override http request option.
|
|
7101
|
+
* @throws {RequiredError}
|
|
7102
|
+
*/
|
|
7103
|
+
getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>>;
|
|
7104
|
+
/**
|
|
7105
|
+
*
|
|
7106
|
+
* @summary Get the Solution security users list
|
|
5761
7107
|
* @param {string} organizationId the Organization identifier
|
|
5762
|
-
* @param {
|
|
7108
|
+
* @param {string} solutionId the Solution identifier
|
|
5763
7109
|
* @param {*} [options] Override http request option.
|
|
5764
7110
|
* @throws {RequiredError}
|
|
5765
7111
|
*/
|
|
5766
|
-
|
|
7112
|
+
getSolutionSecurityUsers(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5767
7113
|
/**
|
|
5768
7114
|
*
|
|
5769
7115
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -5791,16 +7137,47 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
5791
7137
|
* @throws {RequiredError}
|
|
5792
7138
|
*/
|
|
5793
7139
|
removeAllSolutionParameters(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7140
|
+
/**
|
|
7141
|
+
*
|
|
7142
|
+
* @summary Remove the specified access from the given Organization Solution
|
|
7143
|
+
* @param {string} organizationId the Organization identifier
|
|
7144
|
+
* @param {string} solutionId the Solution identifier
|
|
7145
|
+
* @param {string} identityId the User identifier
|
|
7146
|
+
* @param {*} [options] Override http request option.
|
|
7147
|
+
* @throws {RequiredError}
|
|
7148
|
+
*/
|
|
7149
|
+
removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7150
|
+
/**
|
|
7151
|
+
*
|
|
7152
|
+
* @summary Set the Solution default security
|
|
7153
|
+
* @param {string} organizationId the Organization identifier
|
|
7154
|
+
* @param {string} solutionId the Solution identifier
|
|
7155
|
+
* @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.
|
|
7156
|
+
* @param {*} [options] Override http request option.
|
|
7157
|
+
* @throws {RequiredError}
|
|
7158
|
+
*/
|
|
7159
|
+
setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>>;
|
|
5794
7160
|
/**
|
|
5795
7161
|
*
|
|
5796
7162
|
* @summary Update a solution
|
|
5797
7163
|
* @param {string} organizationId the Organization identifier
|
|
5798
7164
|
* @param {string} solutionId the Solution identifier
|
|
5799
|
-
* @param {Solution} solution the new Solution details.
|
|
7165
|
+
* @param {Solution} solution the new Solution details. This endpoint can\'t be used to update security
|
|
5800
7166
|
* @param {*} [options] Override http request option.
|
|
5801
7167
|
* @throws {RequiredError}
|
|
5802
7168
|
*/
|
|
5803
7169
|
updateSolution(organizationId: string, solutionId: string, solution: Solution, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Solution>>;
|
|
7170
|
+
/**
|
|
7171
|
+
*
|
|
7172
|
+
* @summary Update the specified access to User for a Solution
|
|
7173
|
+
* @param {string} organizationId the Organization identifier
|
|
7174
|
+
* @param {string} solutionId the Solution identifier
|
|
7175
|
+
* @param {string} identityId the User identifier
|
|
7176
|
+
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
7177
|
+
* @param {*} [options] Override http request option.
|
|
7178
|
+
* @throws {RequiredError}
|
|
7179
|
+
*/
|
|
7180
|
+
updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
|
|
5804
7181
|
/**
|
|
5805
7182
|
*
|
|
5806
7183
|
* @summary Update the specified Solution Run Template
|
|
@@ -5861,6 +7238,16 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
5861
7238
|
* @throws {RequiredError}
|
|
5862
7239
|
*/
|
|
5863
7240
|
addOrReplaceRunTemplates(organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: any): AxiosPromise<Array<RunTemplate>>;
|
|
7241
|
+
/**
|
|
7242
|
+
*
|
|
7243
|
+
* @summary Add a control access to the Solution
|
|
7244
|
+
* @param {string} organizationId the Organization identifier
|
|
7245
|
+
* @param {string} solutionId the Solution identifier
|
|
7246
|
+
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
7247
|
+
* @param {*} [options] Override http request option.
|
|
7248
|
+
* @throws {RequiredError}
|
|
7249
|
+
*/
|
|
7250
|
+
addSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: any): AxiosPromise<SolutionAccessControl>;
|
|
5864
7251
|
/**
|
|
5865
7252
|
*
|
|
5866
7253
|
* @summary Register a new solution
|
|
@@ -5899,7 +7286,7 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
5899
7286
|
* @param {*} [options] Override http request option.
|
|
5900
7287
|
* @throws {RequiredError}
|
|
5901
7288
|
*/
|
|
5902
|
-
downloadRunTemplateHandler(organizationId: string, solutionId: string, runTemplateId: string, handlerId: RunTemplateHandlerId, options?: any): AxiosPromise<
|
|
7289
|
+
downloadRunTemplateHandler(organizationId: string, solutionId: string, runTemplateId: string, handlerId: RunTemplateHandlerId, options?: any): AxiosPromise<string>;
|
|
5903
7290
|
/**
|
|
5904
7291
|
*
|
|
5905
7292
|
* @summary List all Solutions
|
|
@@ -5921,13 +7308,32 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
5921
7308
|
findSolutionById(organizationId: string, solutionId: string, options?: any): AxiosPromise<Solution>;
|
|
5922
7309
|
/**
|
|
5923
7310
|
*
|
|
5924
|
-
* @summary
|
|
7311
|
+
* @summary Get a control access for the Solution
|
|
7312
|
+
* @param {string} organizationId the Organization identifier
|
|
7313
|
+
* @param {string} solutionId the Solution identifier
|
|
7314
|
+
* @param {string} identityId the User identifier
|
|
7315
|
+
* @param {*} [options] Override http request option.
|
|
7316
|
+
* @throws {RequiredError}
|
|
7317
|
+
*/
|
|
7318
|
+
getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<SolutionAccessControl>;
|
|
7319
|
+
/**
|
|
7320
|
+
*
|
|
7321
|
+
* @summary Get the Solution security information
|
|
7322
|
+
* @param {string} organizationId the Organization identifier
|
|
7323
|
+
* @param {string} solutionId the Solution identifier
|
|
7324
|
+
* @param {*} [options] Override http request option.
|
|
7325
|
+
* @throws {RequiredError}
|
|
7326
|
+
*/
|
|
7327
|
+
getSolutionSecurity(organizationId: string, solutionId: string, options?: any): AxiosPromise<SolutionSecurity>;
|
|
7328
|
+
/**
|
|
7329
|
+
*
|
|
7330
|
+
* @summary Get the Solution security users list
|
|
5925
7331
|
* @param {string} organizationId the Organization identifier
|
|
5926
|
-
* @param {
|
|
7332
|
+
* @param {string} solutionId the Solution identifier
|
|
5927
7333
|
* @param {*} [options] Override http request option.
|
|
5928
7334
|
* @throws {RequiredError}
|
|
5929
7335
|
*/
|
|
5930
|
-
|
|
7336
|
+
getSolutionSecurityUsers(organizationId: string, solutionId: string, options?: any): AxiosPromise<Array<string>>;
|
|
5931
7337
|
/**
|
|
5932
7338
|
*
|
|
5933
7339
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -5955,16 +7361,47 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
5955
7361
|
* @throws {RequiredError}
|
|
5956
7362
|
*/
|
|
5957
7363
|
removeAllSolutionParameters(organizationId: string, solutionId: string, options?: any): AxiosPromise<void>;
|
|
7364
|
+
/**
|
|
7365
|
+
*
|
|
7366
|
+
* @summary Remove the specified access from the given Organization Solution
|
|
7367
|
+
* @param {string} organizationId the Organization identifier
|
|
7368
|
+
* @param {string} solutionId the Solution identifier
|
|
7369
|
+
* @param {string} identityId the User identifier
|
|
7370
|
+
* @param {*} [options] Override http request option.
|
|
7371
|
+
* @throws {RequiredError}
|
|
7372
|
+
*/
|
|
7373
|
+
removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<void>;
|
|
7374
|
+
/**
|
|
7375
|
+
*
|
|
7376
|
+
* @summary Set the Solution default security
|
|
7377
|
+
* @param {string} organizationId the Organization identifier
|
|
7378
|
+
* @param {string} solutionId the Solution identifier
|
|
7379
|
+
* @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.
|
|
7380
|
+
* @param {*} [options] Override http request option.
|
|
7381
|
+
* @throws {RequiredError}
|
|
7382
|
+
*/
|
|
7383
|
+
setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: any): AxiosPromise<SolutionSecurity>;
|
|
5958
7384
|
/**
|
|
5959
7385
|
*
|
|
5960
7386
|
* @summary Update a solution
|
|
5961
7387
|
* @param {string} organizationId the Organization identifier
|
|
5962
7388
|
* @param {string} solutionId the Solution identifier
|
|
5963
|
-
* @param {Solution} solution the new Solution details.
|
|
7389
|
+
* @param {Solution} solution the new Solution details. This endpoint can\'t be used to update security
|
|
5964
7390
|
* @param {*} [options] Override http request option.
|
|
5965
7391
|
* @throws {RequiredError}
|
|
5966
7392
|
*/
|
|
5967
7393
|
updateSolution(organizationId: string, solutionId: string, solution: Solution, options?: any): AxiosPromise<Solution>;
|
|
7394
|
+
/**
|
|
7395
|
+
*
|
|
7396
|
+
* @summary Update the specified access to User for a Solution
|
|
7397
|
+
* @param {string} organizationId the Organization identifier
|
|
7398
|
+
* @param {string} solutionId the Solution identifier
|
|
7399
|
+
* @param {string} identityId the User identifier
|
|
7400
|
+
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
7401
|
+
* @param {*} [options] Override http request option.
|
|
7402
|
+
* @throws {RequiredError}
|
|
7403
|
+
*/
|
|
7404
|
+
updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: any): AxiosPromise<SolutionAccessControl>;
|
|
5968
7405
|
/**
|
|
5969
7406
|
*
|
|
5970
7407
|
* @summary Update the specified Solution Run Template
|
|
@@ -6030,6 +7467,17 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
6030
7467
|
* @memberof SolutionApi
|
|
6031
7468
|
*/
|
|
6032
7469
|
addOrReplaceRunTemplates(organizationId: string, solutionId: string, runTemplate: Array<RunTemplate>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate[]>>;
|
|
7470
|
+
/**
|
|
7471
|
+
*
|
|
7472
|
+
* @summary Add a control access to the Solution
|
|
7473
|
+
* @param {string} organizationId the Organization identifier
|
|
7474
|
+
* @param {string} solutionId the Solution identifier
|
|
7475
|
+
* @param {SolutionAccessControl} solutionAccessControl the new Solution security access to add.
|
|
7476
|
+
* @param {*} [options] Override http request option.
|
|
7477
|
+
* @throws {RequiredError}
|
|
7478
|
+
* @memberof SolutionApi
|
|
7479
|
+
*/
|
|
7480
|
+
addSolutionAccessControl(organizationId: string, solutionId: string, solutionAccessControl: SolutionAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
|
|
6033
7481
|
/**
|
|
6034
7482
|
*
|
|
6035
7483
|
* @summary Register a new solution
|
|
@@ -6072,7 +7520,7 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
6072
7520
|
* @throws {RequiredError}
|
|
6073
7521
|
* @memberof SolutionApi
|
|
6074
7522
|
*/
|
|
6075
|
-
downloadRunTemplateHandler(organizationId: string, solutionId: string, runTemplateId: string, handlerId: RunTemplateHandlerId, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7523
|
+
downloadRunTemplateHandler(organizationId: string, solutionId: string, runTemplateId: string, handlerId: RunTemplateHandlerId, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
6076
7524
|
/**
|
|
6077
7525
|
*
|
|
6078
7526
|
* @summary List all Solutions
|
|
@@ -6096,14 +7544,35 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
6096
7544
|
findSolutionById(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution>>;
|
|
6097
7545
|
/**
|
|
6098
7546
|
*
|
|
6099
|
-
* @summary
|
|
7547
|
+
* @summary Get a control access for the Solution
|
|
7548
|
+
* @param {string} organizationId the Organization identifier
|
|
7549
|
+
* @param {string} solutionId the Solution identifier
|
|
7550
|
+
* @param {string} identityId the User identifier
|
|
7551
|
+
* @param {*} [options] Override http request option.
|
|
7552
|
+
* @throws {RequiredError}
|
|
7553
|
+
* @memberof SolutionApi
|
|
7554
|
+
*/
|
|
7555
|
+
getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
|
|
7556
|
+
/**
|
|
7557
|
+
*
|
|
7558
|
+
* @summary Get the Solution security information
|
|
7559
|
+
* @param {string} organizationId the Organization identifier
|
|
7560
|
+
* @param {string} solutionId the Solution identifier
|
|
7561
|
+
* @param {*} [options] Override http request option.
|
|
7562
|
+
* @throws {RequiredError}
|
|
7563
|
+
* @memberof SolutionApi
|
|
7564
|
+
*/
|
|
7565
|
+
getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity>>;
|
|
7566
|
+
/**
|
|
7567
|
+
*
|
|
7568
|
+
* @summary Get the Solution security users list
|
|
6100
7569
|
* @param {string} organizationId the Organization identifier
|
|
6101
|
-
* @param {
|
|
7570
|
+
* @param {string} solutionId the Solution identifier
|
|
6102
7571
|
* @param {*} [options] Override http request option.
|
|
6103
7572
|
* @throws {RequiredError}
|
|
6104
7573
|
* @memberof SolutionApi
|
|
6105
7574
|
*/
|
|
6106
|
-
|
|
7575
|
+
getSolutionSecurityUsers(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
6107
7576
|
/**
|
|
6108
7577
|
*
|
|
6109
7578
|
* @summary Remove all Run Templates from the Solution specified
|
|
@@ -6134,17 +7603,51 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
6134
7603
|
* @memberof SolutionApi
|
|
6135
7604
|
*/
|
|
6136
7605
|
removeAllSolutionParameters(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
7606
|
+
/**
|
|
7607
|
+
*
|
|
7608
|
+
* @summary Remove the specified access from the given Organization Solution
|
|
7609
|
+
* @param {string} organizationId the Organization identifier
|
|
7610
|
+
* @param {string} solutionId the Solution identifier
|
|
7611
|
+
* @param {string} identityId the User identifier
|
|
7612
|
+
* @param {*} [options] Override http request option.
|
|
7613
|
+
* @throws {RequiredError}
|
|
7614
|
+
* @memberof SolutionApi
|
|
7615
|
+
*/
|
|
7616
|
+
removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
7617
|
+
/**
|
|
7618
|
+
*
|
|
7619
|
+
* @summary Set the Solution default security
|
|
7620
|
+
* @param {string} organizationId the Organization identifier
|
|
7621
|
+
* @param {string} solutionId the Solution identifier
|
|
7622
|
+
* @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.
|
|
7623
|
+
* @param {*} [options] Override http request option.
|
|
7624
|
+
* @throws {RequiredError}
|
|
7625
|
+
* @memberof SolutionApi
|
|
7626
|
+
*/
|
|
7627
|
+
setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity>>;
|
|
6137
7628
|
/**
|
|
6138
7629
|
*
|
|
6139
7630
|
* @summary Update a solution
|
|
6140
7631
|
* @param {string} organizationId the Organization identifier
|
|
6141
7632
|
* @param {string} solutionId the Solution identifier
|
|
6142
|
-
* @param {Solution} solution the new Solution details.
|
|
7633
|
+
* @param {Solution} solution the new Solution details. This endpoint can\'t be used to update security
|
|
6143
7634
|
* @param {*} [options] Override http request option.
|
|
6144
7635
|
* @throws {RequiredError}
|
|
6145
7636
|
* @memberof SolutionApi
|
|
6146
7637
|
*/
|
|
6147
7638
|
updateSolution(organizationId: string, solutionId: string, solution: Solution, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution>>;
|
|
7639
|
+
/**
|
|
7640
|
+
*
|
|
7641
|
+
* @summary Update the specified access to User for a Solution
|
|
7642
|
+
* @param {string} organizationId the Organization identifier
|
|
7643
|
+
* @param {string} solutionId the Solution identifier
|
|
7644
|
+
* @param {string} identityId the User identifier
|
|
7645
|
+
* @param {SolutionRole} solutionRole The new Solution Access Control
|
|
7646
|
+
* @param {*} [options] Override http request option.
|
|
7647
|
+
* @throws {RequiredError}
|
|
7648
|
+
* @memberof SolutionApi
|
|
7649
|
+
*/
|
|
7650
|
+
updateSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
|
|
6148
7651
|
/**
|
|
6149
7652
|
*
|
|
6150
7653
|
* @summary Update the specified Solution Run Template
|
|
@@ -6178,11 +7681,12 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
6178
7681
|
*/
|
|
6179
7682
|
export declare const TwingraphApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6180
7683
|
/**
|
|
6181
|
-
*
|
|
6182
|
-
* @summary
|
|
7684
|
+
* Delete all versions of a graph and his metadatas
|
|
7685
|
+
* @summary Delete all versions of a graph and his metadatas
|
|
6183
7686
|
* @param {string} organizationId the Organization identifier
|
|
6184
7687
|
* @param {string} graphId the Graph Identifier
|
|
6185
7688
|
* @param {*} [options] Override http request option.
|
|
7689
|
+
* @deprecated
|
|
6186
7690
|
* @throws {RequiredError}
|
|
6187
7691
|
*/
|
|
6188
7692
|
_delete: (organizationId: string, graphId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6193,6 +7697,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6193
7697
|
* @param {string} graphId the Graph Identifier
|
|
6194
7698
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6195
7699
|
* @param {*} [options] Override http request option.
|
|
7700
|
+
* @deprecated
|
|
6196
7701
|
* @throws {RequiredError}
|
|
6197
7702
|
*/
|
|
6198
7703
|
batchQuery: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6204,6 +7709,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6204
7709
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
6205
7710
|
* @param {any} body
|
|
6206
7711
|
* @param {*} [options] Override http request option.
|
|
7712
|
+
* @deprecated
|
|
6207
7713
|
* @throws {RequiredError}
|
|
6208
7714
|
*/
|
|
6209
7715
|
batchUploadUpdate: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6212,19 +7718,21 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6212
7718
|
* @summary Create new entities in a graph instance
|
|
6213
7719
|
* @param {string} organizationId the Organization identifier
|
|
6214
7720
|
* @param {string} graphId the Graph Identifier
|
|
6215
|
-
* @param {'node' | 'relationship'}
|
|
7721
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6216
7722
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
6217
7723
|
* @param {*} [options] Override http request option.
|
|
7724
|
+
* @deprecated
|
|
6218
7725
|
* @throws {RequiredError}
|
|
6219
7726
|
*/
|
|
6220
|
-
createEntities: (organizationId: string, graphId: string,
|
|
7727
|
+
createEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6221
7728
|
/**
|
|
6222
|
-
*
|
|
7729
|
+
* 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.
|
|
6223
7730
|
* @summary Create a new graph
|
|
6224
7731
|
* @param {string} organizationId the Organization identifier
|
|
6225
7732
|
* @param {string} graphId the Graph Identifier
|
|
6226
7733
|
* @param {any} [body]
|
|
6227
7734
|
* @param {*} [options] Override http request option.
|
|
7735
|
+
* @deprecated
|
|
6228
7736
|
* @throws {RequiredError}
|
|
6229
7737
|
*/
|
|
6230
7738
|
createGraph: (organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6233,18 +7741,20 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6233
7741
|
* @summary Delete entities in a graph instance
|
|
6234
7742
|
* @param {string} organizationId the Organization identifier
|
|
6235
7743
|
* @param {string} graphId the Graph Identifier
|
|
6236
|
-
* @param {'node' | 'relationship'}
|
|
7744
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6237
7745
|
* @param {Array<string>} ids the entities to delete
|
|
6238
7746
|
* @param {*} [options] Override http request option.
|
|
7747
|
+
* @deprecated
|
|
6239
7748
|
* @throws {RequiredError}
|
|
6240
7749
|
*/
|
|
6241
|
-
deleteEntities: (organizationId: string, graphId: string,
|
|
7750
|
+
deleteEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6242
7751
|
/**
|
|
6243
7752
|
* Download a graph compressed in a zip file
|
|
6244
7753
|
* @summary Download a graph compressed in a zip file
|
|
6245
7754
|
* @param {string} organizationId the Organization identifier
|
|
6246
7755
|
* @param {string} hash the Graph download identifier
|
|
6247
7756
|
* @param {*} [options] Override http request option.
|
|
7757
|
+
* @deprecated
|
|
6248
7758
|
* @throws {RequiredError}
|
|
6249
7759
|
*/
|
|
6250
7760
|
downloadGraph: (organizationId: string, hash: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6253,6 +7763,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6253
7763
|
* @summary Return the list of all graphs stored in the organization
|
|
6254
7764
|
* @param {string} organizationId the Organization identifier
|
|
6255
7765
|
* @param {*} [options] Override http request option.
|
|
7766
|
+
* @deprecated
|
|
6256
7767
|
* @throws {RequiredError}
|
|
6257
7768
|
*/
|
|
6258
7769
|
findAllTwingraphs: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6261,36 +7772,30 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6261
7772
|
* @summary Get entities in a graph instance
|
|
6262
7773
|
* @param {string} organizationId the Organization identifier
|
|
6263
7774
|
* @param {string} graphId the Graph Identifier
|
|
6264
|
-
* @param {'node' | 'relationship'}
|
|
7775
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6265
7776
|
* @param {Array<string>} ids the entities to get
|
|
6266
7777
|
* @param {*} [options] Override http request option.
|
|
7778
|
+
* @deprecated
|
|
6267
7779
|
* @throws {RequiredError}
|
|
6268
7780
|
*/
|
|
6269
|
-
getEntities: (organizationId: string, graphId: string,
|
|
7781
|
+
getEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6270
7782
|
/**
|
|
6271
7783
|
* Return the metaData of the specified graph
|
|
6272
7784
|
* @summary Return the metaData of the specified graph
|
|
6273
7785
|
* @param {string} organizationId the Organization identifier
|
|
6274
7786
|
* @param {string} graphId the Graph Identifier
|
|
6275
7787
|
* @param {*} [options] Override http request option.
|
|
7788
|
+
* @deprecated
|
|
6276
7789
|
* @throws {RequiredError}
|
|
6277
7790
|
*/
|
|
6278
7791
|
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>;
|
|
6288
7792
|
/**
|
|
6289
7793
|
* Get the status of a job
|
|
6290
7794
|
* @summary Get the status of a job
|
|
6291
7795
|
* @param {string} organizationId the Organization identifier
|
|
6292
7796
|
* @param {string} jobId the job identifier
|
|
6293
7797
|
* @param {*} [options] Override http request option.
|
|
7798
|
+
* @deprecated
|
|
6294
7799
|
* @throws {RequiredError}
|
|
6295
7800
|
*/
|
|
6296
7801
|
jobStatus: (organizationId: string, jobId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6301,6 +7806,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6301
7806
|
* @param {string} graphId the Graph Identifier
|
|
6302
7807
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6303
7808
|
* @param {*} [options] Override http request option.
|
|
7809
|
+
* @deprecated
|
|
6304
7810
|
* @throws {RequiredError}
|
|
6305
7811
|
*/
|
|
6306
7812
|
query: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -6309,12 +7815,13 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6309
7815
|
* @summary Update entities in a graph instance
|
|
6310
7816
|
* @param {string} organizationId the Organization identifier
|
|
6311
7817
|
* @param {string} graphId the Graph Identifier
|
|
6312
|
-
* @param {'node' | 'relationship'}
|
|
7818
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6313
7819
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
6314
7820
|
* @param {*} [options] Override http request option.
|
|
7821
|
+
* @deprecated
|
|
6315
7822
|
* @throws {RequiredError}
|
|
6316
7823
|
*/
|
|
6317
|
-
updateEntities: (organizationId: string, graphId: string,
|
|
7824
|
+
updateEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6318
7825
|
/**
|
|
6319
7826
|
* Update the metaData of the specified graph
|
|
6320
7827
|
* @summary Update the metaData of the specified graph
|
|
@@ -6322,6 +7829,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6322
7829
|
* @param {string} graphId the Graph Identifier
|
|
6323
7830
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
6324
7831
|
* @param {*} [options] Override http request option.
|
|
7832
|
+
* @deprecated
|
|
6325
7833
|
* @throws {RequiredError}
|
|
6326
7834
|
*/
|
|
6327
7835
|
updateGraphMetaData: (organizationId: string, graphId: string, requestBody: {
|
|
@@ -6334,11 +7842,12 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
|
|
|
6334
7842
|
*/
|
|
6335
7843
|
export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
6336
7844
|
/**
|
|
6337
|
-
*
|
|
6338
|
-
* @summary
|
|
7845
|
+
* Delete all versions of a graph and his metadatas
|
|
7846
|
+
* @summary Delete all versions of a graph and his metadatas
|
|
6339
7847
|
* @param {string} organizationId the Organization identifier
|
|
6340
7848
|
* @param {string} graphId the Graph Identifier
|
|
6341
7849
|
* @param {*} [options] Override http request option.
|
|
7850
|
+
* @deprecated
|
|
6342
7851
|
* @throws {RequiredError}
|
|
6343
7852
|
*/
|
|
6344
7853
|
_delete(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
@@ -6349,6 +7858,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6349
7858
|
* @param {string} graphId the Graph Identifier
|
|
6350
7859
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6351
7860
|
* @param {*} [options] Override http request option.
|
|
7861
|
+
* @deprecated
|
|
6352
7862
|
* @throws {RequiredError}
|
|
6353
7863
|
*/
|
|
6354
7864
|
batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphHash>>;
|
|
@@ -6360,6 +7870,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6360
7870
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
6361
7871
|
* @param {any} body
|
|
6362
7872
|
* @param {*} [options] Override http request option.
|
|
7873
|
+
* @deprecated
|
|
6363
7874
|
* @throws {RequiredError}
|
|
6364
7875
|
*/
|
|
6365
7876
|
batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>>;
|
|
@@ -6368,19 +7879,21 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6368
7879
|
* @summary Create new entities in a graph instance
|
|
6369
7880
|
* @param {string} organizationId the Organization identifier
|
|
6370
7881
|
* @param {string} graphId the Graph Identifier
|
|
6371
|
-
* @param {'node' | 'relationship'}
|
|
7882
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6372
7883
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
6373
7884
|
* @param {*} [options] Override http request option.
|
|
7885
|
+
* @deprecated
|
|
6374
7886
|
* @throws {RequiredError}
|
|
6375
7887
|
*/
|
|
6376
|
-
createEntities(organizationId: string, graphId: string,
|
|
7888
|
+
createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
6377
7889
|
/**
|
|
6378
|
-
*
|
|
7890
|
+
* 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.
|
|
6379
7891
|
* @summary Create a new graph
|
|
6380
7892
|
* @param {string} organizationId the Organization identifier
|
|
6381
7893
|
* @param {string} graphId the Graph Identifier
|
|
6382
7894
|
* @param {any} [body]
|
|
6383
7895
|
* @param {*} [options] Override http request option.
|
|
7896
|
+
* @deprecated
|
|
6384
7897
|
* @throws {RequiredError}
|
|
6385
7898
|
*/
|
|
6386
7899
|
createGraph(organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
@@ -6389,18 +7902,20 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6389
7902
|
* @summary Delete entities in a graph instance
|
|
6390
7903
|
* @param {string} organizationId the Organization identifier
|
|
6391
7904
|
* @param {string} graphId the Graph Identifier
|
|
6392
|
-
* @param {'node' | 'relationship'}
|
|
7905
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6393
7906
|
* @param {Array<string>} ids the entities to delete
|
|
6394
7907
|
* @param {*} [options] Override http request option.
|
|
7908
|
+
* @deprecated
|
|
6395
7909
|
* @throws {RequiredError}
|
|
6396
7910
|
*/
|
|
6397
|
-
deleteEntities(organizationId: string, graphId: string,
|
|
7911
|
+
deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
6398
7912
|
/**
|
|
6399
7913
|
* Download a graph compressed in a zip file
|
|
6400
7914
|
* @summary Download a graph compressed in a zip file
|
|
6401
7915
|
* @param {string} organizationId the Organization identifier
|
|
6402
7916
|
* @param {string} hash the Graph download identifier
|
|
6403
7917
|
* @param {*} [options] Override http request option.
|
|
7918
|
+
* @deprecated
|
|
6404
7919
|
* @throws {RequiredError}
|
|
6405
7920
|
*/
|
|
6406
7921
|
downloadGraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
@@ -6409,6 +7924,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6409
7924
|
* @summary Return the list of all graphs stored in the organization
|
|
6410
7925
|
* @param {string} organizationId the Organization identifier
|
|
6411
7926
|
* @param {*} [options] Override http request option.
|
|
7927
|
+
* @deprecated
|
|
6412
7928
|
* @throws {RequiredError}
|
|
6413
7929
|
*/
|
|
6414
7930
|
findAllTwingraphs(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
@@ -6417,36 +7933,30 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6417
7933
|
* @summary Get entities in a graph instance
|
|
6418
7934
|
* @param {string} organizationId the Organization identifier
|
|
6419
7935
|
* @param {string} graphId the Graph Identifier
|
|
6420
|
-
* @param {'node' | 'relationship'}
|
|
7936
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6421
7937
|
* @param {Array<string>} ids the entities to get
|
|
6422
7938
|
* @param {*} [options] Override http request option.
|
|
7939
|
+
* @deprecated
|
|
6423
7940
|
* @throws {RequiredError}
|
|
6424
7941
|
*/
|
|
6425
|
-
getEntities(organizationId: string, graphId: string,
|
|
7942
|
+
getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
6426
7943
|
/**
|
|
6427
7944
|
* Return the metaData of the specified graph
|
|
6428
7945
|
* @summary Return the metaData of the specified graph
|
|
6429
7946
|
* @param {string} organizationId the Organization identifier
|
|
6430
7947
|
* @param {string} graphId the Graph Identifier
|
|
6431
7948
|
* @param {*} [options] Override http request option.
|
|
7949
|
+
* @deprecated
|
|
6432
7950
|
* @throws {RequiredError}
|
|
6433
7951
|
*/
|
|
6434
7952
|
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>>;
|
|
6444
7953
|
/**
|
|
6445
7954
|
* Get the status of a job
|
|
6446
7955
|
* @summary Get the status of a job
|
|
6447
7956
|
* @param {string} organizationId the Organization identifier
|
|
6448
7957
|
* @param {string} jobId the job identifier
|
|
6449
7958
|
* @param {*} [options] Override http request option.
|
|
7959
|
+
* @deprecated
|
|
6450
7960
|
* @throws {RequiredError}
|
|
6451
7961
|
*/
|
|
6452
7962
|
jobStatus(organizationId: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
@@ -6457,6 +7967,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6457
7967
|
* @param {string} graphId the Graph Identifier
|
|
6458
7968
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6459
7969
|
* @param {*} [options] Override http request option.
|
|
7970
|
+
* @deprecated
|
|
6460
7971
|
* @throws {RequiredError}
|
|
6461
7972
|
*/
|
|
6462
7973
|
query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
@@ -6465,12 +7976,13 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6465
7976
|
* @summary Update entities in a graph instance
|
|
6466
7977
|
* @param {string} organizationId the Organization identifier
|
|
6467
7978
|
* @param {string} graphId the Graph Identifier
|
|
6468
|
-
* @param {'node' | 'relationship'}
|
|
7979
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6469
7980
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
6470
7981
|
* @param {*} [options] Override http request option.
|
|
7982
|
+
* @deprecated
|
|
6471
7983
|
* @throws {RequiredError}
|
|
6472
7984
|
*/
|
|
6473
|
-
updateEntities(organizationId: string, graphId: string,
|
|
7985
|
+
updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
6474
7986
|
/**
|
|
6475
7987
|
* Update the metaData of the specified graph
|
|
6476
7988
|
* @summary Update the metaData of the specified graph
|
|
@@ -6478,6 +7990,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6478
7990
|
* @param {string} graphId the Graph Identifier
|
|
6479
7991
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
6480
7992
|
* @param {*} [options] Override http request option.
|
|
7993
|
+
* @deprecated
|
|
6481
7994
|
* @throws {RequiredError}
|
|
6482
7995
|
*/
|
|
6483
7996
|
updateGraphMetaData(organizationId: string, graphId: string, requestBody: {
|
|
@@ -6490,11 +8003,12 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
|
|
|
6490
8003
|
*/
|
|
6491
8004
|
export declare const TwingraphApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6492
8005
|
/**
|
|
6493
|
-
*
|
|
6494
|
-
* @summary
|
|
8006
|
+
* Delete all versions of a graph and his metadatas
|
|
8007
|
+
* @summary Delete all versions of a graph and his metadatas
|
|
6495
8008
|
* @param {string} organizationId the Organization identifier
|
|
6496
8009
|
* @param {string} graphId the Graph Identifier
|
|
6497
8010
|
* @param {*} [options] Override http request option.
|
|
8011
|
+
* @deprecated
|
|
6498
8012
|
* @throws {RequiredError}
|
|
6499
8013
|
*/
|
|
6500
8014
|
_delete(organizationId: string, graphId: string, options?: any): AxiosPromise<void>;
|
|
@@ -6505,6 +8019,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6505
8019
|
* @param {string} graphId the Graph Identifier
|
|
6506
8020
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6507
8021
|
* @param {*} [options] Override http request option.
|
|
8022
|
+
* @deprecated
|
|
6508
8023
|
* @throws {RequiredError}
|
|
6509
8024
|
*/
|
|
6510
8025
|
batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<TwinGraphHash>;
|
|
@@ -6516,6 +8031,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6516
8031
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
6517
8032
|
* @param {any} body
|
|
6518
8033
|
* @param {*} [options] Override http request option.
|
|
8034
|
+
* @deprecated
|
|
6519
8035
|
* @throws {RequiredError}
|
|
6520
8036
|
*/
|
|
6521
8037
|
batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult>;
|
|
@@ -6524,19 +8040,21 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6524
8040
|
* @summary Create new entities in a graph instance
|
|
6525
8041
|
* @param {string} organizationId the Organization identifier
|
|
6526
8042
|
* @param {string} graphId the Graph Identifier
|
|
6527
|
-
* @param {'node' | 'relationship'}
|
|
8043
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6528
8044
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
6529
8045
|
* @param {*} [options] Override http request option.
|
|
8046
|
+
* @deprecated
|
|
6530
8047
|
* @throws {RequiredError}
|
|
6531
8048
|
*/
|
|
6532
|
-
createEntities(organizationId: string, graphId: string,
|
|
8049
|
+
createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
6533
8050
|
/**
|
|
6534
|
-
*
|
|
8051
|
+
* 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.
|
|
6535
8052
|
* @summary Create a new graph
|
|
6536
8053
|
* @param {string} organizationId the Organization identifier
|
|
6537
8054
|
* @param {string} graphId the Graph Identifier
|
|
6538
8055
|
* @param {any} [body]
|
|
6539
8056
|
* @param {*} [options] Override http request option.
|
|
8057
|
+
* @deprecated
|
|
6540
8058
|
* @throws {RequiredError}
|
|
6541
8059
|
*/
|
|
6542
8060
|
createGraph(organizationId: string, graphId: string, body?: any, options?: any): AxiosPromise<void>;
|
|
@@ -6545,18 +8063,20 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6545
8063
|
* @summary Delete entities in a graph instance
|
|
6546
8064
|
* @param {string} organizationId the Organization identifier
|
|
6547
8065
|
* @param {string} graphId the Graph Identifier
|
|
6548
|
-
* @param {'node' | 'relationship'}
|
|
8066
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6549
8067
|
* @param {Array<string>} ids the entities to delete
|
|
6550
8068
|
* @param {*} [options] Override http request option.
|
|
8069
|
+
* @deprecated
|
|
6551
8070
|
* @throws {RequiredError}
|
|
6552
8071
|
*/
|
|
6553
|
-
deleteEntities(organizationId: string, graphId: string,
|
|
8072
|
+
deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
|
|
6554
8073
|
/**
|
|
6555
8074
|
* Download a graph compressed in a zip file
|
|
6556
8075
|
* @summary Download a graph compressed in a zip file
|
|
6557
8076
|
* @param {string} organizationId the Organization identifier
|
|
6558
8077
|
* @param {string} hash the Graph download identifier
|
|
6559
8078
|
* @param {*} [options] Override http request option.
|
|
8079
|
+
* @deprecated
|
|
6560
8080
|
* @throws {RequiredError}
|
|
6561
8081
|
*/
|
|
6562
8082
|
downloadGraph(organizationId: string, hash: string, options?: any): AxiosPromise<any>;
|
|
@@ -6565,6 +8085,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6565
8085
|
* @summary Return the list of all graphs stored in the organization
|
|
6566
8086
|
* @param {string} organizationId the Organization identifier
|
|
6567
8087
|
* @param {*} [options] Override http request option.
|
|
8088
|
+
* @deprecated
|
|
6568
8089
|
* @throws {RequiredError}
|
|
6569
8090
|
*/
|
|
6570
8091
|
findAllTwingraphs(organizationId: string, options?: any): AxiosPromise<Array<string>>;
|
|
@@ -6573,36 +8094,30 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6573
8094
|
* @summary Get entities in a graph instance
|
|
6574
8095
|
* @param {string} organizationId the Organization identifier
|
|
6575
8096
|
* @param {string} graphId the Graph Identifier
|
|
6576
|
-
* @param {'node' | 'relationship'}
|
|
8097
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6577
8098
|
* @param {Array<string>} ids the entities to get
|
|
6578
8099
|
* @param {*} [options] Override http request option.
|
|
8100
|
+
* @deprecated
|
|
6579
8101
|
* @throws {RequiredError}
|
|
6580
8102
|
*/
|
|
6581
|
-
getEntities(organizationId: string, graphId: string,
|
|
8103
|
+
getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
|
|
6582
8104
|
/**
|
|
6583
8105
|
* Return the metaData of the specified graph
|
|
6584
8106
|
* @summary Return the metaData of the specified graph
|
|
6585
8107
|
* @param {string} organizationId the Organization identifier
|
|
6586
8108
|
* @param {string} graphId the Graph Identifier
|
|
6587
8109
|
* @param {*} [options] Override http request option.
|
|
8110
|
+
* @deprecated
|
|
6588
8111
|
* @throws {RequiredError}
|
|
6589
8112
|
*/
|
|
6590
8113
|
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>;
|
|
6600
8114
|
/**
|
|
6601
8115
|
* Get the status of a job
|
|
6602
8116
|
* @summary Get the status of a job
|
|
6603
8117
|
* @param {string} organizationId the Organization identifier
|
|
6604
8118
|
* @param {string} jobId the job identifier
|
|
6605
8119
|
* @param {*} [options] Override http request option.
|
|
8120
|
+
* @deprecated
|
|
6606
8121
|
* @throws {RequiredError}
|
|
6607
8122
|
*/
|
|
6608
8123
|
jobStatus(organizationId: string, jobId: string, options?: any): AxiosPromise<string>;
|
|
@@ -6613,6 +8128,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6613
8128
|
* @param {string} graphId the Graph Identifier
|
|
6614
8129
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6615
8130
|
* @param {*} [options] Override http request option.
|
|
8131
|
+
* @deprecated
|
|
6616
8132
|
* @throws {RequiredError}
|
|
6617
8133
|
*/
|
|
6618
8134
|
query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<string>;
|
|
@@ -6621,12 +8137,13 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6621
8137
|
* @summary Update entities in a graph instance
|
|
6622
8138
|
* @param {string} organizationId the Organization identifier
|
|
6623
8139
|
* @param {string} graphId the Graph Identifier
|
|
6624
|
-
* @param {'node' | 'relationship'}
|
|
8140
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6625
8141
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
6626
8142
|
* @param {*} [options] Override http request option.
|
|
8143
|
+
* @deprecated
|
|
6627
8144
|
* @throws {RequiredError}
|
|
6628
8145
|
*/
|
|
6629
|
-
updateEntities(organizationId: string, graphId: string,
|
|
8146
|
+
updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
|
|
6630
8147
|
/**
|
|
6631
8148
|
* Update the metaData of the specified graph
|
|
6632
8149
|
* @summary Update the metaData of the specified graph
|
|
@@ -6634,6 +8151,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6634
8151
|
* @param {string} graphId the Graph Identifier
|
|
6635
8152
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
6636
8153
|
* @param {*} [options] Override http request option.
|
|
8154
|
+
* @deprecated
|
|
6637
8155
|
* @throws {RequiredError}
|
|
6638
8156
|
*/
|
|
6639
8157
|
updateGraphMetaData(organizationId: string, graphId: string, requestBody: {
|
|
@@ -6648,11 +8166,12 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
|
|
|
6648
8166
|
*/
|
|
6649
8167
|
export declare class TwingraphApi extends BaseAPI {
|
|
6650
8168
|
/**
|
|
6651
|
-
*
|
|
6652
|
-
* @summary
|
|
8169
|
+
* Delete all versions of a graph and his metadatas
|
|
8170
|
+
* @summary Delete all versions of a graph and his metadatas
|
|
6653
8171
|
* @param {string} organizationId the Organization identifier
|
|
6654
8172
|
* @param {string} graphId the Graph Identifier
|
|
6655
8173
|
* @param {*} [options] Override http request option.
|
|
8174
|
+
* @deprecated
|
|
6656
8175
|
* @throws {RequiredError}
|
|
6657
8176
|
* @memberof TwingraphApi
|
|
6658
8177
|
*/
|
|
@@ -6664,6 +8183,7 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6664
8183
|
* @param {string} graphId the Graph Identifier
|
|
6665
8184
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6666
8185
|
* @param {*} [options] Override http request option.
|
|
8186
|
+
* @deprecated
|
|
6667
8187
|
* @throws {RequiredError}
|
|
6668
8188
|
* @memberof TwingraphApi
|
|
6669
8189
|
*/
|
|
@@ -6676,6 +8196,7 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6676
8196
|
* @param {TwinGraphQuery} twinGraphQuery
|
|
6677
8197
|
* @param {any} body
|
|
6678
8198
|
* @param {*} [options] Override http request option.
|
|
8199
|
+
* @deprecated
|
|
6679
8200
|
* @throws {RequiredError}
|
|
6680
8201
|
* @memberof TwingraphApi
|
|
6681
8202
|
*/
|
|
@@ -6685,20 +8206,22 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6685
8206
|
* @summary Create new entities in a graph instance
|
|
6686
8207
|
* @param {string} organizationId the Organization identifier
|
|
6687
8208
|
* @param {string} graphId the Graph Identifier
|
|
6688
|
-
* @param {'node' | 'relationship'}
|
|
8209
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6689
8210
|
* @param {Array<GraphProperties>} graphProperties the entities to create
|
|
6690
8211
|
* @param {*} [options] Override http request option.
|
|
8212
|
+
* @deprecated
|
|
6691
8213
|
* @throws {RequiredError}
|
|
6692
8214
|
* @memberof TwingraphApi
|
|
6693
8215
|
*/
|
|
6694
|
-
createEntities(organizationId: string, graphId: string,
|
|
8216
|
+
createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
6695
8217
|
/**
|
|
6696
|
-
*
|
|
8218
|
+
* 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.
|
|
6697
8219
|
* @summary Create a new graph
|
|
6698
8220
|
* @param {string} organizationId the Organization identifier
|
|
6699
8221
|
* @param {string} graphId the Graph Identifier
|
|
6700
8222
|
* @param {any} [body]
|
|
6701
8223
|
* @param {*} [options] Override http request option.
|
|
8224
|
+
* @deprecated
|
|
6702
8225
|
* @throws {RequiredError}
|
|
6703
8226
|
* @memberof TwingraphApi
|
|
6704
8227
|
*/
|
|
@@ -6708,19 +8231,21 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6708
8231
|
* @summary Delete entities in a graph instance
|
|
6709
8232
|
* @param {string} organizationId the Organization identifier
|
|
6710
8233
|
* @param {string} graphId the Graph Identifier
|
|
6711
|
-
* @param {'node' | 'relationship'}
|
|
8234
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6712
8235
|
* @param {Array<string>} ids the entities to delete
|
|
6713
8236
|
* @param {*} [options] Override http request option.
|
|
8237
|
+
* @deprecated
|
|
6714
8238
|
* @throws {RequiredError}
|
|
6715
8239
|
* @memberof TwingraphApi
|
|
6716
8240
|
*/
|
|
6717
|
-
deleteEntities(organizationId: string, graphId: string,
|
|
8241
|
+
deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
|
|
6718
8242
|
/**
|
|
6719
8243
|
* Download a graph compressed in a zip file
|
|
6720
8244
|
* @summary Download a graph compressed in a zip file
|
|
6721
8245
|
* @param {string} organizationId the Organization identifier
|
|
6722
8246
|
* @param {string} hash the Graph download identifier
|
|
6723
8247
|
* @param {*} [options] Override http request option.
|
|
8248
|
+
* @deprecated
|
|
6724
8249
|
* @throws {RequiredError}
|
|
6725
8250
|
* @memberof TwingraphApi
|
|
6726
8251
|
*/
|
|
@@ -6730,6 +8255,7 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6730
8255
|
* @summary Return the list of all graphs stored in the organization
|
|
6731
8256
|
* @param {string} organizationId the Organization identifier
|
|
6732
8257
|
* @param {*} [options] Override http request option.
|
|
8258
|
+
* @deprecated
|
|
6733
8259
|
* @throws {RequiredError}
|
|
6734
8260
|
* @memberof TwingraphApi
|
|
6735
8261
|
*/
|
|
@@ -6739,39 +8265,32 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6739
8265
|
* @summary Get entities in a graph instance
|
|
6740
8266
|
* @param {string} organizationId the Organization identifier
|
|
6741
8267
|
* @param {string} graphId the Graph Identifier
|
|
6742
|
-
* @param {'node' | 'relationship'}
|
|
8268
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6743
8269
|
* @param {Array<string>} ids the entities to get
|
|
6744
8270
|
* @param {*} [options] Override http request option.
|
|
8271
|
+
* @deprecated
|
|
6745
8272
|
* @throws {RequiredError}
|
|
6746
8273
|
* @memberof TwingraphApi
|
|
6747
8274
|
*/
|
|
6748
|
-
getEntities(organizationId: string, graphId: string,
|
|
8275
|
+
getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
6749
8276
|
/**
|
|
6750
8277
|
* Return the metaData of the specified graph
|
|
6751
8278
|
* @summary Return the metaData of the specified graph
|
|
6752
8279
|
* @param {string} organizationId the Organization identifier
|
|
6753
8280
|
* @param {string} graphId the Graph Identifier
|
|
6754
8281
|
* @param {*} [options] Override http request option.
|
|
8282
|
+
* @deprecated
|
|
6755
8283
|
* @throws {RequiredError}
|
|
6756
8284
|
* @memberof TwingraphApi
|
|
6757
8285
|
*/
|
|
6758
8286
|
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>>;
|
|
6769
8287
|
/**
|
|
6770
8288
|
* Get the status of a job
|
|
6771
8289
|
* @summary Get the status of a job
|
|
6772
8290
|
* @param {string} organizationId the Organization identifier
|
|
6773
8291
|
* @param {string} jobId the job identifier
|
|
6774
8292
|
* @param {*} [options] Override http request option.
|
|
8293
|
+
* @deprecated
|
|
6775
8294
|
* @throws {RequiredError}
|
|
6776
8295
|
* @memberof TwingraphApi
|
|
6777
8296
|
*/
|
|
@@ -6783,6 +8302,7 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6783
8302
|
* @param {string} graphId the Graph Identifier
|
|
6784
8303
|
* @param {TwinGraphQuery} twinGraphQuery the query to run
|
|
6785
8304
|
* @param {*} [options] Override http request option.
|
|
8305
|
+
* @deprecated
|
|
6786
8306
|
* @throws {RequiredError}
|
|
6787
8307
|
* @memberof TwingraphApi
|
|
6788
8308
|
*/
|
|
@@ -6792,13 +8312,14 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6792
8312
|
* @summary Update entities in a graph instance
|
|
6793
8313
|
* @param {string} organizationId the Organization identifier
|
|
6794
8314
|
* @param {string} graphId the Graph Identifier
|
|
6795
|
-
* @param {'node' | 'relationship'}
|
|
8315
|
+
* @param {'node' | 'relationship'} type the entity model type
|
|
6796
8316
|
* @param {Array<GraphProperties>} graphProperties the entities to update
|
|
6797
8317
|
* @param {*} [options] Override http request option.
|
|
8318
|
+
* @deprecated
|
|
6798
8319
|
* @throws {RequiredError}
|
|
6799
8320
|
* @memberof TwingraphApi
|
|
6800
8321
|
*/
|
|
6801
|
-
updateEntities(organizationId: string, graphId: string,
|
|
8322
|
+
updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
|
|
6802
8323
|
/**
|
|
6803
8324
|
* Update the metaData of the specified graph
|
|
6804
8325
|
* @summary Update the metaData of the specified graph
|
|
@@ -6806,6 +8327,7 @@ export declare class TwingraphApi extends BaseAPI {
|
|
|
6806
8327
|
* @param {string} graphId the Graph Identifier
|
|
6807
8328
|
* @param {{ [key: string]: string; }} requestBody the metaData to update
|
|
6808
8329
|
* @param {*} [options] Override http request option.
|
|
8330
|
+
* @deprecated
|
|
6809
8331
|
* @throws {RequiredError}
|
|
6810
8332
|
* @memberof TwingraphApi
|
|
6811
8333
|
*/
|
|
@@ -7324,13 +8846,13 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7324
8846
|
getWorkspaceSecurityUsers: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7325
8847
|
/**
|
|
7326
8848
|
*
|
|
7327
|
-
* @summary Import a workspace
|
|
7328
8849
|
* @param {string} organizationId the Organization identifier
|
|
7329
|
-
* @param {
|
|
8850
|
+
* @param {string} workspaceId the Workspace identifier
|
|
8851
|
+
* @param {string} datasetId dataset id to be linked to
|
|
7330
8852
|
* @param {*} [options] Override http request option.
|
|
7331
8853
|
* @throws {RequiredError}
|
|
7332
8854
|
*/
|
|
7333
|
-
|
|
8855
|
+
linkDataset: (organizationId: string, workspaceId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7334
8856
|
/**
|
|
7335
8857
|
*
|
|
7336
8858
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -7346,17 +8868,26 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
7346
8868
|
* @summary Set the Workspace default security
|
|
7347
8869
|
* @param {string} organizationId the Organization identifier
|
|
7348
8870
|
* @param {string} workspaceId the Workspace identifier
|
|
7349
|
-
* @param {WorkspaceRole} workspaceRole the
|
|
8871
|
+
* @param {WorkspaceRole} workspaceRole This change the workspace 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 workspace.
|
|
7350
8872
|
* @param {*} [options] Override http request option.
|
|
7351
8873
|
* @throws {RequiredError}
|
|
7352
8874
|
*/
|
|
7353
8875
|
setWorkspaceDefaultSecurity: (organizationId: string, workspaceId: string, workspaceRole: WorkspaceRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8876
|
+
/**
|
|
8877
|
+
*
|
|
8878
|
+
* @param {string} organizationId the Organization identifier
|
|
8879
|
+
* @param {string} workspaceId the Workspace identifier
|
|
8880
|
+
* @param {string} datasetId dataset id to be linked to
|
|
8881
|
+
* @param {*} [options] Override http request option.
|
|
8882
|
+
* @throws {RequiredError}
|
|
8883
|
+
*/
|
|
8884
|
+
unlinkDataset: (organizationId: string, workspaceId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7354
8885
|
/**
|
|
7355
8886
|
*
|
|
7356
8887
|
* @summary Update a workspace
|
|
7357
8888
|
* @param {string} organizationId the Organization identifier
|
|
7358
8889
|
* @param {string} workspaceId the Workspace identifier
|
|
7359
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
8890
|
+
* @param {Workspace} workspace The new Workspace details. This endpoint can\'t be used to update security
|
|
7360
8891
|
* @param {*} [options] Override http request option.
|
|
7361
8892
|
* @throws {RequiredError}
|
|
7362
8893
|
*/
|
|
@@ -7525,13 +9056,13 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
7525
9056
|
getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
7526
9057
|
/**
|
|
7527
9058
|
*
|
|
7528
|
-
* @summary Import a workspace
|
|
7529
9059
|
* @param {string} organizationId the Organization identifier
|
|
7530
|
-
* @param {
|
|
9060
|
+
* @param {string} workspaceId the Workspace identifier
|
|
9061
|
+
* @param {string} datasetId dataset id to be linked to
|
|
7531
9062
|
* @param {*} [options] Override http request option.
|
|
7532
9063
|
* @throws {RequiredError}
|
|
7533
9064
|
*/
|
|
7534
|
-
|
|
9065
|
+
linkDataset(organizationId: string, workspaceId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
|
|
7535
9066
|
/**
|
|
7536
9067
|
*
|
|
7537
9068
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -7547,17 +9078,26 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
7547
9078
|
* @summary Set the Workspace default security
|
|
7548
9079
|
* @param {string} organizationId the Organization identifier
|
|
7549
9080
|
* @param {string} workspaceId the Workspace identifier
|
|
7550
|
-
* @param {WorkspaceRole} workspaceRole the
|
|
9081
|
+
* @param {WorkspaceRole} workspaceRole This change the workspace 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 workspace.
|
|
7551
9082
|
* @param {*} [options] Override http request option.
|
|
7552
9083
|
* @throws {RequiredError}
|
|
7553
9084
|
*/
|
|
7554
9085
|
setWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, workspaceRole: WorkspaceRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceSecurity>>;
|
|
9086
|
+
/**
|
|
9087
|
+
*
|
|
9088
|
+
* @param {string} organizationId the Organization identifier
|
|
9089
|
+
* @param {string} workspaceId the Workspace identifier
|
|
9090
|
+
* @param {string} datasetId dataset id to be linked to
|
|
9091
|
+
* @param {*} [options] Override http request option.
|
|
9092
|
+
* @throws {RequiredError}
|
|
9093
|
+
*/
|
|
9094
|
+
unlinkDataset(organizationId: string, workspaceId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
|
|
7555
9095
|
/**
|
|
7556
9096
|
*
|
|
7557
9097
|
* @summary Update a workspace
|
|
7558
9098
|
* @param {string} organizationId the Organization identifier
|
|
7559
9099
|
* @param {string} workspaceId the Workspace identifier
|
|
7560
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
9100
|
+
* @param {Workspace} workspace The new Workspace details. This endpoint can\'t be used to update security
|
|
7561
9101
|
* @param {*} [options] Override http request option.
|
|
7562
9102
|
* @throws {RequiredError}
|
|
7563
9103
|
*/
|
|
@@ -7726,13 +9266,13 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
7726
9266
|
getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: any): AxiosPromise<Array<string>>;
|
|
7727
9267
|
/**
|
|
7728
9268
|
*
|
|
7729
|
-
* @summary Import a workspace
|
|
7730
9269
|
* @param {string} organizationId the Organization identifier
|
|
7731
|
-
* @param {
|
|
9270
|
+
* @param {string} workspaceId the Workspace identifier
|
|
9271
|
+
* @param {string} datasetId dataset id to be linked to
|
|
7732
9272
|
* @param {*} [options] Override http request option.
|
|
7733
9273
|
* @throws {RequiredError}
|
|
7734
9274
|
*/
|
|
7735
|
-
|
|
9275
|
+
linkDataset(organizationId: string, workspaceId: string, datasetId: string, options?: any): AxiosPromise<Workspace>;
|
|
7736
9276
|
/**
|
|
7737
9277
|
*
|
|
7738
9278
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -7748,17 +9288,26 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
7748
9288
|
* @summary Set the Workspace default security
|
|
7749
9289
|
* @param {string} organizationId the Organization identifier
|
|
7750
9290
|
* @param {string} workspaceId the Workspace identifier
|
|
7751
|
-
* @param {WorkspaceRole} workspaceRole the
|
|
9291
|
+
* @param {WorkspaceRole} workspaceRole This change the workspace 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 workspace.
|
|
7752
9292
|
* @param {*} [options] Override http request option.
|
|
7753
9293
|
* @throws {RequiredError}
|
|
7754
9294
|
*/
|
|
7755
9295
|
setWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, workspaceRole: WorkspaceRole, options?: any): AxiosPromise<WorkspaceSecurity>;
|
|
9296
|
+
/**
|
|
9297
|
+
*
|
|
9298
|
+
* @param {string} organizationId the Organization identifier
|
|
9299
|
+
* @param {string} workspaceId the Workspace identifier
|
|
9300
|
+
* @param {string} datasetId dataset id to be linked to
|
|
9301
|
+
* @param {*} [options] Override http request option.
|
|
9302
|
+
* @throws {RequiredError}
|
|
9303
|
+
*/
|
|
9304
|
+
unlinkDataset(organizationId: string, workspaceId: string, datasetId: string, options?: any): AxiosPromise<Workspace>;
|
|
7756
9305
|
/**
|
|
7757
9306
|
*
|
|
7758
9307
|
* @summary Update a workspace
|
|
7759
9308
|
* @param {string} organizationId the Organization identifier
|
|
7760
9309
|
* @param {string} workspaceId the Workspace identifier
|
|
7761
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
9310
|
+
* @param {Workspace} workspace The new Workspace details. This endpoint can\'t be used to update security
|
|
7762
9311
|
* @param {*} [options] Override http request option.
|
|
7763
9312
|
* @throws {RequiredError}
|
|
7764
9313
|
*/
|
|
@@ -7943,14 +9492,14 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
7943
9492
|
getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
|
|
7944
9493
|
/**
|
|
7945
9494
|
*
|
|
7946
|
-
* @summary Import a workspace
|
|
7947
9495
|
* @param {string} organizationId the Organization identifier
|
|
7948
|
-
* @param {
|
|
9496
|
+
* @param {string} workspaceId the Workspace identifier
|
|
9497
|
+
* @param {string} datasetId dataset id to be linked to
|
|
7949
9498
|
* @param {*} [options] Override http request option.
|
|
7950
9499
|
* @throws {RequiredError}
|
|
7951
9500
|
* @memberof WorkspaceApi
|
|
7952
9501
|
*/
|
|
7953
|
-
|
|
9502
|
+
linkDataset(organizationId: string, workspaceId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace>>;
|
|
7954
9503
|
/**
|
|
7955
9504
|
*
|
|
7956
9505
|
* @summary Remove the specified access from the given Organization Workspace
|
|
@@ -7967,18 +9516,28 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
7967
9516
|
* @summary Set the Workspace default security
|
|
7968
9517
|
* @param {string} organizationId the Organization identifier
|
|
7969
9518
|
* @param {string} workspaceId the Workspace identifier
|
|
7970
|
-
* @param {WorkspaceRole} workspaceRole the
|
|
9519
|
+
* @param {WorkspaceRole} workspaceRole This change the workspace 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 workspace.
|
|
7971
9520
|
* @param {*} [options] Override http request option.
|
|
7972
9521
|
* @throws {RequiredError}
|
|
7973
9522
|
* @memberof WorkspaceApi
|
|
7974
9523
|
*/
|
|
7975
9524
|
setWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, workspaceRole: WorkspaceRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceSecurity>>;
|
|
9525
|
+
/**
|
|
9526
|
+
*
|
|
9527
|
+
* @param {string} organizationId the Organization identifier
|
|
9528
|
+
* @param {string} workspaceId the Workspace identifier
|
|
9529
|
+
* @param {string} datasetId dataset id to be linked to
|
|
9530
|
+
* @param {*} [options] Override http request option.
|
|
9531
|
+
* @throws {RequiredError}
|
|
9532
|
+
* @memberof WorkspaceApi
|
|
9533
|
+
*/
|
|
9534
|
+
unlinkDataset(organizationId: string, workspaceId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace>>;
|
|
7976
9535
|
/**
|
|
7977
9536
|
*
|
|
7978
9537
|
* @summary Update a workspace
|
|
7979
9538
|
* @param {string} organizationId the Organization identifier
|
|
7980
9539
|
* @param {string} workspaceId the Workspace identifier
|
|
7981
|
-
* @param {Workspace} workspace The new Workspace details.
|
|
9540
|
+
* @param {Workspace} workspace The new Workspace details. This endpoint can\'t be used to update security
|
|
7982
9541
|
* @param {*} [options] Override http request option.
|
|
7983
9542
|
* @throws {RequiredError}
|
|
7984
9543
|
* @memberof WorkspaceApi
|