@gooddata/api-client-tiger 10.35.0-alpha.2 → 10.35.0-alpha.21
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/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1639 -478
- package/esm/generated/afm-rest-api/api.d.ts +11 -11
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +8 -8
- package/esm/generated/afm-rest-api/openapi-spec.json +3 -3
- package/esm/generated/auth-json-api/api.d.ts +0 -561
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +0 -696
- package/esm/generated/auth-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/openapi-spec.json +0 -166
- package/esm/generated/automation-json-api/api.d.ts +19 -12
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +2 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +6 -2
- package/esm/generated/export-json-api/api.d.ts +1 -0
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +1 -0
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +1 -0
- package/esm/generated/metadata-json-api/api.d.ts +1533 -409
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +1835 -940
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +9099 -8671
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.js +1 -1
- package/esm/generated/result-json-api/base.js.map +1 -1
- package/esm/generated/result-json-api/openapi-spec.json +1 -1
- package/esm/generated/scan-json-api/api.d.ts +96 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +112 -0
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +1 -1
- package/package.json +3 -3
|
@@ -727,10 +727,10 @@ export interface AutomationMetadata {
|
|
|
727
727
|
export interface AutomationRawExport {
|
|
728
728
|
/**
|
|
729
729
|
*
|
|
730
|
-
* @type {
|
|
730
|
+
* @type {RawExportAutomationRequest}
|
|
731
731
|
* @memberof AutomationRawExport
|
|
732
732
|
*/
|
|
733
|
-
requestPayload:
|
|
733
|
+
requestPayload: RawExportAutomationRequest;
|
|
734
734
|
}
|
|
735
735
|
/**
|
|
736
736
|
*
|
|
@@ -1621,6 +1621,59 @@ export interface DateValue {
|
|
|
1621
1621
|
*/
|
|
1622
1622
|
value: string;
|
|
1623
1623
|
}
|
|
1624
|
+
/**
|
|
1625
|
+
* A dataset fact.
|
|
1626
|
+
* @export
|
|
1627
|
+
* @interface DeclarativeAggregatedFact
|
|
1628
|
+
*/
|
|
1629
|
+
export interface DeclarativeAggregatedFact {
|
|
1630
|
+
/**
|
|
1631
|
+
* Fact ID.
|
|
1632
|
+
* @type {string}
|
|
1633
|
+
* @memberof DeclarativeAggregatedFact
|
|
1634
|
+
*/
|
|
1635
|
+
id: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* Fact description.
|
|
1638
|
+
* @type {string}
|
|
1639
|
+
* @memberof DeclarativeAggregatedFact
|
|
1640
|
+
*/
|
|
1641
|
+
description?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* A name of the source column in the table.
|
|
1644
|
+
* @type {string}
|
|
1645
|
+
* @memberof DeclarativeAggregatedFact
|
|
1646
|
+
*/
|
|
1647
|
+
sourceColumn: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* A type of the source column
|
|
1650
|
+
* @type {string}
|
|
1651
|
+
* @memberof DeclarativeAggregatedFact
|
|
1652
|
+
*/
|
|
1653
|
+
sourceColumnDataType?: DeclarativeAggregatedFactSourceColumnDataTypeEnum;
|
|
1654
|
+
/**
|
|
1655
|
+
* A list of tags.
|
|
1656
|
+
* @type {Array<string>}
|
|
1657
|
+
* @memberof DeclarativeAggregatedFact
|
|
1658
|
+
*/
|
|
1659
|
+
tags?: Array<string>;
|
|
1660
|
+
/**
|
|
1661
|
+
*
|
|
1662
|
+
* @type {DeclarativeSourceFactReference}
|
|
1663
|
+
* @memberof DeclarativeAggregatedFact
|
|
1664
|
+
*/
|
|
1665
|
+
sourceFactReference: DeclarativeSourceFactReference;
|
|
1666
|
+
}
|
|
1667
|
+
export declare const DeclarativeAggregatedFactSourceColumnDataTypeEnum: {
|
|
1668
|
+
readonly INT: "INT";
|
|
1669
|
+
readonly STRING: "STRING";
|
|
1670
|
+
readonly DATE: "DATE";
|
|
1671
|
+
readonly NUMERIC: "NUMERIC";
|
|
1672
|
+
readonly TIMESTAMP: "TIMESTAMP";
|
|
1673
|
+
readonly TIMESTAMP_TZ: "TIMESTAMP_TZ";
|
|
1674
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
1675
|
+
};
|
|
1676
|
+
export type DeclarativeAggregatedFactSourceColumnDataTypeEnum = typeof DeclarativeAggregatedFactSourceColumnDataTypeEnum[keyof typeof DeclarativeAggregatedFactSourceColumnDataTypeEnum];
|
|
1624
1677
|
/**
|
|
1625
1678
|
*
|
|
1626
1679
|
* @export
|
|
@@ -2613,6 +2666,12 @@ export interface DeclarativeDataset {
|
|
|
2613
2666
|
* @memberof DeclarativeDataset
|
|
2614
2667
|
*/
|
|
2615
2668
|
facts?: Array<DeclarativeFact>;
|
|
2669
|
+
/**
|
|
2670
|
+
* An array of aggregated facts.
|
|
2671
|
+
* @type {Array<DeclarativeAggregatedFact>}
|
|
2672
|
+
* @memberof DeclarativeDataset
|
|
2673
|
+
*/
|
|
2674
|
+
aggregatedFacts?: Array<DeclarativeAggregatedFact>;
|
|
2616
2675
|
/**
|
|
2617
2676
|
* An array of references.
|
|
2618
2677
|
* @type {Array<DeclarativeReference>}
|
|
@@ -2925,12 +2984,6 @@ export interface DeclarativeFact {
|
|
|
2925
2984
|
* @memberof DeclarativeFact
|
|
2926
2985
|
*/
|
|
2927
2986
|
tags?: Array<string>;
|
|
2928
|
-
/**
|
|
2929
|
-
*
|
|
2930
|
-
* @type {DeclarativeSourceFactReference}
|
|
2931
|
-
* @memberof DeclarativeFact
|
|
2932
|
-
*/
|
|
2933
|
-
sourceFactReference?: DeclarativeSourceFactReference;
|
|
2934
2987
|
}
|
|
2935
2988
|
export declare const DeclarativeFactSourceColumnDataTypeEnum: {
|
|
2936
2989
|
readonly INT: "INT";
|
|
@@ -5299,6 +5352,7 @@ export declare const IdentifierRefIdentifierTypeEnum: {
|
|
|
5299
5352
|
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
5300
5353
|
readonly DATASET: "dataset";
|
|
5301
5354
|
readonly FACT: "fact";
|
|
5355
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
5302
5356
|
readonly LABEL: "label";
|
|
5303
5357
|
readonly METRIC: "metric";
|
|
5304
5358
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
@@ -5490,6 +5544,269 @@ export interface IntroSlideTemplate {
|
|
|
5490
5544
|
*/
|
|
5491
5545
|
backgroundImage?: boolean;
|
|
5492
5546
|
}
|
|
5547
|
+
/**
|
|
5548
|
+
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
5549
|
+
* @export
|
|
5550
|
+
* @interface JsonApiAggregatedFactLinkage
|
|
5551
|
+
*/
|
|
5552
|
+
export interface JsonApiAggregatedFactLinkage {
|
|
5553
|
+
/**
|
|
5554
|
+
*
|
|
5555
|
+
* @type {string}
|
|
5556
|
+
* @memberof JsonApiAggregatedFactLinkage
|
|
5557
|
+
*/
|
|
5558
|
+
id: string;
|
|
5559
|
+
/**
|
|
5560
|
+
*
|
|
5561
|
+
* @type {string}
|
|
5562
|
+
* @memberof JsonApiAggregatedFactLinkage
|
|
5563
|
+
*/
|
|
5564
|
+
type: JsonApiAggregatedFactLinkageTypeEnum;
|
|
5565
|
+
}
|
|
5566
|
+
export declare const JsonApiAggregatedFactLinkageTypeEnum: {
|
|
5567
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
5568
|
+
};
|
|
5569
|
+
export type JsonApiAggregatedFactLinkageTypeEnum = typeof JsonApiAggregatedFactLinkageTypeEnum[keyof typeof JsonApiAggregatedFactLinkageTypeEnum];
|
|
5570
|
+
/**
|
|
5571
|
+
* JSON:API representation of aggregatedFact entity.
|
|
5572
|
+
* @export
|
|
5573
|
+
* @interface JsonApiAggregatedFactOut
|
|
5574
|
+
*/
|
|
5575
|
+
export interface JsonApiAggregatedFactOut {
|
|
5576
|
+
/**
|
|
5577
|
+
* Object type
|
|
5578
|
+
* @type {string}
|
|
5579
|
+
* @memberof JsonApiAggregatedFactOut
|
|
5580
|
+
*/
|
|
5581
|
+
type: JsonApiAggregatedFactOutTypeEnum;
|
|
5582
|
+
/**
|
|
5583
|
+
* API identifier of an object
|
|
5584
|
+
* @type {string}
|
|
5585
|
+
* @memberof JsonApiAggregatedFactOut
|
|
5586
|
+
*/
|
|
5587
|
+
id: string;
|
|
5588
|
+
/**
|
|
5589
|
+
*
|
|
5590
|
+
* @type {JsonApiVisualizationObjectOutMeta}
|
|
5591
|
+
* @memberof JsonApiAggregatedFactOut
|
|
5592
|
+
*/
|
|
5593
|
+
meta?: JsonApiVisualizationObjectOutMeta;
|
|
5594
|
+
/**
|
|
5595
|
+
*
|
|
5596
|
+
* @type {JsonApiAggregatedFactOutAttributes}
|
|
5597
|
+
* @memberof JsonApiAggregatedFactOut
|
|
5598
|
+
*/
|
|
5599
|
+
attributes: JsonApiAggregatedFactOutAttributes;
|
|
5600
|
+
/**
|
|
5601
|
+
*
|
|
5602
|
+
* @type {JsonApiAggregatedFactOutRelationships}
|
|
5603
|
+
* @memberof JsonApiAggregatedFactOut
|
|
5604
|
+
*/
|
|
5605
|
+
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
5606
|
+
}
|
|
5607
|
+
export declare const JsonApiAggregatedFactOutTypeEnum: {
|
|
5608
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
5609
|
+
};
|
|
5610
|
+
export type JsonApiAggregatedFactOutTypeEnum = typeof JsonApiAggregatedFactOutTypeEnum[keyof typeof JsonApiAggregatedFactOutTypeEnum];
|
|
5611
|
+
/**
|
|
5612
|
+
*
|
|
5613
|
+
* @export
|
|
5614
|
+
* @interface JsonApiAggregatedFactOutAttributes
|
|
5615
|
+
*/
|
|
5616
|
+
export interface JsonApiAggregatedFactOutAttributes {
|
|
5617
|
+
/**
|
|
5618
|
+
*
|
|
5619
|
+
* @type {string}
|
|
5620
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
5621
|
+
*/
|
|
5622
|
+
description?: string;
|
|
5623
|
+
/**
|
|
5624
|
+
*
|
|
5625
|
+
* @type {Array<string>}
|
|
5626
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
5627
|
+
*/
|
|
5628
|
+
tags?: Array<string>;
|
|
5629
|
+
/**
|
|
5630
|
+
*
|
|
5631
|
+
* @type {string}
|
|
5632
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
5633
|
+
*/
|
|
5634
|
+
sourceColumn?: string;
|
|
5635
|
+
/**
|
|
5636
|
+
*
|
|
5637
|
+
* @type {string}
|
|
5638
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
5639
|
+
*/
|
|
5640
|
+
sourceColumnDataType?: JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum;
|
|
5641
|
+
/**
|
|
5642
|
+
*
|
|
5643
|
+
* @type {boolean}
|
|
5644
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
5645
|
+
*/
|
|
5646
|
+
areRelationsValid?: boolean;
|
|
5647
|
+
/**
|
|
5648
|
+
*
|
|
5649
|
+
* @type {string}
|
|
5650
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
5651
|
+
*/
|
|
5652
|
+
operation: JsonApiAggregatedFactOutAttributesOperationEnum;
|
|
5653
|
+
}
|
|
5654
|
+
export declare const JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum: {
|
|
5655
|
+
readonly INT: "INT";
|
|
5656
|
+
readonly STRING: "STRING";
|
|
5657
|
+
readonly DATE: "DATE";
|
|
5658
|
+
readonly NUMERIC: "NUMERIC";
|
|
5659
|
+
readonly TIMESTAMP: "TIMESTAMP";
|
|
5660
|
+
readonly TIMESTAMP_TZ: "TIMESTAMP_TZ";
|
|
5661
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
5662
|
+
};
|
|
5663
|
+
export type JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum = typeof JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum[keyof typeof JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum];
|
|
5664
|
+
export declare const JsonApiAggregatedFactOutAttributesOperationEnum: {
|
|
5665
|
+
readonly SUM: "SUM";
|
|
5666
|
+
readonly MIN: "MIN";
|
|
5667
|
+
readonly MAX: "MAX";
|
|
5668
|
+
};
|
|
5669
|
+
export type JsonApiAggregatedFactOutAttributesOperationEnum = typeof JsonApiAggregatedFactOutAttributesOperationEnum[keyof typeof JsonApiAggregatedFactOutAttributesOperationEnum];
|
|
5670
|
+
/**
|
|
5671
|
+
*
|
|
5672
|
+
* @export
|
|
5673
|
+
* @interface JsonApiAggregatedFactOutDocument
|
|
5674
|
+
*/
|
|
5675
|
+
export interface JsonApiAggregatedFactOutDocument {
|
|
5676
|
+
/**
|
|
5677
|
+
*
|
|
5678
|
+
* @type {JsonApiAggregatedFactOut}
|
|
5679
|
+
* @memberof JsonApiAggregatedFactOutDocument
|
|
5680
|
+
*/
|
|
5681
|
+
data: JsonApiAggregatedFactOut;
|
|
5682
|
+
/**
|
|
5683
|
+
*
|
|
5684
|
+
* @type {ObjectLinks}
|
|
5685
|
+
* @memberof JsonApiAggregatedFactOutDocument
|
|
5686
|
+
*/
|
|
5687
|
+
links?: ObjectLinks;
|
|
5688
|
+
/**
|
|
5689
|
+
* Included resources
|
|
5690
|
+
* @type {Array<JsonApiAggregatedFactOutIncludes>}
|
|
5691
|
+
* @memberof JsonApiAggregatedFactOutDocument
|
|
5692
|
+
*/
|
|
5693
|
+
included?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
5694
|
+
}
|
|
5695
|
+
/**
|
|
5696
|
+
* @type JsonApiAggregatedFactOutIncludes
|
|
5697
|
+
* @export
|
|
5698
|
+
*/
|
|
5699
|
+
export type JsonApiAggregatedFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
5700
|
+
/**
|
|
5701
|
+
* A JSON:API document with a list of resources
|
|
5702
|
+
* @export
|
|
5703
|
+
* @interface JsonApiAggregatedFactOutList
|
|
5704
|
+
*/
|
|
5705
|
+
export interface JsonApiAggregatedFactOutList {
|
|
5706
|
+
/**
|
|
5707
|
+
*
|
|
5708
|
+
* @type {Array<JsonApiAggregatedFactOutWithLinks>}
|
|
5709
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
5710
|
+
*/
|
|
5711
|
+
data: Array<JsonApiAggregatedFactOutWithLinks>;
|
|
5712
|
+
/**
|
|
5713
|
+
*
|
|
5714
|
+
* @type {ListLinks}
|
|
5715
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
5716
|
+
*/
|
|
5717
|
+
links?: ListLinks;
|
|
5718
|
+
/**
|
|
5719
|
+
*
|
|
5720
|
+
* @type {JsonApiColorPaletteOutListMeta}
|
|
5721
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
5722
|
+
*/
|
|
5723
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5724
|
+
/**
|
|
5725
|
+
* Included resources
|
|
5726
|
+
* @type {Array<JsonApiAggregatedFactOutIncludes>}
|
|
5727
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
5728
|
+
*/
|
|
5729
|
+
included?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
5730
|
+
}
|
|
5731
|
+
/**
|
|
5732
|
+
*
|
|
5733
|
+
* @export
|
|
5734
|
+
* @interface JsonApiAggregatedFactOutRelationships
|
|
5735
|
+
*/
|
|
5736
|
+
export interface JsonApiAggregatedFactOutRelationships {
|
|
5737
|
+
/**
|
|
5738
|
+
*
|
|
5739
|
+
* @type {JsonApiAttributeOutRelationshipsDataset}
|
|
5740
|
+
* @memberof JsonApiAggregatedFactOutRelationships
|
|
5741
|
+
*/
|
|
5742
|
+
dataset?: JsonApiAttributeOutRelationshipsDataset;
|
|
5743
|
+
/**
|
|
5744
|
+
*
|
|
5745
|
+
* @type {JsonApiAggregatedFactOutRelationshipsSourceFact}
|
|
5746
|
+
* @memberof JsonApiAggregatedFactOutRelationships
|
|
5747
|
+
*/
|
|
5748
|
+
sourceFact?: JsonApiAggregatedFactOutRelationshipsSourceFact;
|
|
5749
|
+
}
|
|
5750
|
+
/**
|
|
5751
|
+
*
|
|
5752
|
+
* @export
|
|
5753
|
+
* @interface JsonApiAggregatedFactOutRelationshipsSourceFact
|
|
5754
|
+
*/
|
|
5755
|
+
export interface JsonApiAggregatedFactOutRelationshipsSourceFact {
|
|
5756
|
+
/**
|
|
5757
|
+
*
|
|
5758
|
+
* @type {JsonApiFactToOneLinkage}
|
|
5759
|
+
* @memberof JsonApiAggregatedFactOutRelationshipsSourceFact
|
|
5760
|
+
*/
|
|
5761
|
+
data: JsonApiFactToOneLinkage | null;
|
|
5762
|
+
}
|
|
5763
|
+
/**
|
|
5764
|
+
*
|
|
5765
|
+
* @export
|
|
5766
|
+
* @interface JsonApiAggregatedFactOutWithLinks
|
|
5767
|
+
*/
|
|
5768
|
+
export interface JsonApiAggregatedFactOutWithLinks {
|
|
5769
|
+
/**
|
|
5770
|
+
* Object type
|
|
5771
|
+
* @type {string}
|
|
5772
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
5773
|
+
*/
|
|
5774
|
+
type: JsonApiAggregatedFactOutWithLinksTypeEnum;
|
|
5775
|
+
/**
|
|
5776
|
+
* API identifier of an object
|
|
5777
|
+
* @type {string}
|
|
5778
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
5779
|
+
*/
|
|
5780
|
+
id: string;
|
|
5781
|
+
/**
|
|
5782
|
+
*
|
|
5783
|
+
* @type {JsonApiVisualizationObjectOutMeta}
|
|
5784
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
5785
|
+
*/
|
|
5786
|
+
meta?: JsonApiVisualizationObjectOutMeta;
|
|
5787
|
+
/**
|
|
5788
|
+
*
|
|
5789
|
+
* @type {JsonApiAggregatedFactOutAttributes}
|
|
5790
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
5791
|
+
*/
|
|
5792
|
+
attributes: JsonApiAggregatedFactOutAttributes;
|
|
5793
|
+
/**
|
|
5794
|
+
*
|
|
5795
|
+
* @type {JsonApiAggregatedFactOutRelationships}
|
|
5796
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
5797
|
+
*/
|
|
5798
|
+
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
5799
|
+
/**
|
|
5800
|
+
*
|
|
5801
|
+
* @type {ObjectLinks}
|
|
5802
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
5803
|
+
*/
|
|
5804
|
+
links?: ObjectLinks;
|
|
5805
|
+
}
|
|
5806
|
+
export declare const JsonApiAggregatedFactOutWithLinksTypeEnum: {
|
|
5807
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
5808
|
+
};
|
|
5809
|
+
export type JsonApiAggregatedFactOutWithLinksTypeEnum = typeof JsonApiAggregatedFactOutWithLinksTypeEnum[keyof typeof JsonApiAggregatedFactOutWithLinksTypeEnum];
|
|
5493
5810
|
/**
|
|
5494
5811
|
* JSON:API representation of analyticalDashboard entity.
|
|
5495
5812
|
* @export
|
|
@@ -7130,10 +7447,10 @@ export interface JsonApiAutomationInAttributesMetadata {
|
|
|
7130
7447
|
export interface JsonApiAutomationInAttributesRawExports {
|
|
7131
7448
|
/**
|
|
7132
7449
|
*
|
|
7133
|
-
* @type {
|
|
7450
|
+
* @type {RawExportAutomationRequest}
|
|
7134
7451
|
* @memberof JsonApiAutomationInAttributesRawExports
|
|
7135
7452
|
*/
|
|
7136
|
-
requestPayload:
|
|
7453
|
+
requestPayload: RawExportAutomationRequest;
|
|
7137
7454
|
}
|
|
7138
7455
|
/**
|
|
7139
7456
|
*
|
|
@@ -10079,7 +10396,7 @@ export interface JsonApiDatasetOutDocument {
|
|
|
10079
10396
|
* @type JsonApiDatasetOutIncludes
|
|
10080
10397
|
* @export
|
|
10081
10398
|
*/
|
|
10082
|
-
export type JsonApiDatasetOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiWorkspaceDataFilterOutWithLinks;
|
|
10399
|
+
export type JsonApiDatasetOutIncludes = JsonApiAggregatedFactOutWithLinks | JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiWorkspaceDataFilterOutWithLinks;
|
|
10083
10400
|
/**
|
|
10084
10401
|
* A JSON:API document with a list of resources
|
|
10085
10402
|
* @export
|
|
@@ -10129,6 +10446,12 @@ export interface JsonApiDatasetOutRelationships {
|
|
|
10129
10446
|
* @memberof JsonApiDatasetOutRelationships
|
|
10130
10447
|
*/
|
|
10131
10448
|
facts?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
10449
|
+
/**
|
|
10450
|
+
*
|
|
10451
|
+
* @type {JsonApiDatasetOutRelationshipsAggregatedFacts}
|
|
10452
|
+
* @memberof JsonApiDatasetOutRelationships
|
|
10453
|
+
*/
|
|
10454
|
+
aggregatedFacts?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
10132
10455
|
/**
|
|
10133
10456
|
*
|
|
10134
10457
|
* @type {JsonApiVisualizationObjectOutRelationshipsDatasets}
|
|
@@ -10142,6 +10465,19 @@ export interface JsonApiDatasetOutRelationships {
|
|
|
10142
10465
|
*/
|
|
10143
10466
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
10144
10467
|
}
|
|
10468
|
+
/**
|
|
10469
|
+
*
|
|
10470
|
+
* @export
|
|
10471
|
+
* @interface JsonApiDatasetOutRelationshipsAggregatedFacts
|
|
10472
|
+
*/
|
|
10473
|
+
export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
10474
|
+
/**
|
|
10475
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
10476
|
+
* @type {Array<JsonApiAggregatedFactLinkage>}
|
|
10477
|
+
* @memberof JsonApiDatasetOutRelationshipsAggregatedFacts
|
|
10478
|
+
*/
|
|
10479
|
+
data: Array<JsonApiAggregatedFactLinkage>;
|
|
10480
|
+
}
|
|
10145
10481
|
/**
|
|
10146
10482
|
*
|
|
10147
10483
|
* @export
|
|
@@ -11275,12 +11611,6 @@ export interface JsonApiFactOutAttributes {
|
|
|
11275
11611
|
* @memberof JsonApiFactOutAttributes
|
|
11276
11612
|
*/
|
|
11277
11613
|
areRelationsValid?: boolean;
|
|
11278
|
-
/**
|
|
11279
|
-
*
|
|
11280
|
-
* @type {string}
|
|
11281
|
-
* @memberof JsonApiFactOutAttributes
|
|
11282
|
-
*/
|
|
11283
|
-
operation?: JsonApiFactOutAttributesOperationEnum;
|
|
11284
11614
|
}
|
|
11285
11615
|
export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
11286
11616
|
readonly INT: "INT";
|
|
@@ -11292,12 +11622,6 @@ export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
|
11292
11622
|
readonly BOOLEAN: "BOOLEAN";
|
|
11293
11623
|
};
|
|
11294
11624
|
export type JsonApiFactOutAttributesSourceColumnDataTypeEnum = typeof JsonApiFactOutAttributesSourceColumnDataTypeEnum[keyof typeof JsonApiFactOutAttributesSourceColumnDataTypeEnum];
|
|
11295
|
-
export declare const JsonApiFactOutAttributesOperationEnum: {
|
|
11296
|
-
readonly SUM: "SUM";
|
|
11297
|
-
readonly MIN: "MIN";
|
|
11298
|
-
readonly MAX: "MAX";
|
|
11299
|
-
};
|
|
11300
|
-
export type JsonApiFactOutAttributesOperationEnum = typeof JsonApiFactOutAttributesOperationEnum[keyof typeof JsonApiFactOutAttributesOperationEnum];
|
|
11301
11625
|
/**
|
|
11302
11626
|
*
|
|
11303
11627
|
* @export
|
|
@@ -11318,16 +11642,11 @@ export interface JsonApiFactOutDocument {
|
|
|
11318
11642
|
links?: ObjectLinks;
|
|
11319
11643
|
/**
|
|
11320
11644
|
* Included resources
|
|
11321
|
-
* @type {Array<
|
|
11645
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
11322
11646
|
* @memberof JsonApiFactOutDocument
|
|
11323
11647
|
*/
|
|
11324
|
-
included?: Array<
|
|
11648
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
11325
11649
|
}
|
|
11326
|
-
/**
|
|
11327
|
-
* @type JsonApiFactOutIncludes
|
|
11328
|
-
* @export
|
|
11329
|
-
*/
|
|
11330
|
-
export type JsonApiFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
11331
11650
|
/**
|
|
11332
11651
|
* A JSON:API document with a list of resources
|
|
11333
11652
|
* @export
|
|
@@ -11354,10 +11673,10 @@ export interface JsonApiFactOutList {
|
|
|
11354
11673
|
meta?: JsonApiColorPaletteOutListMeta;
|
|
11355
11674
|
/**
|
|
11356
11675
|
* Included resources
|
|
11357
|
-
* @type {Array<
|
|
11676
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
11358
11677
|
* @memberof JsonApiFactOutList
|
|
11359
11678
|
*/
|
|
11360
|
-
included?: Array<
|
|
11679
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
11361
11680
|
}
|
|
11362
11681
|
/**
|
|
11363
11682
|
*
|
|
@@ -11371,25 +11690,6 @@ export interface JsonApiFactOutRelationships {
|
|
|
11371
11690
|
* @memberof JsonApiFactOutRelationships
|
|
11372
11691
|
*/
|
|
11373
11692
|
dataset?: JsonApiAttributeOutRelationshipsDataset;
|
|
11374
|
-
/**
|
|
11375
|
-
*
|
|
11376
|
-
* @type {JsonApiFactOutRelationshipsSourceFact}
|
|
11377
|
-
* @memberof JsonApiFactOutRelationships
|
|
11378
|
-
*/
|
|
11379
|
-
sourceFact?: JsonApiFactOutRelationshipsSourceFact;
|
|
11380
|
-
}
|
|
11381
|
-
/**
|
|
11382
|
-
*
|
|
11383
|
-
* @export
|
|
11384
|
-
* @interface JsonApiFactOutRelationshipsSourceFact
|
|
11385
|
-
*/
|
|
11386
|
-
export interface JsonApiFactOutRelationshipsSourceFact {
|
|
11387
|
-
/**
|
|
11388
|
-
*
|
|
11389
|
-
* @type {JsonApiFactToOneLinkage}
|
|
11390
|
-
* @memberof JsonApiFactOutRelationshipsSourceFact
|
|
11391
|
-
*/
|
|
11392
|
-
data: JsonApiFactToOneLinkage | null;
|
|
11393
11693
|
}
|
|
11394
11694
|
/**
|
|
11395
11695
|
*
|
|
@@ -14757,10 +15057,10 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
14757
15057
|
id: string;
|
|
14758
15058
|
/**
|
|
14759
15059
|
*
|
|
14760
|
-
* @type {
|
|
15060
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
14761
15061
|
* @memberof JsonApiOrganizationSettingIn
|
|
14762
15062
|
*/
|
|
14763
|
-
attributes?:
|
|
15063
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
14764
15064
|
}
|
|
14765
15065
|
export declare const JsonApiOrganizationSettingInTypeEnum: {
|
|
14766
15066
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -14799,62 +15099,15 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
14799
15099
|
id: string;
|
|
14800
15100
|
/**
|
|
14801
15101
|
*
|
|
14802
|
-
* @type {
|
|
15102
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
14803
15103
|
* @memberof JsonApiOrganizationSettingOut
|
|
14804
15104
|
*/
|
|
14805
|
-
attributes?:
|
|
15105
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
14806
15106
|
}
|
|
14807
15107
|
export declare const JsonApiOrganizationSettingOutTypeEnum: {
|
|
14808
15108
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
14809
15109
|
};
|
|
14810
15110
|
export type JsonApiOrganizationSettingOutTypeEnum = typeof JsonApiOrganizationSettingOutTypeEnum[keyof typeof JsonApiOrganizationSettingOutTypeEnum];
|
|
14811
|
-
/**
|
|
14812
|
-
*
|
|
14813
|
-
* @export
|
|
14814
|
-
* @interface JsonApiOrganizationSettingOutAttributes
|
|
14815
|
-
*/
|
|
14816
|
-
export interface JsonApiOrganizationSettingOutAttributes {
|
|
14817
|
-
/**
|
|
14818
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
14819
|
-
* @type {object}
|
|
14820
|
-
* @memberof JsonApiOrganizationSettingOutAttributes
|
|
14821
|
-
*/
|
|
14822
|
-
content?: object;
|
|
14823
|
-
/**
|
|
14824
|
-
*
|
|
14825
|
-
* @type {string}
|
|
14826
|
-
* @memberof JsonApiOrganizationSettingOutAttributes
|
|
14827
|
-
*/
|
|
14828
|
-
type?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
14829
|
-
}
|
|
14830
|
-
export declare const JsonApiOrganizationSettingOutAttributesTypeEnum: {
|
|
14831
|
-
readonly TIMEZONE: "TIMEZONE";
|
|
14832
|
-
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
14833
|
-
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
14834
|
-
readonly ACTIVE_LLM_ENDPOINT: "ACTIVE_LLM_ENDPOINT";
|
|
14835
|
-
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
14836
|
-
readonly LOCALE: "LOCALE";
|
|
14837
|
-
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
14838
|
-
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
14839
|
-
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
14840
|
-
readonly WEEK_START: "WEEK_START";
|
|
14841
|
-
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
14842
|
-
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
14843
|
-
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
14844
|
-
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
14845
|
-
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
14846
|
-
readonly ALERT: "ALERT";
|
|
14847
|
-
readonly SEPARATORS: "SEPARATORS";
|
|
14848
|
-
readonly DATE_FILTER_CONFIG: "DATE_FILTER_CONFIG";
|
|
14849
|
-
readonly JIT_PROVISIONING: "JIT_PROVISIONING";
|
|
14850
|
-
readonly JWT_JIT_PROVISIONING: "JWT_JIT_PROVISIONING";
|
|
14851
|
-
readonly DASHBOARD_FILTERS_APPLY_MODE: "DASHBOARD_FILTERS_APPLY_MODE";
|
|
14852
|
-
readonly ENABLE_SLIDES_EXPORT: "ENABLE_SLIDES_EXPORT";
|
|
14853
|
-
readonly AI_RATE_LIMIT: "AI_RATE_LIMIT";
|
|
14854
|
-
readonly ATTACHMENT_SIZE_LIMIT: "ATTACHMENT_SIZE_LIMIT";
|
|
14855
|
-
readonly ATTACHMENT_LINK_TTL: "ATTACHMENT_LINK_TTL";
|
|
14856
|
-
};
|
|
14857
|
-
export type JsonApiOrganizationSettingOutAttributesTypeEnum = typeof JsonApiOrganizationSettingOutAttributesTypeEnum[keyof typeof JsonApiOrganizationSettingOutAttributesTypeEnum];
|
|
14858
15111
|
/**
|
|
14859
15112
|
*
|
|
14860
15113
|
* @export
|
|
@@ -14919,10 +15172,10 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
14919
15172
|
id: string;
|
|
14920
15173
|
/**
|
|
14921
15174
|
*
|
|
14922
|
-
* @type {
|
|
15175
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
14923
15176
|
* @memberof JsonApiOrganizationSettingOutWithLinks
|
|
14924
15177
|
*/
|
|
14925
|
-
attributes?:
|
|
15178
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
14926
15179
|
/**
|
|
14927
15180
|
*
|
|
14928
15181
|
* @type {ObjectLinks}
|
|
@@ -14954,10 +15207,10 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
14954
15207
|
id: string;
|
|
14955
15208
|
/**
|
|
14956
15209
|
*
|
|
14957
|
-
* @type {
|
|
15210
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
14958
15211
|
* @memberof JsonApiOrganizationSettingPatch
|
|
14959
15212
|
*/
|
|
14960
|
-
attributes?:
|
|
15213
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
14961
15214
|
}
|
|
14962
15215
|
export declare const JsonApiOrganizationSettingPatchTypeEnum: {
|
|
14963
15216
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -15799,23 +16052,10 @@ export interface JsonApiUserGroupOutList {
|
|
|
15799
16052
|
export interface JsonApiUserGroupOutRelationships {
|
|
15800
16053
|
/**
|
|
15801
16054
|
*
|
|
15802
|
-
* @type {
|
|
16055
|
+
* @type {JsonApiUserOutRelationshipsUserGroups}
|
|
15803
16056
|
* @memberof JsonApiUserGroupOutRelationships
|
|
15804
16057
|
*/
|
|
15805
|
-
parents?:
|
|
15806
|
-
}
|
|
15807
|
-
/**
|
|
15808
|
-
*
|
|
15809
|
-
* @export
|
|
15810
|
-
* @interface JsonApiUserGroupOutRelationshipsParents
|
|
15811
|
-
*/
|
|
15812
|
-
export interface JsonApiUserGroupOutRelationshipsParents {
|
|
15813
|
-
/**
|
|
15814
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
15815
|
-
* @type {Array<JsonApiUserGroupLinkage>}
|
|
15816
|
-
* @memberof JsonApiUserGroupOutRelationshipsParents
|
|
15817
|
-
*/
|
|
15818
|
-
data: Array<JsonApiUserGroupLinkage>;
|
|
16058
|
+
parents?: JsonApiUserOutRelationshipsUserGroups;
|
|
15819
16059
|
}
|
|
15820
16060
|
/**
|
|
15821
16061
|
*
|
|
@@ -16275,10 +16515,23 @@ export interface JsonApiUserOutList {
|
|
|
16275
16515
|
export interface JsonApiUserOutRelationships {
|
|
16276
16516
|
/**
|
|
16277
16517
|
*
|
|
16278
|
-
* @type {
|
|
16518
|
+
* @type {JsonApiUserOutRelationshipsUserGroups}
|
|
16279
16519
|
* @memberof JsonApiUserOutRelationships
|
|
16280
16520
|
*/
|
|
16281
|
-
userGroups?:
|
|
16521
|
+
userGroups?: JsonApiUserOutRelationshipsUserGroups;
|
|
16522
|
+
}
|
|
16523
|
+
/**
|
|
16524
|
+
*
|
|
16525
|
+
* @export
|
|
16526
|
+
* @interface JsonApiUserOutRelationshipsUserGroups
|
|
16527
|
+
*/
|
|
16528
|
+
export interface JsonApiUserOutRelationshipsUserGroups {
|
|
16529
|
+
/**
|
|
16530
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
16531
|
+
* @type {Array<JsonApiUserGroupLinkage>}
|
|
16532
|
+
* @memberof JsonApiUserOutRelationshipsUserGroups
|
|
16533
|
+
*/
|
|
16534
|
+
data: Array<JsonApiUserGroupLinkage>;
|
|
16282
16535
|
}
|
|
16283
16536
|
/**
|
|
16284
16537
|
*
|
|
@@ -16389,10 +16642,10 @@ export interface JsonApiUserSettingIn {
|
|
|
16389
16642
|
id: string;
|
|
16390
16643
|
/**
|
|
16391
16644
|
*
|
|
16392
|
-
* @type {
|
|
16645
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
16393
16646
|
* @memberof JsonApiUserSettingIn
|
|
16394
16647
|
*/
|
|
16395
|
-
attributes?:
|
|
16648
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
16396
16649
|
}
|
|
16397
16650
|
export declare const JsonApiUserSettingInTypeEnum: {
|
|
16398
16651
|
readonly USER_SETTING: "userSetting";
|
|
@@ -16431,10 +16684,10 @@ export interface JsonApiUserSettingOut {
|
|
|
16431
16684
|
id: string;
|
|
16432
16685
|
/**
|
|
16433
16686
|
*
|
|
16434
|
-
* @type {
|
|
16687
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
16435
16688
|
* @memberof JsonApiUserSettingOut
|
|
16436
16689
|
*/
|
|
16437
|
-
attributes?:
|
|
16690
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
16438
16691
|
}
|
|
16439
16692
|
export declare const JsonApiUserSettingOutTypeEnum: {
|
|
16440
16693
|
readonly USER_SETTING: "userSetting";
|
|
@@ -16504,10 +16757,10 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
16504
16757
|
id: string;
|
|
16505
16758
|
/**
|
|
16506
16759
|
*
|
|
16507
|
-
* @type {
|
|
16760
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
16508
16761
|
* @memberof JsonApiUserSettingOutWithLinks
|
|
16509
16762
|
*/
|
|
16510
|
-
attributes?:
|
|
16763
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
16511
16764
|
/**
|
|
16512
16765
|
*
|
|
16513
16766
|
* @type {ObjectLinks}
|
|
@@ -18143,15 +18396,62 @@ export interface JsonApiWorkspaceSettingIn {
|
|
|
18143
18396
|
id: string;
|
|
18144
18397
|
/**
|
|
18145
18398
|
*
|
|
18146
|
-
* @type {
|
|
18399
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
18147
18400
|
* @memberof JsonApiWorkspaceSettingIn
|
|
18148
18401
|
*/
|
|
18149
|
-
attributes?:
|
|
18402
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
18150
18403
|
}
|
|
18151
18404
|
export declare const JsonApiWorkspaceSettingInTypeEnum: {
|
|
18152
18405
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
18153
18406
|
};
|
|
18154
18407
|
export type JsonApiWorkspaceSettingInTypeEnum = typeof JsonApiWorkspaceSettingInTypeEnum[keyof typeof JsonApiWorkspaceSettingInTypeEnum];
|
|
18408
|
+
/**
|
|
18409
|
+
*
|
|
18410
|
+
* @export
|
|
18411
|
+
* @interface JsonApiWorkspaceSettingInAttributes
|
|
18412
|
+
*/
|
|
18413
|
+
export interface JsonApiWorkspaceSettingInAttributes {
|
|
18414
|
+
/**
|
|
18415
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
18416
|
+
* @type {object}
|
|
18417
|
+
* @memberof JsonApiWorkspaceSettingInAttributes
|
|
18418
|
+
*/
|
|
18419
|
+
content?: object;
|
|
18420
|
+
/**
|
|
18421
|
+
*
|
|
18422
|
+
* @type {string}
|
|
18423
|
+
* @memberof JsonApiWorkspaceSettingInAttributes
|
|
18424
|
+
*/
|
|
18425
|
+
type?: JsonApiWorkspaceSettingInAttributesTypeEnum;
|
|
18426
|
+
}
|
|
18427
|
+
export declare const JsonApiWorkspaceSettingInAttributesTypeEnum: {
|
|
18428
|
+
readonly TIMEZONE: "TIMEZONE";
|
|
18429
|
+
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
18430
|
+
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
18431
|
+
readonly ACTIVE_LLM_ENDPOINT: "ACTIVE_LLM_ENDPOINT";
|
|
18432
|
+
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
18433
|
+
readonly LOCALE: "LOCALE";
|
|
18434
|
+
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
18435
|
+
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
18436
|
+
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
18437
|
+
readonly WEEK_START: "WEEK_START";
|
|
18438
|
+
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
18439
|
+
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
18440
|
+
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
18441
|
+
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
18442
|
+
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
18443
|
+
readonly ALERT: "ALERT";
|
|
18444
|
+
readonly SEPARATORS: "SEPARATORS";
|
|
18445
|
+
readonly DATE_FILTER_CONFIG: "DATE_FILTER_CONFIG";
|
|
18446
|
+
readonly JIT_PROVISIONING: "JIT_PROVISIONING";
|
|
18447
|
+
readonly JWT_JIT_PROVISIONING: "JWT_JIT_PROVISIONING";
|
|
18448
|
+
readonly DASHBOARD_FILTERS_APPLY_MODE: "DASHBOARD_FILTERS_APPLY_MODE";
|
|
18449
|
+
readonly ENABLE_SLIDES_EXPORT: "ENABLE_SLIDES_EXPORT";
|
|
18450
|
+
readonly AI_RATE_LIMIT: "AI_RATE_LIMIT";
|
|
18451
|
+
readonly ATTACHMENT_SIZE_LIMIT: "ATTACHMENT_SIZE_LIMIT";
|
|
18452
|
+
readonly ATTACHMENT_LINK_TTL: "ATTACHMENT_LINK_TTL";
|
|
18453
|
+
};
|
|
18454
|
+
export type JsonApiWorkspaceSettingInAttributesTypeEnum = typeof JsonApiWorkspaceSettingInAttributesTypeEnum[keyof typeof JsonApiWorkspaceSettingInAttributesTypeEnum];
|
|
18155
18455
|
/**
|
|
18156
18456
|
*
|
|
18157
18457
|
* @export
|
|
@@ -18191,10 +18491,10 @@ export interface JsonApiWorkspaceSettingOut {
|
|
|
18191
18491
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
18192
18492
|
/**
|
|
18193
18493
|
*
|
|
18194
|
-
* @type {
|
|
18494
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
18195
18495
|
* @memberof JsonApiWorkspaceSettingOut
|
|
18196
18496
|
*/
|
|
18197
|
-
attributes?:
|
|
18497
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
18198
18498
|
}
|
|
18199
18499
|
export declare const JsonApiWorkspaceSettingOutTypeEnum: {
|
|
18200
18500
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -18270,10 +18570,10 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
18270
18570
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
18271
18571
|
/**
|
|
18272
18572
|
*
|
|
18273
|
-
* @type {
|
|
18573
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
18274
18574
|
* @memberof JsonApiWorkspaceSettingOutWithLinks
|
|
18275
18575
|
*/
|
|
18276
|
-
attributes?:
|
|
18576
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
18277
18577
|
/**
|
|
18278
18578
|
*
|
|
18279
18579
|
* @type {ObjectLinks}
|
|
@@ -18305,10 +18605,10 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
18305
18605
|
id: string;
|
|
18306
18606
|
/**
|
|
18307
18607
|
*
|
|
18308
|
-
* @type {
|
|
18608
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
18309
18609
|
* @memberof JsonApiWorkspaceSettingPatch
|
|
18310
18610
|
*/
|
|
18311
|
-
attributes?:
|
|
18611
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
18312
18612
|
}
|
|
18313
18613
|
export declare const JsonApiWorkspaceSettingPatchTypeEnum: {
|
|
18314
18614
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -18347,10 +18647,10 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
18347
18647
|
id?: string;
|
|
18348
18648
|
/**
|
|
18349
18649
|
*
|
|
18350
|
-
* @type {
|
|
18650
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
18351
18651
|
* @memberof JsonApiWorkspaceSettingPostOptionalId
|
|
18352
18652
|
*/
|
|
18353
|
-
attributes?:
|
|
18653
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
18354
18654
|
}
|
|
18355
18655
|
export declare const JsonApiWorkspaceSettingPostOptionalIdTypeEnum: {
|
|
18356
18656
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -19431,46 +19731,52 @@ export interface RawCustomOverride {
|
|
|
19431
19731
|
/**
|
|
19432
19732
|
* Export request object describing the export properties and overrides for raw exports.
|
|
19433
19733
|
* @export
|
|
19434
|
-
* @interface
|
|
19734
|
+
* @interface RawExportAutomationRequest
|
|
19435
19735
|
*/
|
|
19436
|
-
export interface
|
|
19736
|
+
export interface RawExportAutomationRequest {
|
|
19437
19737
|
/**
|
|
19438
19738
|
* Requested resulting file type.
|
|
19439
19739
|
* @type {string}
|
|
19440
|
-
* @memberof
|
|
19740
|
+
* @memberof RawExportAutomationRequest
|
|
19441
19741
|
*/
|
|
19442
|
-
format:
|
|
19742
|
+
format: RawExportAutomationRequestFormatEnum;
|
|
19443
19743
|
/**
|
|
19444
19744
|
*
|
|
19445
19745
|
* @type {AFM}
|
|
19446
|
-
* @memberof
|
|
19746
|
+
* @memberof RawExportAutomationRequest
|
|
19447
19747
|
*/
|
|
19448
19748
|
execution: AFM;
|
|
19449
19749
|
/**
|
|
19450
19750
|
* Filename of downloaded file without extension.
|
|
19451
19751
|
* @type {string}
|
|
19452
|
-
* @memberof
|
|
19752
|
+
* @memberof RawExportAutomationRequest
|
|
19453
19753
|
*/
|
|
19454
19754
|
fileName: string;
|
|
19455
19755
|
/**
|
|
19456
19756
|
*
|
|
19457
19757
|
* @type {RawCustomOverride}
|
|
19458
|
-
* @memberof
|
|
19758
|
+
* @memberof RawExportAutomationRequest
|
|
19459
19759
|
*/
|
|
19460
19760
|
customOverride?: RawCustomOverride;
|
|
19461
19761
|
/**
|
|
19462
19762
|
*
|
|
19463
19763
|
* @type {ExecutionSettings}
|
|
19464
|
-
* @memberof
|
|
19764
|
+
* @memberof RawExportAutomationRequest
|
|
19465
19765
|
*/
|
|
19466
19766
|
executionSettings?: ExecutionSettings;
|
|
19767
|
+
/**
|
|
19768
|
+
* Free-form JSON object
|
|
19769
|
+
* @type {object}
|
|
19770
|
+
* @memberof RawExportAutomationRequest
|
|
19771
|
+
*/
|
|
19772
|
+
metadata?: object | null;
|
|
19467
19773
|
}
|
|
19468
|
-
export declare const
|
|
19774
|
+
export declare const RawExportAutomationRequestFormatEnum: {
|
|
19469
19775
|
readonly ARROW_FILE: "ARROW_FILE";
|
|
19470
19776
|
readonly ARROW_STREAM: "ARROW_STREAM";
|
|
19471
19777
|
readonly CSV: "CSV";
|
|
19472
19778
|
};
|
|
19473
|
-
export type
|
|
19779
|
+
export type RawExportAutomationRequestFormatEnum = typeof RawExportAutomationRequestFormatEnum[keyof typeof RawExportAutomationRequestFormatEnum];
|
|
19474
19780
|
/**
|
|
19475
19781
|
* A reference identifier.
|
|
19476
19782
|
* @export
|
|
@@ -25374,6 +25680,30 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
25374
25680
|
* @throws {RequiredError}
|
|
25375
25681
|
*/
|
|
25376
25682
|
setAutomations: (workspaceId: string, declarativeAutomation: Array<DeclarativeAutomation>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25683
|
+
/**
|
|
25684
|
+
*
|
|
25685
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
25686
|
+
* @param {*} [options] Override http request option.
|
|
25687
|
+
* @throws {RequiredError}
|
|
25688
|
+
*/
|
|
25689
|
+
unsubscribeAllAutomations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25690
|
+
/**
|
|
25691
|
+
*
|
|
25692
|
+
* @summary Unsubscribe from an automation
|
|
25693
|
+
* @param {string} workspaceId
|
|
25694
|
+
* @param {string} automationId
|
|
25695
|
+
* @param {*} [options] Override http request option.
|
|
25696
|
+
* @throws {RequiredError}
|
|
25697
|
+
*/
|
|
25698
|
+
unsubscribeAutomation: (workspaceId: string, automationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25699
|
+
/**
|
|
25700
|
+
*
|
|
25701
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
25702
|
+
* @param {string} workspaceId
|
|
25703
|
+
* @param {*} [options] Override http request option.
|
|
25704
|
+
* @throws {RequiredError}
|
|
25705
|
+
*/
|
|
25706
|
+
unsubscribeWorkspaceAutomations: (workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25377
25707
|
/**
|
|
25378
25708
|
*
|
|
25379
25709
|
* @summary Put an Automation
|
|
@@ -25472,6 +25802,30 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
25472
25802
|
* @throws {RequiredError}
|
|
25473
25803
|
*/
|
|
25474
25804
|
setAutomations(workspaceId: string, declarativeAutomation: Array<DeclarativeAutomation>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25805
|
+
/**
|
|
25806
|
+
*
|
|
25807
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
25808
|
+
* @param {*} [options] Override http request option.
|
|
25809
|
+
* @throws {RequiredError}
|
|
25810
|
+
*/
|
|
25811
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25812
|
+
/**
|
|
25813
|
+
*
|
|
25814
|
+
* @summary Unsubscribe from an automation
|
|
25815
|
+
* @param {string} workspaceId
|
|
25816
|
+
* @param {string} automationId
|
|
25817
|
+
* @param {*} [options] Override http request option.
|
|
25818
|
+
* @throws {RequiredError}
|
|
25819
|
+
*/
|
|
25820
|
+
unsubscribeAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25821
|
+
/**
|
|
25822
|
+
*
|
|
25823
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
25824
|
+
* @param {string} workspaceId
|
|
25825
|
+
* @param {*} [options] Override http request option.
|
|
25826
|
+
* @throws {RequiredError}
|
|
25827
|
+
*/
|
|
25828
|
+
unsubscribeWorkspaceAutomations(workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25475
25829
|
/**
|
|
25476
25830
|
*
|
|
25477
25831
|
* @summary Put an Automation
|
|
@@ -25546,6 +25900,29 @@ export declare const AutomationsApiFactory: (configuration?: Configuration, base
|
|
|
25546
25900
|
* @throws {RequiredError}
|
|
25547
25901
|
*/
|
|
25548
25902
|
setAutomations(requestParameters: AutomationsApiSetAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
25903
|
+
/**
|
|
25904
|
+
*
|
|
25905
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
25906
|
+
* @param {*} [options] Override http request option.
|
|
25907
|
+
* @throws {RequiredError}
|
|
25908
|
+
*/
|
|
25909
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
25910
|
+
/**
|
|
25911
|
+
*
|
|
25912
|
+
* @summary Unsubscribe from an automation
|
|
25913
|
+
* @param {AutomationsApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
25914
|
+
* @param {*} [options] Override http request option.
|
|
25915
|
+
* @throws {RequiredError}
|
|
25916
|
+
*/
|
|
25917
|
+
unsubscribeAutomation(requestParameters: AutomationsApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
25918
|
+
/**
|
|
25919
|
+
*
|
|
25920
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
25921
|
+
* @param {AutomationsApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
25922
|
+
* @param {*} [options] Override http request option.
|
|
25923
|
+
* @throws {RequiredError}
|
|
25924
|
+
*/
|
|
25925
|
+
unsubscribeWorkspaceAutomations(requestParameters: AutomationsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
25549
25926
|
/**
|
|
25550
25927
|
*
|
|
25551
25928
|
* @summary Put an Automation
|
|
@@ -25624,6 +26001,32 @@ export interface AutomationsApiInterface {
|
|
|
25624
26001
|
* @memberof AutomationsApiInterface
|
|
25625
26002
|
*/
|
|
25626
26003
|
setAutomations(requestParameters: AutomationsApiSetAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
26004
|
+
/**
|
|
26005
|
+
*
|
|
26006
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
26007
|
+
* @param {*} [options] Override http request option.
|
|
26008
|
+
* @throws {RequiredError}
|
|
26009
|
+
* @memberof AutomationsApiInterface
|
|
26010
|
+
*/
|
|
26011
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
26012
|
+
/**
|
|
26013
|
+
*
|
|
26014
|
+
* @summary Unsubscribe from an automation
|
|
26015
|
+
* @param {AutomationsApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
26016
|
+
* @param {*} [options] Override http request option.
|
|
26017
|
+
* @throws {RequiredError}
|
|
26018
|
+
* @memberof AutomationsApiInterface
|
|
26019
|
+
*/
|
|
26020
|
+
unsubscribeAutomation(requestParameters: AutomationsApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
26021
|
+
/**
|
|
26022
|
+
*
|
|
26023
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
26024
|
+
* @param {AutomationsApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
26025
|
+
* @param {*} [options] Override http request option.
|
|
26026
|
+
* @throws {RequiredError}
|
|
26027
|
+
* @memberof AutomationsApiInterface
|
|
26028
|
+
*/
|
|
26029
|
+
unsubscribeWorkspaceAutomations(requestParameters: AutomationsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
25627
26030
|
/**
|
|
25628
26031
|
*
|
|
25629
26032
|
* @summary Put an Automation
|
|
@@ -25869,6 +26272,38 @@ export interface AutomationsApiSetAutomationsRequest {
|
|
|
25869
26272
|
*/
|
|
25870
26273
|
readonly declarativeAutomation: Array<DeclarativeAutomation>;
|
|
25871
26274
|
}
|
|
26275
|
+
/**
|
|
26276
|
+
* Request parameters for unsubscribeAutomation operation in AutomationsApi.
|
|
26277
|
+
* @export
|
|
26278
|
+
* @interface AutomationsApiUnsubscribeAutomationRequest
|
|
26279
|
+
*/
|
|
26280
|
+
export interface AutomationsApiUnsubscribeAutomationRequest {
|
|
26281
|
+
/**
|
|
26282
|
+
*
|
|
26283
|
+
* @type {string}
|
|
26284
|
+
* @memberof AutomationsApiUnsubscribeAutomation
|
|
26285
|
+
*/
|
|
26286
|
+
readonly workspaceId: string;
|
|
26287
|
+
/**
|
|
26288
|
+
*
|
|
26289
|
+
* @type {string}
|
|
26290
|
+
* @memberof AutomationsApiUnsubscribeAutomation
|
|
26291
|
+
*/
|
|
26292
|
+
readonly automationId: string;
|
|
26293
|
+
}
|
|
26294
|
+
/**
|
|
26295
|
+
* Request parameters for unsubscribeWorkspaceAutomations operation in AutomationsApi.
|
|
26296
|
+
* @export
|
|
26297
|
+
* @interface AutomationsApiUnsubscribeWorkspaceAutomationsRequest
|
|
26298
|
+
*/
|
|
26299
|
+
export interface AutomationsApiUnsubscribeWorkspaceAutomationsRequest {
|
|
26300
|
+
/**
|
|
26301
|
+
*
|
|
26302
|
+
* @type {string}
|
|
26303
|
+
* @memberof AutomationsApiUnsubscribeWorkspaceAutomations
|
|
26304
|
+
*/
|
|
26305
|
+
readonly workspaceId: string;
|
|
26306
|
+
}
|
|
25872
26307
|
/**
|
|
25873
26308
|
* Request parameters for updateEntityAutomations operation in AutomationsApi.
|
|
25874
26309
|
* @export
|
|
@@ -25976,6 +26411,32 @@ export declare class AutomationsApi extends BaseAPI implements AutomationsApiInt
|
|
|
25976
26411
|
* @memberof AutomationsApi
|
|
25977
26412
|
*/
|
|
25978
26413
|
setAutomations(requestParameters: AutomationsApiSetAutomationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26414
|
+
/**
|
|
26415
|
+
*
|
|
26416
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
26417
|
+
* @param {*} [options] Override http request option.
|
|
26418
|
+
* @throws {RequiredError}
|
|
26419
|
+
* @memberof AutomationsApi
|
|
26420
|
+
*/
|
|
26421
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26422
|
+
/**
|
|
26423
|
+
*
|
|
26424
|
+
* @summary Unsubscribe from an automation
|
|
26425
|
+
* @param {AutomationsApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
26426
|
+
* @param {*} [options] Override http request option.
|
|
26427
|
+
* @throws {RequiredError}
|
|
26428
|
+
* @memberof AutomationsApi
|
|
26429
|
+
*/
|
|
26430
|
+
unsubscribeAutomation(requestParameters: AutomationsApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26431
|
+
/**
|
|
26432
|
+
*
|
|
26433
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
26434
|
+
* @param {AutomationsApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
26435
|
+
* @param {*} [options] Override http request option.
|
|
26436
|
+
* @throws {RequiredError}
|
|
26437
|
+
* @memberof AutomationsApi
|
|
26438
|
+
*/
|
|
26439
|
+
unsubscribeWorkspaceAutomations(requestParameters: AutomationsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
25979
26440
|
/**
|
|
25980
26441
|
*
|
|
25981
26442
|
* @summary Put an Automation
|
|
@@ -30379,7 +30840,7 @@ export declare const DatasetsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30379
30840
|
* @param {string} workspaceId
|
|
30380
30841
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
30381
30842
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30382
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30843
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30383
30844
|
* @param {number} [page] Zero-based page index (0..N)
|
|
30384
30845
|
* @param {number} [size] The size of the page to be returned
|
|
30385
30846
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -30388,20 +30849,20 @@ export declare const DatasetsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
30388
30849
|
* @param {*} [options] Override http request option.
|
|
30389
30850
|
* @throws {RequiredError}
|
|
30390
30851
|
*/
|
|
30391
|
-
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30852
|
+
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30392
30853
|
/**
|
|
30393
30854
|
*
|
|
30394
30855
|
* @summary Get a Dataset
|
|
30395
30856
|
* @param {string} workspaceId
|
|
30396
30857
|
* @param {string} objectId
|
|
30397
30858
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30398
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30859
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30399
30860
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
30400
30861
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
30401
30862
|
* @param {*} [options] Override http request option.
|
|
30402
30863
|
* @throws {RequiredError}
|
|
30403
30864
|
*/
|
|
30404
|
-
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30865
|
+
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30405
30866
|
};
|
|
30406
30867
|
/**
|
|
30407
30868
|
* DatasetsApi - functional programming interface
|
|
@@ -30414,7 +30875,7 @@ export declare const DatasetsApiFp: (configuration?: Configuration) => {
|
|
|
30414
30875
|
* @param {string} workspaceId
|
|
30415
30876
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
30416
30877
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30417
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30878
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30418
30879
|
* @param {number} [page] Zero-based page index (0..N)
|
|
30419
30880
|
* @param {number} [size] The size of the page to be returned
|
|
30420
30881
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -30423,20 +30884,20 @@ export declare const DatasetsApiFp: (configuration?: Configuration) => {
|
|
|
30423
30884
|
* @param {*} [options] Override http request option.
|
|
30424
30885
|
* @throws {RequiredError}
|
|
30425
30886
|
*/
|
|
30426
|
-
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
30887
|
+
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
30427
30888
|
/**
|
|
30428
30889
|
*
|
|
30429
30890
|
* @summary Get a Dataset
|
|
30430
30891
|
* @param {string} workspaceId
|
|
30431
30892
|
* @param {string} objectId
|
|
30432
30893
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
30433
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30894
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30434
30895
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
30435
30896
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
30436
30897
|
* @param {*} [options] Override http request option.
|
|
30437
30898
|
* @throws {RequiredError}
|
|
30438
30899
|
*/
|
|
30439
|
-
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
30900
|
+
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
30440
30901
|
};
|
|
30441
30902
|
/**
|
|
30442
30903
|
* DatasetsApi - factory interface
|
|
@@ -30511,10 +30972,10 @@ export interface DatasetsApiGetAllEntitiesDatasetsRequest {
|
|
|
30511
30972
|
readonly filter?: string;
|
|
30512
30973
|
/**
|
|
30513
30974
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30514
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
30975
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
30515
30976
|
* @memberof DatasetsApiGetAllEntitiesDatasets
|
|
30516
30977
|
*/
|
|
30517
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
30978
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
30518
30979
|
/**
|
|
30519
30980
|
* Zero-based page index (0..N)
|
|
30520
30981
|
* @type {number}
|
|
@@ -30572,10 +31033,10 @@ export interface DatasetsApiGetEntityDatasetsRequest {
|
|
|
30572
31033
|
readonly filter?: string;
|
|
30573
31034
|
/**
|
|
30574
31035
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30575
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
31036
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
30576
31037
|
* @memberof DatasetsApiGetEntityDatasets
|
|
30577
31038
|
*/
|
|
30578
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
31039
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
30579
31040
|
/**
|
|
30580
31041
|
*
|
|
30581
31042
|
* @type {boolean}
|
|
@@ -31325,6 +31786,21 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31325
31786
|
* @throws {RequiredError}
|
|
31326
31787
|
*/
|
|
31327
31788
|
deleteEntityWorkspaces: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31789
|
+
/**
|
|
31790
|
+
*
|
|
31791
|
+
* @param {string} workspaceId
|
|
31792
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
31793
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31794
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31795
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
31796
|
+
* @param {number} [size] The size of the page to be returned
|
|
31797
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
31798
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
31799
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31800
|
+
* @param {*} [options] Override http request option.
|
|
31801
|
+
* @throws {RequiredError}
|
|
31802
|
+
*/
|
|
31803
|
+
getAllEntitiesAggregatedFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31328
31804
|
/**
|
|
31329
31805
|
*
|
|
31330
31806
|
* @summary Get all Dashboards
|
|
@@ -31487,7 +31963,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31487
31963
|
* @param {string} workspaceId
|
|
31488
31964
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
31489
31965
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31490
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31966
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31491
31967
|
* @param {number} [page] Zero-based page index (0..N)
|
|
31492
31968
|
* @param {number} [size] The size of the page to be returned
|
|
31493
31969
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -31496,7 +31972,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31496
31972
|
* @param {*} [options] Override http request option.
|
|
31497
31973
|
* @throws {RequiredError}
|
|
31498
31974
|
*/
|
|
31499
|
-
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31975
|
+
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31500
31976
|
/**
|
|
31501
31977
|
* Space of the shared interest
|
|
31502
31978
|
* @summary Get Entitlements
|
|
@@ -31543,7 +32019,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31543
32019
|
* @param {string} workspaceId
|
|
31544
32020
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
31545
32021
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
31546
|
-
* @param {Array<'datasets' | '
|
|
32022
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
31547
32023
|
* @param {number} [page] Zero-based page index (0..N)
|
|
31548
32024
|
* @param {number} [size] The size of the page to be returned
|
|
31549
32025
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -31552,7 +32028,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31552
32028
|
* @param {*} [options] Override http request option.
|
|
31553
32029
|
* @throws {RequiredError}
|
|
31554
32030
|
*/
|
|
31555
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
32031
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31556
32032
|
/**
|
|
31557
32033
|
*
|
|
31558
32034
|
* @summary Get all Context Filters
|
|
@@ -31857,6 +32333,18 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31857
32333
|
* @throws {RequiredError}
|
|
31858
32334
|
*/
|
|
31859
32335
|
getDataSourceDrivers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32336
|
+
/**
|
|
32337
|
+
*
|
|
32338
|
+
* @param {string} workspaceId
|
|
32339
|
+
* @param {string} objectId
|
|
32340
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
32341
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
32342
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
32343
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
32344
|
+
* @param {*} [options] Override http request option.
|
|
32345
|
+
* @throws {RequiredError}
|
|
32346
|
+
*/
|
|
32347
|
+
getEntityAggregatedFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31860
32348
|
/**
|
|
31861
32349
|
*
|
|
31862
32350
|
* @summary Get a Dashboard
|
|
@@ -31997,13 +32485,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31997
32485
|
* @param {string} workspaceId
|
|
31998
32486
|
* @param {string} objectId
|
|
31999
32487
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
32000
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
32488
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
32001
32489
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
32002
32490
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
32003
32491
|
* @param {*} [options] Override http request option.
|
|
32004
32492
|
* @throws {RequiredError}
|
|
32005
32493
|
*/
|
|
32006
|
-
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32494
|
+
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32007
32495
|
/**
|
|
32008
32496
|
* Space of the shared interest
|
|
32009
32497
|
* @summary Get Entitlement
|
|
@@ -32041,13 +32529,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32041
32529
|
* @param {string} workspaceId
|
|
32042
32530
|
* @param {string} objectId
|
|
32043
32531
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
32044
|
-
* @param {Array<'datasets' | '
|
|
32532
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
32045
32533
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
32046
32534
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
32047
32535
|
* @param {*} [options] Override http request option.
|
|
32048
32536
|
* @throws {RequiredError}
|
|
32049
32537
|
*/
|
|
32050
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
32538
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32051
32539
|
/**
|
|
32052
32540
|
*
|
|
32053
32541
|
* @summary Get a Context Filter
|
|
@@ -33505,6 +33993,21 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33505
33993
|
* @throws {RequiredError}
|
|
33506
33994
|
*/
|
|
33507
33995
|
deleteEntityWorkspaces(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
33996
|
+
/**
|
|
33997
|
+
*
|
|
33998
|
+
* @param {string} workspaceId
|
|
33999
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
34000
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
34001
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34002
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
34003
|
+
* @param {number} [size] The size of the page to be returned
|
|
34004
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
34005
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
34006
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
34007
|
+
* @param {*} [options] Override http request option.
|
|
34008
|
+
* @throws {RequiredError}
|
|
34009
|
+
*/
|
|
34010
|
+
getAllEntitiesAggregatedFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutList>>;
|
|
33508
34011
|
/**
|
|
33509
34012
|
*
|
|
33510
34013
|
* @summary Get all Dashboards
|
|
@@ -33667,7 +34170,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33667
34170
|
* @param {string} workspaceId
|
|
33668
34171
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
33669
34172
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
33670
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34173
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
33671
34174
|
* @param {number} [page] Zero-based page index (0..N)
|
|
33672
34175
|
* @param {number} [size] The size of the page to be returned
|
|
33673
34176
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -33676,7 +34179,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33676
34179
|
* @param {*} [options] Override http request option.
|
|
33677
34180
|
* @throws {RequiredError}
|
|
33678
34181
|
*/
|
|
33679
|
-
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
34182
|
+
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
33680
34183
|
/**
|
|
33681
34184
|
* Space of the shared interest
|
|
33682
34185
|
* @summary Get Entitlements
|
|
@@ -33723,7 +34226,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33723
34226
|
* @param {string} workspaceId
|
|
33724
34227
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
33725
34228
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
33726
|
-
* @param {Array<'datasets' | '
|
|
34229
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
33727
34230
|
* @param {number} [page] Zero-based page index (0..N)
|
|
33728
34231
|
* @param {number} [size] The size of the page to be returned
|
|
33729
34232
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -33732,7 +34235,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
33732
34235
|
* @param {*} [options] Override http request option.
|
|
33733
34236
|
* @throws {RequiredError}
|
|
33734
34237
|
*/
|
|
33735
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
34238
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
33736
34239
|
/**
|
|
33737
34240
|
*
|
|
33738
34241
|
* @summary Get all Context Filters
|
|
@@ -34039,6 +34542,18 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
34039
34542
|
getDataSourceDrivers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
34040
34543
|
[key: string]: string;
|
|
34041
34544
|
}>>;
|
|
34545
|
+
/**
|
|
34546
|
+
*
|
|
34547
|
+
* @param {string} workspaceId
|
|
34548
|
+
* @param {string} objectId
|
|
34549
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
34550
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34551
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
34552
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
34553
|
+
* @param {*} [options] Override http request option.
|
|
34554
|
+
* @throws {RequiredError}
|
|
34555
|
+
*/
|
|
34556
|
+
getEntityAggregatedFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutDocument>>;
|
|
34042
34557
|
/**
|
|
34043
34558
|
*
|
|
34044
34559
|
* @summary Get a Dashboard
|
|
@@ -34179,13 +34694,13 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
34179
34694
|
* @param {string} workspaceId
|
|
34180
34695
|
* @param {string} objectId
|
|
34181
34696
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
34182
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34697
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34183
34698
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
34184
34699
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
34185
34700
|
* @param {*} [options] Override http request option.
|
|
34186
34701
|
* @throws {RequiredError}
|
|
34187
34702
|
*/
|
|
34188
|
-
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
34703
|
+
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
34189
34704
|
/**
|
|
34190
34705
|
* Space of the shared interest
|
|
34191
34706
|
* @summary Get Entitlement
|
|
@@ -34223,13 +34738,13 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
34223
34738
|
* @param {string} workspaceId
|
|
34224
34739
|
* @param {string} objectId
|
|
34225
34740
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
34226
|
-
* @param {Array<'datasets' | '
|
|
34741
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
34227
34742
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
34228
34743
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
34229
34744
|
* @param {*} [options] Override http request option.
|
|
34230
34745
|
* @throws {RequiredError}
|
|
34231
34746
|
*/
|
|
34232
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
34747
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
34233
34748
|
/**
|
|
34234
34749
|
*
|
|
34235
34750
|
* @summary Get a Context Filter
|
|
@@ -35596,6 +36111,13 @@ export declare const EntitiesApiFactory: (configuration?: Configuration, basePat
|
|
|
35596
36111
|
* @throws {RequiredError}
|
|
35597
36112
|
*/
|
|
35598
36113
|
deleteEntityWorkspaces(requestParameters: EntitiesApiDeleteEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
36114
|
+
/**
|
|
36115
|
+
*
|
|
36116
|
+
* @param {EntitiesApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
36117
|
+
* @param {*} [options] Override http request option.
|
|
36118
|
+
* @throws {RequiredError}
|
|
36119
|
+
*/
|
|
36120
|
+
getAllEntitiesAggregatedFacts(requestParameters: EntitiesApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
35599
36121
|
/**
|
|
35600
36122
|
*
|
|
35601
36123
|
* @summary Get all Dashboards
|
|
@@ -35907,6 +36429,13 @@ export declare const EntitiesApiFactory: (configuration?: Configuration, basePat
|
|
|
35907
36429
|
getDataSourceDrivers(options?: AxiosRequestConfig): AxiosPromise<{
|
|
35908
36430
|
[key: string]: string;
|
|
35909
36431
|
}>;
|
|
36432
|
+
/**
|
|
36433
|
+
*
|
|
36434
|
+
* @param {EntitiesApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
36435
|
+
* @param {*} [options] Override http request option.
|
|
36436
|
+
* @throws {RequiredError}
|
|
36437
|
+
*/
|
|
36438
|
+
getEntityAggregatedFacts(requestParameters: EntitiesApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
35910
36439
|
/**
|
|
35911
36440
|
*
|
|
35912
36441
|
* @summary Get a Dashboard
|
|
@@ -37226,6 +37755,14 @@ export interface EntitiesApiInterface {
|
|
|
37226
37755
|
* @memberof EntitiesApiInterface
|
|
37227
37756
|
*/
|
|
37228
37757
|
deleteEntityWorkspaces(requestParameters: EntitiesApiDeleteEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
37758
|
+
/**
|
|
37759
|
+
*
|
|
37760
|
+
* @param {EntitiesApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
37761
|
+
* @param {*} [options] Override http request option.
|
|
37762
|
+
* @throws {RequiredError}
|
|
37763
|
+
* @memberof EntitiesApiInterface
|
|
37764
|
+
*/
|
|
37765
|
+
getAllEntitiesAggregatedFacts(requestParameters: EntitiesApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
37229
37766
|
/**
|
|
37230
37767
|
*
|
|
37231
37768
|
* @summary Get all Dashboards
|
|
@@ -37576,6 +38113,14 @@ export interface EntitiesApiInterface {
|
|
|
37576
38113
|
getDataSourceDrivers(options?: AxiosRequestConfig): AxiosPromise<{
|
|
37577
38114
|
[key: string]: string;
|
|
37578
38115
|
}>;
|
|
38116
|
+
/**
|
|
38117
|
+
*
|
|
38118
|
+
* @param {EntitiesApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
38119
|
+
* @param {*} [options] Override http request option.
|
|
38120
|
+
* @throws {RequiredError}
|
|
38121
|
+
* @memberof EntitiesApiInterface
|
|
38122
|
+
*/
|
|
38123
|
+
getEntityAggregatedFacts(requestParameters: EntitiesApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
37579
38124
|
/**
|
|
37580
38125
|
*
|
|
37581
38126
|
* @summary Get a Dashboard
|
|
@@ -39767,6 +40312,67 @@ export interface EntitiesApiDeleteEntityWorkspacesRequest {
|
|
|
39767
40312
|
*/
|
|
39768
40313
|
readonly filter?: string;
|
|
39769
40314
|
}
|
|
40315
|
+
/**
|
|
40316
|
+
* Request parameters for getAllEntitiesAggregatedFacts operation in EntitiesApi.
|
|
40317
|
+
* @export
|
|
40318
|
+
* @interface EntitiesApiGetAllEntitiesAggregatedFactsRequest
|
|
40319
|
+
*/
|
|
40320
|
+
export interface EntitiesApiGetAllEntitiesAggregatedFactsRequest {
|
|
40321
|
+
/**
|
|
40322
|
+
*
|
|
40323
|
+
* @type {string}
|
|
40324
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40325
|
+
*/
|
|
40326
|
+
readonly workspaceId: string;
|
|
40327
|
+
/**
|
|
40328
|
+
*
|
|
40329
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
40330
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40331
|
+
*/
|
|
40332
|
+
readonly origin?: "ALL" | "PARENTS" | "NATIVE";
|
|
40333
|
+
/**
|
|
40334
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
40335
|
+
* @type {string}
|
|
40336
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40337
|
+
*/
|
|
40338
|
+
readonly filter?: string;
|
|
40339
|
+
/**
|
|
40340
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40341
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
40342
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40343
|
+
*/
|
|
40344
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
40345
|
+
/**
|
|
40346
|
+
* Zero-based page index (0..N)
|
|
40347
|
+
* @type {number}
|
|
40348
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40349
|
+
*/
|
|
40350
|
+
readonly page?: number;
|
|
40351
|
+
/**
|
|
40352
|
+
* The size of the page to be returned
|
|
40353
|
+
* @type {number}
|
|
40354
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40355
|
+
*/
|
|
40356
|
+
readonly size?: number;
|
|
40357
|
+
/**
|
|
40358
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
40359
|
+
* @type {Array<string>}
|
|
40360
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40361
|
+
*/
|
|
40362
|
+
readonly sort?: Array<string>;
|
|
40363
|
+
/**
|
|
40364
|
+
*
|
|
40365
|
+
* @type {boolean}
|
|
40366
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40367
|
+
*/
|
|
40368
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
40369
|
+
/**
|
|
40370
|
+
* Include Meta objects.
|
|
40371
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
40372
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
40373
|
+
*/
|
|
40374
|
+
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
40375
|
+
}
|
|
39770
40376
|
/**
|
|
39771
40377
|
* Request parameters for getAllEntitiesAnalyticalDashboards operation in EntitiesApi.
|
|
39772
40378
|
* @export
|
|
@@ -40344,10 +40950,10 @@ export interface EntitiesApiGetAllEntitiesDatasetsRequest {
|
|
|
40344
40950
|
readonly filter?: string;
|
|
40345
40951
|
/**
|
|
40346
40952
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40347
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
40953
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
40348
40954
|
* @memberof EntitiesApiGetAllEntitiesDatasets
|
|
40349
40955
|
*/
|
|
40350
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
40956
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
40351
40957
|
/**
|
|
40352
40958
|
* Zero-based page index (0..N)
|
|
40353
40959
|
* @type {number}
|
|
@@ -40540,10 +41146,10 @@ export interface EntitiesApiGetAllEntitiesFactsRequest {
|
|
|
40540
41146
|
readonly filter?: string;
|
|
40541
41147
|
/**
|
|
40542
41148
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40543
|
-
* @type {Array<'datasets' | '
|
|
41149
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
40544
41150
|
* @memberof EntitiesApiGetAllEntitiesFacts
|
|
40545
41151
|
*/
|
|
40546
|
-
readonly include?: Array<"datasets" | "
|
|
41152
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
40547
41153
|
/**
|
|
40548
41154
|
* Zero-based page index (0..N)
|
|
40549
41155
|
* @type {number}
|
|
@@ -41586,6 +42192,49 @@ export interface EntitiesApiGetAllEntitiesWorkspacesRequest {
|
|
|
41586
42192
|
*/
|
|
41587
42193
|
readonly metaInclude?: Array<"config" | "permissions" | "hierarchy" | "dataModelDatasets" | "page" | "all" | "ALL">;
|
|
41588
42194
|
}
|
|
42195
|
+
/**
|
|
42196
|
+
* Request parameters for getEntityAggregatedFacts operation in EntitiesApi.
|
|
42197
|
+
* @export
|
|
42198
|
+
* @interface EntitiesApiGetEntityAggregatedFactsRequest
|
|
42199
|
+
*/
|
|
42200
|
+
export interface EntitiesApiGetEntityAggregatedFactsRequest {
|
|
42201
|
+
/**
|
|
42202
|
+
*
|
|
42203
|
+
* @type {string}
|
|
42204
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
42205
|
+
*/
|
|
42206
|
+
readonly workspaceId: string;
|
|
42207
|
+
/**
|
|
42208
|
+
*
|
|
42209
|
+
* @type {string}
|
|
42210
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
42211
|
+
*/
|
|
42212
|
+
readonly objectId: string;
|
|
42213
|
+
/**
|
|
42214
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
42215
|
+
* @type {string}
|
|
42216
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
42217
|
+
*/
|
|
42218
|
+
readonly filter?: string;
|
|
42219
|
+
/**
|
|
42220
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
42221
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
42222
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
42223
|
+
*/
|
|
42224
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
42225
|
+
/**
|
|
42226
|
+
*
|
|
42227
|
+
* @type {boolean}
|
|
42228
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
42229
|
+
*/
|
|
42230
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
42231
|
+
/**
|
|
42232
|
+
* Include Meta objects.
|
|
42233
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
42234
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
42235
|
+
*/
|
|
42236
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
42237
|
+
}
|
|
41589
42238
|
/**
|
|
41590
42239
|
* Request parameters for getEntityAnalyticalDashboards operation in EntitiesApi.
|
|
41591
42240
|
* @export
|
|
@@ -41996,10 +42645,10 @@ export interface EntitiesApiGetEntityDatasetsRequest {
|
|
|
41996
42645
|
readonly filter?: string;
|
|
41997
42646
|
/**
|
|
41998
42647
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
41999
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
42648
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
42000
42649
|
* @memberof EntitiesApiGetEntityDatasets
|
|
42001
42650
|
*/
|
|
42002
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
42651
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
42003
42652
|
/**
|
|
42004
42653
|
*
|
|
42005
42654
|
* @type {boolean}
|
|
@@ -42120,10 +42769,10 @@ export interface EntitiesApiGetEntityFactsRequest {
|
|
|
42120
42769
|
readonly filter?: string;
|
|
42121
42770
|
/**
|
|
42122
42771
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
42123
|
-
* @type {Array<'datasets' | '
|
|
42772
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
42124
42773
|
* @memberof EntitiesApiGetEntityFacts
|
|
42125
42774
|
*/
|
|
42126
|
-
readonly include?: Array<"datasets" | "
|
|
42775
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
42127
42776
|
/**
|
|
42128
42777
|
*
|
|
42129
42778
|
* @type {boolean}
|
|
@@ -45183,6 +45832,14 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
45183
45832
|
* @memberof EntitiesApi
|
|
45184
45833
|
*/
|
|
45185
45834
|
deleteEntityWorkspaces(requestParameters: EntitiesApiDeleteEntityWorkspacesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
45835
|
+
/**
|
|
45836
|
+
*
|
|
45837
|
+
* @param {EntitiesApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
45838
|
+
* @param {*} [options] Override http request option.
|
|
45839
|
+
* @throws {RequiredError}
|
|
45840
|
+
* @memberof EntitiesApi
|
|
45841
|
+
*/
|
|
45842
|
+
getAllEntitiesAggregatedFacts(requestParameters: EntitiesApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiAggregatedFactOutList, any>>;
|
|
45186
45843
|
/**
|
|
45187
45844
|
*
|
|
45188
45845
|
* @summary Get all Dashboards
|
|
@@ -45533,6 +46190,14 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
45533
46190
|
getDataSourceDrivers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
45534
46191
|
[key: string]: string;
|
|
45535
46192
|
}, any>>;
|
|
46193
|
+
/**
|
|
46194
|
+
*
|
|
46195
|
+
* @param {EntitiesApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
46196
|
+
* @param {*} [options] Override http request option.
|
|
46197
|
+
* @throws {RequiredError}
|
|
46198
|
+
* @memberof EntitiesApi
|
|
46199
|
+
*/
|
|
46200
|
+
getEntityAggregatedFacts(requestParameters: EntitiesApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiAggregatedFactOutDocument, any>>;
|
|
45536
46201
|
/**
|
|
45537
46202
|
*
|
|
45538
46203
|
* @summary Get a Dashboard
|
|
@@ -47270,6 +47935,449 @@ export declare class ExportDefinitionsApi extends BaseAPI implements ExportDefin
|
|
|
47270
47935
|
*/
|
|
47271
47936
|
updateEntityExportDefinitions(requestParameters: ExportDefinitionsApiUpdateEntityExportDefinitionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiExportDefinitionOutDocument, any>>;
|
|
47272
47937
|
}
|
|
47938
|
+
/**
|
|
47939
|
+
* ExportTemplatesApi - axios parameter creator
|
|
47940
|
+
* @export
|
|
47941
|
+
*/
|
|
47942
|
+
export declare const ExportTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
47943
|
+
/**
|
|
47944
|
+
*
|
|
47945
|
+
* @summary Post Export Template entities
|
|
47946
|
+
* @param {JsonApiExportTemplatePostOptionalIdDocument} jsonApiExportTemplatePostOptionalIdDocument
|
|
47947
|
+
* @param {*} [options] Override http request option.
|
|
47948
|
+
* @throws {RequiredError}
|
|
47949
|
+
*/
|
|
47950
|
+
createEntityExportTemplates: (jsonApiExportTemplatePostOptionalIdDocument: JsonApiExportTemplatePostOptionalIdDocument, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47951
|
+
/**
|
|
47952
|
+
*
|
|
47953
|
+
* @summary Delete Export Template entity
|
|
47954
|
+
* @param {string} id
|
|
47955
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47956
|
+
* @param {*} [options] Override http request option.
|
|
47957
|
+
* @throws {RequiredError}
|
|
47958
|
+
*/
|
|
47959
|
+
deleteEntityExportTemplates: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47960
|
+
/**
|
|
47961
|
+
*
|
|
47962
|
+
* @summary GET all Export Template entities
|
|
47963
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47964
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
47965
|
+
* @param {number} [size] The size of the page to be returned
|
|
47966
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
47967
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
47968
|
+
* @param {*} [options] Override http request option.
|
|
47969
|
+
* @throws {RequiredError}
|
|
47970
|
+
*/
|
|
47971
|
+
getAllEntitiesExportTemplates: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47972
|
+
/**
|
|
47973
|
+
*
|
|
47974
|
+
* @summary GET Export Template entity
|
|
47975
|
+
* @param {string} id
|
|
47976
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47977
|
+
* @param {*} [options] Override http request option.
|
|
47978
|
+
* @throws {RequiredError}
|
|
47979
|
+
*/
|
|
47980
|
+
getEntityExportTemplates: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47981
|
+
/**
|
|
47982
|
+
*
|
|
47983
|
+
* @summary Patch Export Template entity
|
|
47984
|
+
* @param {string} id
|
|
47985
|
+
* @param {JsonApiExportTemplatePatchDocument} jsonApiExportTemplatePatchDocument
|
|
47986
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47987
|
+
* @param {*} [options] Override http request option.
|
|
47988
|
+
* @throws {RequiredError}
|
|
47989
|
+
*/
|
|
47990
|
+
patchEntityExportTemplates: (id: string, jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47991
|
+
/**
|
|
47992
|
+
*
|
|
47993
|
+
* @summary PUT Export Template entity
|
|
47994
|
+
* @param {string} id
|
|
47995
|
+
* @param {JsonApiExportTemplateInDocument} jsonApiExportTemplateInDocument
|
|
47996
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47997
|
+
* @param {*} [options] Override http request option.
|
|
47998
|
+
* @throws {RequiredError}
|
|
47999
|
+
*/
|
|
48000
|
+
updateEntityExportTemplates: (id: string, jsonApiExportTemplateInDocument: JsonApiExportTemplateInDocument, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48001
|
+
};
|
|
48002
|
+
/**
|
|
48003
|
+
* ExportTemplatesApi - functional programming interface
|
|
48004
|
+
* @export
|
|
48005
|
+
*/
|
|
48006
|
+
export declare const ExportTemplatesApiFp: (configuration?: Configuration) => {
|
|
48007
|
+
/**
|
|
48008
|
+
*
|
|
48009
|
+
* @summary Post Export Template entities
|
|
48010
|
+
* @param {JsonApiExportTemplatePostOptionalIdDocument} jsonApiExportTemplatePostOptionalIdDocument
|
|
48011
|
+
* @param {*} [options] Override http request option.
|
|
48012
|
+
* @throws {RequiredError}
|
|
48013
|
+
*/
|
|
48014
|
+
createEntityExportTemplates(jsonApiExportTemplatePostOptionalIdDocument: JsonApiExportTemplatePostOptionalIdDocument, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
48015
|
+
/**
|
|
48016
|
+
*
|
|
48017
|
+
* @summary Delete Export Template entity
|
|
48018
|
+
* @param {string} id
|
|
48019
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48020
|
+
* @param {*} [options] Override http request option.
|
|
48021
|
+
* @throws {RequiredError}
|
|
48022
|
+
*/
|
|
48023
|
+
deleteEntityExportTemplates(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
48024
|
+
/**
|
|
48025
|
+
*
|
|
48026
|
+
* @summary GET all Export Template entities
|
|
48027
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48028
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
48029
|
+
* @param {number} [size] The size of the page to be returned
|
|
48030
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
48031
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
48032
|
+
* @param {*} [options] Override http request option.
|
|
48033
|
+
* @throws {RequiredError}
|
|
48034
|
+
*/
|
|
48035
|
+
getAllEntitiesExportTemplates(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutList>>;
|
|
48036
|
+
/**
|
|
48037
|
+
*
|
|
48038
|
+
* @summary GET Export Template entity
|
|
48039
|
+
* @param {string} id
|
|
48040
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48041
|
+
* @param {*} [options] Override http request option.
|
|
48042
|
+
* @throws {RequiredError}
|
|
48043
|
+
*/
|
|
48044
|
+
getEntityExportTemplates(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
48045
|
+
/**
|
|
48046
|
+
*
|
|
48047
|
+
* @summary Patch Export Template entity
|
|
48048
|
+
* @param {string} id
|
|
48049
|
+
* @param {JsonApiExportTemplatePatchDocument} jsonApiExportTemplatePatchDocument
|
|
48050
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48051
|
+
* @param {*} [options] Override http request option.
|
|
48052
|
+
* @throws {RequiredError}
|
|
48053
|
+
*/
|
|
48054
|
+
patchEntityExportTemplates(id: string, jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
48055
|
+
/**
|
|
48056
|
+
*
|
|
48057
|
+
* @summary PUT Export Template entity
|
|
48058
|
+
* @param {string} id
|
|
48059
|
+
* @param {JsonApiExportTemplateInDocument} jsonApiExportTemplateInDocument
|
|
48060
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48061
|
+
* @param {*} [options] Override http request option.
|
|
48062
|
+
* @throws {RequiredError}
|
|
48063
|
+
*/
|
|
48064
|
+
updateEntityExportTemplates(id: string, jsonApiExportTemplateInDocument: JsonApiExportTemplateInDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
48065
|
+
};
|
|
48066
|
+
/**
|
|
48067
|
+
* ExportTemplatesApi - factory interface
|
|
48068
|
+
* @export
|
|
48069
|
+
*/
|
|
48070
|
+
export declare const ExportTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48071
|
+
/**
|
|
48072
|
+
*
|
|
48073
|
+
* @summary Post Export Template entities
|
|
48074
|
+
* @param {ExportTemplatesApiCreateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48075
|
+
* @param {*} [options] Override http request option.
|
|
48076
|
+
* @throws {RequiredError}
|
|
48077
|
+
*/
|
|
48078
|
+
createEntityExportTemplates(requestParameters: ExportTemplatesApiCreateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48079
|
+
/**
|
|
48080
|
+
*
|
|
48081
|
+
* @summary Delete Export Template entity
|
|
48082
|
+
* @param {ExportTemplatesApiDeleteEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48083
|
+
* @param {*} [options] Override http request option.
|
|
48084
|
+
* @throws {RequiredError}
|
|
48085
|
+
*/
|
|
48086
|
+
deleteEntityExportTemplates(requestParameters: ExportTemplatesApiDeleteEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
48087
|
+
/**
|
|
48088
|
+
*
|
|
48089
|
+
* @summary GET all Export Template entities
|
|
48090
|
+
* @param {ExportTemplatesApiGetAllEntitiesExportTemplatesRequest} requestParameters Request parameters.
|
|
48091
|
+
* @param {*} [options] Override http request option.
|
|
48092
|
+
* @throws {RequiredError}
|
|
48093
|
+
*/
|
|
48094
|
+
getAllEntitiesExportTemplates(requestParameters: ExportTemplatesApiGetAllEntitiesExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutList>;
|
|
48095
|
+
/**
|
|
48096
|
+
*
|
|
48097
|
+
* @summary GET Export Template entity
|
|
48098
|
+
* @param {ExportTemplatesApiGetEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48099
|
+
* @param {*} [options] Override http request option.
|
|
48100
|
+
* @throws {RequiredError}
|
|
48101
|
+
*/
|
|
48102
|
+
getEntityExportTemplates(requestParameters: ExportTemplatesApiGetEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48103
|
+
/**
|
|
48104
|
+
*
|
|
48105
|
+
* @summary Patch Export Template entity
|
|
48106
|
+
* @param {ExportTemplatesApiPatchEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48107
|
+
* @param {*} [options] Override http request option.
|
|
48108
|
+
* @throws {RequiredError}
|
|
48109
|
+
*/
|
|
48110
|
+
patchEntityExportTemplates(requestParameters: ExportTemplatesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48111
|
+
/**
|
|
48112
|
+
*
|
|
48113
|
+
* @summary PUT Export Template entity
|
|
48114
|
+
* @param {ExportTemplatesApiUpdateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48115
|
+
* @param {*} [options] Override http request option.
|
|
48116
|
+
* @throws {RequiredError}
|
|
48117
|
+
*/
|
|
48118
|
+
updateEntityExportTemplates(requestParameters: ExportTemplatesApiUpdateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48119
|
+
};
|
|
48120
|
+
/**
|
|
48121
|
+
* ExportTemplatesApi - interface
|
|
48122
|
+
* @export
|
|
48123
|
+
* @interface ExportTemplatesApi
|
|
48124
|
+
*/
|
|
48125
|
+
export interface ExportTemplatesApiInterface {
|
|
48126
|
+
/**
|
|
48127
|
+
*
|
|
48128
|
+
* @summary Post Export Template entities
|
|
48129
|
+
* @param {ExportTemplatesApiCreateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48130
|
+
* @param {*} [options] Override http request option.
|
|
48131
|
+
* @throws {RequiredError}
|
|
48132
|
+
* @memberof ExportTemplatesApiInterface
|
|
48133
|
+
*/
|
|
48134
|
+
createEntityExportTemplates(requestParameters: ExportTemplatesApiCreateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48135
|
+
/**
|
|
48136
|
+
*
|
|
48137
|
+
* @summary Delete Export Template entity
|
|
48138
|
+
* @param {ExportTemplatesApiDeleteEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48139
|
+
* @param {*} [options] Override http request option.
|
|
48140
|
+
* @throws {RequiredError}
|
|
48141
|
+
* @memberof ExportTemplatesApiInterface
|
|
48142
|
+
*/
|
|
48143
|
+
deleteEntityExportTemplates(requestParameters: ExportTemplatesApiDeleteEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
48144
|
+
/**
|
|
48145
|
+
*
|
|
48146
|
+
* @summary GET all Export Template entities
|
|
48147
|
+
* @param {ExportTemplatesApiGetAllEntitiesExportTemplatesRequest} requestParameters Request parameters.
|
|
48148
|
+
* @param {*} [options] Override http request option.
|
|
48149
|
+
* @throws {RequiredError}
|
|
48150
|
+
* @memberof ExportTemplatesApiInterface
|
|
48151
|
+
*/
|
|
48152
|
+
getAllEntitiesExportTemplates(requestParameters: ExportTemplatesApiGetAllEntitiesExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutList>;
|
|
48153
|
+
/**
|
|
48154
|
+
*
|
|
48155
|
+
* @summary GET Export Template entity
|
|
48156
|
+
* @param {ExportTemplatesApiGetEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48157
|
+
* @param {*} [options] Override http request option.
|
|
48158
|
+
* @throws {RequiredError}
|
|
48159
|
+
* @memberof ExportTemplatesApiInterface
|
|
48160
|
+
*/
|
|
48161
|
+
getEntityExportTemplates(requestParameters: ExportTemplatesApiGetEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48162
|
+
/**
|
|
48163
|
+
*
|
|
48164
|
+
* @summary Patch Export Template entity
|
|
48165
|
+
* @param {ExportTemplatesApiPatchEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48166
|
+
* @param {*} [options] Override http request option.
|
|
48167
|
+
* @throws {RequiredError}
|
|
48168
|
+
* @memberof ExportTemplatesApiInterface
|
|
48169
|
+
*/
|
|
48170
|
+
patchEntityExportTemplates(requestParameters: ExportTemplatesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48171
|
+
/**
|
|
48172
|
+
*
|
|
48173
|
+
* @summary PUT Export Template entity
|
|
48174
|
+
* @param {ExportTemplatesApiUpdateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48175
|
+
* @param {*} [options] Override http request option.
|
|
48176
|
+
* @throws {RequiredError}
|
|
48177
|
+
* @memberof ExportTemplatesApiInterface
|
|
48178
|
+
*/
|
|
48179
|
+
updateEntityExportTemplates(requestParameters: ExportTemplatesApiUpdateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
48180
|
+
}
|
|
48181
|
+
/**
|
|
48182
|
+
* Request parameters for createEntityExportTemplates operation in ExportTemplatesApi.
|
|
48183
|
+
* @export
|
|
48184
|
+
* @interface ExportTemplatesApiCreateEntityExportTemplatesRequest
|
|
48185
|
+
*/
|
|
48186
|
+
export interface ExportTemplatesApiCreateEntityExportTemplatesRequest {
|
|
48187
|
+
/**
|
|
48188
|
+
*
|
|
48189
|
+
* @type {JsonApiExportTemplatePostOptionalIdDocument}
|
|
48190
|
+
* @memberof ExportTemplatesApiCreateEntityExportTemplates
|
|
48191
|
+
*/
|
|
48192
|
+
readonly jsonApiExportTemplatePostOptionalIdDocument: JsonApiExportTemplatePostOptionalIdDocument;
|
|
48193
|
+
}
|
|
48194
|
+
/**
|
|
48195
|
+
* Request parameters for deleteEntityExportTemplates operation in ExportTemplatesApi.
|
|
48196
|
+
* @export
|
|
48197
|
+
* @interface ExportTemplatesApiDeleteEntityExportTemplatesRequest
|
|
48198
|
+
*/
|
|
48199
|
+
export interface ExportTemplatesApiDeleteEntityExportTemplatesRequest {
|
|
48200
|
+
/**
|
|
48201
|
+
*
|
|
48202
|
+
* @type {string}
|
|
48203
|
+
* @memberof ExportTemplatesApiDeleteEntityExportTemplates
|
|
48204
|
+
*/
|
|
48205
|
+
readonly id: string;
|
|
48206
|
+
/**
|
|
48207
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48208
|
+
* @type {string}
|
|
48209
|
+
* @memberof ExportTemplatesApiDeleteEntityExportTemplates
|
|
48210
|
+
*/
|
|
48211
|
+
readonly filter?: string;
|
|
48212
|
+
}
|
|
48213
|
+
/**
|
|
48214
|
+
* Request parameters for getAllEntitiesExportTemplates operation in ExportTemplatesApi.
|
|
48215
|
+
* @export
|
|
48216
|
+
* @interface ExportTemplatesApiGetAllEntitiesExportTemplatesRequest
|
|
48217
|
+
*/
|
|
48218
|
+
export interface ExportTemplatesApiGetAllEntitiesExportTemplatesRequest {
|
|
48219
|
+
/**
|
|
48220
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48221
|
+
* @type {string}
|
|
48222
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
48223
|
+
*/
|
|
48224
|
+
readonly filter?: string;
|
|
48225
|
+
/**
|
|
48226
|
+
* Zero-based page index (0..N)
|
|
48227
|
+
* @type {number}
|
|
48228
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
48229
|
+
*/
|
|
48230
|
+
readonly page?: number;
|
|
48231
|
+
/**
|
|
48232
|
+
* The size of the page to be returned
|
|
48233
|
+
* @type {number}
|
|
48234
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
48235
|
+
*/
|
|
48236
|
+
readonly size?: number;
|
|
48237
|
+
/**
|
|
48238
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
48239
|
+
* @type {Array<string>}
|
|
48240
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
48241
|
+
*/
|
|
48242
|
+
readonly sort?: Array<string>;
|
|
48243
|
+
/**
|
|
48244
|
+
* Include Meta objects.
|
|
48245
|
+
* @type {Array<'page' | 'all' | 'ALL'>}
|
|
48246
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
48247
|
+
*/
|
|
48248
|
+
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
48249
|
+
}
|
|
48250
|
+
/**
|
|
48251
|
+
* Request parameters for getEntityExportTemplates operation in ExportTemplatesApi.
|
|
48252
|
+
* @export
|
|
48253
|
+
* @interface ExportTemplatesApiGetEntityExportTemplatesRequest
|
|
48254
|
+
*/
|
|
48255
|
+
export interface ExportTemplatesApiGetEntityExportTemplatesRequest {
|
|
48256
|
+
/**
|
|
48257
|
+
*
|
|
48258
|
+
* @type {string}
|
|
48259
|
+
* @memberof ExportTemplatesApiGetEntityExportTemplates
|
|
48260
|
+
*/
|
|
48261
|
+
readonly id: string;
|
|
48262
|
+
/**
|
|
48263
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48264
|
+
* @type {string}
|
|
48265
|
+
* @memberof ExportTemplatesApiGetEntityExportTemplates
|
|
48266
|
+
*/
|
|
48267
|
+
readonly filter?: string;
|
|
48268
|
+
}
|
|
48269
|
+
/**
|
|
48270
|
+
* Request parameters for patchEntityExportTemplates operation in ExportTemplatesApi.
|
|
48271
|
+
* @export
|
|
48272
|
+
* @interface ExportTemplatesApiPatchEntityExportTemplatesRequest
|
|
48273
|
+
*/
|
|
48274
|
+
export interface ExportTemplatesApiPatchEntityExportTemplatesRequest {
|
|
48275
|
+
/**
|
|
48276
|
+
*
|
|
48277
|
+
* @type {string}
|
|
48278
|
+
* @memberof ExportTemplatesApiPatchEntityExportTemplates
|
|
48279
|
+
*/
|
|
48280
|
+
readonly id: string;
|
|
48281
|
+
/**
|
|
48282
|
+
*
|
|
48283
|
+
* @type {JsonApiExportTemplatePatchDocument}
|
|
48284
|
+
* @memberof ExportTemplatesApiPatchEntityExportTemplates
|
|
48285
|
+
*/
|
|
48286
|
+
readonly jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument;
|
|
48287
|
+
/**
|
|
48288
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48289
|
+
* @type {string}
|
|
48290
|
+
* @memberof ExportTemplatesApiPatchEntityExportTemplates
|
|
48291
|
+
*/
|
|
48292
|
+
readonly filter?: string;
|
|
48293
|
+
}
|
|
48294
|
+
/**
|
|
48295
|
+
* Request parameters for updateEntityExportTemplates operation in ExportTemplatesApi.
|
|
48296
|
+
* @export
|
|
48297
|
+
* @interface ExportTemplatesApiUpdateEntityExportTemplatesRequest
|
|
48298
|
+
*/
|
|
48299
|
+
export interface ExportTemplatesApiUpdateEntityExportTemplatesRequest {
|
|
48300
|
+
/**
|
|
48301
|
+
*
|
|
48302
|
+
* @type {string}
|
|
48303
|
+
* @memberof ExportTemplatesApiUpdateEntityExportTemplates
|
|
48304
|
+
*/
|
|
48305
|
+
readonly id: string;
|
|
48306
|
+
/**
|
|
48307
|
+
*
|
|
48308
|
+
* @type {JsonApiExportTemplateInDocument}
|
|
48309
|
+
* @memberof ExportTemplatesApiUpdateEntityExportTemplates
|
|
48310
|
+
*/
|
|
48311
|
+
readonly jsonApiExportTemplateInDocument: JsonApiExportTemplateInDocument;
|
|
48312
|
+
/**
|
|
48313
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
48314
|
+
* @type {string}
|
|
48315
|
+
* @memberof ExportTemplatesApiUpdateEntityExportTemplates
|
|
48316
|
+
*/
|
|
48317
|
+
readonly filter?: string;
|
|
48318
|
+
}
|
|
48319
|
+
/**
|
|
48320
|
+
* ExportTemplatesApi - object-oriented interface
|
|
48321
|
+
* @export
|
|
48322
|
+
* @class ExportTemplatesApi
|
|
48323
|
+
* @extends {BaseAPI}
|
|
48324
|
+
*/
|
|
48325
|
+
export declare class ExportTemplatesApi extends BaseAPI implements ExportTemplatesApiInterface {
|
|
48326
|
+
/**
|
|
48327
|
+
*
|
|
48328
|
+
* @summary Post Export Template entities
|
|
48329
|
+
* @param {ExportTemplatesApiCreateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48330
|
+
* @param {*} [options] Override http request option.
|
|
48331
|
+
* @throws {RequiredError}
|
|
48332
|
+
* @memberof ExportTemplatesApi
|
|
48333
|
+
*/
|
|
48334
|
+
createEntityExportTemplates(requestParameters: ExportTemplatesApiCreateEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
48335
|
+
/**
|
|
48336
|
+
*
|
|
48337
|
+
* @summary Delete Export Template entity
|
|
48338
|
+
* @param {ExportTemplatesApiDeleteEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48339
|
+
* @param {*} [options] Override http request option.
|
|
48340
|
+
* @throws {RequiredError}
|
|
48341
|
+
* @memberof ExportTemplatesApi
|
|
48342
|
+
*/
|
|
48343
|
+
deleteEntityExportTemplates(requestParameters: ExportTemplatesApiDeleteEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
48344
|
+
/**
|
|
48345
|
+
*
|
|
48346
|
+
* @summary GET all Export Template entities
|
|
48347
|
+
* @param {ExportTemplatesApiGetAllEntitiesExportTemplatesRequest} requestParameters Request parameters.
|
|
48348
|
+
* @param {*} [options] Override http request option.
|
|
48349
|
+
* @throws {RequiredError}
|
|
48350
|
+
* @memberof ExportTemplatesApi
|
|
48351
|
+
*/
|
|
48352
|
+
getAllEntitiesExportTemplates(requestParameters?: ExportTemplatesApiGetAllEntitiesExportTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiExportTemplateOutList, any>>;
|
|
48353
|
+
/**
|
|
48354
|
+
*
|
|
48355
|
+
* @summary GET Export Template entity
|
|
48356
|
+
* @param {ExportTemplatesApiGetEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48357
|
+
* @param {*} [options] Override http request option.
|
|
48358
|
+
* @throws {RequiredError}
|
|
48359
|
+
* @memberof ExportTemplatesApi
|
|
48360
|
+
*/
|
|
48361
|
+
getEntityExportTemplates(requestParameters: ExportTemplatesApiGetEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
48362
|
+
/**
|
|
48363
|
+
*
|
|
48364
|
+
* @summary Patch Export Template entity
|
|
48365
|
+
* @param {ExportTemplatesApiPatchEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48366
|
+
* @param {*} [options] Override http request option.
|
|
48367
|
+
* @throws {RequiredError}
|
|
48368
|
+
* @memberof ExportTemplatesApi
|
|
48369
|
+
*/
|
|
48370
|
+
patchEntityExportTemplates(requestParameters: ExportTemplatesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
48371
|
+
/**
|
|
48372
|
+
*
|
|
48373
|
+
* @summary PUT Export Template entity
|
|
48374
|
+
* @param {ExportTemplatesApiUpdateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
48375
|
+
* @param {*} [options] Override http request option.
|
|
48376
|
+
* @throws {RequiredError}
|
|
48377
|
+
* @memberof ExportTemplatesApi
|
|
48378
|
+
*/
|
|
48379
|
+
updateEntityExportTemplates(requestParameters: ExportTemplatesApiUpdateEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
48380
|
+
}
|
|
47273
48381
|
/**
|
|
47274
48382
|
* FactsApi - axios parameter creator
|
|
47275
48383
|
* @export
|
|
@@ -47281,7 +48389,7 @@ export declare const FactsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
47281
48389
|
* @param {string} workspaceId
|
|
47282
48390
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
47283
48391
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47284
|
-
* @param {Array<'datasets' | '
|
|
48392
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
47285
48393
|
* @param {number} [page] Zero-based page index (0..N)
|
|
47286
48394
|
* @param {number} [size] The size of the page to be returned
|
|
47287
48395
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -47290,20 +48398,20 @@ export declare const FactsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
47290
48398
|
* @param {*} [options] Override http request option.
|
|
47291
48399
|
* @throws {RequiredError}
|
|
47292
48400
|
*/
|
|
47293
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
48401
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47294
48402
|
/**
|
|
47295
48403
|
*
|
|
47296
48404
|
* @summary Get a Fact
|
|
47297
48405
|
* @param {string} workspaceId
|
|
47298
48406
|
* @param {string} objectId
|
|
47299
48407
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47300
|
-
* @param {Array<'datasets' | '
|
|
48408
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
47301
48409
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
47302
48410
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
47303
48411
|
* @param {*} [options] Override http request option.
|
|
47304
48412
|
* @throws {RequiredError}
|
|
47305
48413
|
*/
|
|
47306
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
48414
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47307
48415
|
};
|
|
47308
48416
|
/**
|
|
47309
48417
|
* FactsApi - functional programming interface
|
|
@@ -47316,7 +48424,7 @@ export declare const FactsApiFp: (configuration?: Configuration) => {
|
|
|
47316
48424
|
* @param {string} workspaceId
|
|
47317
48425
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
47318
48426
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47319
|
-
* @param {Array<'datasets' | '
|
|
48427
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
47320
48428
|
* @param {number} [page] Zero-based page index (0..N)
|
|
47321
48429
|
* @param {number} [size] The size of the page to be returned
|
|
47322
48430
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -47325,20 +48433,20 @@ export declare const FactsApiFp: (configuration?: Configuration) => {
|
|
|
47325
48433
|
* @param {*} [options] Override http request option.
|
|
47326
48434
|
* @throws {RequiredError}
|
|
47327
48435
|
*/
|
|
47328
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
48436
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
47329
48437
|
/**
|
|
47330
48438
|
*
|
|
47331
48439
|
* @summary Get a Fact
|
|
47332
48440
|
* @param {string} workspaceId
|
|
47333
48441
|
* @param {string} objectId
|
|
47334
48442
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
47335
|
-
* @param {Array<'datasets' | '
|
|
48443
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
47336
48444
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
47337
48445
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
47338
48446
|
* @param {*} [options] Override http request option.
|
|
47339
48447
|
* @throws {RequiredError}
|
|
47340
48448
|
*/
|
|
47341
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
48449
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
47342
48450
|
};
|
|
47343
48451
|
/**
|
|
47344
48452
|
* FactsApi - factory interface
|
|
@@ -47413,10 +48521,10 @@ export interface FactsApiGetAllEntitiesFactsRequest {
|
|
|
47413
48521
|
readonly filter?: string;
|
|
47414
48522
|
/**
|
|
47415
48523
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
47416
|
-
* @type {Array<'datasets' | '
|
|
48524
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
47417
48525
|
* @memberof FactsApiGetAllEntitiesFacts
|
|
47418
48526
|
*/
|
|
47419
|
-
readonly include?: Array<"datasets" | "
|
|
48527
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
47420
48528
|
/**
|
|
47421
48529
|
* Zero-based page index (0..N)
|
|
47422
48530
|
* @type {number}
|
|
@@ -47474,10 +48582,10 @@ export interface FactsApiGetEntityFactsRequest {
|
|
|
47474
48582
|
readonly filter?: string;
|
|
47475
48583
|
/**
|
|
47476
48584
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
47477
|
-
* @type {Array<'datasets' | '
|
|
48585
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
47478
48586
|
* @memberof FactsApiGetEntityFacts
|
|
47479
48587
|
*/
|
|
47480
|
-
readonly include?: Array<"datasets" | "
|
|
48588
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
47481
48589
|
/**
|
|
47482
48590
|
*
|
|
47483
48591
|
* @type {boolean}
|
|
@@ -63892,194 +65000,6 @@ export declare class TranslationsApi extends BaseAPI implements TranslationsApiI
|
|
|
63892
65000
|
*/
|
|
63893
65001
|
setTranslations(requestParameters: TranslationsApiSetTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
63894
65002
|
}
|
|
63895
|
-
/**
|
|
63896
|
-
* UnsubscribeApi - axios parameter creator
|
|
63897
|
-
* @export
|
|
63898
|
-
*/
|
|
63899
|
-
export declare const UnsubscribeApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
63900
|
-
/**
|
|
63901
|
-
*
|
|
63902
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
63903
|
-
* @param {*} [options] Override http request option.
|
|
63904
|
-
* @throws {RequiredError}
|
|
63905
|
-
*/
|
|
63906
|
-
unsubscribeAllAutomations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
63907
|
-
/**
|
|
63908
|
-
*
|
|
63909
|
-
* @summary Unsubscribe from an automation
|
|
63910
|
-
* @param {string} workspaceId
|
|
63911
|
-
* @param {string} automationId
|
|
63912
|
-
* @param {*} [options] Override http request option.
|
|
63913
|
-
* @throws {RequiredError}
|
|
63914
|
-
*/
|
|
63915
|
-
unsubscribeAutomation: (workspaceId: string, automationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
63916
|
-
/**
|
|
63917
|
-
*
|
|
63918
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
63919
|
-
* @param {string} workspaceId
|
|
63920
|
-
* @param {*} [options] Override http request option.
|
|
63921
|
-
* @throws {RequiredError}
|
|
63922
|
-
*/
|
|
63923
|
-
unsubscribeWorkspaceAutomations: (workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
63924
|
-
};
|
|
63925
|
-
/**
|
|
63926
|
-
* UnsubscribeApi - functional programming interface
|
|
63927
|
-
* @export
|
|
63928
|
-
*/
|
|
63929
|
-
export declare const UnsubscribeApiFp: (configuration?: Configuration) => {
|
|
63930
|
-
/**
|
|
63931
|
-
*
|
|
63932
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
63933
|
-
* @param {*} [options] Override http request option.
|
|
63934
|
-
* @throws {RequiredError}
|
|
63935
|
-
*/
|
|
63936
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
63937
|
-
/**
|
|
63938
|
-
*
|
|
63939
|
-
* @summary Unsubscribe from an automation
|
|
63940
|
-
* @param {string} workspaceId
|
|
63941
|
-
* @param {string} automationId
|
|
63942
|
-
* @param {*} [options] Override http request option.
|
|
63943
|
-
* @throws {RequiredError}
|
|
63944
|
-
*/
|
|
63945
|
-
unsubscribeAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
63946
|
-
/**
|
|
63947
|
-
*
|
|
63948
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
63949
|
-
* @param {string} workspaceId
|
|
63950
|
-
* @param {*} [options] Override http request option.
|
|
63951
|
-
* @throws {RequiredError}
|
|
63952
|
-
*/
|
|
63953
|
-
unsubscribeWorkspaceAutomations(workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
63954
|
-
};
|
|
63955
|
-
/**
|
|
63956
|
-
* UnsubscribeApi - factory interface
|
|
63957
|
-
* @export
|
|
63958
|
-
*/
|
|
63959
|
-
export declare const UnsubscribeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
63960
|
-
/**
|
|
63961
|
-
*
|
|
63962
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
63963
|
-
* @param {*} [options] Override http request option.
|
|
63964
|
-
* @throws {RequiredError}
|
|
63965
|
-
*/
|
|
63966
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
63967
|
-
/**
|
|
63968
|
-
*
|
|
63969
|
-
* @summary Unsubscribe from an automation
|
|
63970
|
-
* @param {UnsubscribeApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
63971
|
-
* @param {*} [options] Override http request option.
|
|
63972
|
-
* @throws {RequiredError}
|
|
63973
|
-
*/
|
|
63974
|
-
unsubscribeAutomation(requestParameters: UnsubscribeApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
63975
|
-
/**
|
|
63976
|
-
*
|
|
63977
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
63978
|
-
* @param {UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
63979
|
-
* @param {*} [options] Override http request option.
|
|
63980
|
-
* @throws {RequiredError}
|
|
63981
|
-
*/
|
|
63982
|
-
unsubscribeWorkspaceAutomations(requestParameters: UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
63983
|
-
};
|
|
63984
|
-
/**
|
|
63985
|
-
* UnsubscribeApi - interface
|
|
63986
|
-
* @export
|
|
63987
|
-
* @interface UnsubscribeApi
|
|
63988
|
-
*/
|
|
63989
|
-
export interface UnsubscribeApiInterface {
|
|
63990
|
-
/**
|
|
63991
|
-
*
|
|
63992
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
63993
|
-
* @param {*} [options] Override http request option.
|
|
63994
|
-
* @throws {RequiredError}
|
|
63995
|
-
* @memberof UnsubscribeApiInterface
|
|
63996
|
-
*/
|
|
63997
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
63998
|
-
/**
|
|
63999
|
-
*
|
|
64000
|
-
* @summary Unsubscribe from an automation
|
|
64001
|
-
* @param {UnsubscribeApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
64002
|
-
* @param {*} [options] Override http request option.
|
|
64003
|
-
* @throws {RequiredError}
|
|
64004
|
-
* @memberof UnsubscribeApiInterface
|
|
64005
|
-
*/
|
|
64006
|
-
unsubscribeAutomation(requestParameters: UnsubscribeApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
64007
|
-
/**
|
|
64008
|
-
*
|
|
64009
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
64010
|
-
* @param {UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
64011
|
-
* @param {*} [options] Override http request option.
|
|
64012
|
-
* @throws {RequiredError}
|
|
64013
|
-
* @memberof UnsubscribeApiInterface
|
|
64014
|
-
*/
|
|
64015
|
-
unsubscribeWorkspaceAutomations(requestParameters: UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
64016
|
-
}
|
|
64017
|
-
/**
|
|
64018
|
-
* Request parameters for unsubscribeAutomation operation in UnsubscribeApi.
|
|
64019
|
-
* @export
|
|
64020
|
-
* @interface UnsubscribeApiUnsubscribeAutomationRequest
|
|
64021
|
-
*/
|
|
64022
|
-
export interface UnsubscribeApiUnsubscribeAutomationRequest {
|
|
64023
|
-
/**
|
|
64024
|
-
*
|
|
64025
|
-
* @type {string}
|
|
64026
|
-
* @memberof UnsubscribeApiUnsubscribeAutomation
|
|
64027
|
-
*/
|
|
64028
|
-
readonly workspaceId: string;
|
|
64029
|
-
/**
|
|
64030
|
-
*
|
|
64031
|
-
* @type {string}
|
|
64032
|
-
* @memberof UnsubscribeApiUnsubscribeAutomation
|
|
64033
|
-
*/
|
|
64034
|
-
readonly automationId: string;
|
|
64035
|
-
}
|
|
64036
|
-
/**
|
|
64037
|
-
* Request parameters for unsubscribeWorkspaceAutomations operation in UnsubscribeApi.
|
|
64038
|
-
* @export
|
|
64039
|
-
* @interface UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest
|
|
64040
|
-
*/
|
|
64041
|
-
export interface UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest {
|
|
64042
|
-
/**
|
|
64043
|
-
*
|
|
64044
|
-
* @type {string}
|
|
64045
|
-
* @memberof UnsubscribeApiUnsubscribeWorkspaceAutomations
|
|
64046
|
-
*/
|
|
64047
|
-
readonly workspaceId: string;
|
|
64048
|
-
}
|
|
64049
|
-
/**
|
|
64050
|
-
* UnsubscribeApi - object-oriented interface
|
|
64051
|
-
* @export
|
|
64052
|
-
* @class UnsubscribeApi
|
|
64053
|
-
* @extends {BaseAPI}
|
|
64054
|
-
*/
|
|
64055
|
-
export declare class UnsubscribeApi extends BaseAPI implements UnsubscribeApiInterface {
|
|
64056
|
-
/**
|
|
64057
|
-
*
|
|
64058
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
64059
|
-
* @param {*} [options] Override http request option.
|
|
64060
|
-
* @throws {RequiredError}
|
|
64061
|
-
* @memberof UnsubscribeApi
|
|
64062
|
-
*/
|
|
64063
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
64064
|
-
/**
|
|
64065
|
-
*
|
|
64066
|
-
* @summary Unsubscribe from an automation
|
|
64067
|
-
* @param {UnsubscribeApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
64068
|
-
* @param {*} [options] Override http request option.
|
|
64069
|
-
* @throws {RequiredError}
|
|
64070
|
-
* @memberof UnsubscribeApi
|
|
64071
|
-
*/
|
|
64072
|
-
unsubscribeAutomation(requestParameters: UnsubscribeApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
64073
|
-
/**
|
|
64074
|
-
*
|
|
64075
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
64076
|
-
* @param {UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
64077
|
-
* @param {*} [options] Override http request option.
|
|
64078
|
-
* @throws {RequiredError}
|
|
64079
|
-
* @memberof UnsubscribeApi
|
|
64080
|
-
*/
|
|
64081
|
-
unsubscribeWorkspaceAutomations(requestParameters: UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
64082
|
-
}
|
|
64083
65003
|
/**
|
|
64084
65004
|
* UsageApi - axios parameter creator
|
|
64085
65005
|
* @export
|
|
@@ -68575,6 +69495,21 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68575
69495
|
* @throws {RequiredError}
|
|
68576
69496
|
*/
|
|
68577
69497
|
deleteEntityWorkspaceSettings: (workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69498
|
+
/**
|
|
69499
|
+
*
|
|
69500
|
+
* @param {string} workspaceId
|
|
69501
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
69502
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69503
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69504
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
69505
|
+
* @param {number} [size] The size of the page to be returned
|
|
69506
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
69507
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
69508
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
69509
|
+
* @param {*} [options] Override http request option.
|
|
69510
|
+
* @throws {RequiredError}
|
|
69511
|
+
*/
|
|
69512
|
+
getAllEntitiesAggregatedFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68578
69513
|
/**
|
|
68579
69514
|
*
|
|
68580
69515
|
* @summary Get all Dashboards
|
|
@@ -68676,7 +69611,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68676
69611
|
* @param {string} workspaceId
|
|
68677
69612
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
68678
69613
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68679
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69614
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68680
69615
|
* @param {number} [page] Zero-based page index (0..N)
|
|
68681
69616
|
* @param {number} [size] The size of the page to be returned
|
|
68682
69617
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -68685,7 +69620,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68685
69620
|
* @param {*} [options] Override http request option.
|
|
68686
69621
|
* @throws {RequiredError}
|
|
68687
69622
|
*/
|
|
68688
|
-
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69623
|
+
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68689
69624
|
/**
|
|
68690
69625
|
*
|
|
68691
69626
|
* @summary Get all Export Definitions
|
|
@@ -68708,7 +69643,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68708
69643
|
* @param {string} workspaceId
|
|
68709
69644
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
68710
69645
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68711
|
-
* @param {Array<'datasets' | '
|
|
69646
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68712
69647
|
* @param {number} [page] Zero-based page index (0..N)
|
|
68713
69648
|
* @param {number} [size] The size of the page to be returned
|
|
68714
69649
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -68717,7 +69652,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68717
69652
|
* @param {*} [options] Override http request option.
|
|
68718
69653
|
* @throws {RequiredError}
|
|
68719
69654
|
*/
|
|
68720
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
69655
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68721
69656
|
/**
|
|
68722
69657
|
*
|
|
68723
69658
|
* @summary Get all Context Filters
|
|
@@ -68861,6 +69796,18 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68861
69796
|
* @throws {RequiredError}
|
|
68862
69797
|
*/
|
|
68863
69798
|
getAllEntitiesWorkspaceSettings: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69799
|
+
/**
|
|
69800
|
+
*
|
|
69801
|
+
* @param {string} workspaceId
|
|
69802
|
+
* @param {string} objectId
|
|
69803
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69804
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69805
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
69806
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
69807
|
+
* @param {*} [options] Override http request option.
|
|
69808
|
+
* @throws {RequiredError}
|
|
69809
|
+
*/
|
|
69810
|
+
getEntityAggregatedFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68864
69811
|
/**
|
|
68865
69812
|
*
|
|
68866
69813
|
* @summary Get a Dashboard
|
|
@@ -68944,13 +69891,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68944
69891
|
* @param {string} workspaceId
|
|
68945
69892
|
* @param {string} objectId
|
|
68946
69893
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68947
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69894
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68948
69895
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
68949
69896
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
68950
69897
|
* @param {*} [options] Override http request option.
|
|
68951
69898
|
* @throws {RequiredError}
|
|
68952
69899
|
*/
|
|
68953
|
-
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69900
|
+
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68954
69901
|
/**
|
|
68955
69902
|
*
|
|
68956
69903
|
* @summary Get an Export Definition
|
|
@@ -68970,13 +69917,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
68970
69917
|
* @param {string} workspaceId
|
|
68971
69918
|
* @param {string} objectId
|
|
68972
69919
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
68973
|
-
* @param {Array<'datasets' | '
|
|
69920
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
68974
69921
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
68975
69922
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
68976
69923
|
* @param {*} [options] Override http request option.
|
|
68977
69924
|
* @throws {RequiredError}
|
|
68978
69925
|
*/
|
|
68979
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
69926
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68980
69927
|
/**
|
|
68981
69928
|
*
|
|
68982
69929
|
* @summary Get a Context Filter
|
|
@@ -69721,6 +70668,21 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69721
70668
|
* @throws {RequiredError}
|
|
69722
70669
|
*/
|
|
69723
70670
|
deleteEntityWorkspaceSettings(workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
70671
|
+
/**
|
|
70672
|
+
*
|
|
70673
|
+
* @param {string} workspaceId
|
|
70674
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
70675
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
70676
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70677
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
70678
|
+
* @param {number} [size] The size of the page to be returned
|
|
70679
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
70680
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
70681
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
70682
|
+
* @param {*} [options] Override http request option.
|
|
70683
|
+
* @throws {RequiredError}
|
|
70684
|
+
*/
|
|
70685
|
+
getAllEntitiesAggregatedFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutList>>;
|
|
69724
70686
|
/**
|
|
69725
70687
|
*
|
|
69726
70688
|
* @summary Get all Dashboards
|
|
@@ -69822,7 +70784,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69822
70784
|
* @param {string} workspaceId
|
|
69823
70785
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
69824
70786
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69825
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70787
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69826
70788
|
* @param {number} [page] Zero-based page index (0..N)
|
|
69827
70789
|
* @param {number} [size] The size of the page to be returned
|
|
69828
70790
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -69831,7 +70793,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69831
70793
|
* @param {*} [options] Override http request option.
|
|
69832
70794
|
* @throws {RequiredError}
|
|
69833
70795
|
*/
|
|
69834
|
-
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
70796
|
+
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
69835
70797
|
/**
|
|
69836
70798
|
*
|
|
69837
70799
|
* @summary Get all Export Definitions
|
|
@@ -69854,7 +70816,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69854
70816
|
* @param {string} workspaceId
|
|
69855
70817
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
69856
70818
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
69857
|
-
* @param {Array<'datasets' | '
|
|
70819
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
69858
70820
|
* @param {number} [page] Zero-based page index (0..N)
|
|
69859
70821
|
* @param {number} [size] The size of the page to be returned
|
|
69860
70822
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -69863,7 +70825,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
69863
70825
|
* @param {*} [options] Override http request option.
|
|
69864
70826
|
* @throws {RequiredError}
|
|
69865
70827
|
*/
|
|
69866
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
70828
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
69867
70829
|
/**
|
|
69868
70830
|
*
|
|
69869
70831
|
* @summary Get all Context Filters
|
|
@@ -70007,6 +70969,18 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
70007
70969
|
* @throws {RequiredError}
|
|
70008
70970
|
*/
|
|
70009
70971
|
getAllEntitiesWorkspaceSettings(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceSettingOutList>>;
|
|
70972
|
+
/**
|
|
70973
|
+
*
|
|
70974
|
+
* @param {string} workspaceId
|
|
70975
|
+
* @param {string} objectId
|
|
70976
|
+
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
70977
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70978
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
70979
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
70980
|
+
* @param {*} [options] Override http request option.
|
|
70981
|
+
* @throws {RequiredError}
|
|
70982
|
+
*/
|
|
70983
|
+
getEntityAggregatedFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutDocument>>;
|
|
70010
70984
|
/**
|
|
70011
70985
|
*
|
|
70012
70986
|
* @summary Get a Dashboard
|
|
@@ -70090,13 +71064,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
70090
71064
|
* @param {string} workspaceId
|
|
70091
71065
|
* @param {string} objectId
|
|
70092
71066
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
70093
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
71067
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70094
71068
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
70095
71069
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
70096
71070
|
* @param {*} [options] Override http request option.
|
|
70097
71071
|
* @throws {RequiredError}
|
|
70098
71072
|
*/
|
|
70099
|
-
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
71073
|
+
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
70100
71074
|
/**
|
|
70101
71075
|
*
|
|
70102
71076
|
* @summary Get an Export Definition
|
|
@@ -70116,13 +71090,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: Configurat
|
|
|
70116
71090
|
* @param {string} workspaceId
|
|
70117
71091
|
* @param {string} objectId
|
|
70118
71092
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
70119
|
-
* @param {Array<'datasets' | '
|
|
71093
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
70120
71094
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
70121
71095
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
70122
71096
|
* @param {*} [options] Override http request option.
|
|
70123
71097
|
* @throws {RequiredError}
|
|
70124
71098
|
*/
|
|
70125
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
71099
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
70126
71100
|
/**
|
|
70127
71101
|
*
|
|
70128
71102
|
* @summary Get a Context Filter
|
|
@@ -70800,6 +71774,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Confi
|
|
|
70800
71774
|
* @throws {RequiredError}
|
|
70801
71775
|
*/
|
|
70802
71776
|
deleteEntityWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
71777
|
+
/**
|
|
71778
|
+
*
|
|
71779
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
71780
|
+
* @param {*} [options] Override http request option.
|
|
71781
|
+
* @throws {RequiredError}
|
|
71782
|
+
*/
|
|
71783
|
+
getAllEntitiesAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
70803
71784
|
/**
|
|
70804
71785
|
*
|
|
70805
71786
|
* @summary Get all Dashboards
|
|
@@ -70944,6 +71925,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Confi
|
|
|
70944
71925
|
* @throws {RequiredError}
|
|
70945
71926
|
*/
|
|
70946
71927
|
getAllEntitiesWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceSettingOutList>;
|
|
71928
|
+
/**
|
|
71929
|
+
*
|
|
71930
|
+
* @param {WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
71931
|
+
* @param {*} [options] Override http request option.
|
|
71932
|
+
* @throws {RequiredError}
|
|
71933
|
+
*/
|
|
71934
|
+
getEntityAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
70947
71935
|
/**
|
|
70948
71936
|
*
|
|
70949
71937
|
* @summary Get a Dashboard
|
|
@@ -71571,6 +72559,14 @@ export interface WorkspaceObjectControllerApiInterface {
|
|
|
71571
72559
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
71572
72560
|
*/
|
|
71573
72561
|
deleteEntityWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
72562
|
+
/**
|
|
72563
|
+
*
|
|
72564
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
72565
|
+
* @param {*} [options] Override http request option.
|
|
72566
|
+
* @throws {RequiredError}
|
|
72567
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
72568
|
+
*/
|
|
72569
|
+
getAllEntitiesAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
71574
72570
|
/**
|
|
71575
72571
|
*
|
|
71576
72572
|
* @summary Get all Dashboards
|
|
@@ -71733,6 +72729,14 @@ export interface WorkspaceObjectControllerApiInterface {
|
|
|
71733
72729
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
71734
72730
|
*/
|
|
71735
72731
|
getAllEntitiesWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceSettingOutList>;
|
|
72732
|
+
/**
|
|
72733
|
+
*
|
|
72734
|
+
* @param {WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
72735
|
+
* @param {*} [options] Override http request option.
|
|
72736
|
+
* @throws {RequiredError}
|
|
72737
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
72738
|
+
*/
|
|
72739
|
+
getEntityAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
71736
72740
|
/**
|
|
71737
72741
|
*
|
|
71738
72742
|
* @summary Get a Dashboard
|
|
@@ -72914,6 +73918,67 @@ export interface WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsReques
|
|
|
72914
73918
|
*/
|
|
72915
73919
|
readonly filter?: string;
|
|
72916
73920
|
}
|
|
73921
|
+
/**
|
|
73922
|
+
* Request parameters for getAllEntitiesAggregatedFacts operation in WorkspaceObjectControllerApi.
|
|
73923
|
+
* @export
|
|
73924
|
+
* @interface WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest
|
|
73925
|
+
*/
|
|
73926
|
+
export interface WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest {
|
|
73927
|
+
/**
|
|
73928
|
+
*
|
|
73929
|
+
* @type {string}
|
|
73930
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73931
|
+
*/
|
|
73932
|
+
readonly workspaceId: string;
|
|
73933
|
+
/**
|
|
73934
|
+
*
|
|
73935
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
73936
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73937
|
+
*/
|
|
73938
|
+
readonly origin?: "ALL" | "PARENTS" | "NATIVE";
|
|
73939
|
+
/**
|
|
73940
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
73941
|
+
* @type {string}
|
|
73942
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73943
|
+
*/
|
|
73944
|
+
readonly filter?: string;
|
|
73945
|
+
/**
|
|
73946
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
73947
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
73948
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73949
|
+
*/
|
|
73950
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
73951
|
+
/**
|
|
73952
|
+
* Zero-based page index (0..N)
|
|
73953
|
+
* @type {number}
|
|
73954
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73955
|
+
*/
|
|
73956
|
+
readonly page?: number;
|
|
73957
|
+
/**
|
|
73958
|
+
* The size of the page to be returned
|
|
73959
|
+
* @type {number}
|
|
73960
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73961
|
+
*/
|
|
73962
|
+
readonly size?: number;
|
|
73963
|
+
/**
|
|
73964
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
73965
|
+
* @type {Array<string>}
|
|
73966
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73967
|
+
*/
|
|
73968
|
+
readonly sort?: Array<string>;
|
|
73969
|
+
/**
|
|
73970
|
+
*
|
|
73971
|
+
* @type {boolean}
|
|
73972
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73973
|
+
*/
|
|
73974
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
73975
|
+
/**
|
|
73976
|
+
* Include Meta objects.
|
|
73977
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
73978
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
73979
|
+
*/
|
|
73980
|
+
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
73981
|
+
}
|
|
72917
73982
|
/**
|
|
72918
73983
|
* Request parameters for getAllEntitiesAnalyticalDashboards operation in WorkspaceObjectControllerApi.
|
|
72919
73984
|
* @export
|
|
@@ -73300,10 +74365,10 @@ export interface WorkspaceObjectControllerApiGetAllEntitiesDatasetsRequest {
|
|
|
73300
74365
|
readonly filter?: string;
|
|
73301
74366
|
/**
|
|
73302
74367
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
73303
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
74368
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
73304
74369
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesDatasets
|
|
73305
74370
|
*/
|
|
73306
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
74371
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
73307
74372
|
/**
|
|
73308
74373
|
* Zero-based page index (0..N)
|
|
73309
74374
|
* @type {number}
|
|
@@ -73422,10 +74487,10 @@ export interface WorkspaceObjectControllerApiGetAllEntitiesFactsRequest {
|
|
|
73422
74487
|
readonly filter?: string;
|
|
73423
74488
|
/**
|
|
73424
74489
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
73425
|
-
* @type {Array<'datasets' | '
|
|
74490
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
73426
74491
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesFacts
|
|
73427
74492
|
*/
|
|
73428
|
-
readonly include?: Array<"datasets" | "
|
|
74493
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
73429
74494
|
/**
|
|
73430
74495
|
* Zero-based page index (0..N)
|
|
73431
74496
|
* @type {number}
|
|
@@ -74000,6 +75065,49 @@ export interface WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequ
|
|
|
74000
75065
|
*/
|
|
74001
75066
|
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
74002
75067
|
}
|
|
75068
|
+
/**
|
|
75069
|
+
* Request parameters for getEntityAggregatedFacts operation in WorkspaceObjectControllerApi.
|
|
75070
|
+
* @export
|
|
75071
|
+
* @interface WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest
|
|
75072
|
+
*/
|
|
75073
|
+
export interface WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest {
|
|
75074
|
+
/**
|
|
75075
|
+
*
|
|
75076
|
+
* @type {string}
|
|
75077
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
75078
|
+
*/
|
|
75079
|
+
readonly workspaceId: string;
|
|
75080
|
+
/**
|
|
75081
|
+
*
|
|
75082
|
+
* @type {string}
|
|
75083
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
75084
|
+
*/
|
|
75085
|
+
readonly objectId: string;
|
|
75086
|
+
/**
|
|
75087
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
75088
|
+
* @type {string}
|
|
75089
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
75090
|
+
*/
|
|
75091
|
+
readonly filter?: string;
|
|
75092
|
+
/**
|
|
75093
|
+
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
75094
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
75095
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
75096
|
+
*/
|
|
75097
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
75098
|
+
/**
|
|
75099
|
+
*
|
|
75100
|
+
* @type {boolean}
|
|
75101
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
75102
|
+
*/
|
|
75103
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
75104
|
+
/**
|
|
75105
|
+
* Include Meta objects.
|
|
75106
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
75107
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
75108
|
+
*/
|
|
75109
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
75110
|
+
}
|
|
74003
75111
|
/**
|
|
74004
75112
|
* Request parameters for getEntityAnalyticalDashboards operation in WorkspaceObjectControllerApi.
|
|
74005
75113
|
* @export
|
|
@@ -74278,10 +75386,10 @@ export interface WorkspaceObjectControllerApiGetEntityDatasetsRequest {
|
|
|
74278
75386
|
readonly filter?: string;
|
|
74279
75387
|
/**
|
|
74280
75388
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
74281
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
75389
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
74282
75390
|
* @memberof WorkspaceObjectControllerApiGetEntityDatasets
|
|
74283
75391
|
*/
|
|
74284
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
75392
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
74285
75393
|
/**
|
|
74286
75394
|
*
|
|
74287
75395
|
* @type {boolean}
|
|
@@ -74364,10 +75472,10 @@ export interface WorkspaceObjectControllerApiGetEntityFactsRequest {
|
|
|
74364
75472
|
readonly filter?: string;
|
|
74365
75473
|
/**
|
|
74366
75474
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
74367
|
-
* @type {Array<'datasets' | '
|
|
75475
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
74368
75476
|
* @memberof WorkspaceObjectControllerApiGetEntityFacts
|
|
74369
75477
|
*/
|
|
74370
|
-
readonly include?: Array<"datasets" | "
|
|
75478
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
74371
75479
|
/**
|
|
74372
75480
|
*
|
|
74373
75481
|
* @type {boolean}
|
|
@@ -76027,6 +77135,14 @@ export declare class WorkspaceObjectControllerApi extends BaseAPI implements Wor
|
|
|
76027
77135
|
* @memberof WorkspaceObjectControllerApi
|
|
76028
77136
|
*/
|
|
76029
77137
|
deleteEntityWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
77138
|
+
/**
|
|
77139
|
+
*
|
|
77140
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
77141
|
+
* @param {*} [options] Override http request option.
|
|
77142
|
+
* @throws {RequiredError}
|
|
77143
|
+
* @memberof WorkspaceObjectControllerApi
|
|
77144
|
+
*/
|
|
77145
|
+
getAllEntitiesAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiAggregatedFactOutList, any>>;
|
|
76030
77146
|
/**
|
|
76031
77147
|
*
|
|
76032
77148
|
* @summary Get all Dashboards
|
|
@@ -76189,6 +77305,14 @@ export declare class WorkspaceObjectControllerApi extends BaseAPI implements Wor
|
|
|
76189
77305
|
* @memberof WorkspaceObjectControllerApi
|
|
76190
77306
|
*/
|
|
76191
77307
|
getAllEntitiesWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiWorkspaceSettingOutList, any>>;
|
|
77308
|
+
/**
|
|
77309
|
+
*
|
|
77310
|
+
* @param {WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
77311
|
+
* @param {*} [options] Override http request option.
|
|
77312
|
+
* @throws {RequiredError}
|
|
77313
|
+
* @memberof WorkspaceObjectControllerApi
|
|
77314
|
+
*/
|
|
77315
|
+
getEntityAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonApiAggregatedFactOutDocument, any>>;
|
|
76192
77316
|
/**
|
|
76193
77317
|
*
|
|
76194
77318
|
* @summary Get a Dashboard
|