@gooddata/api-client-tiger 11.53.0-alpha.4 → 11.53.0-alpha.5
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.js +1 -1
- package/esm/api-client-tiger.d.ts +1448 -152
- package/esm/generated/ai-json-api/api.d.ts +17 -1
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +8 -0
- package/esm/generated/automation-json-api/api.d.ts +1 -1
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +1 -1
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +2623 -147
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +2063 -289
- package/esm/generated/scan-json-api/api.d.ts +1 -1
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -735,6 +735,178 @@ export interface CompoundMeasureValueFilterCompoundMeasureValueFilter {
|
|
|
735
735
|
*/
|
|
736
736
|
'treatNullValuesAs'?: number;
|
|
737
737
|
}
|
|
738
|
+
/**
|
|
739
|
+
* Conditional formatting for a table, with one entry per formatted column.
|
|
740
|
+
*/
|
|
741
|
+
export interface ConditionalFormatting {
|
|
742
|
+
/**
|
|
743
|
+
* Whether the rules are applied when rendering.
|
|
744
|
+
*/
|
|
745
|
+
'enabled': boolean;
|
|
746
|
+
/**
|
|
747
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
748
|
+
*/
|
|
749
|
+
'rules': Array<ConditionalFormattingRule>;
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* A fixed, inclusive date period.
|
|
753
|
+
*/
|
|
754
|
+
export interface ConditionalFormattingAbsoluteDateValue {
|
|
755
|
+
/**
|
|
756
|
+
* `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.
|
|
757
|
+
*/
|
|
758
|
+
'from': string;
|
|
759
|
+
/**
|
|
760
|
+
* The value kind.
|
|
761
|
+
*/
|
|
762
|
+
'kind': ConditionalFormattingAbsoluteDateValueKindEnum;
|
|
763
|
+
/**
|
|
764
|
+
* `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.
|
|
765
|
+
*/
|
|
766
|
+
'to': string;
|
|
767
|
+
}
|
|
768
|
+
export type ConditionalFormattingAbsoluteDateValueKindEnum = 'absoluteDate';
|
|
769
|
+
/**
|
|
770
|
+
* An attribute column, addressed by its bucket item local identifier.
|
|
771
|
+
*/
|
|
772
|
+
export interface ConditionalFormattingAttributeTarget {
|
|
773
|
+
'attributeIdentifier': string;
|
|
774
|
+
/**
|
|
775
|
+
* The target kind.
|
|
776
|
+
*/
|
|
777
|
+
'kind': ConditionalFormattingAttributeTargetKindEnum;
|
|
778
|
+
}
|
|
779
|
+
export type ConditionalFormattingAttributeTargetKindEnum = 'attribute';
|
|
780
|
+
/**
|
|
781
|
+
* A condition and the formatting applied to cells matching it.
|
|
782
|
+
*/
|
|
783
|
+
export interface ConditionalFormattingCondition {
|
|
784
|
+
'format': ConditionalFormattingFormat;
|
|
785
|
+
/**
|
|
786
|
+
* Client-assigned identifier, stable across edits.
|
|
787
|
+
*/
|
|
788
|
+
'id'?: string;
|
|
789
|
+
/**
|
|
790
|
+
* How a condition compares the cell value against its value.
|
|
791
|
+
*/
|
|
792
|
+
'operator': ConditionalFormattingConditionOperatorEnum;
|
|
793
|
+
'value': ConditionalFormattingValue;
|
|
794
|
+
}
|
|
795
|
+
export type ConditionalFormattingConditionOperatorEnum = 'ALL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO' | 'BETWEEN' | 'NOT_BETWEEN' | 'CONTAINS' | 'NOT_CONTAINS' | 'STARTS_WITH' | 'NOT_STARTS_WITH' | 'ENDS_WITH' | 'NOT_ENDS_WITH' | 'IS_EMPTY' | 'IS_NOT_EMPTY';
|
|
796
|
+
/**
|
|
797
|
+
* Visual formatting applied to a matching cell.
|
|
798
|
+
*/
|
|
799
|
+
export interface ConditionalFormattingFormat {
|
|
800
|
+
/**
|
|
801
|
+
* Background color as a hex triplet.
|
|
802
|
+
*/
|
|
803
|
+
'backgroundColor'?: string;
|
|
804
|
+
/**
|
|
805
|
+
* Text color as a hex triplet.
|
|
806
|
+
*/
|
|
807
|
+
'color'?: string;
|
|
808
|
+
/**
|
|
809
|
+
* Whether the formatting applies to the matching cell only, or to its whole row.
|
|
810
|
+
*/
|
|
811
|
+
'scope': ConditionalFormattingFormatScopeEnum;
|
|
812
|
+
}
|
|
813
|
+
export type ConditionalFormattingFormatScopeEnum = 'cell' | 'row';
|
|
814
|
+
/**
|
|
815
|
+
* @type ConditionalFormattingLiteral
|
|
816
|
+
* A string or a number, serialized in whichever form it was authored.
|
|
817
|
+
*/
|
|
818
|
+
export type ConditionalFormattingLiteral = number | string;
|
|
819
|
+
/**
|
|
820
|
+
* An inclusive numeric range.
|
|
821
|
+
*/
|
|
822
|
+
export interface ConditionalFormattingLiteralRangeValue {
|
|
823
|
+
'from': number;
|
|
824
|
+
/**
|
|
825
|
+
* The value kind.
|
|
826
|
+
*/
|
|
827
|
+
'kind': ConditionalFormattingLiteralRangeValueKindEnum;
|
|
828
|
+
'to': number;
|
|
829
|
+
}
|
|
830
|
+
export type ConditionalFormattingLiteralRangeValueKindEnum = 'literalRange';
|
|
831
|
+
/**
|
|
832
|
+
* A single value compared against the cell value.
|
|
833
|
+
*/
|
|
834
|
+
export interface ConditionalFormattingLiteralValue {
|
|
835
|
+
/**
|
|
836
|
+
* The value kind.
|
|
837
|
+
*/
|
|
838
|
+
'kind': ConditionalFormattingLiteralValueKindEnum;
|
|
839
|
+
'value': ConditionalFormattingLiteral;
|
|
840
|
+
}
|
|
841
|
+
export type ConditionalFormattingLiteralValueKindEnum = 'literal';
|
|
842
|
+
/**
|
|
843
|
+
* A measure column, addressed by its bucket item local identifier.
|
|
844
|
+
*/
|
|
845
|
+
export interface ConditionalFormattingMeasureTarget {
|
|
846
|
+
/**
|
|
847
|
+
* The target kind.
|
|
848
|
+
*/
|
|
849
|
+
'kind': ConditionalFormattingMeasureTargetKindEnum;
|
|
850
|
+
'measureIdentifier': string;
|
|
851
|
+
}
|
|
852
|
+
export type ConditionalFormattingMeasureTargetKindEnum = 'measure';
|
|
853
|
+
/**
|
|
854
|
+
* No value; used by operators that take none.
|
|
855
|
+
*/
|
|
856
|
+
export interface ConditionalFormattingNoneValue {
|
|
857
|
+
/**
|
|
858
|
+
* The value kind.
|
|
859
|
+
*/
|
|
860
|
+
'kind': ConditionalFormattingNoneValueKindEnum;
|
|
861
|
+
}
|
|
862
|
+
export type ConditionalFormattingNoneValueKindEnum = 'none';
|
|
863
|
+
/**
|
|
864
|
+
* A date period relative to the moment of evaluation, resolved at render time.
|
|
865
|
+
*/
|
|
866
|
+
export interface ConditionalFormattingRelativeDateValue {
|
|
867
|
+
/**
|
|
868
|
+
* Offset in periods; 0 is the current period, negative is the past.
|
|
869
|
+
*/
|
|
870
|
+
'from': number;
|
|
871
|
+
/**
|
|
872
|
+
* Granularity the offsets are counted in.
|
|
873
|
+
*/
|
|
874
|
+
'granularity': ConditionalFormattingRelativeDateValueGranularityEnum;
|
|
875
|
+
/**
|
|
876
|
+
* The value kind.
|
|
877
|
+
*/
|
|
878
|
+
'kind': ConditionalFormattingRelativeDateValueKindEnum;
|
|
879
|
+
/**
|
|
880
|
+
* Offset in periods, not lower than `from`.
|
|
881
|
+
*/
|
|
882
|
+
'to': number;
|
|
883
|
+
}
|
|
884
|
+
export type ConditionalFormattingRelativeDateValueGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.minute_in_day' | 'GDC.time.second' | 'GDC.time.second_in_minute' | 'GDC.time.second_in_day' | 'GDC.time.fiscal_week' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_semester' | 'GDC.time.fiscal_year' | 'GDC.time.fiscal_day_in_fiscal_week' | 'GDC.time.fiscal_day_in_fiscal_month' | 'GDC.time.fiscal_day_in_fiscal_quarter' | 'GDC.time.fiscal_day_in_fiscal_semester' | 'GDC.time.fiscal_day_in_fiscal_year' | 'GDC.time.fiscal_week_in_fiscal_month' | 'GDC.time.fiscal_week_in_fiscal_quarter' | 'GDC.time.fiscal_week_in_fiscal_semester' | 'GDC.time.fiscal_week_in_fiscal_year' | 'GDC.time.fiscal_month_in_fiscal_quarter' | 'GDC.time.fiscal_month_in_fiscal_semester' | 'GDC.time.fiscal_month_in_fiscal_year' | 'GDC.time.fiscal_quarter_in_fiscal_semester' | 'GDC.time.fiscal_quarter_in_fiscal_year' | 'GDC.time.fiscal_semester_in_fiscal_year';
|
|
885
|
+
export type ConditionalFormattingRelativeDateValueKindEnum = 'relativeDate';
|
|
886
|
+
/**
|
|
887
|
+
* Conditions applied to a single column.
|
|
888
|
+
*/
|
|
889
|
+
export interface ConditionalFormattingRule {
|
|
890
|
+
/**
|
|
891
|
+
* Conditions evaluated in order; the first match wins.
|
|
892
|
+
*/
|
|
893
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
894
|
+
/**
|
|
895
|
+
* Client-assigned identifier, stable across edits.
|
|
896
|
+
*/
|
|
897
|
+
'id'?: string;
|
|
898
|
+
'target': ConditionalFormattingTarget;
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* @type ConditionalFormattingTarget
|
|
902
|
+
* Column a rule formats. The shape is selected by the `kind` property.
|
|
903
|
+
*/
|
|
904
|
+
export type ConditionalFormattingTarget = ConditionalFormattingAttributeTarget | ConditionalFormattingMeasureTarget;
|
|
905
|
+
/**
|
|
906
|
+
* @type ConditionalFormattingValue
|
|
907
|
+
* Value a condition compares against. The shape is selected by the `kind` property.
|
|
908
|
+
*/
|
|
909
|
+
export type ConditionalFormattingValue = ConditionalFormattingAbsoluteDateValue | ConditionalFormattingLiteralRangeValue | ConditionalFormattingLiteralValue | ConditionalFormattingNoneValue | ConditionalFormattingRelativeDateValue;
|
|
738
910
|
/**
|
|
739
911
|
* Settings for content slide.
|
|
740
912
|
*/
|
|
@@ -1315,6 +1487,10 @@ export interface DeclarativeAnalyticsLayer {
|
|
|
1315
1487
|
* A list of attribute hierarchies.
|
|
1316
1488
|
*/
|
|
1317
1489
|
'attributeHierarchies'?: Array<DeclarativeAttributeHierarchy>;
|
|
1490
|
+
/**
|
|
1491
|
+
* A list of computed attributes available in the model.
|
|
1492
|
+
*/
|
|
1493
|
+
'computedAttributes'?: Array<DeclarativeComputedAttribute>;
|
|
1318
1494
|
/**
|
|
1319
1495
|
* A list of dashboard plugins available in the model.
|
|
1320
1496
|
*/
|
|
@@ -1348,6 +1524,7 @@ export interface DeclarativeAnalyticsLayer {
|
|
|
1348
1524
|
* A dataset attribute.
|
|
1349
1525
|
*/
|
|
1350
1526
|
export interface DeclarativeAttribute {
|
|
1527
|
+
'conditionalFormatting'?: ObjectConditionalFormatting | null;
|
|
1351
1528
|
'defaultView'?: LabelIdentifier;
|
|
1352
1529
|
/**
|
|
1353
1530
|
* Attribute description.
|
|
@@ -1552,6 +1729,90 @@ export interface DeclarativeColumn {
|
|
|
1552
1729
|
'referencedTableId'?: string;
|
|
1553
1730
|
}
|
|
1554
1731
|
export type DeclarativeColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
1732
|
+
export interface DeclarativeComputedAttribute {
|
|
1733
|
+
/**
|
|
1734
|
+
* Certification status of the entity.
|
|
1735
|
+
*/
|
|
1736
|
+
'certification'?: DeclarativeComputedAttributeCertificationEnum;
|
|
1737
|
+
/**
|
|
1738
|
+
* Optional message associated with the certification.
|
|
1739
|
+
*/
|
|
1740
|
+
'certificationMessage'?: string | null;
|
|
1741
|
+
/**
|
|
1742
|
+
* Time when the certification was set.
|
|
1743
|
+
*/
|
|
1744
|
+
'certifiedAt'?: string | null;
|
|
1745
|
+
'certifiedBy'?: DeclarativeUserIdentifier;
|
|
1746
|
+
'content': DeclarativeComputedAttributeContent;
|
|
1747
|
+
/**
|
|
1748
|
+
* Time of the entity creation.
|
|
1749
|
+
*/
|
|
1750
|
+
'createdAt'?: string | null;
|
|
1751
|
+
'createdBy'?: DeclarativeUserIdentifier;
|
|
1752
|
+
/**
|
|
1753
|
+
* Computed attribute data type
|
|
1754
|
+
*/
|
|
1755
|
+
'dataType'?: DeclarativeComputedAttributeDataTypeEnum;
|
|
1756
|
+
/**
|
|
1757
|
+
* Computed attribute description.
|
|
1758
|
+
*/
|
|
1759
|
+
'description'?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* Computed attribute ID.
|
|
1762
|
+
*/
|
|
1763
|
+
'id': string;
|
|
1764
|
+
/**
|
|
1765
|
+
* If true, this computed attribute is hidden from AI search results.
|
|
1766
|
+
*/
|
|
1767
|
+
'isHidden'?: boolean;
|
|
1768
|
+
/**
|
|
1769
|
+
* Flag indicating whether the associated source column allows null values.
|
|
1770
|
+
*/
|
|
1771
|
+
'isNullable'?: boolean;
|
|
1772
|
+
/**
|
|
1773
|
+
* Default locale for primary computed label.
|
|
1774
|
+
*/
|
|
1775
|
+
'locale'?: string;
|
|
1776
|
+
/**
|
|
1777
|
+
* Time of the last entity modification.
|
|
1778
|
+
*/
|
|
1779
|
+
'modifiedAt'?: string | null;
|
|
1780
|
+
'modifiedBy'?: DeclarativeUserIdentifier;
|
|
1781
|
+
/**
|
|
1782
|
+
* Value used in coalesce during joins instead of null.
|
|
1783
|
+
*/
|
|
1784
|
+
'nullValue'?: string;
|
|
1785
|
+
/**
|
|
1786
|
+
* A list of tags.
|
|
1787
|
+
*/
|
|
1788
|
+
'tags'?: Array<string>;
|
|
1789
|
+
/**
|
|
1790
|
+
* Computed attribute title.
|
|
1791
|
+
*/
|
|
1792
|
+
'title': string;
|
|
1793
|
+
/**
|
|
1794
|
+
* Specific type of the computed attribute value
|
|
1795
|
+
*/
|
|
1796
|
+
'valueType'?: DeclarativeComputedAttributeValueTypeEnum;
|
|
1797
|
+
}
|
|
1798
|
+
export type DeclarativeComputedAttributeCertificationEnum = 'CERTIFIED';
|
|
1799
|
+
export type DeclarativeComputedAttributeDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
1800
|
+
export type DeclarativeComputedAttributeValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
1801
|
+
/**
|
|
1802
|
+
* A definition of the computed attribute content.
|
|
1803
|
+
*/
|
|
1804
|
+
export interface DeclarativeComputedAttributeContent {
|
|
1805
|
+
/**
|
|
1806
|
+
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
1807
|
+
*/
|
|
1808
|
+
'format'?: string | null;
|
|
1809
|
+
'maql': string;
|
|
1810
|
+
/**
|
|
1811
|
+
* Categorizes metric semantics (e.g., currency).
|
|
1812
|
+
*/
|
|
1813
|
+
'metricType'?: DeclarativeComputedAttributeContentMetricTypeEnum;
|
|
1814
|
+
}
|
|
1815
|
+
export type DeclarativeComputedAttributeContentMetricTypeEnum = 'UNSPECIFIED' | 'CURRENCY';
|
|
1555
1816
|
export interface DeclarativeCspDirective {
|
|
1556
1817
|
'directive': string;
|
|
1557
1818
|
'sources': Array<string>;
|
|
@@ -1704,7 +1965,7 @@ export interface DeclarativeDataSource {
|
|
|
1704
1965
|
export type DeclarativeDataSourceAuthenticationTypeEnum = 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'OIDC_PASSTHROUGH';
|
|
1705
1966
|
export type DeclarativeDataSourceCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
1706
1967
|
export type DeclarativeDataSourceDateTimeSemanticsEnum = 'LOCAL' | 'UTC';
|
|
1707
|
-
export type DeclarativeDataSourceTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | '
|
|
1968
|
+
export type DeclarativeDataSourceTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO';
|
|
1708
1969
|
export interface DeclarativeDataSourcePermission {
|
|
1709
1970
|
'assignee': AssigneeIdentifier;
|
|
1710
1971
|
/**
|
|
@@ -1815,6 +2076,7 @@ export interface DeclarativeDatasetSql {
|
|
|
1815
2076
|
* A date dataset.
|
|
1816
2077
|
*/
|
|
1817
2078
|
export interface DeclarativeDateDataset {
|
|
2079
|
+
'conditionalFormatting'?: ObjectConditionalFormatting | null;
|
|
1818
2080
|
/**
|
|
1819
2081
|
* Date dataset description.
|
|
1820
2082
|
*/
|
|
@@ -2092,6 +2354,7 @@ export interface DeclarativeJwk {
|
|
|
2092
2354
|
* A attribute label.
|
|
2093
2355
|
*/
|
|
2094
2356
|
export interface DeclarativeLabel {
|
|
2357
|
+
'conditionalFormatting'?: ObjectConditionalFormatting | null;
|
|
2095
2358
|
/**
|
|
2096
2359
|
* Label description.
|
|
2097
2360
|
*/
|
|
@@ -2239,6 +2502,7 @@ export interface DeclarativeMetric {
|
|
|
2239
2502
|
*/
|
|
2240
2503
|
'certifiedAt'?: string | null;
|
|
2241
2504
|
'certifiedBy'?: DeclarativeUserIdentifier;
|
|
2505
|
+
'conditionalFormatting'?: ObjectConditionalFormatting | null;
|
|
2242
2506
|
/**
|
|
2243
2507
|
* Free-form JSON object
|
|
2244
2508
|
*/
|
|
@@ -2556,7 +2820,7 @@ export interface DeclarativeSetting {
|
|
|
2556
2820
|
*/
|
|
2557
2821
|
'type'?: DeclarativeSettingTypeEnum;
|
|
2558
2822
|
}
|
|
2559
|
-
export type DeclarativeSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
2823
|
+
export type DeclarativeSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
2560
2824
|
export interface DeclarativeSingleWorkspacePermission {
|
|
2561
2825
|
'assignee': AssigneeIdentifier;
|
|
2562
2826
|
/**
|
|
@@ -2790,6 +3054,7 @@ export interface DeclarativeVisualizationObject {
|
|
|
2790
3054
|
*/
|
|
2791
3055
|
'certifiedAt'?: string | null;
|
|
2792
3056
|
'certifiedBy'?: DeclarativeUserIdentifier;
|
|
3057
|
+
'conditionalFormatting'?: ConditionalFormatting | null;
|
|
2793
3058
|
/**
|
|
2794
3059
|
* Free-form JSON object
|
|
2795
3060
|
*/
|
|
@@ -3362,7 +3627,7 @@ export interface IdentifierRefIdentifier {
|
|
|
3362
3627
|
'id': string;
|
|
3363
3628
|
'type': IdentifierRefIdentifierTypeEnum;
|
|
3364
3629
|
}
|
|
3365
|
-
export type IdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
3630
|
+
export type IdentifierRefIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'aggregatedFact' | 'label' | 'metric' | 'computedAttribute' | 'userDataFilter' | 'parameter' | 'exportDefinition' | 'automation' | 'automationResult' | 'memoryItem' | 'knowledgeRecommendation' | 'prompt' | 'visualizationObject' | 'filterContext' | 'workspaceSettings' | 'customApplicationSetting' | 'workspaceDataFilter' | 'workspaceDataFilterSetting' | 'filterView' | 'workspaceExportTemplate' | 'workspaceTheme' | 'workspaceColorPalette' | 'fiscalCalendar' | 'fiscalCalendarGranularity';
|
|
3366
3631
|
/**
|
|
3367
3632
|
* Export request object describing the export properties and metadata for image exports.
|
|
3368
3633
|
*/
|
|
@@ -4295,6 +4560,7 @@ export interface JsonApiAttributeOut {
|
|
|
4295
4560
|
export type JsonApiAttributeOutTypeEnum = 'attribute';
|
|
4296
4561
|
export interface JsonApiAttributeOutAttributes {
|
|
4297
4562
|
'areRelationsValid'?: boolean;
|
|
4563
|
+
'conditionalFormatting'?: JsonApiAttributeOutAttributesConditionalFormatting | null;
|
|
4298
4564
|
'description'?: string;
|
|
4299
4565
|
'granularity'?: JsonApiAttributeOutAttributesGranularityEnum;
|
|
4300
4566
|
'isHidden'?: boolean;
|
|
@@ -4311,6 +4577,19 @@ export interface JsonApiAttributeOutAttributes {
|
|
|
4311
4577
|
export type JsonApiAttributeOutAttributesGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
4312
4578
|
export type JsonApiAttributeOutAttributesSortDirectionEnum = 'ASC' | 'DESC';
|
|
4313
4579
|
export type JsonApiAttributeOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
4580
|
+
/**
|
|
4581
|
+
* Conditional formatting applied to table columns that render this attribute.
|
|
4582
|
+
*/
|
|
4583
|
+
export interface JsonApiAttributeOutAttributesConditionalFormatting {
|
|
4584
|
+
/**
|
|
4585
|
+
* Conditions evaluated in order; the first match wins.
|
|
4586
|
+
*/
|
|
4587
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
4588
|
+
/**
|
|
4589
|
+
* Whether the conditions are applied when rendering.
|
|
4590
|
+
*/
|
|
4591
|
+
'enabled': boolean;
|
|
4592
|
+
}
|
|
4314
4593
|
export interface JsonApiAttributeOutDocument {
|
|
4315
4594
|
'data': JsonApiAttributeOut;
|
|
4316
4595
|
/**
|
|
@@ -4408,10 +4687,24 @@ export interface JsonApiAttributePatch {
|
|
|
4408
4687
|
}
|
|
4409
4688
|
export type JsonApiAttributePatchTypeEnum = 'attribute';
|
|
4410
4689
|
export interface JsonApiAttributePatchAttributes {
|
|
4690
|
+
'conditionalFormatting'?: JsonApiAttributePatchAttributesConditionalFormatting | null;
|
|
4411
4691
|
'description'?: string;
|
|
4412
4692
|
'tags'?: Array<string>;
|
|
4413
4693
|
'title'?: string;
|
|
4414
4694
|
}
|
|
4695
|
+
/**
|
|
4696
|
+
* Conditional formatting applied to table columns that render this attribute.
|
|
4697
|
+
*/
|
|
4698
|
+
export interface JsonApiAttributePatchAttributesConditionalFormatting {
|
|
4699
|
+
/**
|
|
4700
|
+
* Conditions evaluated in order; the first match wins.
|
|
4701
|
+
*/
|
|
4702
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
4703
|
+
/**
|
|
4704
|
+
* Whether the conditions are applied when rendering.
|
|
4705
|
+
*/
|
|
4706
|
+
'enabled': boolean;
|
|
4707
|
+
}
|
|
4415
4708
|
export interface JsonApiAttributePatchDocument {
|
|
4416
4709
|
'data': JsonApiAttributePatch;
|
|
4417
4710
|
}
|
|
@@ -5098,6 +5391,333 @@ export interface JsonApiColorPalettePatchAttributes {
|
|
|
5098
5391
|
export interface JsonApiColorPalettePatchDocument {
|
|
5099
5392
|
'data': JsonApiColorPalettePatch;
|
|
5100
5393
|
}
|
|
5394
|
+
/**
|
|
5395
|
+
* JSON:API representation of computedAttribute entity.
|
|
5396
|
+
*/
|
|
5397
|
+
export interface JsonApiComputedAttributeIn {
|
|
5398
|
+
'attributes': JsonApiComputedAttributeInAttributes;
|
|
5399
|
+
/**
|
|
5400
|
+
* API identifier of an object
|
|
5401
|
+
*/
|
|
5402
|
+
'id': string;
|
|
5403
|
+
/**
|
|
5404
|
+
* Object type
|
|
5405
|
+
*/
|
|
5406
|
+
'type': JsonApiComputedAttributeInTypeEnum;
|
|
5407
|
+
}
|
|
5408
|
+
export type JsonApiComputedAttributeInTypeEnum = 'computedAttribute';
|
|
5409
|
+
export interface JsonApiComputedAttributeInAttributes {
|
|
5410
|
+
'areRelationsValid'?: boolean;
|
|
5411
|
+
'content': JsonApiComputedAttributeInAttributesContent;
|
|
5412
|
+
'dataType'?: JsonApiComputedAttributeInAttributesDataTypeEnum;
|
|
5413
|
+
'description'?: string;
|
|
5414
|
+
'isHidden'?: boolean;
|
|
5415
|
+
'isNullable'?: boolean;
|
|
5416
|
+
'locale'?: string;
|
|
5417
|
+
'nullValue'?: string;
|
|
5418
|
+
'tags'?: Array<string>;
|
|
5419
|
+
'title'?: string;
|
|
5420
|
+
'valueType'?: JsonApiComputedAttributeInAttributesValueTypeEnum;
|
|
5421
|
+
}
|
|
5422
|
+
export type JsonApiComputedAttributeInAttributesDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
5423
|
+
export type JsonApiComputedAttributeInAttributesValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
5424
|
+
export interface JsonApiComputedAttributeInAttributesContent {
|
|
5425
|
+
/**
|
|
5426
|
+
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
5427
|
+
*/
|
|
5428
|
+
'format'?: string | null;
|
|
5429
|
+
'maql': string;
|
|
5430
|
+
/**
|
|
5431
|
+
* Categorizes metric semantics (e.g., currency).
|
|
5432
|
+
*/
|
|
5433
|
+
'metricType'?: JsonApiComputedAttributeInAttributesContentMetricTypeEnum;
|
|
5434
|
+
}
|
|
5435
|
+
export type JsonApiComputedAttributeInAttributesContentMetricTypeEnum = 'UNSPECIFIED' | 'CURRENCY';
|
|
5436
|
+
export interface JsonApiComputedAttributeInDocument {
|
|
5437
|
+
'data': JsonApiComputedAttributeIn;
|
|
5438
|
+
}
|
|
5439
|
+
/**
|
|
5440
|
+
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
5441
|
+
*/
|
|
5442
|
+
export interface JsonApiComputedAttributeLinkage {
|
|
5443
|
+
'id': string;
|
|
5444
|
+
'type': JsonApiComputedAttributeLinkageTypeEnum;
|
|
5445
|
+
}
|
|
5446
|
+
export type JsonApiComputedAttributeLinkageTypeEnum = 'computedAttribute';
|
|
5447
|
+
/**
|
|
5448
|
+
* JSON:API representation of computedAttribute entity.
|
|
5449
|
+
*/
|
|
5450
|
+
export interface JsonApiComputedAttributeOut {
|
|
5451
|
+
'attributes': JsonApiComputedAttributeOutAttributes;
|
|
5452
|
+
/**
|
|
5453
|
+
* API identifier of an object
|
|
5454
|
+
*/
|
|
5455
|
+
'id': string;
|
|
5456
|
+
'meta'?: JsonApiComputedAttributeOutMeta;
|
|
5457
|
+
'relationships'?: JsonApiComputedAttributeOutRelationships;
|
|
5458
|
+
/**
|
|
5459
|
+
* Object type
|
|
5460
|
+
*/
|
|
5461
|
+
'type': JsonApiComputedAttributeOutTypeEnum;
|
|
5462
|
+
}
|
|
5463
|
+
export type JsonApiComputedAttributeOutTypeEnum = 'computedAttribute';
|
|
5464
|
+
export interface JsonApiComputedAttributeOutAttributes {
|
|
5465
|
+
'areRelationsValid'?: boolean;
|
|
5466
|
+
/**
|
|
5467
|
+
* Certification status of the entity.
|
|
5468
|
+
*/
|
|
5469
|
+
'certification'?: JsonApiComputedAttributeOutAttributesCertificationEnum;
|
|
5470
|
+
/**
|
|
5471
|
+
* Optional message associated with the certification.
|
|
5472
|
+
*/
|
|
5473
|
+
'certificationMessage'?: string | null;
|
|
5474
|
+
/**
|
|
5475
|
+
* Time when the certification was set.
|
|
5476
|
+
*/
|
|
5477
|
+
'certifiedAt'?: string | null;
|
|
5478
|
+
'content': JsonApiComputedAttributeOutAttributesContent;
|
|
5479
|
+
/**
|
|
5480
|
+
* Time of the entity creation.
|
|
5481
|
+
*/
|
|
5482
|
+
'createdAt'?: string | null;
|
|
5483
|
+
'dataType'?: JsonApiComputedAttributeOutAttributesDataTypeEnum;
|
|
5484
|
+
'description'?: string;
|
|
5485
|
+
'isHidden'?: boolean;
|
|
5486
|
+
'isNullable'?: boolean;
|
|
5487
|
+
'locale'?: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* Time of the last entity modification.
|
|
5490
|
+
*/
|
|
5491
|
+
'modifiedAt'?: string | null;
|
|
5492
|
+
'nullValue'?: string;
|
|
5493
|
+
'tags'?: Array<string>;
|
|
5494
|
+
'title'?: string;
|
|
5495
|
+
'valueType'?: JsonApiComputedAttributeOutAttributesValueTypeEnum;
|
|
5496
|
+
}
|
|
5497
|
+
export type JsonApiComputedAttributeOutAttributesCertificationEnum = 'CERTIFIED';
|
|
5498
|
+
export type JsonApiComputedAttributeOutAttributesDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
5499
|
+
export type JsonApiComputedAttributeOutAttributesValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
5500
|
+
export interface JsonApiComputedAttributeOutAttributesContent {
|
|
5501
|
+
/**
|
|
5502
|
+
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
5503
|
+
*/
|
|
5504
|
+
'format'?: string | null;
|
|
5505
|
+
'maql': string;
|
|
5506
|
+
/**
|
|
5507
|
+
* Categorizes metric semantics (e.g., currency).
|
|
5508
|
+
*/
|
|
5509
|
+
'metricType'?: JsonApiComputedAttributeOutAttributesContentMetricTypeEnum;
|
|
5510
|
+
}
|
|
5511
|
+
export type JsonApiComputedAttributeOutAttributesContentMetricTypeEnum = 'UNSPECIFIED' | 'CURRENCY';
|
|
5512
|
+
export interface JsonApiComputedAttributeOutDocument {
|
|
5513
|
+
'data': JsonApiComputedAttributeOut;
|
|
5514
|
+
/**
|
|
5515
|
+
* Included resources
|
|
5516
|
+
*/
|
|
5517
|
+
'included'?: Array<JsonApiComputedAttributeOutIncludes>;
|
|
5518
|
+
'links'?: ObjectLinks;
|
|
5519
|
+
}
|
|
5520
|
+
/**
|
|
5521
|
+
* @type JsonApiComputedAttributeOutIncludes
|
|
5522
|
+
*/
|
|
5523
|
+
export type JsonApiComputedAttributeOutIncludes = JsonApiAttributeOutWithLinks | JsonApiComputedAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
5524
|
+
/**
|
|
5525
|
+
* A JSON:API document with a list of resources
|
|
5526
|
+
*/
|
|
5527
|
+
export interface JsonApiComputedAttributeOutList {
|
|
5528
|
+
'data': Array<JsonApiComputedAttributeOutWithLinks>;
|
|
5529
|
+
/**
|
|
5530
|
+
* Included resources
|
|
5531
|
+
*/
|
|
5532
|
+
'included'?: Array<JsonApiComputedAttributeOutIncludes>;
|
|
5533
|
+
'links'?: ListLinks;
|
|
5534
|
+
'meta'?: JsonApiComputedAttributeOutListMeta;
|
|
5535
|
+
}
|
|
5536
|
+
export interface JsonApiComputedAttributeOutListMeta {
|
|
5537
|
+
'page'?: PageMetadata;
|
|
5538
|
+
}
|
|
5539
|
+
export interface JsonApiComputedAttributeOutMeta {
|
|
5540
|
+
'origin'?: JsonApiComputedAttributeOutMetaOrigin;
|
|
5541
|
+
}
|
|
5542
|
+
export interface JsonApiComputedAttributeOutMetaOrigin {
|
|
5543
|
+
/**
|
|
5544
|
+
* defines id of the workspace where the entity comes from
|
|
5545
|
+
*/
|
|
5546
|
+
'originId': string;
|
|
5547
|
+
/**
|
|
5548
|
+
* defines type of the origin of the entity
|
|
5549
|
+
*/
|
|
5550
|
+
'originType': JsonApiComputedAttributeOutMetaOriginOriginTypeEnum;
|
|
5551
|
+
}
|
|
5552
|
+
export type JsonApiComputedAttributeOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
5553
|
+
export interface JsonApiComputedAttributeOutRelationships {
|
|
5554
|
+
'attributes'?: JsonApiComputedAttributeOutRelationshipsAttributes;
|
|
5555
|
+
'certifiedBy'?: JsonApiComputedAttributeOutRelationshipsCertifiedBy;
|
|
5556
|
+
'computedAttributes'?: JsonApiComputedAttributeOutRelationshipsComputedAttributes;
|
|
5557
|
+
'createdBy'?: JsonApiComputedAttributeOutRelationshipsCreatedBy;
|
|
5558
|
+
'datasets'?: JsonApiComputedAttributeOutRelationshipsDatasets;
|
|
5559
|
+
'facts'?: JsonApiComputedAttributeOutRelationshipsFacts;
|
|
5560
|
+
'labels'?: JsonApiComputedAttributeOutRelationshipsLabels;
|
|
5561
|
+
'metrics'?: JsonApiComputedAttributeOutRelationshipsMetrics;
|
|
5562
|
+
'modifiedBy'?: JsonApiComputedAttributeOutRelationshipsModifiedBy;
|
|
5563
|
+
'parameters'?: JsonApiComputedAttributeOutRelationshipsParameters;
|
|
5564
|
+
}
|
|
5565
|
+
export interface JsonApiComputedAttributeOutRelationshipsAttributes {
|
|
5566
|
+
/**
|
|
5567
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5568
|
+
*/
|
|
5569
|
+
'data': Array<JsonApiAttributeLinkage>;
|
|
5570
|
+
}
|
|
5571
|
+
export interface JsonApiComputedAttributeOutRelationshipsCertifiedBy {
|
|
5572
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
5573
|
+
}
|
|
5574
|
+
export interface JsonApiComputedAttributeOutRelationshipsComputedAttributes {
|
|
5575
|
+
/**
|
|
5576
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5577
|
+
*/
|
|
5578
|
+
'data': Array<JsonApiComputedAttributeLinkage>;
|
|
5579
|
+
}
|
|
5580
|
+
export interface JsonApiComputedAttributeOutRelationshipsCreatedBy {
|
|
5581
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
5582
|
+
}
|
|
5583
|
+
export interface JsonApiComputedAttributeOutRelationshipsDatasets {
|
|
5584
|
+
/**
|
|
5585
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5586
|
+
*/
|
|
5587
|
+
'data': Array<JsonApiDatasetLinkage>;
|
|
5588
|
+
}
|
|
5589
|
+
export interface JsonApiComputedAttributeOutRelationshipsFacts {
|
|
5590
|
+
/**
|
|
5591
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5592
|
+
*/
|
|
5593
|
+
'data': Array<JsonApiFactLinkage>;
|
|
5594
|
+
}
|
|
5595
|
+
export interface JsonApiComputedAttributeOutRelationshipsLabels {
|
|
5596
|
+
/**
|
|
5597
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5598
|
+
*/
|
|
5599
|
+
'data': Array<JsonApiLabelLinkage>;
|
|
5600
|
+
}
|
|
5601
|
+
export interface JsonApiComputedAttributeOutRelationshipsMetrics {
|
|
5602
|
+
/**
|
|
5603
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5604
|
+
*/
|
|
5605
|
+
'data': Array<JsonApiMetricLinkage>;
|
|
5606
|
+
}
|
|
5607
|
+
export interface JsonApiComputedAttributeOutRelationshipsModifiedBy {
|
|
5608
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
5609
|
+
}
|
|
5610
|
+
export interface JsonApiComputedAttributeOutRelationshipsParameters {
|
|
5611
|
+
/**
|
|
5612
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5613
|
+
*/
|
|
5614
|
+
'data': Array<JsonApiParameterLinkage>;
|
|
5615
|
+
}
|
|
5616
|
+
export interface JsonApiComputedAttributeOutWithLinks {
|
|
5617
|
+
'attributes': JsonApiComputedAttributeOutAttributes;
|
|
5618
|
+
/**
|
|
5619
|
+
* API identifier of an object
|
|
5620
|
+
*/
|
|
5621
|
+
'id': string;
|
|
5622
|
+
'meta'?: JsonApiComputedAttributeOutMeta;
|
|
5623
|
+
'relationships'?: JsonApiComputedAttributeOutRelationships;
|
|
5624
|
+
/**
|
|
5625
|
+
* Object type
|
|
5626
|
+
*/
|
|
5627
|
+
'type': JsonApiComputedAttributeOutWithLinksTypeEnum;
|
|
5628
|
+
'links'?: ObjectLinks;
|
|
5629
|
+
}
|
|
5630
|
+
export type JsonApiComputedAttributeOutWithLinksTypeEnum = 'computedAttribute';
|
|
5631
|
+
/**
|
|
5632
|
+
* JSON:API representation of patching computedAttribute entity.
|
|
5633
|
+
*/
|
|
5634
|
+
export interface JsonApiComputedAttributePatch {
|
|
5635
|
+
'attributes': JsonApiComputedAttributePatchAttributes;
|
|
5636
|
+
/**
|
|
5637
|
+
* API identifier of an object
|
|
5638
|
+
*/
|
|
5639
|
+
'id': string;
|
|
5640
|
+
/**
|
|
5641
|
+
* Object type
|
|
5642
|
+
*/
|
|
5643
|
+
'type': JsonApiComputedAttributePatchTypeEnum;
|
|
5644
|
+
}
|
|
5645
|
+
export type JsonApiComputedAttributePatchTypeEnum = 'computedAttribute';
|
|
5646
|
+
export interface JsonApiComputedAttributePatchAttributes {
|
|
5647
|
+
'areRelationsValid'?: boolean;
|
|
5648
|
+
'content'?: JsonApiComputedAttributePatchAttributesContent;
|
|
5649
|
+
'dataType'?: JsonApiComputedAttributePatchAttributesDataTypeEnum;
|
|
5650
|
+
'description'?: string;
|
|
5651
|
+
'isHidden'?: boolean;
|
|
5652
|
+
'isNullable'?: boolean;
|
|
5653
|
+
'locale'?: string;
|
|
5654
|
+
'nullValue'?: string;
|
|
5655
|
+
'tags'?: Array<string>;
|
|
5656
|
+
'title'?: string;
|
|
5657
|
+
'valueType'?: JsonApiComputedAttributePatchAttributesValueTypeEnum;
|
|
5658
|
+
}
|
|
5659
|
+
export type JsonApiComputedAttributePatchAttributesDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
5660
|
+
export type JsonApiComputedAttributePatchAttributesValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
5661
|
+
export interface JsonApiComputedAttributePatchAttributesContent {
|
|
5662
|
+
/**
|
|
5663
|
+
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
5664
|
+
*/
|
|
5665
|
+
'format'?: string | null;
|
|
5666
|
+
'maql': string;
|
|
5667
|
+
/**
|
|
5668
|
+
* Categorizes metric semantics (e.g., currency).
|
|
5669
|
+
*/
|
|
5670
|
+
'metricType'?: JsonApiComputedAttributePatchAttributesContentMetricTypeEnum;
|
|
5671
|
+
}
|
|
5672
|
+
export type JsonApiComputedAttributePatchAttributesContentMetricTypeEnum = 'UNSPECIFIED' | 'CURRENCY';
|
|
5673
|
+
export interface JsonApiComputedAttributePatchDocument {
|
|
5674
|
+
'data': JsonApiComputedAttributePatch;
|
|
5675
|
+
}
|
|
5676
|
+
/**
|
|
5677
|
+
* JSON:API representation of computedAttribute entity.
|
|
5678
|
+
*/
|
|
5679
|
+
export interface JsonApiComputedAttributePostOptionalId {
|
|
5680
|
+
'attributes': JsonApiComputedAttributePostOptionalIdAttributes;
|
|
5681
|
+
/**
|
|
5682
|
+
* API identifier of an object
|
|
5683
|
+
*/
|
|
5684
|
+
'id'?: string;
|
|
5685
|
+
/**
|
|
5686
|
+
* Object type
|
|
5687
|
+
*/
|
|
5688
|
+
'type': JsonApiComputedAttributePostOptionalIdTypeEnum;
|
|
5689
|
+
}
|
|
5690
|
+
export type JsonApiComputedAttributePostOptionalIdTypeEnum = 'computedAttribute';
|
|
5691
|
+
export interface JsonApiComputedAttributePostOptionalIdAttributes {
|
|
5692
|
+
'areRelationsValid'?: boolean;
|
|
5693
|
+
'content': JsonApiComputedAttributePostOptionalIdAttributesContent;
|
|
5694
|
+
'dataType'?: JsonApiComputedAttributePostOptionalIdAttributesDataTypeEnum;
|
|
5695
|
+
'description'?: string;
|
|
5696
|
+
'isHidden'?: boolean;
|
|
5697
|
+
'isNullable'?: boolean;
|
|
5698
|
+
'locale'?: string;
|
|
5699
|
+
'nullValue'?: string;
|
|
5700
|
+
'tags'?: Array<string>;
|
|
5701
|
+
'title'?: string;
|
|
5702
|
+
'valueType'?: JsonApiComputedAttributePostOptionalIdAttributesValueTypeEnum;
|
|
5703
|
+
}
|
|
5704
|
+
export type JsonApiComputedAttributePostOptionalIdAttributesDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
5705
|
+
export type JsonApiComputedAttributePostOptionalIdAttributesValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
5706
|
+
export interface JsonApiComputedAttributePostOptionalIdAttributesContent {
|
|
5707
|
+
/**
|
|
5708
|
+
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
5709
|
+
*/
|
|
5710
|
+
'format'?: string | null;
|
|
5711
|
+
'maql': string;
|
|
5712
|
+
/**
|
|
5713
|
+
* Categorizes metric semantics (e.g., currency).
|
|
5714
|
+
*/
|
|
5715
|
+
'metricType'?: JsonApiComputedAttributePostOptionalIdAttributesContentMetricTypeEnum;
|
|
5716
|
+
}
|
|
5717
|
+
export type JsonApiComputedAttributePostOptionalIdAttributesContentMetricTypeEnum = 'UNSPECIFIED' | 'CURRENCY';
|
|
5718
|
+
export interface JsonApiComputedAttributePostOptionalIdDocument {
|
|
5719
|
+
'data': JsonApiComputedAttributePostOptionalId;
|
|
5720
|
+
}
|
|
5101
5721
|
/**
|
|
5102
5722
|
* JSON:API representation of cookieSecurityConfiguration entity.
|
|
5103
5723
|
*/
|
|
@@ -5816,7 +6436,7 @@ export interface JsonApiDataSourceIdentifierOutAttributes {
|
|
|
5816
6436
|
'schema': string;
|
|
5817
6437
|
'type': JsonApiDataSourceIdentifierOutAttributesTypeEnum;
|
|
5818
6438
|
}
|
|
5819
|
-
export type JsonApiDataSourceIdentifierOutAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | '
|
|
6439
|
+
export type JsonApiDataSourceIdentifierOutAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO';
|
|
5820
6440
|
export interface JsonApiDataSourceIdentifierOutDocument {
|
|
5821
6441
|
'data': JsonApiDataSourceIdentifierOut;
|
|
5822
6442
|
'links'?: ObjectLinks;
|
|
@@ -5938,7 +6558,7 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
5938
6558
|
export type JsonApiDataSourceInAttributesAuthenticationTypeEnum = 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'OIDC_PASSTHROUGH';
|
|
5939
6559
|
export type JsonApiDataSourceInAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
5940
6560
|
export type JsonApiDataSourceInAttributesDateTimeSemanticsEnum = 'LOCAL' | 'UTC';
|
|
5941
|
-
export type JsonApiDataSourceInAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | '
|
|
6561
|
+
export type JsonApiDataSourceInAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO';
|
|
5942
6562
|
/**
|
|
5943
6563
|
* @type JsonApiDataSourceInAttributesCacheRetention
|
|
5944
6564
|
* Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.
|
|
@@ -6025,7 +6645,7 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
6025
6645
|
export type JsonApiDataSourceOutAttributesAuthenticationTypeEnum = 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'OIDC_PASSTHROUGH';
|
|
6026
6646
|
export type JsonApiDataSourceOutAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
6027
6647
|
export type JsonApiDataSourceOutAttributesDateTimeSemanticsEnum = 'LOCAL' | 'UTC';
|
|
6028
|
-
export type JsonApiDataSourceOutAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | '
|
|
6648
|
+
export type JsonApiDataSourceOutAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO';
|
|
6029
6649
|
/**
|
|
6030
6650
|
* @type JsonApiDataSourceOutAttributesCacheRetention
|
|
6031
6651
|
* Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.
|
|
@@ -6160,7 +6780,7 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
6160
6780
|
export type JsonApiDataSourcePatchAttributesAuthenticationTypeEnum = 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'OIDC_PASSTHROUGH';
|
|
6161
6781
|
export type JsonApiDataSourcePatchAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
6162
6782
|
export type JsonApiDataSourcePatchAttributesDateTimeSemanticsEnum = 'LOCAL' | 'UTC';
|
|
6163
|
-
export type JsonApiDataSourcePatchAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | '
|
|
6783
|
+
export type JsonApiDataSourcePatchAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO';
|
|
6164
6784
|
/**
|
|
6165
6785
|
* @type JsonApiDataSourcePatchAttributesCacheRetention
|
|
6166
6786
|
* Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.
|
|
@@ -8354,6 +8974,7 @@ export interface JsonApiLabelOut {
|
|
|
8354
8974
|
export type JsonApiLabelOutTypeEnum = 'label';
|
|
8355
8975
|
export interface JsonApiLabelOutAttributes {
|
|
8356
8976
|
'areRelationsValid'?: boolean;
|
|
8977
|
+
'conditionalFormatting'?: JsonApiLabelOutAttributesConditionalFormatting | null;
|
|
8357
8978
|
'description'?: string;
|
|
8358
8979
|
'geoAreaConfig'?: JsonApiLabelOutAttributesGeoAreaConfig;
|
|
8359
8980
|
'isHidden'?: boolean;
|
|
@@ -8370,6 +8991,19 @@ export interface JsonApiLabelOutAttributes {
|
|
|
8370
8991
|
}
|
|
8371
8992
|
export type JsonApiLabelOutAttributesSourceColumnDataTypeEnum = 'INT' | 'STRING' | 'DATE' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMP_TZ' | 'BOOLEAN' | 'HLL';
|
|
8372
8993
|
export type JsonApiLabelOutAttributesValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
8994
|
+
/**
|
|
8995
|
+
* Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted.
|
|
8996
|
+
*/
|
|
8997
|
+
export interface JsonApiLabelOutAttributesConditionalFormatting {
|
|
8998
|
+
/**
|
|
8999
|
+
* Conditions evaluated in order; the first match wins.
|
|
9000
|
+
*/
|
|
9001
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
9002
|
+
/**
|
|
9003
|
+
* Whether the conditions are applied when rendering.
|
|
9004
|
+
*/
|
|
9005
|
+
'enabled': boolean;
|
|
9006
|
+
}
|
|
8373
9007
|
/**
|
|
8374
9008
|
* Configuration specific to geo area labels.
|
|
8375
9009
|
*/
|
|
@@ -8454,10 +9088,24 @@ export interface JsonApiLabelPatch {
|
|
|
8454
9088
|
}
|
|
8455
9089
|
export type JsonApiLabelPatchTypeEnum = 'label';
|
|
8456
9090
|
export interface JsonApiLabelPatchAttributes {
|
|
9091
|
+
'conditionalFormatting'?: JsonApiLabelPatchAttributesConditionalFormatting | null;
|
|
8457
9092
|
'description'?: string;
|
|
8458
9093
|
'tags'?: Array<string>;
|
|
8459
9094
|
'title'?: string;
|
|
8460
9095
|
}
|
|
9096
|
+
/**
|
|
9097
|
+
* Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted.
|
|
9098
|
+
*/
|
|
9099
|
+
export interface JsonApiLabelPatchAttributesConditionalFormatting {
|
|
9100
|
+
/**
|
|
9101
|
+
* Conditions evaluated in order; the first match wins.
|
|
9102
|
+
*/
|
|
9103
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
9104
|
+
/**
|
|
9105
|
+
* Whether the conditions are applied when rendering.
|
|
9106
|
+
*/
|
|
9107
|
+
'enabled': boolean;
|
|
9108
|
+
}
|
|
8461
9109
|
export interface JsonApiLabelPatchDocument {
|
|
8462
9110
|
'data': JsonApiLabelPatch;
|
|
8463
9111
|
}
|
|
@@ -8895,6 +9543,7 @@ export interface JsonApiMetricIn {
|
|
|
8895
9543
|
export type JsonApiMetricInTypeEnum = 'metric';
|
|
8896
9544
|
export interface JsonApiMetricInAttributes {
|
|
8897
9545
|
'areRelationsValid'?: boolean;
|
|
9546
|
+
'conditionalFormatting'?: JsonApiMetricInAttributesConditionalFormatting | null;
|
|
8898
9547
|
'content': JsonApiMetricInAttributesContent;
|
|
8899
9548
|
'description'?: string;
|
|
8900
9549
|
'isHidden'?: boolean;
|
|
@@ -8902,6 +9551,19 @@ export interface JsonApiMetricInAttributes {
|
|
|
8902
9551
|
'tags'?: Array<string>;
|
|
8903
9552
|
'title'?: string;
|
|
8904
9553
|
}
|
|
9554
|
+
/**
|
|
9555
|
+
* Conditional formatting inherited by every table column that renders this metric.
|
|
9556
|
+
*/
|
|
9557
|
+
export interface JsonApiMetricInAttributesConditionalFormatting {
|
|
9558
|
+
/**
|
|
9559
|
+
* Conditions evaluated in order; the first match wins.
|
|
9560
|
+
*/
|
|
9561
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
9562
|
+
/**
|
|
9563
|
+
* Whether the conditions are applied when rendering.
|
|
9564
|
+
*/
|
|
9565
|
+
'enabled': boolean;
|
|
9566
|
+
}
|
|
8905
9567
|
export interface JsonApiMetricInAttributesContent {
|
|
8906
9568
|
/**
|
|
8907
9569
|
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
@@ -8956,6 +9618,7 @@ export interface JsonApiMetricOutAttributes {
|
|
|
8956
9618
|
* Time when the certification was set.
|
|
8957
9619
|
*/
|
|
8958
9620
|
'certifiedAt'?: string | null;
|
|
9621
|
+
'conditionalFormatting'?: JsonApiMetricOutAttributesConditionalFormatting | null;
|
|
8959
9622
|
'content': JsonApiMetricOutAttributesContent;
|
|
8960
9623
|
/**
|
|
8961
9624
|
* Time of the entity creation.
|
|
@@ -8972,6 +9635,19 @@ export interface JsonApiMetricOutAttributes {
|
|
|
8972
9635
|
'title'?: string;
|
|
8973
9636
|
}
|
|
8974
9637
|
export type JsonApiMetricOutAttributesCertificationEnum = 'CERTIFIED';
|
|
9638
|
+
/**
|
|
9639
|
+
* Conditional formatting inherited by every table column that renders this metric.
|
|
9640
|
+
*/
|
|
9641
|
+
export interface JsonApiMetricOutAttributesConditionalFormatting {
|
|
9642
|
+
/**
|
|
9643
|
+
* Conditions evaluated in order; the first match wins.
|
|
9644
|
+
*/
|
|
9645
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
9646
|
+
/**
|
|
9647
|
+
* Whether the conditions are applied when rendering.
|
|
9648
|
+
*/
|
|
9649
|
+
'enabled': boolean;
|
|
9650
|
+
}
|
|
8975
9651
|
export interface JsonApiMetricOutAttributesContent {
|
|
8976
9652
|
/**
|
|
8977
9653
|
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
@@ -8989,13 +9665,9 @@ export interface JsonApiMetricOutDocument {
|
|
|
8989
9665
|
/**
|
|
8990
9666
|
* Included resources
|
|
8991
9667
|
*/
|
|
8992
|
-
'included'?: Array<
|
|
9668
|
+
'included'?: Array<JsonApiComputedAttributeOutIncludes>;
|
|
8993
9669
|
'links'?: ObjectLinks;
|
|
8994
9670
|
}
|
|
8995
|
-
/**
|
|
8996
|
-
* @type JsonApiMetricOutIncludes
|
|
8997
|
-
*/
|
|
8998
|
-
export type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
8999
9671
|
/**
|
|
9000
9672
|
* A JSON:API document with a list of resources
|
|
9001
9673
|
*/
|
|
@@ -9004,7 +9676,7 @@ export interface JsonApiMetricOutList {
|
|
|
9004
9676
|
/**
|
|
9005
9677
|
* Included resources
|
|
9006
9678
|
*/
|
|
9007
|
-
'included'?: Array<
|
|
9679
|
+
'included'?: Array<JsonApiComputedAttributeOutIncludes>;
|
|
9008
9680
|
'links'?: ListLinks;
|
|
9009
9681
|
'meta'?: JsonApiMetricOutListMeta;
|
|
9010
9682
|
}
|
|
@@ -9028,6 +9700,7 @@ export type JsonApiMetricOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
|
9028
9700
|
export interface JsonApiMetricOutRelationships {
|
|
9029
9701
|
'attributes'?: JsonApiMetricOutRelationshipsAttributes;
|
|
9030
9702
|
'certifiedBy'?: JsonApiMetricOutRelationshipsCertifiedBy;
|
|
9703
|
+
'computedAttributes'?: JsonApiMetricOutRelationshipsComputedAttributes;
|
|
9031
9704
|
'createdBy'?: JsonApiMetricOutRelationshipsCreatedBy;
|
|
9032
9705
|
'datasets'?: JsonApiMetricOutRelationshipsDatasets;
|
|
9033
9706
|
'facts'?: JsonApiMetricOutRelationshipsFacts;
|
|
@@ -9045,6 +9718,12 @@ export interface JsonApiMetricOutRelationshipsAttributes {
|
|
|
9045
9718
|
export interface JsonApiMetricOutRelationshipsCertifiedBy {
|
|
9046
9719
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
9047
9720
|
}
|
|
9721
|
+
export interface JsonApiMetricOutRelationshipsComputedAttributes {
|
|
9722
|
+
/**
|
|
9723
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
9724
|
+
*/
|
|
9725
|
+
'data': Array<JsonApiComputedAttributeLinkage>;
|
|
9726
|
+
}
|
|
9048
9727
|
export interface JsonApiMetricOutRelationshipsCreatedBy {
|
|
9049
9728
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
9050
9729
|
}
|
|
@@ -9113,6 +9792,7 @@ export interface JsonApiMetricPatch {
|
|
|
9113
9792
|
export type JsonApiMetricPatchTypeEnum = 'metric';
|
|
9114
9793
|
export interface JsonApiMetricPatchAttributes {
|
|
9115
9794
|
'areRelationsValid'?: boolean;
|
|
9795
|
+
'conditionalFormatting'?: JsonApiMetricPatchAttributesConditionalFormatting | null;
|
|
9116
9796
|
'content'?: JsonApiMetricPatchAttributesContent;
|
|
9117
9797
|
'description'?: string;
|
|
9118
9798
|
'isHidden'?: boolean;
|
|
@@ -9120,6 +9800,19 @@ export interface JsonApiMetricPatchAttributes {
|
|
|
9120
9800
|
'tags'?: Array<string>;
|
|
9121
9801
|
'title'?: string;
|
|
9122
9802
|
}
|
|
9803
|
+
/**
|
|
9804
|
+
* Conditional formatting inherited by every table column that renders this metric.
|
|
9805
|
+
*/
|
|
9806
|
+
export interface JsonApiMetricPatchAttributesConditionalFormatting {
|
|
9807
|
+
/**
|
|
9808
|
+
* Conditions evaluated in order; the first match wins.
|
|
9809
|
+
*/
|
|
9810
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
9811
|
+
/**
|
|
9812
|
+
* Whether the conditions are applied when rendering.
|
|
9813
|
+
*/
|
|
9814
|
+
'enabled': boolean;
|
|
9815
|
+
}
|
|
9123
9816
|
export interface JsonApiMetricPatchAttributesContent {
|
|
9124
9817
|
/**
|
|
9125
9818
|
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
@@ -9152,6 +9845,7 @@ export interface JsonApiMetricPostOptionalId {
|
|
|
9152
9845
|
export type JsonApiMetricPostOptionalIdTypeEnum = 'metric';
|
|
9153
9846
|
export interface JsonApiMetricPostOptionalIdAttributes {
|
|
9154
9847
|
'areRelationsValid'?: boolean;
|
|
9848
|
+
'conditionalFormatting'?: JsonApiMetricPostOptionalIdAttributesConditionalFormatting | null;
|
|
9155
9849
|
'content': JsonApiMetricPostOptionalIdAttributesContent;
|
|
9156
9850
|
'description'?: string;
|
|
9157
9851
|
'isHidden'?: boolean;
|
|
@@ -9159,6 +9853,19 @@ export interface JsonApiMetricPostOptionalIdAttributes {
|
|
|
9159
9853
|
'tags'?: Array<string>;
|
|
9160
9854
|
'title'?: string;
|
|
9161
9855
|
}
|
|
9856
|
+
/**
|
|
9857
|
+
* Conditional formatting inherited by every table column that renders this metric.
|
|
9858
|
+
*/
|
|
9859
|
+
export interface JsonApiMetricPostOptionalIdAttributesConditionalFormatting {
|
|
9860
|
+
/**
|
|
9861
|
+
* Conditions evaluated in order; the first match wins.
|
|
9862
|
+
*/
|
|
9863
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
9864
|
+
/**
|
|
9865
|
+
* Whether the conditions are applied when rendering.
|
|
9866
|
+
*/
|
|
9867
|
+
'enabled': boolean;
|
|
9868
|
+
}
|
|
9162
9869
|
export interface JsonApiMetricPostOptionalIdAttributesContent {
|
|
9163
9870
|
/**
|
|
9164
9871
|
* Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user\'s format locale. Single-value filters only; multi-value filters use fallback values.
|
|
@@ -9815,7 +10522,7 @@ export interface JsonApiOrganizationSettingInAttributes {
|
|
|
9815
10522
|
'content'?: object;
|
|
9816
10523
|
'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
9817
10524
|
}
|
|
9818
|
-
export type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
10525
|
+
export type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
9819
10526
|
export interface JsonApiOrganizationSettingInDocument {
|
|
9820
10527
|
'data': JsonApiOrganizationSettingIn;
|
|
9821
10528
|
}
|
|
@@ -9841,7 +10548,7 @@ export interface JsonApiOrganizationSettingOutAttributes {
|
|
|
9841
10548
|
'content'?: object;
|
|
9842
10549
|
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
9843
10550
|
}
|
|
9844
|
-
export type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
10551
|
+
export type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
9845
10552
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
9846
10553
|
'data': JsonApiOrganizationSettingOut;
|
|
9847
10554
|
'links'?: ObjectLinks;
|
|
@@ -9892,7 +10599,7 @@ export interface JsonApiOrganizationSettingPatchAttributes {
|
|
|
9892
10599
|
'content'?: object;
|
|
9893
10600
|
'type'?: JsonApiOrganizationSettingPatchAttributesTypeEnum;
|
|
9894
10601
|
}
|
|
9895
|
-
export type JsonApiOrganizationSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
10602
|
+
export type JsonApiOrganizationSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
9896
10603
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
9897
10604
|
'data': JsonApiOrganizationSettingPatch;
|
|
9898
10605
|
}
|
|
@@ -10276,7 +10983,7 @@ export interface JsonApiUserDataFilterOutDocument {
|
|
|
10276
10983
|
/**
|
|
10277
10984
|
* @type JsonApiUserDataFilterOutIncludes
|
|
10278
10985
|
*/
|
|
10279
|
-
export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
10986
|
+
export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | JsonApiComputedAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserGroupOutWithLinks | JsonApiUserOutWithLinks;
|
|
10280
10987
|
/**
|
|
10281
10988
|
* A JSON:API document with a list of resources
|
|
10282
10989
|
*/
|
|
@@ -10308,6 +11015,7 @@ export interface JsonApiUserDataFilterOutMetaOrigin {
|
|
|
10308
11015
|
export type JsonApiUserDataFilterOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
10309
11016
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
10310
11017
|
'attributes'?: JsonApiUserDataFilterOutRelationshipsAttributes;
|
|
11018
|
+
'computedAttributes'?: JsonApiUserDataFilterOutRelationshipsComputedAttributes;
|
|
10311
11019
|
'datasets'?: JsonApiUserDataFilterOutRelationshipsDatasets;
|
|
10312
11020
|
'facts'?: JsonApiUserDataFilterOutRelationshipsFacts;
|
|
10313
11021
|
'labels'?: JsonApiUserDataFilterOutRelationshipsLabels;
|
|
@@ -10322,6 +11030,12 @@ export interface JsonApiUserDataFilterOutRelationshipsAttributes {
|
|
|
10322
11030
|
*/
|
|
10323
11031
|
'data': Array<JsonApiAttributeLinkage>;
|
|
10324
11032
|
}
|
|
11033
|
+
export interface JsonApiUserDataFilterOutRelationshipsComputedAttributes {
|
|
11034
|
+
/**
|
|
11035
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11036
|
+
*/
|
|
11037
|
+
'data': Array<JsonApiComputedAttributeLinkage>;
|
|
11038
|
+
}
|
|
10325
11039
|
export interface JsonApiUserDataFilterOutRelationshipsDatasets {
|
|
10326
11040
|
/**
|
|
10327
11041
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -10814,7 +11528,7 @@ export interface JsonApiUserSettingInAttributes {
|
|
|
10814
11528
|
'content'?: object;
|
|
10815
11529
|
'type'?: JsonApiUserSettingInAttributesTypeEnum;
|
|
10816
11530
|
}
|
|
10817
|
-
export type JsonApiUserSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
11531
|
+
export type JsonApiUserSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
10818
11532
|
export interface JsonApiUserSettingInDocument {
|
|
10819
11533
|
'data': JsonApiUserSettingIn;
|
|
10820
11534
|
}
|
|
@@ -10840,7 +11554,7 @@ export interface JsonApiUserSettingOutAttributes {
|
|
|
10840
11554
|
'content'?: object;
|
|
10841
11555
|
'type'?: JsonApiUserSettingOutAttributesTypeEnum;
|
|
10842
11556
|
}
|
|
10843
|
-
export type JsonApiUserSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
11557
|
+
export type JsonApiUserSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
10844
11558
|
export interface JsonApiUserSettingOutDocument {
|
|
10845
11559
|
'data': JsonApiUserSettingOut;
|
|
10846
11560
|
'links'?: ObjectLinks;
|
|
@@ -10886,6 +11600,7 @@ export interface JsonApiVisualizationObjectIn {
|
|
|
10886
11600
|
export type JsonApiVisualizationObjectInTypeEnum = 'visualizationObject';
|
|
10887
11601
|
export interface JsonApiVisualizationObjectInAttributes {
|
|
10888
11602
|
'areRelationsValid'?: boolean;
|
|
11603
|
+
'conditionalFormatting'?: JsonApiVisualizationObjectInAttributesConditionalFormatting | null;
|
|
10889
11604
|
/**
|
|
10890
11605
|
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
10891
11606
|
*/
|
|
@@ -10895,6 +11610,19 @@ export interface JsonApiVisualizationObjectInAttributes {
|
|
|
10895
11610
|
'tags'?: Array<string>;
|
|
10896
11611
|
'title'?: string;
|
|
10897
11612
|
}
|
|
11613
|
+
/**
|
|
11614
|
+
* Conditional formatting applied when this visualization is rendered.
|
|
11615
|
+
*/
|
|
11616
|
+
export interface JsonApiVisualizationObjectInAttributesConditionalFormatting {
|
|
11617
|
+
/**
|
|
11618
|
+
* Whether the rules are applied when rendering.
|
|
11619
|
+
*/
|
|
11620
|
+
'enabled': boolean;
|
|
11621
|
+
/**
|
|
11622
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
11623
|
+
*/
|
|
11624
|
+
'rules': Array<ConditionalFormattingRule>;
|
|
11625
|
+
}
|
|
10898
11626
|
export interface JsonApiVisualizationObjectInDocument {
|
|
10899
11627
|
'data': JsonApiVisualizationObjectIn;
|
|
10900
11628
|
}
|
|
@@ -10937,6 +11665,7 @@ export interface JsonApiVisualizationObjectOutAttributes {
|
|
|
10937
11665
|
* Time when the certification was set.
|
|
10938
11666
|
*/
|
|
10939
11667
|
'certifiedAt'?: string | null;
|
|
11668
|
+
'conditionalFormatting'?: JsonApiVisualizationObjectOutAttributesConditionalFormatting | null;
|
|
10940
11669
|
/**
|
|
10941
11670
|
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
10942
11671
|
*/
|
|
@@ -10955,14 +11684,31 @@ export interface JsonApiVisualizationObjectOutAttributes {
|
|
|
10955
11684
|
'title'?: string;
|
|
10956
11685
|
}
|
|
10957
11686
|
export type JsonApiVisualizationObjectOutAttributesCertificationEnum = 'CERTIFIED';
|
|
11687
|
+
/**
|
|
11688
|
+
* Conditional formatting applied when this visualization is rendered.
|
|
11689
|
+
*/
|
|
11690
|
+
export interface JsonApiVisualizationObjectOutAttributesConditionalFormatting {
|
|
11691
|
+
/**
|
|
11692
|
+
* Whether the rules are applied when rendering.
|
|
11693
|
+
*/
|
|
11694
|
+
'enabled': boolean;
|
|
11695
|
+
/**
|
|
11696
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
11697
|
+
*/
|
|
11698
|
+
'rules': Array<ConditionalFormattingRule>;
|
|
11699
|
+
}
|
|
10958
11700
|
export interface JsonApiVisualizationObjectOutDocument {
|
|
10959
11701
|
'data': JsonApiVisualizationObjectOut;
|
|
10960
11702
|
/**
|
|
10961
11703
|
* Included resources
|
|
10962
11704
|
*/
|
|
10963
|
-
'included'?: Array<
|
|
11705
|
+
'included'?: Array<JsonApiVisualizationObjectOutIncludes>;
|
|
10964
11706
|
'links'?: ObjectLinks;
|
|
10965
11707
|
}
|
|
11708
|
+
/**
|
|
11709
|
+
* @type JsonApiVisualizationObjectOutIncludes
|
|
11710
|
+
*/
|
|
11711
|
+
export type JsonApiVisualizationObjectOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
10966
11712
|
/**
|
|
10967
11713
|
* A JSON:API document with a list of resources
|
|
10968
11714
|
*/
|
|
@@ -10971,7 +11717,7 @@ export interface JsonApiVisualizationObjectOutList {
|
|
|
10971
11717
|
/**
|
|
10972
11718
|
* Included resources
|
|
10973
11719
|
*/
|
|
10974
|
-
'included'?: Array<
|
|
11720
|
+
'included'?: Array<JsonApiVisualizationObjectOutIncludes>;
|
|
10975
11721
|
'links'?: ListLinks;
|
|
10976
11722
|
'meta'?: JsonApiVisualizationObjectOutListMeta;
|
|
10977
11723
|
}
|
|
@@ -11080,6 +11826,7 @@ export interface JsonApiVisualizationObjectPatch {
|
|
|
11080
11826
|
export type JsonApiVisualizationObjectPatchTypeEnum = 'visualizationObject';
|
|
11081
11827
|
export interface JsonApiVisualizationObjectPatchAttributes {
|
|
11082
11828
|
'areRelationsValid'?: boolean;
|
|
11829
|
+
'conditionalFormatting'?: JsonApiVisualizationObjectPatchAttributesConditionalFormatting | null;
|
|
11083
11830
|
/**
|
|
11084
11831
|
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
11085
11832
|
*/
|
|
@@ -11089,6 +11836,19 @@ export interface JsonApiVisualizationObjectPatchAttributes {
|
|
|
11089
11836
|
'tags'?: Array<string>;
|
|
11090
11837
|
'title'?: string;
|
|
11091
11838
|
}
|
|
11839
|
+
/**
|
|
11840
|
+
* Conditional formatting applied when this visualization is rendered.
|
|
11841
|
+
*/
|
|
11842
|
+
export interface JsonApiVisualizationObjectPatchAttributesConditionalFormatting {
|
|
11843
|
+
/**
|
|
11844
|
+
* Whether the rules are applied when rendering.
|
|
11845
|
+
*/
|
|
11846
|
+
'enabled': boolean;
|
|
11847
|
+
/**
|
|
11848
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
11849
|
+
*/
|
|
11850
|
+
'rules': Array<ConditionalFormattingRule>;
|
|
11851
|
+
}
|
|
11092
11852
|
export interface JsonApiVisualizationObjectPatchDocument {
|
|
11093
11853
|
'data': JsonApiVisualizationObjectPatch;
|
|
11094
11854
|
}
|
|
@@ -11109,6 +11869,7 @@ export interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
11109
11869
|
export type JsonApiVisualizationObjectPostOptionalIdTypeEnum = 'visualizationObject';
|
|
11110
11870
|
export interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
11111
11871
|
'areRelationsValid'?: boolean;
|
|
11872
|
+
'conditionalFormatting'?: JsonApiVisualizationObjectPostOptionalIdAttributesConditionalFormatting | null;
|
|
11112
11873
|
/**
|
|
11113
11874
|
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
11114
11875
|
*/
|
|
@@ -11118,6 +11879,19 @@ export interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
|
11118
11879
|
'tags'?: Array<string>;
|
|
11119
11880
|
'title'?: string;
|
|
11120
11881
|
}
|
|
11882
|
+
/**
|
|
11883
|
+
* Conditional formatting applied when this visualization is rendered.
|
|
11884
|
+
*/
|
|
11885
|
+
export interface JsonApiVisualizationObjectPostOptionalIdAttributesConditionalFormatting {
|
|
11886
|
+
/**
|
|
11887
|
+
* Whether the rules are applied when rendering.
|
|
11888
|
+
*/
|
|
11889
|
+
'enabled': boolean;
|
|
11890
|
+
/**
|
|
11891
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
11892
|
+
*/
|
|
11893
|
+
'rules': Array<ConditionalFormattingRule>;
|
|
11894
|
+
}
|
|
11121
11895
|
export interface JsonApiVisualizationObjectPostOptionalIdDocument {
|
|
11122
11896
|
'data': JsonApiVisualizationObjectPostOptionalId;
|
|
11123
11897
|
}
|
|
@@ -12255,7 +13029,7 @@ export interface JsonApiWorkspaceSettingInAttributes {
|
|
|
12255
13029
|
'content'?: object;
|
|
12256
13030
|
'type'?: JsonApiWorkspaceSettingInAttributesTypeEnum;
|
|
12257
13031
|
}
|
|
12258
|
-
export type JsonApiWorkspaceSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
13032
|
+
export type JsonApiWorkspaceSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
12259
13033
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
12260
13034
|
'data': JsonApiWorkspaceSettingIn;
|
|
12261
13035
|
}
|
|
@@ -12282,7 +13056,7 @@ export interface JsonApiWorkspaceSettingOutAttributes {
|
|
|
12282
13056
|
'content'?: object;
|
|
12283
13057
|
'type'?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
12284
13058
|
}
|
|
12285
|
-
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
13059
|
+
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
12286
13060
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
12287
13061
|
'data': JsonApiWorkspaceSettingOut;
|
|
12288
13062
|
'links'?: ObjectLinks;
|
|
@@ -12348,7 +13122,7 @@ export interface JsonApiWorkspaceSettingPatchAttributes {
|
|
|
12348
13122
|
'content'?: object;
|
|
12349
13123
|
'type'?: JsonApiWorkspaceSettingPatchAttributesTypeEnum;
|
|
12350
13124
|
}
|
|
12351
|
-
export type JsonApiWorkspaceSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
13125
|
+
export type JsonApiWorkspaceSettingPatchAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
12352
13126
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
12353
13127
|
'data': JsonApiWorkspaceSettingPatch;
|
|
12354
13128
|
}
|
|
@@ -12374,7 +13148,7 @@ export interface JsonApiWorkspaceSettingPostOptionalIdAttributes {
|
|
|
12374
13148
|
'content'?: object;
|
|
12375
13149
|
'type'?: JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum;
|
|
12376
13150
|
}
|
|
12377
|
-
export type JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
13151
|
+
export type JsonApiWorkspaceSettingPostOptionalIdAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
12378
13152
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
12379
13153
|
'data': JsonApiWorkspaceSettingPostOptionalId;
|
|
12380
13154
|
}
|
|
@@ -12787,6 +13561,19 @@ export interface NumberParameterDefinition {
|
|
|
12787
13561
|
'type': NumberParameterDefinitionTypeEnum;
|
|
12788
13562
|
}
|
|
12789
13563
|
export type NumberParameterDefinitionTypeEnum = 'NUMBER';
|
|
13564
|
+
/**
|
|
13565
|
+
* Conditional formatting inherited by every table column that renders this object.
|
|
13566
|
+
*/
|
|
13567
|
+
export interface ObjectConditionalFormatting {
|
|
13568
|
+
/**
|
|
13569
|
+
* Conditions evaluated in order; the first match wins.
|
|
13570
|
+
*/
|
|
13571
|
+
'conditions': Array<ConditionalFormattingCondition>;
|
|
13572
|
+
/**
|
|
13573
|
+
* Whether the conditions are applied when rendering.
|
|
13574
|
+
*/
|
|
13575
|
+
'enabled': boolean;
|
|
13576
|
+
}
|
|
12790
13577
|
export interface ObjectLinks {
|
|
12791
13578
|
/**
|
|
12792
13579
|
* A string containing the link\'s URL.
|
|
@@ -13326,7 +14113,7 @@ export interface ResolvedSetting {
|
|
|
13326
14113
|
*/
|
|
13327
14114
|
'type'?: ResolvedSettingTypeEnum;
|
|
13328
14115
|
}
|
|
13329
|
-
export type ResolvedSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
14116
|
+
export type ResolvedSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'DEFAULT_EXPORT_TEMPLATE' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'ENABLE_PARTIAL_DATA_RESULTS' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE' | 'ENABLE_TIMEZONE_CHANGE';
|
|
13330
14117
|
export interface RsaSpecification {
|
|
13331
14118
|
'alg': RsaSpecificationAlgEnum;
|
|
13332
14119
|
'e': string;
|
|
@@ -13410,7 +14197,7 @@ export interface SetCertificationRequest {
|
|
|
13410
14197
|
'type': SetCertificationRequestTypeEnum;
|
|
13411
14198
|
}
|
|
13412
14199
|
export type SetCertificationRequestStatusEnum = 'CERTIFIED';
|
|
13413
|
-
export type SetCertificationRequestTypeEnum = 'metric' | 'visualizationObject' | 'analyticalDashboard';
|
|
14200
|
+
export type SetCertificationRequestTypeEnum = 'metric' | 'visualizationObject' | 'analyticalDashboard' | 'computedAttribute';
|
|
13414
14201
|
/**
|
|
13415
14202
|
* Additional settings.
|
|
13416
14203
|
*/
|
|
@@ -27772,6 +28559,1142 @@ export declare class ColorPaletteControllerApi extends BaseAPI implements ColorP
|
|
|
27772
28559
|
*/
|
|
27773
28560
|
updateEntityColorPalettes(requestParameters: ColorPaletteControllerApiUpdateEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
27774
28561
|
}
|
|
28562
|
+
/**
|
|
28563
|
+
*
|
|
28564
|
+
* @summary Post Computed Attributes
|
|
28565
|
+
* @param {string} workspaceId
|
|
28566
|
+
* @param {JsonApiComputedAttributePostOptionalIdDocument} jsonApiComputedAttributePostOptionalIdDocument
|
|
28567
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
28568
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28569
|
+
* @param {*} [options] Override http request option.
|
|
28570
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28571
|
+
* @throws {RequiredError}
|
|
28572
|
+
*/
|
|
28573
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_CreateEntityComputedAttributes(workspaceId: string, jsonApiComputedAttributePostOptionalIdDocument: JsonApiComputedAttributePostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28574
|
+
/**
|
|
28575
|
+
*
|
|
28576
|
+
* @summary Delete a Computed Attribute
|
|
28577
|
+
* @param {string} workspaceId
|
|
28578
|
+
* @param {string} objectId
|
|
28579
|
+
* @param {*} [options] Override http request option.
|
|
28580
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28581
|
+
* @throws {RequiredError}
|
|
28582
|
+
*/
|
|
28583
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_DeleteEntityComputedAttributes(workspaceId: string, objectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28584
|
+
/**
|
|
28585
|
+
*
|
|
28586
|
+
* @summary Get all Computed Attributes
|
|
28587
|
+
* @param {string} workspaceId
|
|
28588
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
28589
|
+
* @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\').
|
|
28590
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
28591
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
28592
|
+
* @param {number} [size] The size of the page to be returned
|
|
28593
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
28594
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28595
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28596
|
+
* @param {*} [options] Override http request option.
|
|
28597
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28598
|
+
* @throws {RequiredError}
|
|
28599
|
+
*/
|
|
28600
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_GetAllEntitiesComputedAttributes(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28601
|
+
/**
|
|
28602
|
+
*
|
|
28603
|
+
* @summary Get a Computed Attribute
|
|
28604
|
+
* @param {string} workspaceId
|
|
28605
|
+
* @param {string} objectId
|
|
28606
|
+
* @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\').
|
|
28607
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
28608
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28609
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28610
|
+
* @param {*} [options] Override http request option.
|
|
28611
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28612
|
+
* @throws {RequiredError}
|
|
28613
|
+
*/
|
|
28614
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_GetEntityComputedAttributes(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28615
|
+
/**
|
|
28616
|
+
*
|
|
28617
|
+
* @summary Patch a Computed Attribute
|
|
28618
|
+
* @param {string} workspaceId
|
|
28619
|
+
* @param {string} objectId
|
|
28620
|
+
* @param {JsonApiComputedAttributePatchDocument} jsonApiComputedAttributePatchDocument
|
|
28621
|
+
* @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\').
|
|
28622
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
28623
|
+
* @param {*} [options] Override http request option.
|
|
28624
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28625
|
+
* @throws {RequiredError}
|
|
28626
|
+
*/
|
|
28627
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_PatchEntityComputedAttributes(workspaceId: string, objectId: string, jsonApiComputedAttributePatchDocument: JsonApiComputedAttributePatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28628
|
+
/**
|
|
28629
|
+
*
|
|
28630
|
+
* @summary The search endpoint (beta)
|
|
28631
|
+
* @param {string} workspaceId
|
|
28632
|
+
* @param {EntitySearchBody} entitySearchBody Search request body with filter, pagination, and sorting options
|
|
28633
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
28634
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28635
|
+
* @param {*} [options] Override http request option.
|
|
28636
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28637
|
+
* @throws {RequiredError}
|
|
28638
|
+
*/
|
|
28639
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_SearchEntitiesComputedAttributes(workspaceId: string, entitySearchBody: EntitySearchBody, origin?: 'ALL' | 'PARENTS' | 'NATIVE', xGDCVALIDATERELATIONS?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28640
|
+
/**
|
|
28641
|
+
*
|
|
28642
|
+
* @summary Put a Computed Attribute
|
|
28643
|
+
* @param {string} workspaceId
|
|
28644
|
+
* @param {string} objectId
|
|
28645
|
+
* @param {JsonApiComputedAttributeInDocument} jsonApiComputedAttributeInDocument
|
|
28646
|
+
* @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\').
|
|
28647
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
28648
|
+
* @param {*} [options] Override http request option.
|
|
28649
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28650
|
+
* @throws {RequiredError}
|
|
28651
|
+
*/
|
|
28652
|
+
export declare function ComputedAttributeControllerApiAxiosParamCreator_UpdateEntityComputedAttributes(workspaceId: string, objectId: string, jsonApiComputedAttributeInDocument: JsonApiComputedAttributeInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
28653
|
+
/**
|
|
28654
|
+
*
|
|
28655
|
+
* @summary Post Computed Attributes
|
|
28656
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28657
|
+
* @param {string} basePath Base path.
|
|
28658
|
+
* @param {ComputedAttributeControllerApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28659
|
+
* @param {*} [options] Override http request option.
|
|
28660
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28661
|
+
* @throws {RequiredError}
|
|
28662
|
+
*/
|
|
28663
|
+
export declare function ComputedAttributeControllerApi_CreateEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28664
|
+
/**
|
|
28665
|
+
*
|
|
28666
|
+
* @summary Delete a Computed Attribute
|
|
28667
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28668
|
+
* @param {string} basePath Base path.
|
|
28669
|
+
* @param {ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28670
|
+
* @param {*} [options] Override http request option.
|
|
28671
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28672
|
+
* @throws {RequiredError}
|
|
28673
|
+
*/
|
|
28674
|
+
export declare function ComputedAttributeControllerApi_DeleteEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
28675
|
+
/**
|
|
28676
|
+
*
|
|
28677
|
+
* @summary Get all Computed Attributes
|
|
28678
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28679
|
+
* @param {string} basePath Base path.
|
|
28680
|
+
* @param {ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
28681
|
+
* @param {*} [options] Override http request option.
|
|
28682
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28683
|
+
* @throws {RequiredError}
|
|
28684
|
+
*/
|
|
28685
|
+
export declare function ComputedAttributeControllerApi_GetAllEntitiesComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
28686
|
+
/**
|
|
28687
|
+
*
|
|
28688
|
+
* @summary Get a Computed Attribute
|
|
28689
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28690
|
+
* @param {string} basePath Base path.
|
|
28691
|
+
* @param {ComputedAttributeControllerApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28692
|
+
* @param {*} [options] Override http request option.
|
|
28693
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28694
|
+
* @throws {RequiredError}
|
|
28695
|
+
*/
|
|
28696
|
+
export declare function ComputedAttributeControllerApi_GetEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28697
|
+
/**
|
|
28698
|
+
*
|
|
28699
|
+
* @summary Patch a Computed Attribute
|
|
28700
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28701
|
+
* @param {string} basePath Base path.
|
|
28702
|
+
* @param {ComputedAttributeControllerApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28703
|
+
* @param {*} [options] Override http request option.
|
|
28704
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28705
|
+
* @throws {RequiredError}
|
|
28706
|
+
*/
|
|
28707
|
+
export declare function ComputedAttributeControllerApi_PatchEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28708
|
+
/**
|
|
28709
|
+
*
|
|
28710
|
+
* @summary The search endpoint (beta)
|
|
28711
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28712
|
+
* @param {string} basePath Base path.
|
|
28713
|
+
* @param {ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
28714
|
+
* @param {*} [options] Override http request option.
|
|
28715
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28716
|
+
* @throws {RequiredError}
|
|
28717
|
+
*/
|
|
28718
|
+
export declare function ComputedAttributeControllerApi_SearchEntitiesComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
28719
|
+
/**
|
|
28720
|
+
*
|
|
28721
|
+
* @summary Put a Computed Attribute
|
|
28722
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
28723
|
+
* @param {string} basePath Base path.
|
|
28724
|
+
* @param {ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28725
|
+
* @param {*} [options] Override http request option.
|
|
28726
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
28727
|
+
* @throws {RequiredError}
|
|
28728
|
+
*/
|
|
28729
|
+
export declare function ComputedAttributeControllerApi_UpdateEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28730
|
+
/**
|
|
28731
|
+
* ComputedAttributeControllerApi - interface
|
|
28732
|
+
* @export
|
|
28733
|
+
* @interface ComputedAttributeControllerApi
|
|
28734
|
+
*/
|
|
28735
|
+
export interface ComputedAttributeControllerApiInterface {
|
|
28736
|
+
/**
|
|
28737
|
+
*
|
|
28738
|
+
* @summary Post Computed Attributes
|
|
28739
|
+
* @param {ComputedAttributeControllerApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28740
|
+
* @param {*} [options] Override http request option.
|
|
28741
|
+
* @throws {RequiredError}
|
|
28742
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28743
|
+
*/
|
|
28744
|
+
createEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28745
|
+
/**
|
|
28746
|
+
*
|
|
28747
|
+
* @summary Delete a Computed Attribute
|
|
28748
|
+
* @param {ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28749
|
+
* @param {*} [options] Override http request option.
|
|
28750
|
+
* @throws {RequiredError}
|
|
28751
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28752
|
+
*/
|
|
28753
|
+
deleteEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
28754
|
+
/**
|
|
28755
|
+
*
|
|
28756
|
+
* @summary Get all Computed Attributes
|
|
28757
|
+
* @param {ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
28758
|
+
* @param {*} [options] Override http request option.
|
|
28759
|
+
* @throws {RequiredError}
|
|
28760
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28761
|
+
*/
|
|
28762
|
+
getAllEntitiesComputedAttributes(requestParameters: ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
28763
|
+
/**
|
|
28764
|
+
*
|
|
28765
|
+
* @summary Get a Computed Attribute
|
|
28766
|
+
* @param {ComputedAttributeControllerApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28767
|
+
* @param {*} [options] Override http request option.
|
|
28768
|
+
* @throws {RequiredError}
|
|
28769
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28770
|
+
*/
|
|
28771
|
+
getEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28772
|
+
/**
|
|
28773
|
+
*
|
|
28774
|
+
* @summary Patch a Computed Attribute
|
|
28775
|
+
* @param {ComputedAttributeControllerApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28776
|
+
* @param {*} [options] Override http request option.
|
|
28777
|
+
* @throws {RequiredError}
|
|
28778
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28779
|
+
*/
|
|
28780
|
+
patchEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28781
|
+
/**
|
|
28782
|
+
*
|
|
28783
|
+
* @summary The search endpoint (beta)
|
|
28784
|
+
* @param {ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
28785
|
+
* @param {*} [options] Override http request option.
|
|
28786
|
+
* @throws {RequiredError}
|
|
28787
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28788
|
+
*/
|
|
28789
|
+
searchEntitiesComputedAttributes(requestParameters: ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
28790
|
+
/**
|
|
28791
|
+
*
|
|
28792
|
+
* @summary Put a Computed Attribute
|
|
28793
|
+
* @param {ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
28794
|
+
* @param {*} [options] Override http request option.
|
|
28795
|
+
* @throws {RequiredError}
|
|
28796
|
+
* @memberof ComputedAttributeControllerApiInterface
|
|
28797
|
+
*/
|
|
28798
|
+
updateEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
28799
|
+
}
|
|
28800
|
+
/**
|
|
28801
|
+
* Request parameters for createEntityComputedAttributes operation in ComputedAttributeControllerApi.
|
|
28802
|
+
* @export
|
|
28803
|
+
* @interface ComputedAttributeControllerApiCreateEntityComputedAttributesRequest
|
|
28804
|
+
*/
|
|
28805
|
+
export interface ComputedAttributeControllerApiCreateEntityComputedAttributesRequest {
|
|
28806
|
+
/**
|
|
28807
|
+
*
|
|
28808
|
+
* @type {string}
|
|
28809
|
+
* @memberof ComputedAttributeControllerApiCreateEntityComputedAttributes
|
|
28810
|
+
*/
|
|
28811
|
+
readonly workspaceId: string;
|
|
28812
|
+
/**
|
|
28813
|
+
*
|
|
28814
|
+
* @type {JsonApiComputedAttributePostOptionalIdDocument}
|
|
28815
|
+
* @memberof ComputedAttributeControllerApiCreateEntityComputedAttributes
|
|
28816
|
+
*/
|
|
28817
|
+
readonly jsonApiComputedAttributePostOptionalIdDocument: JsonApiComputedAttributePostOptionalIdDocument;
|
|
28818
|
+
/**
|
|
28819
|
+
* 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.
|
|
28820
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
28821
|
+
* @memberof ComputedAttributeControllerApiCreateEntityComputedAttributes
|
|
28822
|
+
*/
|
|
28823
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
28824
|
+
/**
|
|
28825
|
+
* Include Meta objects.
|
|
28826
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
28827
|
+
* @memberof ComputedAttributeControllerApiCreateEntityComputedAttributes
|
|
28828
|
+
*/
|
|
28829
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
28830
|
+
}
|
|
28831
|
+
/**
|
|
28832
|
+
* Request parameters for deleteEntityComputedAttributes operation in ComputedAttributeControllerApi.
|
|
28833
|
+
* @export
|
|
28834
|
+
* @interface ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest
|
|
28835
|
+
*/
|
|
28836
|
+
export interface ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest {
|
|
28837
|
+
/**
|
|
28838
|
+
*
|
|
28839
|
+
* @type {string}
|
|
28840
|
+
* @memberof ComputedAttributeControllerApiDeleteEntityComputedAttributes
|
|
28841
|
+
*/
|
|
28842
|
+
readonly workspaceId: string;
|
|
28843
|
+
/**
|
|
28844
|
+
*
|
|
28845
|
+
* @type {string}
|
|
28846
|
+
* @memberof ComputedAttributeControllerApiDeleteEntityComputedAttributes
|
|
28847
|
+
*/
|
|
28848
|
+
readonly objectId: string;
|
|
28849
|
+
}
|
|
28850
|
+
/**
|
|
28851
|
+
* Request parameters for getAllEntitiesComputedAttributes operation in ComputedAttributeControllerApi.
|
|
28852
|
+
* @export
|
|
28853
|
+
* @interface ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest
|
|
28854
|
+
*/
|
|
28855
|
+
export interface ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest {
|
|
28856
|
+
/**
|
|
28857
|
+
*
|
|
28858
|
+
* @type {string}
|
|
28859
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28860
|
+
*/
|
|
28861
|
+
readonly workspaceId: string;
|
|
28862
|
+
/**
|
|
28863
|
+
*
|
|
28864
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
28865
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28866
|
+
*/
|
|
28867
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
28868
|
+
/**
|
|
28869
|
+
* 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\').
|
|
28870
|
+
* @type {string}
|
|
28871
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28872
|
+
*/
|
|
28873
|
+
readonly filter?: string;
|
|
28874
|
+
/**
|
|
28875
|
+
* 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.
|
|
28876
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
28877
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28878
|
+
*/
|
|
28879
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
28880
|
+
/**
|
|
28881
|
+
* Zero-based page index (0..N)
|
|
28882
|
+
* @type {number}
|
|
28883
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28884
|
+
*/
|
|
28885
|
+
readonly page?: number;
|
|
28886
|
+
/**
|
|
28887
|
+
* The size of the page to be returned
|
|
28888
|
+
* @type {number}
|
|
28889
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28890
|
+
*/
|
|
28891
|
+
readonly size?: number;
|
|
28892
|
+
/**
|
|
28893
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
28894
|
+
* @type {Array<string>}
|
|
28895
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28896
|
+
*/
|
|
28897
|
+
readonly sort?: Array<string>;
|
|
28898
|
+
/**
|
|
28899
|
+
*
|
|
28900
|
+
* @type {boolean}
|
|
28901
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28902
|
+
*/
|
|
28903
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
28904
|
+
/**
|
|
28905
|
+
* Include Meta objects.
|
|
28906
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
28907
|
+
* @memberof ComputedAttributeControllerApiGetAllEntitiesComputedAttributes
|
|
28908
|
+
*/
|
|
28909
|
+
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
28910
|
+
}
|
|
28911
|
+
/**
|
|
28912
|
+
* Request parameters for getEntityComputedAttributes operation in ComputedAttributeControllerApi.
|
|
28913
|
+
* @export
|
|
28914
|
+
* @interface ComputedAttributeControllerApiGetEntityComputedAttributesRequest
|
|
28915
|
+
*/
|
|
28916
|
+
export interface ComputedAttributeControllerApiGetEntityComputedAttributesRequest {
|
|
28917
|
+
/**
|
|
28918
|
+
*
|
|
28919
|
+
* @type {string}
|
|
28920
|
+
* @memberof ComputedAttributeControllerApiGetEntityComputedAttributes
|
|
28921
|
+
*/
|
|
28922
|
+
readonly workspaceId: string;
|
|
28923
|
+
/**
|
|
28924
|
+
*
|
|
28925
|
+
* @type {string}
|
|
28926
|
+
* @memberof ComputedAttributeControllerApiGetEntityComputedAttributes
|
|
28927
|
+
*/
|
|
28928
|
+
readonly objectId: string;
|
|
28929
|
+
/**
|
|
28930
|
+
* 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\').
|
|
28931
|
+
* @type {string}
|
|
28932
|
+
* @memberof ComputedAttributeControllerApiGetEntityComputedAttributes
|
|
28933
|
+
*/
|
|
28934
|
+
readonly filter?: string;
|
|
28935
|
+
/**
|
|
28936
|
+
* 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.
|
|
28937
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
28938
|
+
* @memberof ComputedAttributeControllerApiGetEntityComputedAttributes
|
|
28939
|
+
*/
|
|
28940
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
28941
|
+
/**
|
|
28942
|
+
*
|
|
28943
|
+
* @type {boolean}
|
|
28944
|
+
* @memberof ComputedAttributeControllerApiGetEntityComputedAttributes
|
|
28945
|
+
*/
|
|
28946
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
28947
|
+
/**
|
|
28948
|
+
* Include Meta objects.
|
|
28949
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
28950
|
+
* @memberof ComputedAttributeControllerApiGetEntityComputedAttributes
|
|
28951
|
+
*/
|
|
28952
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
28953
|
+
}
|
|
28954
|
+
/**
|
|
28955
|
+
* Request parameters for patchEntityComputedAttributes operation in ComputedAttributeControllerApi.
|
|
28956
|
+
* @export
|
|
28957
|
+
* @interface ComputedAttributeControllerApiPatchEntityComputedAttributesRequest
|
|
28958
|
+
*/
|
|
28959
|
+
export interface ComputedAttributeControllerApiPatchEntityComputedAttributesRequest {
|
|
28960
|
+
/**
|
|
28961
|
+
*
|
|
28962
|
+
* @type {string}
|
|
28963
|
+
* @memberof ComputedAttributeControllerApiPatchEntityComputedAttributes
|
|
28964
|
+
*/
|
|
28965
|
+
readonly workspaceId: string;
|
|
28966
|
+
/**
|
|
28967
|
+
*
|
|
28968
|
+
* @type {string}
|
|
28969
|
+
* @memberof ComputedAttributeControllerApiPatchEntityComputedAttributes
|
|
28970
|
+
*/
|
|
28971
|
+
readonly objectId: string;
|
|
28972
|
+
/**
|
|
28973
|
+
*
|
|
28974
|
+
* @type {JsonApiComputedAttributePatchDocument}
|
|
28975
|
+
* @memberof ComputedAttributeControllerApiPatchEntityComputedAttributes
|
|
28976
|
+
*/
|
|
28977
|
+
readonly jsonApiComputedAttributePatchDocument: JsonApiComputedAttributePatchDocument;
|
|
28978
|
+
/**
|
|
28979
|
+
* 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\').
|
|
28980
|
+
* @type {string}
|
|
28981
|
+
* @memberof ComputedAttributeControllerApiPatchEntityComputedAttributes
|
|
28982
|
+
*/
|
|
28983
|
+
readonly filter?: string;
|
|
28984
|
+
/**
|
|
28985
|
+
* 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.
|
|
28986
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
28987
|
+
* @memberof ComputedAttributeControllerApiPatchEntityComputedAttributes
|
|
28988
|
+
*/
|
|
28989
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
28990
|
+
}
|
|
28991
|
+
/**
|
|
28992
|
+
* Request parameters for searchEntitiesComputedAttributes operation in ComputedAttributeControllerApi.
|
|
28993
|
+
* @export
|
|
28994
|
+
* @interface ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest
|
|
28995
|
+
*/
|
|
28996
|
+
export interface ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest {
|
|
28997
|
+
/**
|
|
28998
|
+
*
|
|
28999
|
+
* @type {string}
|
|
29000
|
+
* @memberof ComputedAttributeControllerApiSearchEntitiesComputedAttributes
|
|
29001
|
+
*/
|
|
29002
|
+
readonly workspaceId: string;
|
|
29003
|
+
/**
|
|
29004
|
+
* Search request body with filter, pagination, and sorting options
|
|
29005
|
+
* @type {EntitySearchBody}
|
|
29006
|
+
* @memberof ComputedAttributeControllerApiSearchEntitiesComputedAttributes
|
|
29007
|
+
*/
|
|
29008
|
+
readonly entitySearchBody: EntitySearchBody;
|
|
29009
|
+
/**
|
|
29010
|
+
*
|
|
29011
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
29012
|
+
* @memberof ComputedAttributeControllerApiSearchEntitiesComputedAttributes
|
|
29013
|
+
*/
|
|
29014
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
29015
|
+
/**
|
|
29016
|
+
*
|
|
29017
|
+
* @type {boolean}
|
|
29018
|
+
* @memberof ComputedAttributeControllerApiSearchEntitiesComputedAttributes
|
|
29019
|
+
*/
|
|
29020
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
29021
|
+
}
|
|
29022
|
+
/**
|
|
29023
|
+
* Request parameters for updateEntityComputedAttributes operation in ComputedAttributeControllerApi.
|
|
29024
|
+
* @export
|
|
29025
|
+
* @interface ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest
|
|
29026
|
+
*/
|
|
29027
|
+
export interface ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest {
|
|
29028
|
+
/**
|
|
29029
|
+
*
|
|
29030
|
+
* @type {string}
|
|
29031
|
+
* @memberof ComputedAttributeControllerApiUpdateEntityComputedAttributes
|
|
29032
|
+
*/
|
|
29033
|
+
readonly workspaceId: string;
|
|
29034
|
+
/**
|
|
29035
|
+
*
|
|
29036
|
+
* @type {string}
|
|
29037
|
+
* @memberof ComputedAttributeControllerApiUpdateEntityComputedAttributes
|
|
29038
|
+
*/
|
|
29039
|
+
readonly objectId: string;
|
|
29040
|
+
/**
|
|
29041
|
+
*
|
|
29042
|
+
* @type {JsonApiComputedAttributeInDocument}
|
|
29043
|
+
* @memberof ComputedAttributeControllerApiUpdateEntityComputedAttributes
|
|
29044
|
+
*/
|
|
29045
|
+
readonly jsonApiComputedAttributeInDocument: JsonApiComputedAttributeInDocument;
|
|
29046
|
+
/**
|
|
29047
|
+
* 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\').
|
|
29048
|
+
* @type {string}
|
|
29049
|
+
* @memberof ComputedAttributeControllerApiUpdateEntityComputedAttributes
|
|
29050
|
+
*/
|
|
29051
|
+
readonly filter?: string;
|
|
29052
|
+
/**
|
|
29053
|
+
* 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.
|
|
29054
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
29055
|
+
* @memberof ComputedAttributeControllerApiUpdateEntityComputedAttributes
|
|
29056
|
+
*/
|
|
29057
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
29058
|
+
}
|
|
29059
|
+
/**
|
|
29060
|
+
* ComputedAttributeControllerApi - object-oriented interface
|
|
29061
|
+
* @export
|
|
29062
|
+
* @class ComputedAttributeControllerApi
|
|
29063
|
+
* @extends {BaseAPI}
|
|
29064
|
+
*/
|
|
29065
|
+
export declare class ComputedAttributeControllerApi extends BaseAPI implements ComputedAttributeControllerApiInterface {
|
|
29066
|
+
/**
|
|
29067
|
+
*
|
|
29068
|
+
* @summary Post Computed Attributes
|
|
29069
|
+
* @param {ComputedAttributeControllerApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29070
|
+
* @param {*} [options] Override http request option.
|
|
29071
|
+
* @throws {RequiredError}
|
|
29072
|
+
* @memberof ComputedAttributeControllerApi
|
|
29073
|
+
*/
|
|
29074
|
+
createEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29075
|
+
/**
|
|
29076
|
+
*
|
|
29077
|
+
* @summary Delete a Computed Attribute
|
|
29078
|
+
* @param {ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29079
|
+
* @param {*} [options] Override http request option.
|
|
29080
|
+
* @throws {RequiredError}
|
|
29081
|
+
* @memberof ComputedAttributeControllerApi
|
|
29082
|
+
*/
|
|
29083
|
+
deleteEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
29084
|
+
/**
|
|
29085
|
+
*
|
|
29086
|
+
* @summary Get all Computed Attributes
|
|
29087
|
+
* @param {ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29088
|
+
* @param {*} [options] Override http request option.
|
|
29089
|
+
* @throws {RequiredError}
|
|
29090
|
+
* @memberof ComputedAttributeControllerApi
|
|
29091
|
+
*/
|
|
29092
|
+
getAllEntitiesComputedAttributes(requestParameters: ComputedAttributeControllerApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29093
|
+
/**
|
|
29094
|
+
*
|
|
29095
|
+
* @summary Get a Computed Attribute
|
|
29096
|
+
* @param {ComputedAttributeControllerApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29097
|
+
* @param {*} [options] Override http request option.
|
|
29098
|
+
* @throws {RequiredError}
|
|
29099
|
+
* @memberof ComputedAttributeControllerApi
|
|
29100
|
+
*/
|
|
29101
|
+
getEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29102
|
+
/**
|
|
29103
|
+
*
|
|
29104
|
+
* @summary Patch a Computed Attribute
|
|
29105
|
+
* @param {ComputedAttributeControllerApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29106
|
+
* @param {*} [options] Override http request option.
|
|
29107
|
+
* @throws {RequiredError}
|
|
29108
|
+
* @memberof ComputedAttributeControllerApi
|
|
29109
|
+
*/
|
|
29110
|
+
patchEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29111
|
+
/**
|
|
29112
|
+
*
|
|
29113
|
+
* @summary The search endpoint (beta)
|
|
29114
|
+
* @param {ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29115
|
+
* @param {*} [options] Override http request option.
|
|
29116
|
+
* @throws {RequiredError}
|
|
29117
|
+
* @memberof ComputedAttributeControllerApi
|
|
29118
|
+
*/
|
|
29119
|
+
searchEntitiesComputedAttributes(requestParameters: ComputedAttributeControllerApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29120
|
+
/**
|
|
29121
|
+
*
|
|
29122
|
+
* @summary Put a Computed Attribute
|
|
29123
|
+
* @param {ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29124
|
+
* @param {*} [options] Override http request option.
|
|
29125
|
+
* @throws {RequiredError}
|
|
29126
|
+
* @memberof ComputedAttributeControllerApi
|
|
29127
|
+
*/
|
|
29128
|
+
updateEntityComputedAttributes(requestParameters: ComputedAttributeControllerApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29129
|
+
}
|
|
29130
|
+
/**
|
|
29131
|
+
*
|
|
29132
|
+
* @summary Post Computed Attributes
|
|
29133
|
+
* @param {string} workspaceId
|
|
29134
|
+
* @param {JsonApiComputedAttributePostOptionalIdDocument} jsonApiComputedAttributePostOptionalIdDocument
|
|
29135
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
29136
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
29137
|
+
* @param {*} [options] Override http request option.
|
|
29138
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29139
|
+
* @throws {RequiredError}
|
|
29140
|
+
*/
|
|
29141
|
+
export declare function ComputedAttributesApiAxiosParamCreator_CreateEntityComputedAttributes(workspaceId: string, jsonApiComputedAttributePostOptionalIdDocument: JsonApiComputedAttributePostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29142
|
+
/**
|
|
29143
|
+
*
|
|
29144
|
+
* @summary Delete a Computed Attribute
|
|
29145
|
+
* @param {string} workspaceId
|
|
29146
|
+
* @param {string} objectId
|
|
29147
|
+
* @param {*} [options] Override http request option.
|
|
29148
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29149
|
+
* @throws {RequiredError}
|
|
29150
|
+
*/
|
|
29151
|
+
export declare function ComputedAttributesApiAxiosParamCreator_DeleteEntityComputedAttributes(workspaceId: string, objectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29152
|
+
/**
|
|
29153
|
+
*
|
|
29154
|
+
* @summary Get all Computed Attributes
|
|
29155
|
+
* @param {string} workspaceId
|
|
29156
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
29157
|
+
* @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\').
|
|
29158
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
29159
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
29160
|
+
* @param {number} [size] The size of the page to be returned
|
|
29161
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
29162
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
29163
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
29164
|
+
* @param {*} [options] Override http request option.
|
|
29165
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29166
|
+
* @throws {RequiredError}
|
|
29167
|
+
*/
|
|
29168
|
+
export declare function ComputedAttributesApiAxiosParamCreator_GetAllEntitiesComputedAttributes(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29169
|
+
/**
|
|
29170
|
+
*
|
|
29171
|
+
* @summary Get a Computed Attribute
|
|
29172
|
+
* @param {string} workspaceId
|
|
29173
|
+
* @param {string} objectId
|
|
29174
|
+
* @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\').
|
|
29175
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
29176
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
29177
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
29178
|
+
* @param {*} [options] Override http request option.
|
|
29179
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29180
|
+
* @throws {RequiredError}
|
|
29181
|
+
*/
|
|
29182
|
+
export declare function ComputedAttributesApiAxiosParamCreator_GetEntityComputedAttributes(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29183
|
+
/**
|
|
29184
|
+
*
|
|
29185
|
+
* @summary Patch a Computed Attribute
|
|
29186
|
+
* @param {string} workspaceId
|
|
29187
|
+
* @param {string} objectId
|
|
29188
|
+
* @param {JsonApiComputedAttributePatchDocument} jsonApiComputedAttributePatchDocument
|
|
29189
|
+
* @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\').
|
|
29190
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
29191
|
+
* @param {*} [options] Override http request option.
|
|
29192
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29193
|
+
* @throws {RequiredError}
|
|
29194
|
+
*/
|
|
29195
|
+
export declare function ComputedAttributesApiAxiosParamCreator_PatchEntityComputedAttributes(workspaceId: string, objectId: string, jsonApiComputedAttributePatchDocument: JsonApiComputedAttributePatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29196
|
+
/**
|
|
29197
|
+
*
|
|
29198
|
+
* @summary The search endpoint (beta)
|
|
29199
|
+
* @param {string} workspaceId
|
|
29200
|
+
* @param {EntitySearchBody} entitySearchBody Search request body with filter, pagination, and sorting options
|
|
29201
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
29202
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
29203
|
+
* @param {*} [options] Override http request option.
|
|
29204
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29205
|
+
* @throws {RequiredError}
|
|
29206
|
+
*/
|
|
29207
|
+
export declare function ComputedAttributesApiAxiosParamCreator_SearchEntitiesComputedAttributes(workspaceId: string, entitySearchBody: EntitySearchBody, origin?: 'ALL' | 'PARENTS' | 'NATIVE', xGDCVALIDATERELATIONS?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29208
|
+
/**
|
|
29209
|
+
*
|
|
29210
|
+
* @summary Put a Computed Attribute
|
|
29211
|
+
* @param {string} workspaceId
|
|
29212
|
+
* @param {string} objectId
|
|
29213
|
+
* @param {JsonApiComputedAttributeInDocument} jsonApiComputedAttributeInDocument
|
|
29214
|
+
* @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\').
|
|
29215
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
29216
|
+
* @param {*} [options] Override http request option.
|
|
29217
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29218
|
+
* @throws {RequiredError}
|
|
29219
|
+
*/
|
|
29220
|
+
export declare function ComputedAttributesApiAxiosParamCreator_UpdateEntityComputedAttributes(workspaceId: string, objectId: string, jsonApiComputedAttributeInDocument: JsonApiComputedAttributeInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
29221
|
+
/**
|
|
29222
|
+
*
|
|
29223
|
+
* @summary Post Computed Attributes
|
|
29224
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29225
|
+
* @param {string} basePath Base path.
|
|
29226
|
+
* @param {ComputedAttributesApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29227
|
+
* @param {*} [options] Override http request option.
|
|
29228
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29229
|
+
* @throws {RequiredError}
|
|
29230
|
+
*/
|
|
29231
|
+
export declare function ComputedAttributesApi_CreateEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29232
|
+
/**
|
|
29233
|
+
*
|
|
29234
|
+
* @summary Delete a Computed Attribute
|
|
29235
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29236
|
+
* @param {string} basePath Base path.
|
|
29237
|
+
* @param {ComputedAttributesApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29238
|
+
* @param {*} [options] Override http request option.
|
|
29239
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29240
|
+
* @throws {RequiredError}
|
|
29241
|
+
*/
|
|
29242
|
+
export declare function ComputedAttributesApi_DeleteEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
29243
|
+
/**
|
|
29244
|
+
*
|
|
29245
|
+
* @summary Get all Computed Attributes
|
|
29246
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29247
|
+
* @param {string} basePath Base path.
|
|
29248
|
+
* @param {ComputedAttributesApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29249
|
+
* @param {*} [options] Override http request option.
|
|
29250
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29251
|
+
* @throws {RequiredError}
|
|
29252
|
+
*/
|
|
29253
|
+
export declare function ComputedAttributesApi_GetAllEntitiesComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29254
|
+
/**
|
|
29255
|
+
*
|
|
29256
|
+
* @summary Get a Computed Attribute
|
|
29257
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29258
|
+
* @param {string} basePath Base path.
|
|
29259
|
+
* @param {ComputedAttributesApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29260
|
+
* @param {*} [options] Override http request option.
|
|
29261
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29262
|
+
* @throws {RequiredError}
|
|
29263
|
+
*/
|
|
29264
|
+
export declare function ComputedAttributesApi_GetEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29265
|
+
/**
|
|
29266
|
+
*
|
|
29267
|
+
* @summary Patch a Computed Attribute
|
|
29268
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29269
|
+
* @param {string} basePath Base path.
|
|
29270
|
+
* @param {ComputedAttributesApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29271
|
+
* @param {*} [options] Override http request option.
|
|
29272
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29273
|
+
* @throws {RequiredError}
|
|
29274
|
+
*/
|
|
29275
|
+
export declare function ComputedAttributesApi_PatchEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29276
|
+
/**
|
|
29277
|
+
*
|
|
29278
|
+
* @summary The search endpoint (beta)
|
|
29279
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29280
|
+
* @param {string} basePath Base path.
|
|
29281
|
+
* @param {ComputedAttributesApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29282
|
+
* @param {*} [options] Override http request option.
|
|
29283
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29284
|
+
* @throws {RequiredError}
|
|
29285
|
+
*/
|
|
29286
|
+
export declare function ComputedAttributesApi_SearchEntitiesComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29287
|
+
/**
|
|
29288
|
+
*
|
|
29289
|
+
* @summary Put a Computed Attribute
|
|
29290
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
29291
|
+
* @param {string} basePath Base path.
|
|
29292
|
+
* @param {ComputedAttributesApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29293
|
+
* @param {*} [options] Override http request option.
|
|
29294
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
29295
|
+
* @throws {RequiredError}
|
|
29296
|
+
*/
|
|
29297
|
+
export declare function ComputedAttributesApi_UpdateEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: ComputedAttributesApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29298
|
+
/**
|
|
29299
|
+
* ComputedAttributesApi - interface
|
|
29300
|
+
* @export
|
|
29301
|
+
* @interface ComputedAttributesApi
|
|
29302
|
+
*/
|
|
29303
|
+
export interface ComputedAttributesApiInterface {
|
|
29304
|
+
/**
|
|
29305
|
+
*
|
|
29306
|
+
* @summary Post Computed Attributes
|
|
29307
|
+
* @param {ComputedAttributesApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29308
|
+
* @param {*} [options] Override http request option.
|
|
29309
|
+
* @throws {RequiredError}
|
|
29310
|
+
* @memberof ComputedAttributesApiInterface
|
|
29311
|
+
*/
|
|
29312
|
+
createEntityComputedAttributes(requestParameters: ComputedAttributesApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29313
|
+
/**
|
|
29314
|
+
*
|
|
29315
|
+
* @summary Delete a Computed Attribute
|
|
29316
|
+
* @param {ComputedAttributesApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29317
|
+
* @param {*} [options] Override http request option.
|
|
29318
|
+
* @throws {RequiredError}
|
|
29319
|
+
* @memberof ComputedAttributesApiInterface
|
|
29320
|
+
*/
|
|
29321
|
+
deleteEntityComputedAttributes(requestParameters: ComputedAttributesApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
29322
|
+
/**
|
|
29323
|
+
*
|
|
29324
|
+
* @summary Get all Computed Attributes
|
|
29325
|
+
* @param {ComputedAttributesApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29326
|
+
* @param {*} [options] Override http request option.
|
|
29327
|
+
* @throws {RequiredError}
|
|
29328
|
+
* @memberof ComputedAttributesApiInterface
|
|
29329
|
+
*/
|
|
29330
|
+
getAllEntitiesComputedAttributes(requestParameters: ComputedAttributesApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29331
|
+
/**
|
|
29332
|
+
*
|
|
29333
|
+
* @summary Get a Computed Attribute
|
|
29334
|
+
* @param {ComputedAttributesApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29335
|
+
* @param {*} [options] Override http request option.
|
|
29336
|
+
* @throws {RequiredError}
|
|
29337
|
+
* @memberof ComputedAttributesApiInterface
|
|
29338
|
+
*/
|
|
29339
|
+
getEntityComputedAttributes(requestParameters: ComputedAttributesApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29340
|
+
/**
|
|
29341
|
+
*
|
|
29342
|
+
* @summary Patch a Computed Attribute
|
|
29343
|
+
* @param {ComputedAttributesApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29344
|
+
* @param {*} [options] Override http request option.
|
|
29345
|
+
* @throws {RequiredError}
|
|
29346
|
+
* @memberof ComputedAttributesApiInterface
|
|
29347
|
+
*/
|
|
29348
|
+
patchEntityComputedAttributes(requestParameters: ComputedAttributesApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29349
|
+
/**
|
|
29350
|
+
*
|
|
29351
|
+
* @summary The search endpoint (beta)
|
|
29352
|
+
* @param {ComputedAttributesApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29353
|
+
* @param {*} [options] Override http request option.
|
|
29354
|
+
* @throws {RequiredError}
|
|
29355
|
+
* @memberof ComputedAttributesApiInterface
|
|
29356
|
+
*/
|
|
29357
|
+
searchEntitiesComputedAttributes(requestParameters: ComputedAttributesApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29358
|
+
/**
|
|
29359
|
+
*
|
|
29360
|
+
* @summary Put a Computed Attribute
|
|
29361
|
+
* @param {ComputedAttributesApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29362
|
+
* @param {*} [options] Override http request option.
|
|
29363
|
+
* @throws {RequiredError}
|
|
29364
|
+
* @memberof ComputedAttributesApiInterface
|
|
29365
|
+
*/
|
|
29366
|
+
updateEntityComputedAttributes(requestParameters: ComputedAttributesApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29367
|
+
}
|
|
29368
|
+
/**
|
|
29369
|
+
* Request parameters for createEntityComputedAttributes operation in ComputedAttributesApi.
|
|
29370
|
+
* @export
|
|
29371
|
+
* @interface ComputedAttributesApiCreateEntityComputedAttributesRequest
|
|
29372
|
+
*/
|
|
29373
|
+
export interface ComputedAttributesApiCreateEntityComputedAttributesRequest {
|
|
29374
|
+
/**
|
|
29375
|
+
*
|
|
29376
|
+
* @type {string}
|
|
29377
|
+
* @memberof ComputedAttributesApiCreateEntityComputedAttributes
|
|
29378
|
+
*/
|
|
29379
|
+
readonly workspaceId: string;
|
|
29380
|
+
/**
|
|
29381
|
+
*
|
|
29382
|
+
* @type {JsonApiComputedAttributePostOptionalIdDocument}
|
|
29383
|
+
* @memberof ComputedAttributesApiCreateEntityComputedAttributes
|
|
29384
|
+
*/
|
|
29385
|
+
readonly jsonApiComputedAttributePostOptionalIdDocument: JsonApiComputedAttributePostOptionalIdDocument;
|
|
29386
|
+
/**
|
|
29387
|
+
* 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.
|
|
29388
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
29389
|
+
* @memberof ComputedAttributesApiCreateEntityComputedAttributes
|
|
29390
|
+
*/
|
|
29391
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
29392
|
+
/**
|
|
29393
|
+
* Include Meta objects.
|
|
29394
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
29395
|
+
* @memberof ComputedAttributesApiCreateEntityComputedAttributes
|
|
29396
|
+
*/
|
|
29397
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
29398
|
+
}
|
|
29399
|
+
/**
|
|
29400
|
+
* Request parameters for deleteEntityComputedAttributes operation in ComputedAttributesApi.
|
|
29401
|
+
* @export
|
|
29402
|
+
* @interface ComputedAttributesApiDeleteEntityComputedAttributesRequest
|
|
29403
|
+
*/
|
|
29404
|
+
export interface ComputedAttributesApiDeleteEntityComputedAttributesRequest {
|
|
29405
|
+
/**
|
|
29406
|
+
*
|
|
29407
|
+
* @type {string}
|
|
29408
|
+
* @memberof ComputedAttributesApiDeleteEntityComputedAttributes
|
|
29409
|
+
*/
|
|
29410
|
+
readonly workspaceId: string;
|
|
29411
|
+
/**
|
|
29412
|
+
*
|
|
29413
|
+
* @type {string}
|
|
29414
|
+
* @memberof ComputedAttributesApiDeleteEntityComputedAttributes
|
|
29415
|
+
*/
|
|
29416
|
+
readonly objectId: string;
|
|
29417
|
+
}
|
|
29418
|
+
/**
|
|
29419
|
+
* Request parameters for getAllEntitiesComputedAttributes operation in ComputedAttributesApi.
|
|
29420
|
+
* @export
|
|
29421
|
+
* @interface ComputedAttributesApiGetAllEntitiesComputedAttributesRequest
|
|
29422
|
+
*/
|
|
29423
|
+
export interface ComputedAttributesApiGetAllEntitiesComputedAttributesRequest {
|
|
29424
|
+
/**
|
|
29425
|
+
*
|
|
29426
|
+
* @type {string}
|
|
29427
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29428
|
+
*/
|
|
29429
|
+
readonly workspaceId: string;
|
|
29430
|
+
/**
|
|
29431
|
+
*
|
|
29432
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
29433
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29434
|
+
*/
|
|
29435
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
29436
|
+
/**
|
|
29437
|
+
* 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\').
|
|
29438
|
+
* @type {string}
|
|
29439
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29440
|
+
*/
|
|
29441
|
+
readonly filter?: string;
|
|
29442
|
+
/**
|
|
29443
|
+
* 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.
|
|
29444
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
29445
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29446
|
+
*/
|
|
29447
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
29448
|
+
/**
|
|
29449
|
+
* Zero-based page index (0..N)
|
|
29450
|
+
* @type {number}
|
|
29451
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29452
|
+
*/
|
|
29453
|
+
readonly page?: number;
|
|
29454
|
+
/**
|
|
29455
|
+
* The size of the page to be returned
|
|
29456
|
+
* @type {number}
|
|
29457
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29458
|
+
*/
|
|
29459
|
+
readonly size?: number;
|
|
29460
|
+
/**
|
|
29461
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
29462
|
+
* @type {Array<string>}
|
|
29463
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29464
|
+
*/
|
|
29465
|
+
readonly sort?: Array<string>;
|
|
29466
|
+
/**
|
|
29467
|
+
*
|
|
29468
|
+
* @type {boolean}
|
|
29469
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29470
|
+
*/
|
|
29471
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
29472
|
+
/**
|
|
29473
|
+
* Include Meta objects.
|
|
29474
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
29475
|
+
* @memberof ComputedAttributesApiGetAllEntitiesComputedAttributes
|
|
29476
|
+
*/
|
|
29477
|
+
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
29478
|
+
}
|
|
29479
|
+
/**
|
|
29480
|
+
* Request parameters for getEntityComputedAttributes operation in ComputedAttributesApi.
|
|
29481
|
+
* @export
|
|
29482
|
+
* @interface ComputedAttributesApiGetEntityComputedAttributesRequest
|
|
29483
|
+
*/
|
|
29484
|
+
export interface ComputedAttributesApiGetEntityComputedAttributesRequest {
|
|
29485
|
+
/**
|
|
29486
|
+
*
|
|
29487
|
+
* @type {string}
|
|
29488
|
+
* @memberof ComputedAttributesApiGetEntityComputedAttributes
|
|
29489
|
+
*/
|
|
29490
|
+
readonly workspaceId: string;
|
|
29491
|
+
/**
|
|
29492
|
+
*
|
|
29493
|
+
* @type {string}
|
|
29494
|
+
* @memberof ComputedAttributesApiGetEntityComputedAttributes
|
|
29495
|
+
*/
|
|
29496
|
+
readonly objectId: string;
|
|
29497
|
+
/**
|
|
29498
|
+
* 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\').
|
|
29499
|
+
* @type {string}
|
|
29500
|
+
* @memberof ComputedAttributesApiGetEntityComputedAttributes
|
|
29501
|
+
*/
|
|
29502
|
+
readonly filter?: string;
|
|
29503
|
+
/**
|
|
29504
|
+
* 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.
|
|
29505
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
29506
|
+
* @memberof ComputedAttributesApiGetEntityComputedAttributes
|
|
29507
|
+
*/
|
|
29508
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
29509
|
+
/**
|
|
29510
|
+
*
|
|
29511
|
+
* @type {boolean}
|
|
29512
|
+
* @memberof ComputedAttributesApiGetEntityComputedAttributes
|
|
29513
|
+
*/
|
|
29514
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
29515
|
+
/**
|
|
29516
|
+
* Include Meta objects.
|
|
29517
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
29518
|
+
* @memberof ComputedAttributesApiGetEntityComputedAttributes
|
|
29519
|
+
*/
|
|
29520
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
29521
|
+
}
|
|
29522
|
+
/**
|
|
29523
|
+
* Request parameters for patchEntityComputedAttributes operation in ComputedAttributesApi.
|
|
29524
|
+
* @export
|
|
29525
|
+
* @interface ComputedAttributesApiPatchEntityComputedAttributesRequest
|
|
29526
|
+
*/
|
|
29527
|
+
export interface ComputedAttributesApiPatchEntityComputedAttributesRequest {
|
|
29528
|
+
/**
|
|
29529
|
+
*
|
|
29530
|
+
* @type {string}
|
|
29531
|
+
* @memberof ComputedAttributesApiPatchEntityComputedAttributes
|
|
29532
|
+
*/
|
|
29533
|
+
readonly workspaceId: string;
|
|
29534
|
+
/**
|
|
29535
|
+
*
|
|
29536
|
+
* @type {string}
|
|
29537
|
+
* @memberof ComputedAttributesApiPatchEntityComputedAttributes
|
|
29538
|
+
*/
|
|
29539
|
+
readonly objectId: string;
|
|
29540
|
+
/**
|
|
29541
|
+
*
|
|
29542
|
+
* @type {JsonApiComputedAttributePatchDocument}
|
|
29543
|
+
* @memberof ComputedAttributesApiPatchEntityComputedAttributes
|
|
29544
|
+
*/
|
|
29545
|
+
readonly jsonApiComputedAttributePatchDocument: JsonApiComputedAttributePatchDocument;
|
|
29546
|
+
/**
|
|
29547
|
+
* 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\').
|
|
29548
|
+
* @type {string}
|
|
29549
|
+
* @memberof ComputedAttributesApiPatchEntityComputedAttributes
|
|
29550
|
+
*/
|
|
29551
|
+
readonly filter?: string;
|
|
29552
|
+
/**
|
|
29553
|
+
* 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.
|
|
29554
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
29555
|
+
* @memberof ComputedAttributesApiPatchEntityComputedAttributes
|
|
29556
|
+
*/
|
|
29557
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
29558
|
+
}
|
|
29559
|
+
/**
|
|
29560
|
+
* Request parameters for searchEntitiesComputedAttributes operation in ComputedAttributesApi.
|
|
29561
|
+
* @export
|
|
29562
|
+
* @interface ComputedAttributesApiSearchEntitiesComputedAttributesRequest
|
|
29563
|
+
*/
|
|
29564
|
+
export interface ComputedAttributesApiSearchEntitiesComputedAttributesRequest {
|
|
29565
|
+
/**
|
|
29566
|
+
*
|
|
29567
|
+
* @type {string}
|
|
29568
|
+
* @memberof ComputedAttributesApiSearchEntitiesComputedAttributes
|
|
29569
|
+
*/
|
|
29570
|
+
readonly workspaceId: string;
|
|
29571
|
+
/**
|
|
29572
|
+
* Search request body with filter, pagination, and sorting options
|
|
29573
|
+
* @type {EntitySearchBody}
|
|
29574
|
+
* @memberof ComputedAttributesApiSearchEntitiesComputedAttributes
|
|
29575
|
+
*/
|
|
29576
|
+
readonly entitySearchBody: EntitySearchBody;
|
|
29577
|
+
/**
|
|
29578
|
+
*
|
|
29579
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
29580
|
+
* @memberof ComputedAttributesApiSearchEntitiesComputedAttributes
|
|
29581
|
+
*/
|
|
29582
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
29583
|
+
/**
|
|
29584
|
+
*
|
|
29585
|
+
* @type {boolean}
|
|
29586
|
+
* @memberof ComputedAttributesApiSearchEntitiesComputedAttributes
|
|
29587
|
+
*/
|
|
29588
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
29589
|
+
}
|
|
29590
|
+
/**
|
|
29591
|
+
* Request parameters for updateEntityComputedAttributes operation in ComputedAttributesApi.
|
|
29592
|
+
* @export
|
|
29593
|
+
* @interface ComputedAttributesApiUpdateEntityComputedAttributesRequest
|
|
29594
|
+
*/
|
|
29595
|
+
export interface ComputedAttributesApiUpdateEntityComputedAttributesRequest {
|
|
29596
|
+
/**
|
|
29597
|
+
*
|
|
29598
|
+
* @type {string}
|
|
29599
|
+
* @memberof ComputedAttributesApiUpdateEntityComputedAttributes
|
|
29600
|
+
*/
|
|
29601
|
+
readonly workspaceId: string;
|
|
29602
|
+
/**
|
|
29603
|
+
*
|
|
29604
|
+
* @type {string}
|
|
29605
|
+
* @memberof ComputedAttributesApiUpdateEntityComputedAttributes
|
|
29606
|
+
*/
|
|
29607
|
+
readonly objectId: string;
|
|
29608
|
+
/**
|
|
29609
|
+
*
|
|
29610
|
+
* @type {JsonApiComputedAttributeInDocument}
|
|
29611
|
+
* @memberof ComputedAttributesApiUpdateEntityComputedAttributes
|
|
29612
|
+
*/
|
|
29613
|
+
readonly jsonApiComputedAttributeInDocument: JsonApiComputedAttributeInDocument;
|
|
29614
|
+
/**
|
|
29615
|
+
* 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\').
|
|
29616
|
+
* @type {string}
|
|
29617
|
+
* @memberof ComputedAttributesApiUpdateEntityComputedAttributes
|
|
29618
|
+
*/
|
|
29619
|
+
readonly filter?: string;
|
|
29620
|
+
/**
|
|
29621
|
+
* 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.
|
|
29622
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
29623
|
+
* @memberof ComputedAttributesApiUpdateEntityComputedAttributes
|
|
29624
|
+
*/
|
|
29625
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
29626
|
+
}
|
|
29627
|
+
/**
|
|
29628
|
+
* ComputedAttributesApi - object-oriented interface
|
|
29629
|
+
* @export
|
|
29630
|
+
* @class ComputedAttributesApi
|
|
29631
|
+
* @extends {BaseAPI}
|
|
29632
|
+
*/
|
|
29633
|
+
export declare class ComputedAttributesApi extends BaseAPI implements ComputedAttributesApiInterface {
|
|
29634
|
+
/**
|
|
29635
|
+
*
|
|
29636
|
+
* @summary Post Computed Attributes
|
|
29637
|
+
* @param {ComputedAttributesApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29638
|
+
* @param {*} [options] Override http request option.
|
|
29639
|
+
* @throws {RequiredError}
|
|
29640
|
+
* @memberof ComputedAttributesApi
|
|
29641
|
+
*/
|
|
29642
|
+
createEntityComputedAttributes(requestParameters: ComputedAttributesApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29643
|
+
/**
|
|
29644
|
+
*
|
|
29645
|
+
* @summary Delete a Computed Attribute
|
|
29646
|
+
* @param {ComputedAttributesApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29647
|
+
* @param {*} [options] Override http request option.
|
|
29648
|
+
* @throws {RequiredError}
|
|
29649
|
+
* @memberof ComputedAttributesApi
|
|
29650
|
+
*/
|
|
29651
|
+
deleteEntityComputedAttributes(requestParameters: ComputedAttributesApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
29652
|
+
/**
|
|
29653
|
+
*
|
|
29654
|
+
* @summary Get all Computed Attributes
|
|
29655
|
+
* @param {ComputedAttributesApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29656
|
+
* @param {*} [options] Override http request option.
|
|
29657
|
+
* @throws {RequiredError}
|
|
29658
|
+
* @memberof ComputedAttributesApi
|
|
29659
|
+
*/
|
|
29660
|
+
getAllEntitiesComputedAttributes(requestParameters: ComputedAttributesApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29661
|
+
/**
|
|
29662
|
+
*
|
|
29663
|
+
* @summary Get a Computed Attribute
|
|
29664
|
+
* @param {ComputedAttributesApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29665
|
+
* @param {*} [options] Override http request option.
|
|
29666
|
+
* @throws {RequiredError}
|
|
29667
|
+
* @memberof ComputedAttributesApi
|
|
29668
|
+
*/
|
|
29669
|
+
getEntityComputedAttributes(requestParameters: ComputedAttributesApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29670
|
+
/**
|
|
29671
|
+
*
|
|
29672
|
+
* @summary Patch a Computed Attribute
|
|
29673
|
+
* @param {ComputedAttributesApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29674
|
+
* @param {*} [options] Override http request option.
|
|
29675
|
+
* @throws {RequiredError}
|
|
29676
|
+
* @memberof ComputedAttributesApi
|
|
29677
|
+
*/
|
|
29678
|
+
patchEntityComputedAttributes(requestParameters: ComputedAttributesApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29679
|
+
/**
|
|
29680
|
+
*
|
|
29681
|
+
* @summary The search endpoint (beta)
|
|
29682
|
+
* @param {ComputedAttributesApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
29683
|
+
* @param {*} [options] Override http request option.
|
|
29684
|
+
* @throws {RequiredError}
|
|
29685
|
+
* @memberof ComputedAttributesApi
|
|
29686
|
+
*/
|
|
29687
|
+
searchEntitiesComputedAttributes(requestParameters: ComputedAttributesApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
29688
|
+
/**
|
|
29689
|
+
*
|
|
29690
|
+
* @summary Put a Computed Attribute
|
|
29691
|
+
* @param {ComputedAttributesApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
29692
|
+
* @param {*} [options] Override http request option.
|
|
29693
|
+
* @throws {RequiredError}
|
|
29694
|
+
* @memberof ComputedAttributesApi
|
|
29695
|
+
*/
|
|
29696
|
+
updateEntityComputedAttributes(requestParameters: ComputedAttributesApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
29697
|
+
}
|
|
27775
29698
|
/**
|
|
27776
29699
|
*
|
|
27777
29700
|
* @summary Get CookieSecurityConfiguration
|
|
@@ -30974,13 +32897,13 @@ export declare class DashboardsApi extends BaseAPI implements DashboardsApiInter
|
|
|
30974
32897
|
* @summary Post User Data Filters
|
|
30975
32898
|
* @param {string} workspaceId
|
|
30976
32899
|
* @param {JsonApiUserDataFilterPostOptionalIdDocument} jsonApiUserDataFilterPostOptionalIdDocument
|
|
30977
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
32900
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
30978
32901
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
30979
32902
|
* @param {*} [options] Override http request option.
|
|
30980
32903
|
* @param {Configuration} [configuration] Optional configuration.
|
|
30981
32904
|
* @throws {RequiredError}
|
|
30982
32905
|
*/
|
|
30983
|
-
export declare function DataFiltersApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
32906
|
+
export declare function DataFiltersApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
30984
32907
|
/**
|
|
30985
32908
|
*
|
|
30986
32909
|
* @summary Post Settings for Workspace Data Filters
|
|
@@ -31041,7 +32964,7 @@ export declare function DataFiltersApiAxiosParamCreator_DeleteEntityWorkspaceDat
|
|
|
31041
32964
|
* @param {string} workspaceId
|
|
31042
32965
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
31043
32966
|
* @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\').
|
|
31044
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
32967
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
31045
32968
|
* @param {number} [page] Zero-based page index (0..N)
|
|
31046
32969
|
* @param {number} [size] The size of the page to be returned
|
|
31047
32970
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -31051,7 +32974,7 @@ export declare function DataFiltersApiAxiosParamCreator_DeleteEntityWorkspaceDat
|
|
|
31051
32974
|
* @param {Configuration} [configuration] Optional configuration.
|
|
31052
32975
|
* @throws {RequiredError}
|
|
31053
32976
|
*/
|
|
31054
|
-
export declare function DataFiltersApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
32977
|
+
export declare function DataFiltersApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31055
32978
|
/**
|
|
31056
32979
|
*
|
|
31057
32980
|
* @summary Get all Settings for Workspace Data Filters
|
|
@@ -31092,14 +33015,14 @@ export declare function DataFiltersApiAxiosParamCreator_GetAllEntitiesWorkspaceD
|
|
|
31092
33015
|
* @param {string} workspaceId
|
|
31093
33016
|
* @param {string} objectId
|
|
31094
33017
|
* @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\').
|
|
31095
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
33018
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
31096
33019
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
31097
33020
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
31098
33021
|
* @param {*} [options] Override http request option.
|
|
31099
33022
|
* @param {Configuration} [configuration] Optional configuration.
|
|
31100
33023
|
* @throws {RequiredError}
|
|
31101
33024
|
*/
|
|
31102
|
-
export declare function DataFiltersApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
33025
|
+
export declare function DataFiltersApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31103
33026
|
/**
|
|
31104
33027
|
*
|
|
31105
33028
|
* @summary Get a Setting for Workspace Data Filter
|
|
@@ -31143,12 +33066,12 @@ export declare function DataFiltersApiAxiosParamCreator_GetWorkspaceDataFiltersL
|
|
|
31143
33066
|
* @param {string} objectId
|
|
31144
33067
|
* @param {JsonApiUserDataFilterPatchDocument} jsonApiUserDataFilterPatchDocument
|
|
31145
33068
|
* @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\').
|
|
31146
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
33069
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
31147
33070
|
* @param {*} [options] Override http request option.
|
|
31148
33071
|
* @param {Configuration} [configuration] Optional configuration.
|
|
31149
33072
|
* @throws {RequiredError}
|
|
31150
33073
|
*/
|
|
31151
|
-
export declare function DataFiltersApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
33074
|
+
export declare function DataFiltersApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31152
33075
|
/**
|
|
31153
33076
|
*
|
|
31154
33077
|
* @summary Patch a Settings for Workspace Data Filter
|
|
@@ -31227,12 +33150,12 @@ export declare function DataFiltersApiAxiosParamCreator_SetWorkspaceDataFiltersL
|
|
|
31227
33150
|
* @param {string} objectId
|
|
31228
33151
|
* @param {JsonApiUserDataFilterInDocument} jsonApiUserDataFilterInDocument
|
|
31229
33152
|
* @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\').
|
|
31230
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
33153
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
31231
33154
|
* @param {*} [options] Override http request option.
|
|
31232
33155
|
* @param {Configuration} [configuration] Optional configuration.
|
|
31233
33156
|
* @throws {RequiredError}
|
|
31234
33157
|
*/
|
|
31235
|
-
export declare function DataFiltersApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
33158
|
+
export declare function DataFiltersApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
31236
33159
|
/**
|
|
31237
33160
|
*
|
|
31238
33161
|
* @summary Put a Settings for Workspace Data Filter
|
|
@@ -31744,10 +33667,10 @@ export interface DataFiltersApiCreateEntityUserDataFiltersRequest {
|
|
|
31744
33667
|
readonly jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument;
|
|
31745
33668
|
/**
|
|
31746
33669
|
* 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.
|
|
31747
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
33670
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
31748
33671
|
* @memberof DataFiltersApiCreateEntityUserDataFilters
|
|
31749
33672
|
*/
|
|
31750
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
33673
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
31751
33674
|
/**
|
|
31752
33675
|
* Include Meta objects.
|
|
31753
33676
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -31900,10 +33823,10 @@ export interface DataFiltersApiGetAllEntitiesUserDataFiltersRequest {
|
|
|
31900
33823
|
readonly filter?: string;
|
|
31901
33824
|
/**
|
|
31902
33825
|
* 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.
|
|
31903
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
33826
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
31904
33827
|
* @memberof DataFiltersApiGetAllEntitiesUserDataFilters
|
|
31905
33828
|
*/
|
|
31906
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
33829
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
31907
33830
|
/**
|
|
31908
33831
|
* Zero-based page index (0..N)
|
|
31909
33832
|
* @type {number}
|
|
@@ -32083,10 +34006,10 @@ export interface DataFiltersApiGetEntityUserDataFiltersRequest {
|
|
|
32083
34006
|
readonly filter?: string;
|
|
32084
34007
|
/**
|
|
32085
34008
|
* 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.
|
|
32086
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
34009
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
32087
34010
|
* @memberof DataFiltersApiGetEntityUserDataFilters
|
|
32088
34011
|
*/
|
|
32089
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
34012
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
32090
34013
|
/**
|
|
32091
34014
|
*
|
|
32092
34015
|
* @type {boolean}
|
|
@@ -32218,10 +34141,10 @@ export interface DataFiltersApiPatchEntityUserDataFiltersRequest {
|
|
|
32218
34141
|
readonly filter?: string;
|
|
32219
34142
|
/**
|
|
32220
34143
|
* 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.
|
|
32221
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
34144
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
32222
34145
|
* @memberof DataFiltersApiPatchEntityUserDataFilters
|
|
32223
34146
|
*/
|
|
32224
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
34147
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
32225
34148
|
}
|
|
32226
34149
|
/**
|
|
32227
34150
|
* Request parameters for patchEntityWorkspaceDataFilterSettings operation in DataFiltersApi.
|
|
@@ -32435,10 +34358,10 @@ export interface DataFiltersApiUpdateEntityUserDataFiltersRequest {
|
|
|
32435
34358
|
readonly filter?: string;
|
|
32436
34359
|
/**
|
|
32437
34360
|
* 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.
|
|
32438
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
34361
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
32439
34362
|
* @memberof DataFiltersApiUpdateEntityUserDataFilters
|
|
32440
34363
|
*/
|
|
32441
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
34364
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
32442
34365
|
}
|
|
32443
34366
|
/**
|
|
32444
34367
|
* Request parameters for updateEntityWorkspaceDataFilterSettings operation in DataFiltersApi.
|
|
@@ -35031,6 +36954,18 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityAutomations(wor
|
|
|
35031
36954
|
* @throws {RequiredError}
|
|
35032
36955
|
*/
|
|
35033
36956
|
export declare function EntitiesApiAxiosParamCreator_CreateEntityColorPalettes(jsonApiColorPaletteInDocument: JsonApiColorPaletteInDocument, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36957
|
+
/**
|
|
36958
|
+
*
|
|
36959
|
+
* @summary Post Computed Attributes
|
|
36960
|
+
* @param {string} workspaceId
|
|
36961
|
+
* @param {JsonApiComputedAttributePostOptionalIdDocument} jsonApiComputedAttributePostOptionalIdDocument
|
|
36962
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
36963
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
36964
|
+
* @param {*} [options] Override http request option.
|
|
36965
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
36966
|
+
* @throws {RequiredError}
|
|
36967
|
+
*/
|
|
36968
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityComputedAttributes(workspaceId: string, jsonApiComputedAttributePostOptionalIdDocument: JsonApiComputedAttributePostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
35034
36969
|
/**
|
|
35035
36970
|
* Context Security Police Directive
|
|
35036
36971
|
* @summary Post CSP Directives
|
|
@@ -35202,13 +37137,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityMemoryItems(wor
|
|
|
35202
37137
|
* @summary Post Metrics
|
|
35203
37138
|
* @param {string} workspaceId
|
|
35204
37139
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
35205
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
37140
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
35206
37141
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
35207
37142
|
* @param {*} [options] Override http request option.
|
|
35208
37143
|
* @param {Configuration} [configuration] Optional configuration.
|
|
35209
37144
|
* @throws {RequiredError}
|
|
35210
37145
|
*/
|
|
35211
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37146
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
35212
37147
|
/**
|
|
35213
37148
|
*
|
|
35214
37149
|
* @summary Post Notification Channel entities
|
|
@@ -35263,13 +37198,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityThemes(jsonApiT
|
|
|
35263
37198
|
* @summary Post User Data Filters
|
|
35264
37199
|
* @param {string} workspaceId
|
|
35265
37200
|
* @param {JsonApiUserDataFilterPostOptionalIdDocument} jsonApiUserDataFilterPostOptionalIdDocument
|
|
35266
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
37201
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
35267
37202
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
35268
37203
|
* @param {*} [options] Override http request option.
|
|
35269
37204
|
* @param {Configuration} [configuration] Optional configuration.
|
|
35270
37205
|
* @throws {RequiredError}
|
|
35271
37206
|
*/
|
|
35272
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37207
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
35273
37208
|
/**
|
|
35274
37209
|
* User Group - creates tree-like structure for categorizing users
|
|
35275
37210
|
* @summary Post User Group entities
|
|
@@ -35458,6 +37393,16 @@ export declare function EntitiesApiAxiosParamCreator_DeleteEntityAutomations(wor
|
|
|
35458
37393
|
* @throws {RequiredError}
|
|
35459
37394
|
*/
|
|
35460
37395
|
export declare function EntitiesApiAxiosParamCreator_DeleteEntityColorPalettes(id: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37396
|
+
/**
|
|
37397
|
+
*
|
|
37398
|
+
* @summary Delete a Computed Attribute
|
|
37399
|
+
* @param {string} workspaceId
|
|
37400
|
+
* @param {string} objectId
|
|
37401
|
+
* @param {*} [options] Override http request option.
|
|
37402
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
37403
|
+
* @throws {RequiredError}
|
|
37404
|
+
*/
|
|
37405
|
+
export declare function EntitiesApiAxiosParamCreator_DeleteEntityComputedAttributes(workspaceId: string, objectId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
35461
37406
|
/**
|
|
35462
37407
|
* Context Security Police Directive
|
|
35463
37408
|
* @summary Delete CSP Directives
|
|
@@ -35931,6 +37876,23 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAutomations(w
|
|
|
35931
37876
|
* @throws {RequiredError}
|
|
35932
37877
|
*/
|
|
35933
37878
|
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesColorPalettes(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37879
|
+
/**
|
|
37880
|
+
*
|
|
37881
|
+
* @summary Get all Computed Attributes
|
|
37882
|
+
* @param {string} workspaceId
|
|
37883
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
37884
|
+
* @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\').
|
|
37885
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
37886
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
37887
|
+
* @param {number} [size] The size of the page to be returned
|
|
37888
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
37889
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
37890
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
37891
|
+
* @param {*} [options] Override http request option.
|
|
37892
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
37893
|
+
* @throws {RequiredError}
|
|
37894
|
+
*/
|
|
37895
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesComputedAttributes(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
35934
37896
|
/**
|
|
35935
37897
|
* Context Security Police Directive
|
|
35936
37898
|
* @summary Get CSP Directives
|
|
@@ -36267,7 +38229,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMemoryItems(w
|
|
|
36267
38229
|
* @param {string} workspaceId
|
|
36268
38230
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
36269
38231
|
* @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\').
|
|
36270
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
38232
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
36271
38233
|
* @param {number} [page] Zero-based page index (0..N)
|
|
36272
38234
|
* @param {number} [size] The size of the page to be returned
|
|
36273
38235
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -36277,7 +38239,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMemoryItems(w
|
|
|
36277
38239
|
* @param {Configuration} [configuration] Optional configuration.
|
|
36278
38240
|
* @throws {RequiredError}
|
|
36279
38241
|
*/
|
|
36280
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38242
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36281
38243
|
/**
|
|
36282
38244
|
*
|
|
36283
38245
|
* @summary Get all Notification Channel Identifier entities
|
|
@@ -36367,7 +38329,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesThemes(filter
|
|
|
36367
38329
|
* @param {string} workspaceId
|
|
36368
38330
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
36369
38331
|
* @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\').
|
|
36370
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
38332
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
36371
38333
|
* @param {number} [page] Zero-based page index (0..N)
|
|
36372
38334
|
* @param {number} [size] The size of the page to be returned
|
|
36373
38335
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -36377,7 +38339,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesThemes(filter
|
|
|
36377
38339
|
* @param {Configuration} [configuration] Optional configuration.
|
|
36378
38340
|
* @throws {RequiredError}
|
|
36379
38341
|
*/
|
|
36380
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38342
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36381
38343
|
/**
|
|
36382
38344
|
* User Group - creates tree-like structure for categorizing users
|
|
36383
38345
|
* @summary Get UserGroup entities
|
|
@@ -36689,6 +38651,20 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityAutomations(worksp
|
|
|
36689
38651
|
* @throws {RequiredError}
|
|
36690
38652
|
*/
|
|
36691
38653
|
export declare function EntitiesApiAxiosParamCreator_GetEntityColorPalettes(id: string, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38654
|
+
/**
|
|
38655
|
+
*
|
|
38656
|
+
* @summary Get a Computed Attribute
|
|
38657
|
+
* @param {string} workspaceId
|
|
38658
|
+
* @param {string} objectId
|
|
38659
|
+
* @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\').
|
|
38660
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
38661
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38662
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38663
|
+
* @param {*} [options] Override http request option.
|
|
38664
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
38665
|
+
* @throws {RequiredError}
|
|
38666
|
+
*/
|
|
38667
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityComputedAttributes(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36692
38668
|
/**
|
|
36693
38669
|
*
|
|
36694
38670
|
* @summary Get CookieSecurityConfiguration
|
|
@@ -36969,14 +38945,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityMemoryItems(worksp
|
|
|
36969
38945
|
* @param {string} workspaceId
|
|
36970
38946
|
* @param {string} objectId
|
|
36971
38947
|
* @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\').
|
|
36972
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
38948
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
36973
38949
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
36974
38950
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
36975
38951
|
* @param {*} [options] Override http request option.
|
|
36976
38952
|
* @param {Configuration} [configuration] Optional configuration.
|
|
36977
38953
|
* @throws {RequiredError}
|
|
36978
38954
|
*/
|
|
36979
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38955
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36980
38956
|
/**
|
|
36981
38957
|
*
|
|
36982
38958
|
* @summary Get Notification Channel Identifier entity
|
|
@@ -37060,14 +39036,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityThemes(id: string,
|
|
|
37060
39036
|
* @param {string} workspaceId
|
|
37061
39037
|
* @param {string} objectId
|
|
37062
39038
|
* @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\').
|
|
37063
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
39039
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
37064
39040
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
37065
39041
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
37066
39042
|
* @param {*} [options] Override http request option.
|
|
37067
39043
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37068
39044
|
* @throws {RequiredError}
|
|
37069
39045
|
*/
|
|
37070
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39046
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37071
39047
|
/**
|
|
37072
39048
|
* User Group - creates tree-like structure for categorizing users
|
|
37073
39049
|
* @summary Get UserGroup entity
|
|
@@ -37310,6 +39286,19 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityAutomations(work
|
|
|
37310
39286
|
* @throws {RequiredError}
|
|
37311
39287
|
*/
|
|
37312
39288
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityColorPalettes(id: string, jsonApiColorPalettePatchDocument: JsonApiColorPalettePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39289
|
+
/**
|
|
39290
|
+
*
|
|
39291
|
+
* @summary Patch a Computed Attribute
|
|
39292
|
+
* @param {string} workspaceId
|
|
39293
|
+
* @param {string} objectId
|
|
39294
|
+
* @param {JsonApiComputedAttributePatchDocument} jsonApiComputedAttributePatchDocument
|
|
39295
|
+
* @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\').
|
|
39296
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
39297
|
+
* @param {*} [options] Override http request option.
|
|
39298
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
39299
|
+
* @throws {RequiredError}
|
|
39300
|
+
*/
|
|
39301
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityComputedAttributes(workspaceId: string, objectId: string, jsonApiComputedAttributePatchDocument: JsonApiComputedAttributePatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37313
39302
|
/**
|
|
37314
39303
|
*
|
|
37315
39304
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -37534,12 +39523,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityMemoryItems(work
|
|
|
37534
39523
|
* @param {string} objectId
|
|
37535
39524
|
* @param {JsonApiMetricPatchDocument} jsonApiMetricPatchDocument
|
|
37536
39525
|
* @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\').
|
|
37537
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
39526
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
37538
39527
|
* @param {*} [options] Override http request option.
|
|
37539
39528
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37540
39529
|
* @throws {RequiredError}
|
|
37541
39530
|
*/
|
|
37542
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39531
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37543
39532
|
/**
|
|
37544
39533
|
*
|
|
37545
39534
|
* @summary Patch Notification Channel entity
|
|
@@ -37617,12 +39606,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityThemes(id: strin
|
|
|
37617
39606
|
* @param {string} objectId
|
|
37618
39607
|
* @param {JsonApiUserDataFilterPatchDocument} jsonApiUserDataFilterPatchDocument
|
|
37619
39608
|
* @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\').
|
|
37620
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
39609
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
37621
39610
|
* @param {*} [options] Override http request option.
|
|
37622
39611
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37623
39612
|
* @throws {RequiredError}
|
|
37624
39613
|
*/
|
|
37625
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39614
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37626
39615
|
/**
|
|
37627
39616
|
* User Group - creates tree-like structure for categorizing users
|
|
37628
39617
|
* @summary Patch UserGroup entity
|
|
@@ -37818,6 +39807,18 @@ export declare function EntitiesApiAxiosParamCreator_SearchEntitiesAutomationRes
|
|
|
37818
39807
|
* @throws {RequiredError}
|
|
37819
39808
|
*/
|
|
37820
39809
|
export declare function EntitiesApiAxiosParamCreator_SearchEntitiesAutomations(workspaceId: string, entitySearchBody: EntitySearchBody, origin?: 'ALL' | 'PARENTS' | 'NATIVE', xGDCVALIDATERELATIONS?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39810
|
+
/**
|
|
39811
|
+
*
|
|
39812
|
+
* @summary The search endpoint (beta)
|
|
39813
|
+
* @param {string} workspaceId
|
|
39814
|
+
* @param {EntitySearchBody} entitySearchBody Search request body with filter, pagination, and sorting options
|
|
39815
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
39816
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39817
|
+
* @param {*} [options] Override http request option.
|
|
39818
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
39819
|
+
* @throws {RequiredError}
|
|
39820
|
+
*/
|
|
39821
|
+
export declare function EntitiesApiAxiosParamCreator_SearchEntitiesComputedAttributes(workspaceId: string, entitySearchBody: EntitySearchBody, origin?: 'ALL' | 'PARENTS' | 'NATIVE', xGDCVALIDATERELATIONS?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37821
39822
|
/**
|
|
37822
39823
|
*
|
|
37823
39824
|
* @summary The search endpoint (beta)
|
|
@@ -38093,6 +40094,19 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityAutomations(wor
|
|
|
38093
40094
|
* @throws {RequiredError}
|
|
38094
40095
|
*/
|
|
38095
40096
|
export declare function EntitiesApiAxiosParamCreator_UpdateEntityColorPalettes(id: string, jsonApiColorPaletteInDocument: JsonApiColorPaletteInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40097
|
+
/**
|
|
40098
|
+
*
|
|
40099
|
+
* @summary Put a Computed Attribute
|
|
40100
|
+
* @param {string} workspaceId
|
|
40101
|
+
* @param {string} objectId
|
|
40102
|
+
* @param {JsonApiComputedAttributeInDocument} jsonApiComputedAttributeInDocument
|
|
40103
|
+
* @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\').
|
|
40104
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
40105
|
+
* @param {*} [options] Override http request option.
|
|
40106
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
40107
|
+
* @throws {RequiredError}
|
|
40108
|
+
*/
|
|
40109
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityComputedAttributes(workspaceId: string, objectId: string, jsonApiComputedAttributeInDocument: JsonApiComputedAttributeInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38096
40110
|
/**
|
|
38097
40111
|
*
|
|
38098
40112
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -38302,12 +40316,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityMemoryItems(wor
|
|
|
38302
40316
|
* @param {string} objectId
|
|
38303
40317
|
* @param {JsonApiMetricInDocument} jsonApiMetricInDocument
|
|
38304
40318
|
* @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\').
|
|
38305
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
40319
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
38306
40320
|
* @param {*} [options] Override http request option.
|
|
38307
40321
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38308
40322
|
* @throws {RequiredError}
|
|
38309
40323
|
*/
|
|
38310
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40324
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38311
40325
|
/**
|
|
38312
40326
|
*
|
|
38313
40327
|
* @summary Put Notification Channel entity
|
|
@@ -38385,12 +40399,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityThemes(id: stri
|
|
|
38385
40399
|
* @param {string} objectId
|
|
38386
40400
|
* @param {JsonApiUserDataFilterInDocument} jsonApiUserDataFilterInDocument
|
|
38387
40401
|
* @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\').
|
|
38388
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
40402
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
38389
40403
|
* @param {*} [options] Override http request option.
|
|
38390
40404
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38391
40405
|
* @throws {RequiredError}
|
|
38392
40406
|
*/
|
|
38393
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40407
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38394
40408
|
/**
|
|
38395
40409
|
* User Group - creates tree-like structure for categorizing users
|
|
38396
40410
|
* @summary Put UserGroup entity
|
|
@@ -38602,6 +40616,17 @@ export declare function EntitiesApi_CreateEntityAutomations(axios: AxiosInstance
|
|
|
38602
40616
|
* @throws {RequiredError}
|
|
38603
40617
|
*/
|
|
38604
40618
|
export declare function EntitiesApi_CreateEntityColorPalettes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiCreateEntityColorPalettesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
40619
|
+
/**
|
|
40620
|
+
*
|
|
40621
|
+
* @summary Post Computed Attributes
|
|
40622
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
40623
|
+
* @param {string} basePath Base path.
|
|
40624
|
+
* @param {EntitiesApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
40625
|
+
* @param {*} [options] Override http request option.
|
|
40626
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
40627
|
+
* @throws {RequiredError}
|
|
40628
|
+
*/
|
|
40629
|
+
export declare function EntitiesApi_CreateEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
38605
40630
|
/**
|
|
38606
40631
|
* Context Security Police Directive
|
|
38607
40632
|
* @summary Post CSP Directives
|
|
@@ -39053,6 +41078,17 @@ export declare function EntitiesApi_DeleteEntityAutomations(axios: AxiosInstance
|
|
|
39053
41078
|
* @throws {RequiredError}
|
|
39054
41079
|
*/
|
|
39055
41080
|
export declare function EntitiesApi_DeleteEntityColorPalettes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiDeleteEntityColorPalettesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
41081
|
+
/**
|
|
41082
|
+
*
|
|
41083
|
+
* @summary Delete a Computed Attribute
|
|
41084
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
41085
|
+
* @param {string} basePath Base path.
|
|
41086
|
+
* @param {EntitiesApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
41087
|
+
* @param {*} [options] Override http request option.
|
|
41088
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
41089
|
+
* @throws {RequiredError}
|
|
41090
|
+
*/
|
|
41091
|
+
export declare function EntitiesApi_DeleteEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
39056
41092
|
/**
|
|
39057
41093
|
* Context Security Police Directive
|
|
39058
41094
|
* @summary Delete CSP Directives
|
|
@@ -39536,6 +41572,17 @@ export declare function EntitiesApi_GetAllEntitiesAutomations(axios: AxiosInstan
|
|
|
39536
41572
|
* @throws {RequiredError}
|
|
39537
41573
|
*/
|
|
39538
41574
|
export declare function EntitiesApi_GetAllEntitiesColorPalettes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiGetAllEntitiesColorPalettesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiColorPaletteOutList>;
|
|
41575
|
+
/**
|
|
41576
|
+
*
|
|
41577
|
+
* @summary Get all Computed Attributes
|
|
41578
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
41579
|
+
* @param {string} basePath Base path.
|
|
41580
|
+
* @param {EntitiesApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
41581
|
+
* @param {*} [options] Override http request option.
|
|
41582
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
41583
|
+
* @throws {RequiredError}
|
|
41584
|
+
*/
|
|
41585
|
+
export declare function EntitiesApi_GetAllEntitiesComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
39539
41586
|
/**
|
|
39540
41587
|
* Context Security Police Directive
|
|
39541
41588
|
* @summary Get CSP Directives
|
|
@@ -40119,6 +42166,17 @@ export declare function EntitiesApi_GetEntityAutomations(axios: AxiosInstance, b
|
|
|
40119
42166
|
* @throws {RequiredError}
|
|
40120
42167
|
*/
|
|
40121
42168
|
export declare function EntitiesApi_GetEntityColorPalettes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiGetEntityColorPalettesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
42169
|
+
/**
|
|
42170
|
+
*
|
|
42171
|
+
* @summary Get a Computed Attribute
|
|
42172
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
42173
|
+
* @param {string} basePath Base path.
|
|
42174
|
+
* @param {EntitiesApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
42175
|
+
* @param {*} [options] Override http request option.
|
|
42176
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
42177
|
+
* @throws {RequiredError}
|
|
42178
|
+
*/
|
|
42179
|
+
export declare function EntitiesApi_GetEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
40122
42180
|
/**
|
|
40123
42181
|
*
|
|
40124
42182
|
* @summary Get CookieSecurityConfiguration
|
|
@@ -40691,6 +42749,17 @@ export declare function EntitiesApi_PatchEntityAutomations(axios: AxiosInstance,
|
|
|
40691
42749
|
* @throws {RequiredError}
|
|
40692
42750
|
*/
|
|
40693
42751
|
export declare function EntitiesApi_PatchEntityColorPalettes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityColorPalettesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
42752
|
+
/**
|
|
42753
|
+
*
|
|
42754
|
+
* @summary Patch a Computed Attribute
|
|
42755
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
42756
|
+
* @param {string} basePath Base path.
|
|
42757
|
+
* @param {EntitiesApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
42758
|
+
* @param {*} [options] Override http request option.
|
|
42759
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
42760
|
+
* @throws {RequiredError}
|
|
42761
|
+
*/
|
|
42762
|
+
export declare function EntitiesApi_PatchEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
40694
42763
|
/**
|
|
40695
42764
|
*
|
|
40696
42765
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -41153,6 +43222,17 @@ export declare function EntitiesApi_SearchEntitiesAutomationResults(axios: Axios
|
|
|
41153
43222
|
* @throws {RequiredError}
|
|
41154
43223
|
*/
|
|
41155
43224
|
export declare function EntitiesApi_SearchEntitiesAutomations(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiSearchEntitiesAutomationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAutomationOutList>;
|
|
43225
|
+
/**
|
|
43226
|
+
*
|
|
43227
|
+
* @summary The search endpoint (beta)
|
|
43228
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
43229
|
+
* @param {string} basePath Base path.
|
|
43230
|
+
* @param {EntitiesApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
43231
|
+
* @param {*} [options] Override http request option.
|
|
43232
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
43233
|
+
* @throws {RequiredError}
|
|
43234
|
+
*/
|
|
43235
|
+
export declare function EntitiesApi_SearchEntitiesComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
41156
43236
|
/**
|
|
41157
43237
|
*
|
|
41158
43238
|
* @summary The search endpoint (beta)
|
|
@@ -41406,6 +43486,17 @@ export declare function EntitiesApi_UpdateEntityAutomations(axios: AxiosInstance
|
|
|
41406
43486
|
* @throws {RequiredError}
|
|
41407
43487
|
*/
|
|
41408
43488
|
export declare function EntitiesApi_UpdateEntityColorPalettes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiUpdateEntityColorPalettesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
43489
|
+
/**
|
|
43490
|
+
*
|
|
43491
|
+
* @summary Put a Computed Attribute
|
|
43492
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
43493
|
+
* @param {string} basePath Base path.
|
|
43494
|
+
* @param {EntitiesApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
43495
|
+
* @param {*} [options] Override http request option.
|
|
43496
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
43497
|
+
* @throws {RequiredError}
|
|
43498
|
+
*/
|
|
43499
|
+
export declare function EntitiesApi_UpdateEntityComputedAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
41409
43500
|
/**
|
|
41410
43501
|
*
|
|
41411
43502
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -41871,6 +43962,15 @@ export interface EntitiesApiInterface {
|
|
|
41871
43962
|
* @memberof EntitiesApiInterface
|
|
41872
43963
|
*/
|
|
41873
43964
|
createEntityColorPalettes(requestParameters: EntitiesApiCreateEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
43965
|
+
/**
|
|
43966
|
+
*
|
|
43967
|
+
* @summary Post Computed Attributes
|
|
43968
|
+
* @param {EntitiesApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
43969
|
+
* @param {*} [options] Override http request option.
|
|
43970
|
+
* @throws {RequiredError}
|
|
43971
|
+
* @memberof EntitiesApiInterface
|
|
43972
|
+
*/
|
|
43973
|
+
createEntityComputedAttributes(requestParameters: EntitiesApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
41874
43974
|
/**
|
|
41875
43975
|
* Context Security Police Directive
|
|
41876
43976
|
* @summary Post CSP Directives
|
|
@@ -42241,6 +44341,15 @@ export interface EntitiesApiInterface {
|
|
|
42241
44341
|
* @memberof EntitiesApiInterface
|
|
42242
44342
|
*/
|
|
42243
44343
|
deleteEntityColorPalettes(requestParameters: EntitiesApiDeleteEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
44344
|
+
/**
|
|
44345
|
+
*
|
|
44346
|
+
* @summary Delete a Computed Attribute
|
|
44347
|
+
* @param {EntitiesApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
44348
|
+
* @param {*} [options] Override http request option.
|
|
44349
|
+
* @throws {RequiredError}
|
|
44350
|
+
* @memberof EntitiesApiInterface
|
|
44351
|
+
*/
|
|
44352
|
+
deleteEntityComputedAttributes(requestParameters: EntitiesApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
42244
44353
|
/**
|
|
42245
44354
|
* Context Security Police Directive
|
|
42246
44355
|
* @summary Delete CSP Directives
|
|
@@ -42637,6 +44746,15 @@ export interface EntitiesApiInterface {
|
|
|
42637
44746
|
* @memberof EntitiesApiInterface
|
|
42638
44747
|
*/
|
|
42639
44748
|
getAllEntitiesColorPalettes(requestParameters: EntitiesApiGetAllEntitiesColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutList>;
|
|
44749
|
+
/**
|
|
44750
|
+
*
|
|
44751
|
+
* @summary Get all Computed Attributes
|
|
44752
|
+
* @param {EntitiesApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
44753
|
+
* @param {*} [options] Override http request option.
|
|
44754
|
+
* @throws {RequiredError}
|
|
44755
|
+
* @memberof EntitiesApiInterface
|
|
44756
|
+
*/
|
|
44757
|
+
getAllEntitiesComputedAttributes(requestParameters: EntitiesApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
42640
44758
|
/**
|
|
42641
44759
|
* Context Security Police Directive
|
|
42642
44760
|
* @summary Get CSP Directives
|
|
@@ -43115,6 +45233,15 @@ export interface EntitiesApiInterface {
|
|
|
43115
45233
|
* @memberof EntitiesApiInterface
|
|
43116
45234
|
*/
|
|
43117
45235
|
getEntityColorPalettes(requestParameters: EntitiesApiGetEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
45236
|
+
/**
|
|
45237
|
+
*
|
|
45238
|
+
* @summary Get a Computed Attribute
|
|
45239
|
+
* @param {EntitiesApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
45240
|
+
* @param {*} [options] Override http request option.
|
|
45241
|
+
* @throws {RequiredError}
|
|
45242
|
+
* @memberof EntitiesApiInterface
|
|
45243
|
+
*/
|
|
45244
|
+
getEntityComputedAttributes(requestParameters: EntitiesApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
43118
45245
|
/**
|
|
43119
45246
|
*
|
|
43120
45247
|
* @summary Get CookieSecurityConfiguration
|
|
@@ -43584,6 +45711,15 @@ export interface EntitiesApiInterface {
|
|
|
43584
45711
|
* @memberof EntitiesApiInterface
|
|
43585
45712
|
*/
|
|
43586
45713
|
patchEntityColorPalettes(requestParameters: EntitiesApiPatchEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
45714
|
+
/**
|
|
45715
|
+
*
|
|
45716
|
+
* @summary Patch a Computed Attribute
|
|
45717
|
+
* @param {EntitiesApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
45718
|
+
* @param {*} [options] Override http request option.
|
|
45719
|
+
* @throws {RequiredError}
|
|
45720
|
+
* @memberof EntitiesApiInterface
|
|
45721
|
+
*/
|
|
45722
|
+
patchEntityComputedAttributes(requestParameters: EntitiesApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
43587
45723
|
/**
|
|
43588
45724
|
*
|
|
43589
45725
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -43962,6 +46098,15 @@ export interface EntitiesApiInterface {
|
|
|
43962
46098
|
* @memberof EntitiesApiInterface
|
|
43963
46099
|
*/
|
|
43964
46100
|
searchEntitiesAutomations(requestParameters: EntitiesApiSearchEntitiesAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAutomationOutList>;
|
|
46101
|
+
/**
|
|
46102
|
+
*
|
|
46103
|
+
* @summary The search endpoint (beta)
|
|
46104
|
+
* @param {EntitiesApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
46105
|
+
* @param {*} [options] Override http request option.
|
|
46106
|
+
* @throws {RequiredError}
|
|
46107
|
+
* @memberof EntitiesApiInterface
|
|
46108
|
+
*/
|
|
46109
|
+
searchEntitiesComputedAttributes(requestParameters: EntitiesApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
43965
46110
|
/**
|
|
43966
46111
|
*
|
|
43967
46112
|
* @summary The search endpoint (beta)
|
|
@@ -44170,6 +46315,15 @@ export interface EntitiesApiInterface {
|
|
|
44170
46315
|
* @memberof EntitiesApiInterface
|
|
44171
46316
|
*/
|
|
44172
46317
|
updateEntityColorPalettes(requestParameters: EntitiesApiUpdateEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
46318
|
+
/**
|
|
46319
|
+
*
|
|
46320
|
+
* @summary Put a Computed Attribute
|
|
46321
|
+
* @param {EntitiesApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
46322
|
+
* @param {*} [options] Override http request option.
|
|
46323
|
+
* @throws {RequiredError}
|
|
46324
|
+
* @memberof EntitiesApiInterface
|
|
46325
|
+
*/
|
|
46326
|
+
updateEntityComputedAttributes(requestParameters: EntitiesApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
44173
46327
|
/**
|
|
44174
46328
|
*
|
|
44175
46329
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -44639,6 +46793,37 @@ export interface EntitiesApiCreateEntityColorPalettesRequest {
|
|
|
44639
46793
|
*/
|
|
44640
46794
|
readonly jsonApiColorPaletteInDocument: JsonApiColorPaletteInDocument;
|
|
44641
46795
|
}
|
|
46796
|
+
/**
|
|
46797
|
+
* Request parameters for createEntityComputedAttributes operation in EntitiesApi.
|
|
46798
|
+
* @export
|
|
46799
|
+
* @interface EntitiesApiCreateEntityComputedAttributesRequest
|
|
46800
|
+
*/
|
|
46801
|
+
export interface EntitiesApiCreateEntityComputedAttributesRequest {
|
|
46802
|
+
/**
|
|
46803
|
+
*
|
|
46804
|
+
* @type {string}
|
|
46805
|
+
* @memberof EntitiesApiCreateEntityComputedAttributes
|
|
46806
|
+
*/
|
|
46807
|
+
readonly workspaceId: string;
|
|
46808
|
+
/**
|
|
46809
|
+
*
|
|
46810
|
+
* @type {JsonApiComputedAttributePostOptionalIdDocument}
|
|
46811
|
+
* @memberof EntitiesApiCreateEntityComputedAttributes
|
|
46812
|
+
*/
|
|
46813
|
+
readonly jsonApiComputedAttributePostOptionalIdDocument: JsonApiComputedAttributePostOptionalIdDocument;
|
|
46814
|
+
/**
|
|
46815
|
+
* 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.
|
|
46816
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
46817
|
+
* @memberof EntitiesApiCreateEntityComputedAttributes
|
|
46818
|
+
*/
|
|
46819
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
46820
|
+
/**
|
|
46821
|
+
* Include Meta objects.
|
|
46822
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
46823
|
+
* @memberof EntitiesApiCreateEntityComputedAttributes
|
|
46824
|
+
*/
|
|
46825
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
46826
|
+
}
|
|
44642
46827
|
/**
|
|
44643
46828
|
* Request parameters for createEntityCspDirectives operation in EntitiesApi.
|
|
44644
46829
|
* @export
|
|
@@ -44999,10 +47184,10 @@ export interface EntitiesApiCreateEntityMetricsRequest {
|
|
|
44999
47184
|
readonly jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument;
|
|
45000
47185
|
/**
|
|
45001
47186
|
* 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.
|
|
45002
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
47187
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
45003
47188
|
* @memberof EntitiesApiCreateEntityMetrics
|
|
45004
47189
|
*/
|
|
45005
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
47190
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
45006
47191
|
/**
|
|
45007
47192
|
* Include Meta objects.
|
|
45008
47193
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -45119,10 +47304,10 @@ export interface EntitiesApiCreateEntityUserDataFiltersRequest {
|
|
|
45119
47304
|
readonly jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument;
|
|
45120
47305
|
/**
|
|
45121
47306
|
* 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.
|
|
45122
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
47307
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
45123
47308
|
* @memberof EntitiesApiCreateEntityUserDataFilters
|
|
45124
47309
|
*/
|
|
45125
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
47310
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
45126
47311
|
/**
|
|
45127
47312
|
* Include Meta objects.
|
|
45128
47313
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -45520,6 +47705,25 @@ export interface EntitiesApiDeleteEntityColorPalettesRequest {
|
|
|
45520
47705
|
*/
|
|
45521
47706
|
readonly id: string;
|
|
45522
47707
|
}
|
|
47708
|
+
/**
|
|
47709
|
+
* Request parameters for deleteEntityComputedAttributes operation in EntitiesApi.
|
|
47710
|
+
* @export
|
|
47711
|
+
* @interface EntitiesApiDeleteEntityComputedAttributesRequest
|
|
47712
|
+
*/
|
|
47713
|
+
export interface EntitiesApiDeleteEntityComputedAttributesRequest {
|
|
47714
|
+
/**
|
|
47715
|
+
*
|
|
47716
|
+
* @type {string}
|
|
47717
|
+
* @memberof EntitiesApiDeleteEntityComputedAttributes
|
|
47718
|
+
*/
|
|
47719
|
+
readonly workspaceId: string;
|
|
47720
|
+
/**
|
|
47721
|
+
*
|
|
47722
|
+
* @type {string}
|
|
47723
|
+
* @memberof EntitiesApiDeleteEntityComputedAttributes
|
|
47724
|
+
*/
|
|
47725
|
+
readonly objectId: string;
|
|
47726
|
+
}
|
|
45523
47727
|
/**
|
|
45524
47728
|
* Request parameters for deleteEntityCspDirectives operation in EntitiesApi.
|
|
45525
47729
|
* @export
|
|
@@ -46547,6 +48751,67 @@ export interface EntitiesApiGetAllEntitiesColorPalettesRequest {
|
|
|
46547
48751
|
*/
|
|
46548
48752
|
readonly metaInclude?: Array<'page' | 'all' | 'ALL'>;
|
|
46549
48753
|
}
|
|
48754
|
+
/**
|
|
48755
|
+
* Request parameters for getAllEntitiesComputedAttributes operation in EntitiesApi.
|
|
48756
|
+
* @export
|
|
48757
|
+
* @interface EntitiesApiGetAllEntitiesComputedAttributesRequest
|
|
48758
|
+
*/
|
|
48759
|
+
export interface EntitiesApiGetAllEntitiesComputedAttributesRequest {
|
|
48760
|
+
/**
|
|
48761
|
+
*
|
|
48762
|
+
* @type {string}
|
|
48763
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48764
|
+
*/
|
|
48765
|
+
readonly workspaceId: string;
|
|
48766
|
+
/**
|
|
48767
|
+
*
|
|
48768
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
48769
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48770
|
+
*/
|
|
48771
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
48772
|
+
/**
|
|
48773
|
+
* 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\').
|
|
48774
|
+
* @type {string}
|
|
48775
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48776
|
+
*/
|
|
48777
|
+
readonly filter?: string;
|
|
48778
|
+
/**
|
|
48779
|
+
* 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.
|
|
48780
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
48781
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48782
|
+
*/
|
|
48783
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48784
|
+
/**
|
|
48785
|
+
* Zero-based page index (0..N)
|
|
48786
|
+
* @type {number}
|
|
48787
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48788
|
+
*/
|
|
48789
|
+
readonly page?: number;
|
|
48790
|
+
/**
|
|
48791
|
+
* The size of the page to be returned
|
|
48792
|
+
* @type {number}
|
|
48793
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48794
|
+
*/
|
|
48795
|
+
readonly size?: number;
|
|
48796
|
+
/**
|
|
48797
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
48798
|
+
* @type {Array<string>}
|
|
48799
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48800
|
+
*/
|
|
48801
|
+
readonly sort?: Array<string>;
|
|
48802
|
+
/**
|
|
48803
|
+
*
|
|
48804
|
+
* @type {boolean}
|
|
48805
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48806
|
+
*/
|
|
48807
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
48808
|
+
/**
|
|
48809
|
+
* Include Meta objects.
|
|
48810
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
48811
|
+
* @memberof EntitiesApiGetAllEntitiesComputedAttributes
|
|
48812
|
+
*/
|
|
48813
|
+
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
48814
|
+
}
|
|
46550
48815
|
/**
|
|
46551
48816
|
* Request parameters for getAllEntitiesCspDirectives operation in EntitiesApi.
|
|
46552
48817
|
* @export
|
|
@@ -47651,10 +49916,10 @@ export interface EntitiesApiGetAllEntitiesMetricsRequest {
|
|
|
47651
49916
|
readonly filter?: string;
|
|
47652
49917
|
/**
|
|
47653
49918
|
* 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.
|
|
47654
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
49919
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
47655
49920
|
* @memberof EntitiesApiGetAllEntitiesMetrics
|
|
47656
49921
|
*/
|
|
47657
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
49922
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
47658
49923
|
/**
|
|
47659
49924
|
* Zero-based page index (0..N)
|
|
47660
49925
|
* @type {number}
|
|
@@ -47964,10 +50229,10 @@ export interface EntitiesApiGetAllEntitiesUserDataFiltersRequest {
|
|
|
47964
50229
|
readonly filter?: string;
|
|
47965
50230
|
/**
|
|
47966
50231
|
* 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.
|
|
47967
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
50232
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
47968
50233
|
* @memberof EntitiesApiGetAllEntitiesUserDataFilters
|
|
47969
50234
|
*/
|
|
47970
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
50235
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
47971
50236
|
/**
|
|
47972
50237
|
* Zero-based page index (0..N)
|
|
47973
50238
|
* @type {number}
|
|
@@ -48908,6 +51173,49 @@ export interface EntitiesApiGetEntityColorPalettesRequest {
|
|
|
48908
51173
|
*/
|
|
48909
51174
|
readonly filter?: string;
|
|
48910
51175
|
}
|
|
51176
|
+
/**
|
|
51177
|
+
* Request parameters for getEntityComputedAttributes operation in EntitiesApi.
|
|
51178
|
+
* @export
|
|
51179
|
+
* @interface EntitiesApiGetEntityComputedAttributesRequest
|
|
51180
|
+
*/
|
|
51181
|
+
export interface EntitiesApiGetEntityComputedAttributesRequest {
|
|
51182
|
+
/**
|
|
51183
|
+
*
|
|
51184
|
+
* @type {string}
|
|
51185
|
+
* @memberof EntitiesApiGetEntityComputedAttributes
|
|
51186
|
+
*/
|
|
51187
|
+
readonly workspaceId: string;
|
|
51188
|
+
/**
|
|
51189
|
+
*
|
|
51190
|
+
* @type {string}
|
|
51191
|
+
* @memberof EntitiesApiGetEntityComputedAttributes
|
|
51192
|
+
*/
|
|
51193
|
+
readonly objectId: string;
|
|
51194
|
+
/**
|
|
51195
|
+
* 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\').
|
|
51196
|
+
* @type {string}
|
|
51197
|
+
* @memberof EntitiesApiGetEntityComputedAttributes
|
|
51198
|
+
*/
|
|
51199
|
+
readonly filter?: string;
|
|
51200
|
+
/**
|
|
51201
|
+
* 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.
|
|
51202
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51203
|
+
* @memberof EntitiesApiGetEntityComputedAttributes
|
|
51204
|
+
*/
|
|
51205
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51206
|
+
/**
|
|
51207
|
+
*
|
|
51208
|
+
* @type {boolean}
|
|
51209
|
+
* @memberof EntitiesApiGetEntityComputedAttributes
|
|
51210
|
+
*/
|
|
51211
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
51212
|
+
/**
|
|
51213
|
+
* Include Meta objects.
|
|
51214
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
51215
|
+
* @memberof EntitiesApiGetEntityComputedAttributes
|
|
51216
|
+
*/
|
|
51217
|
+
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
51218
|
+
}
|
|
48911
51219
|
/**
|
|
48912
51220
|
* Request parameters for getEntityCookieSecurityConfigurations operation in EntitiesApi.
|
|
48913
51221
|
* @export
|
|
@@ -49635,10 +51943,10 @@ export interface EntitiesApiGetEntityMetricsRequest {
|
|
|
49635
51943
|
readonly filter?: string;
|
|
49636
51944
|
/**
|
|
49637
51945
|
* 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.
|
|
49638
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51946
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
49639
51947
|
* @memberof EntitiesApiGetEntityMetrics
|
|
49640
51948
|
*/
|
|
49641
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51949
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
49642
51950
|
/**
|
|
49643
51951
|
*
|
|
49644
51952
|
* @type {boolean}
|
|
@@ -49853,10 +52161,10 @@ export interface EntitiesApiGetEntityUserDataFiltersRequest {
|
|
|
49853
52161
|
readonly filter?: string;
|
|
49854
52162
|
/**
|
|
49855
52163
|
* 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.
|
|
49856
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
52164
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
49857
52165
|
* @memberof EntitiesApiGetEntityUserDataFilters
|
|
49858
52166
|
*/
|
|
49859
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
52167
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
49860
52168
|
/**
|
|
49861
52169
|
*
|
|
49862
52170
|
* @type {boolean}
|
|
@@ -50502,6 +52810,43 @@ export interface EntitiesApiPatchEntityColorPalettesRequest {
|
|
|
50502
52810
|
*/
|
|
50503
52811
|
readonly filter?: string;
|
|
50504
52812
|
}
|
|
52813
|
+
/**
|
|
52814
|
+
* Request parameters for patchEntityComputedAttributes operation in EntitiesApi.
|
|
52815
|
+
* @export
|
|
52816
|
+
* @interface EntitiesApiPatchEntityComputedAttributesRequest
|
|
52817
|
+
*/
|
|
52818
|
+
export interface EntitiesApiPatchEntityComputedAttributesRequest {
|
|
52819
|
+
/**
|
|
52820
|
+
*
|
|
52821
|
+
* @type {string}
|
|
52822
|
+
* @memberof EntitiesApiPatchEntityComputedAttributes
|
|
52823
|
+
*/
|
|
52824
|
+
readonly workspaceId: string;
|
|
52825
|
+
/**
|
|
52826
|
+
*
|
|
52827
|
+
* @type {string}
|
|
52828
|
+
* @memberof EntitiesApiPatchEntityComputedAttributes
|
|
52829
|
+
*/
|
|
52830
|
+
readonly objectId: string;
|
|
52831
|
+
/**
|
|
52832
|
+
*
|
|
52833
|
+
* @type {JsonApiComputedAttributePatchDocument}
|
|
52834
|
+
* @memberof EntitiesApiPatchEntityComputedAttributes
|
|
52835
|
+
*/
|
|
52836
|
+
readonly jsonApiComputedAttributePatchDocument: JsonApiComputedAttributePatchDocument;
|
|
52837
|
+
/**
|
|
52838
|
+
* 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\').
|
|
52839
|
+
* @type {string}
|
|
52840
|
+
* @memberof EntitiesApiPatchEntityComputedAttributes
|
|
52841
|
+
*/
|
|
52842
|
+
readonly filter?: string;
|
|
52843
|
+
/**
|
|
52844
|
+
* 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.
|
|
52845
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
52846
|
+
* @memberof EntitiesApiPatchEntityComputedAttributes
|
|
52847
|
+
*/
|
|
52848
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
52849
|
+
}
|
|
50505
52850
|
/**
|
|
50506
52851
|
* Request parameters for patchEntityCookieSecurityConfigurations operation in EntitiesApi.
|
|
50507
52852
|
* @export
|
|
@@ -51098,10 +53443,10 @@ export interface EntitiesApiPatchEntityMetricsRequest {
|
|
|
51098
53443
|
readonly filter?: string;
|
|
51099
53444
|
/**
|
|
51100
53445
|
* 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.
|
|
51101
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
53446
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51102
53447
|
* @memberof EntitiesApiPatchEntityMetrics
|
|
51103
53448
|
*/
|
|
51104
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
53449
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51105
53450
|
}
|
|
51106
53451
|
/**
|
|
51107
53452
|
* Request parameters for patchEntityNotificationChannels operation in EntitiesApi.
|
|
@@ -51309,10 +53654,10 @@ export interface EntitiesApiPatchEntityUserDataFiltersRequest {
|
|
|
51309
53654
|
readonly filter?: string;
|
|
51310
53655
|
/**
|
|
51311
53656
|
* 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.
|
|
51312
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
53657
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
51313
53658
|
* @memberof EntitiesApiPatchEntityUserDataFilters
|
|
51314
53659
|
*/
|
|
51315
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
53660
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
51316
53661
|
}
|
|
51317
53662
|
/**
|
|
51318
53663
|
* Request parameters for patchEntityUserGroups operation in EntitiesApi.
|
|
@@ -51828,6 +54173,37 @@ export interface EntitiesApiSearchEntitiesAutomationsRequest {
|
|
|
51828
54173
|
*/
|
|
51829
54174
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
51830
54175
|
}
|
|
54176
|
+
/**
|
|
54177
|
+
* Request parameters for searchEntitiesComputedAttributes operation in EntitiesApi.
|
|
54178
|
+
* @export
|
|
54179
|
+
* @interface EntitiesApiSearchEntitiesComputedAttributesRequest
|
|
54180
|
+
*/
|
|
54181
|
+
export interface EntitiesApiSearchEntitiesComputedAttributesRequest {
|
|
54182
|
+
/**
|
|
54183
|
+
*
|
|
54184
|
+
* @type {string}
|
|
54185
|
+
* @memberof EntitiesApiSearchEntitiesComputedAttributes
|
|
54186
|
+
*/
|
|
54187
|
+
readonly workspaceId: string;
|
|
54188
|
+
/**
|
|
54189
|
+
* Search request body with filter, pagination, and sorting options
|
|
54190
|
+
* @type {EntitySearchBody}
|
|
54191
|
+
* @memberof EntitiesApiSearchEntitiesComputedAttributes
|
|
54192
|
+
*/
|
|
54193
|
+
readonly entitySearchBody: EntitySearchBody;
|
|
54194
|
+
/**
|
|
54195
|
+
*
|
|
54196
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
54197
|
+
* @memberof EntitiesApiSearchEntitiesComputedAttributes
|
|
54198
|
+
*/
|
|
54199
|
+
readonly origin?: 'ALL' | 'PARENTS' | 'NATIVE';
|
|
54200
|
+
/**
|
|
54201
|
+
*
|
|
54202
|
+
* @type {boolean}
|
|
54203
|
+
* @memberof EntitiesApiSearchEntitiesComputedAttributes
|
|
54204
|
+
*/
|
|
54205
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
54206
|
+
}
|
|
51831
54207
|
/**
|
|
51832
54208
|
* Request parameters for searchEntitiesCustomApplicationSettings operation in EntitiesApi.
|
|
51833
54209
|
* @export
|
|
@@ -52535,6 +54911,43 @@ export interface EntitiesApiUpdateEntityColorPalettesRequest {
|
|
|
52535
54911
|
*/
|
|
52536
54912
|
readonly filter?: string;
|
|
52537
54913
|
}
|
|
54914
|
+
/**
|
|
54915
|
+
* Request parameters for updateEntityComputedAttributes operation in EntitiesApi.
|
|
54916
|
+
* @export
|
|
54917
|
+
* @interface EntitiesApiUpdateEntityComputedAttributesRequest
|
|
54918
|
+
*/
|
|
54919
|
+
export interface EntitiesApiUpdateEntityComputedAttributesRequest {
|
|
54920
|
+
/**
|
|
54921
|
+
*
|
|
54922
|
+
* @type {string}
|
|
54923
|
+
* @memberof EntitiesApiUpdateEntityComputedAttributes
|
|
54924
|
+
*/
|
|
54925
|
+
readonly workspaceId: string;
|
|
54926
|
+
/**
|
|
54927
|
+
*
|
|
54928
|
+
* @type {string}
|
|
54929
|
+
* @memberof EntitiesApiUpdateEntityComputedAttributes
|
|
54930
|
+
*/
|
|
54931
|
+
readonly objectId: string;
|
|
54932
|
+
/**
|
|
54933
|
+
*
|
|
54934
|
+
* @type {JsonApiComputedAttributeInDocument}
|
|
54935
|
+
* @memberof EntitiesApiUpdateEntityComputedAttributes
|
|
54936
|
+
*/
|
|
54937
|
+
readonly jsonApiComputedAttributeInDocument: JsonApiComputedAttributeInDocument;
|
|
54938
|
+
/**
|
|
54939
|
+
* 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\').
|
|
54940
|
+
* @type {string}
|
|
54941
|
+
* @memberof EntitiesApiUpdateEntityComputedAttributes
|
|
54942
|
+
*/
|
|
54943
|
+
readonly filter?: string;
|
|
54944
|
+
/**
|
|
54945
|
+
* 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.
|
|
54946
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
54947
|
+
* @memberof EntitiesApiUpdateEntityComputedAttributes
|
|
54948
|
+
*/
|
|
54949
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
54950
|
+
}
|
|
52538
54951
|
/**
|
|
52539
54952
|
* Request parameters for updateEntityCookieSecurityConfigurations operation in EntitiesApi.
|
|
52540
54953
|
* @export
|
|
@@ -53082,10 +55495,10 @@ export interface EntitiesApiUpdateEntityMetricsRequest {
|
|
|
53082
55495
|
readonly filter?: string;
|
|
53083
55496
|
/**
|
|
53084
55497
|
* 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.
|
|
53085
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
55498
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
53086
55499
|
* @memberof EntitiesApiUpdateEntityMetrics
|
|
53087
55500
|
*/
|
|
53088
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
55501
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
53089
55502
|
}
|
|
53090
55503
|
/**
|
|
53091
55504
|
* Request parameters for updateEntityNotificationChannels operation in EntitiesApi.
|
|
@@ -53293,10 +55706,10 @@ export interface EntitiesApiUpdateEntityUserDataFiltersRequest {
|
|
|
53293
55706
|
readonly filter?: string;
|
|
53294
55707
|
/**
|
|
53295
55708
|
* 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.
|
|
53296
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
55709
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
53297
55710
|
* @memberof EntitiesApiUpdateEntityUserDataFilters
|
|
53298
55711
|
*/
|
|
53299
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
55712
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
53300
55713
|
}
|
|
53301
55714
|
/**
|
|
53302
55715
|
* Request parameters for updateEntityUserGroups operation in EntitiesApi.
|
|
@@ -53727,6 +56140,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
53727
56140
|
* @memberof EntitiesApi
|
|
53728
56141
|
*/
|
|
53729
56142
|
createEntityColorPalettes(requestParameters: EntitiesApiCreateEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
56143
|
+
/**
|
|
56144
|
+
*
|
|
56145
|
+
* @summary Post Computed Attributes
|
|
56146
|
+
* @param {EntitiesApiCreateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
56147
|
+
* @param {*} [options] Override http request option.
|
|
56148
|
+
* @throws {RequiredError}
|
|
56149
|
+
* @memberof EntitiesApi
|
|
56150
|
+
*/
|
|
56151
|
+
createEntityComputedAttributes(requestParameters: EntitiesApiCreateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
53730
56152
|
/**
|
|
53731
56153
|
* Context Security Police Directive
|
|
53732
56154
|
* @summary Post CSP Directives
|
|
@@ -54097,6 +56519,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
54097
56519
|
* @memberof EntitiesApi
|
|
54098
56520
|
*/
|
|
54099
56521
|
deleteEntityColorPalettes(requestParameters: EntitiesApiDeleteEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56522
|
+
/**
|
|
56523
|
+
*
|
|
56524
|
+
* @summary Delete a Computed Attribute
|
|
56525
|
+
* @param {EntitiesApiDeleteEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
56526
|
+
* @param {*} [options] Override http request option.
|
|
56527
|
+
* @throws {RequiredError}
|
|
56528
|
+
* @memberof EntitiesApi
|
|
56529
|
+
*/
|
|
56530
|
+
deleteEntityComputedAttributes(requestParameters: EntitiesApiDeleteEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
54100
56531
|
/**
|
|
54101
56532
|
* Context Security Police Directive
|
|
54102
56533
|
* @summary Delete CSP Directives
|
|
@@ -54493,6 +56924,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
54493
56924
|
* @memberof EntitiesApi
|
|
54494
56925
|
*/
|
|
54495
56926
|
getAllEntitiesColorPalettes(requestParameters?: EntitiesApiGetAllEntitiesColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutList>;
|
|
56927
|
+
/**
|
|
56928
|
+
*
|
|
56929
|
+
* @summary Get all Computed Attributes
|
|
56930
|
+
* @param {EntitiesApiGetAllEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
56931
|
+
* @param {*} [options] Override http request option.
|
|
56932
|
+
* @throws {RequiredError}
|
|
56933
|
+
* @memberof EntitiesApi
|
|
56934
|
+
*/
|
|
56935
|
+
getAllEntitiesComputedAttributes(requestParameters: EntitiesApiGetAllEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
54496
56936
|
/**
|
|
54497
56937
|
* Context Security Police Directive
|
|
54498
56938
|
* @summary Get CSP Directives
|
|
@@ -54971,6 +57411,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
54971
57411
|
* @memberof EntitiesApi
|
|
54972
57412
|
*/
|
|
54973
57413
|
getEntityColorPalettes(requestParameters: EntitiesApiGetEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
57414
|
+
/**
|
|
57415
|
+
*
|
|
57416
|
+
* @summary Get a Computed Attribute
|
|
57417
|
+
* @param {EntitiesApiGetEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
57418
|
+
* @param {*} [options] Override http request option.
|
|
57419
|
+
* @throws {RequiredError}
|
|
57420
|
+
* @memberof EntitiesApi
|
|
57421
|
+
*/
|
|
57422
|
+
getEntityComputedAttributes(requestParameters: EntitiesApiGetEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
54974
57423
|
/**
|
|
54975
57424
|
*
|
|
54976
57425
|
* @summary Get CookieSecurityConfiguration
|
|
@@ -55440,6 +57889,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
55440
57889
|
* @memberof EntitiesApi
|
|
55441
57890
|
*/
|
|
55442
57891
|
patchEntityColorPalettes(requestParameters: EntitiesApiPatchEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
57892
|
+
/**
|
|
57893
|
+
*
|
|
57894
|
+
* @summary Patch a Computed Attribute
|
|
57895
|
+
* @param {EntitiesApiPatchEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
57896
|
+
* @param {*} [options] Override http request option.
|
|
57897
|
+
* @throws {RequiredError}
|
|
57898
|
+
* @memberof EntitiesApi
|
|
57899
|
+
*/
|
|
57900
|
+
patchEntityComputedAttributes(requestParameters: EntitiesApiPatchEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
55443
57901
|
/**
|
|
55444
57902
|
*
|
|
55445
57903
|
* @summary Patch CookieSecurityConfiguration
|
|
@@ -55818,6 +58276,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
55818
58276
|
* @memberof EntitiesApi
|
|
55819
58277
|
*/
|
|
55820
58278
|
searchEntitiesAutomations(requestParameters: EntitiesApiSearchEntitiesAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAutomationOutList>;
|
|
58279
|
+
/**
|
|
58280
|
+
*
|
|
58281
|
+
* @summary The search endpoint (beta)
|
|
58282
|
+
* @param {EntitiesApiSearchEntitiesComputedAttributesRequest} requestParameters Request parameters.
|
|
58283
|
+
* @param {*} [options] Override http request option.
|
|
58284
|
+
* @throws {RequiredError}
|
|
58285
|
+
* @memberof EntitiesApi
|
|
58286
|
+
*/
|
|
58287
|
+
searchEntitiesComputedAttributes(requestParameters: EntitiesApiSearchEntitiesComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutList>;
|
|
55821
58288
|
/**
|
|
55822
58289
|
*
|
|
55823
58290
|
* @summary The search endpoint (beta)
|
|
@@ -56026,6 +58493,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
56026
58493
|
* @memberof EntitiesApi
|
|
56027
58494
|
*/
|
|
56028
58495
|
updateEntityColorPalettes(requestParameters: EntitiesApiUpdateEntityColorPalettesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiColorPaletteOutDocument>;
|
|
58496
|
+
/**
|
|
58497
|
+
*
|
|
58498
|
+
* @summary Put a Computed Attribute
|
|
58499
|
+
* @param {EntitiesApiUpdateEntityComputedAttributesRequest} requestParameters Request parameters.
|
|
58500
|
+
* @param {*} [options] Override http request option.
|
|
58501
|
+
* @throws {RequiredError}
|
|
58502
|
+
* @memberof EntitiesApi
|
|
58503
|
+
*/
|
|
58504
|
+
updateEntityComputedAttributes(requestParameters: EntitiesApiUpdateEntityComputedAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiComputedAttributeOutDocument>;
|
|
56029
58505
|
/**
|
|
56030
58506
|
*
|
|
56031
58507
|
* @summary Put CookieSecurityConfiguration
|
|
@@ -71367,13 +73843,13 @@ export declare class MetadataSynchronizationApi extends BaseAPI implements Metad
|
|
|
71367
73843
|
* @summary Post Metrics
|
|
71368
73844
|
* @param {string} workspaceId
|
|
71369
73845
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
71370
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
73846
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71371
73847
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
71372
73848
|
* @param {*} [options] Override http request option.
|
|
71373
73849
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71374
73850
|
* @throws {RequiredError}
|
|
71375
73851
|
*/
|
|
71376
|
-
export declare function MetricControllerApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
73852
|
+
export declare function MetricControllerApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71377
73853
|
/**
|
|
71378
73854
|
*
|
|
71379
73855
|
* @summary Delete a Metric
|
|
@@ -71390,7 +73866,7 @@ export declare function MetricControllerApiAxiosParamCreator_DeleteEntityMetrics
|
|
|
71390
73866
|
* @param {string} workspaceId
|
|
71391
73867
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
71392
73868
|
* @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\').
|
|
71393
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
73869
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71394
73870
|
* @param {number} [page] Zero-based page index (0..N)
|
|
71395
73871
|
* @param {number} [size] The size of the page to be returned
|
|
71396
73872
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -71400,21 +73876,21 @@ export declare function MetricControllerApiAxiosParamCreator_DeleteEntityMetrics
|
|
|
71400
73876
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71401
73877
|
* @throws {RequiredError}
|
|
71402
73878
|
*/
|
|
71403
|
-
export declare function MetricControllerApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
73879
|
+
export declare function MetricControllerApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71404
73880
|
/**
|
|
71405
73881
|
*
|
|
71406
73882
|
* @summary Get a Metric
|
|
71407
73883
|
* @param {string} workspaceId
|
|
71408
73884
|
* @param {string} objectId
|
|
71409
73885
|
* @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\').
|
|
71410
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
73886
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71411
73887
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
71412
73888
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
71413
73889
|
* @param {*} [options] Override http request option.
|
|
71414
73890
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71415
73891
|
* @throws {RequiredError}
|
|
71416
73892
|
*/
|
|
71417
|
-
export declare function MetricControllerApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
73893
|
+
export declare function MetricControllerApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71418
73894
|
/**
|
|
71419
73895
|
*
|
|
71420
73896
|
* @summary Patch a Metric
|
|
@@ -71422,12 +73898,12 @@ export declare function MetricControllerApiAxiosParamCreator_GetEntityMetrics(wo
|
|
|
71422
73898
|
* @param {string} objectId
|
|
71423
73899
|
* @param {JsonApiMetricPatchDocument} jsonApiMetricPatchDocument
|
|
71424
73900
|
* @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\').
|
|
71425
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
73901
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71426
73902
|
* @param {*} [options] Override http request option.
|
|
71427
73903
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71428
73904
|
* @throws {RequiredError}
|
|
71429
73905
|
*/
|
|
71430
|
-
export declare function MetricControllerApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
73906
|
+
export declare function MetricControllerApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71431
73907
|
/**
|
|
71432
73908
|
*
|
|
71433
73909
|
* @summary The search endpoint (beta)
|
|
@@ -71447,12 +73923,12 @@ export declare function MetricControllerApiAxiosParamCreator_SearchEntitiesMetri
|
|
|
71447
73923
|
* @param {string} objectId
|
|
71448
73924
|
* @param {JsonApiMetricInDocument} jsonApiMetricInDocument
|
|
71449
73925
|
* @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\').
|
|
71450
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
73926
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71451
73927
|
* @param {*} [options] Override http request option.
|
|
71452
73928
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71453
73929
|
* @throws {RequiredError}
|
|
71454
73930
|
*/
|
|
71455
|
-
export declare function MetricControllerApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
73931
|
+
export declare function MetricControllerApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71456
73932
|
/**
|
|
71457
73933
|
*
|
|
71458
73934
|
* @summary Post Metrics
|
|
@@ -71620,10 +74096,10 @@ export interface MetricControllerApiCreateEntityMetricsRequest {
|
|
|
71620
74096
|
readonly jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument;
|
|
71621
74097
|
/**
|
|
71622
74098
|
* 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.
|
|
71623
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74099
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
71624
74100
|
* @memberof MetricControllerApiCreateEntityMetrics
|
|
71625
74101
|
*/
|
|
71626
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74102
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
71627
74103
|
/**
|
|
71628
74104
|
* Include Meta objects.
|
|
71629
74105
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -71676,10 +74152,10 @@ export interface MetricControllerApiGetAllEntitiesMetricsRequest {
|
|
|
71676
74152
|
readonly filter?: string;
|
|
71677
74153
|
/**
|
|
71678
74154
|
* 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.
|
|
71679
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74155
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
71680
74156
|
* @memberof MetricControllerApiGetAllEntitiesMetrics
|
|
71681
74157
|
*/
|
|
71682
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74158
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
71683
74159
|
/**
|
|
71684
74160
|
* Zero-based page index (0..N)
|
|
71685
74161
|
* @type {number}
|
|
@@ -71737,10 +74213,10 @@ export interface MetricControllerApiGetEntityMetricsRequest {
|
|
|
71737
74213
|
readonly filter?: string;
|
|
71738
74214
|
/**
|
|
71739
74215
|
* 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.
|
|
71740
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74216
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
71741
74217
|
* @memberof MetricControllerApiGetEntityMetrics
|
|
71742
74218
|
*/
|
|
71743
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74219
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
71744
74220
|
/**
|
|
71745
74221
|
*
|
|
71746
74222
|
* @type {boolean}
|
|
@@ -71786,10 +74262,10 @@ export interface MetricControllerApiPatchEntityMetricsRequest {
|
|
|
71786
74262
|
readonly filter?: string;
|
|
71787
74263
|
/**
|
|
71788
74264
|
* 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.
|
|
71789
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74265
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
71790
74266
|
* @memberof MetricControllerApiPatchEntityMetrics
|
|
71791
74267
|
*/
|
|
71792
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74268
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
71793
74269
|
}
|
|
71794
74270
|
/**
|
|
71795
74271
|
* Request parameters for searchEntitiesMetrics operation in MetricControllerApi.
|
|
@@ -71854,10 +74330,10 @@ export interface MetricControllerApiUpdateEntityMetricsRequest {
|
|
|
71854
74330
|
readonly filter?: string;
|
|
71855
74331
|
/**
|
|
71856
74332
|
* 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.
|
|
71857
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74333
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
71858
74334
|
* @memberof MetricControllerApiUpdateEntityMetrics
|
|
71859
74335
|
*/
|
|
71860
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74336
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
71861
74337
|
}
|
|
71862
74338
|
/**
|
|
71863
74339
|
* MetricControllerApi - object-oriented interface
|
|
@@ -71935,13 +74411,13 @@ export declare class MetricControllerApi extends BaseAPI implements MetricContro
|
|
|
71935
74411
|
* @summary Post Metrics
|
|
71936
74412
|
* @param {string} workspaceId
|
|
71937
74413
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
71938
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
74414
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71939
74415
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
71940
74416
|
* @param {*} [options] Override http request option.
|
|
71941
74417
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71942
74418
|
* @throws {RequiredError}
|
|
71943
74419
|
*/
|
|
71944
|
-
export declare function MetricsApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
74420
|
+
export declare function MetricsApiAxiosParamCreator_CreateEntityMetrics(workspaceId: string, jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71945
74421
|
/**
|
|
71946
74422
|
*
|
|
71947
74423
|
* @summary Delete a Metric
|
|
@@ -71958,7 +74434,7 @@ export declare function MetricsApiAxiosParamCreator_DeleteEntityMetrics(workspac
|
|
|
71958
74434
|
* @param {string} workspaceId
|
|
71959
74435
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
71960
74436
|
* @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\').
|
|
71961
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
74437
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71962
74438
|
* @param {number} [page] Zero-based page index (0..N)
|
|
71963
74439
|
* @param {number} [size] The size of the page to be returned
|
|
71964
74440
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -71968,21 +74444,21 @@ export declare function MetricsApiAxiosParamCreator_DeleteEntityMetrics(workspac
|
|
|
71968
74444
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71969
74445
|
* @throws {RequiredError}
|
|
71970
74446
|
*/
|
|
71971
|
-
export declare function MetricsApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
74447
|
+
export declare function MetricsApiAxiosParamCreator_GetAllEntitiesMetrics(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71972
74448
|
/**
|
|
71973
74449
|
*
|
|
71974
74450
|
* @summary Get a Metric
|
|
71975
74451
|
* @param {string} workspaceId
|
|
71976
74452
|
* @param {string} objectId
|
|
71977
74453
|
* @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\').
|
|
71978
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
74454
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71979
74455
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
71980
74456
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
71981
74457
|
* @param {*} [options] Override http request option.
|
|
71982
74458
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71983
74459
|
* @throws {RequiredError}
|
|
71984
74460
|
*/
|
|
71985
|
-
export declare function MetricsApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
74461
|
+
export declare function MetricsApiAxiosParamCreator_GetEntityMetrics(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71986
74462
|
/**
|
|
71987
74463
|
*
|
|
71988
74464
|
* @summary Patch a Metric
|
|
@@ -71990,12 +74466,12 @@ export declare function MetricsApiAxiosParamCreator_GetEntityMetrics(workspaceId
|
|
|
71990
74466
|
* @param {string} objectId
|
|
71991
74467
|
* @param {JsonApiMetricPatchDocument} jsonApiMetricPatchDocument
|
|
71992
74468
|
* @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\').
|
|
71993
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
74469
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
71994
74470
|
* @param {*} [options] Override http request option.
|
|
71995
74471
|
* @param {Configuration} [configuration] Optional configuration.
|
|
71996
74472
|
* @throws {RequiredError}
|
|
71997
74473
|
*/
|
|
71998
|
-
export declare function MetricsApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
74474
|
+
export declare function MetricsApiAxiosParamCreator_PatchEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricPatchDocument: JsonApiMetricPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
71999
74475
|
/**
|
|
72000
74476
|
*
|
|
72001
74477
|
* @summary The search endpoint (beta)
|
|
@@ -72015,12 +74491,12 @@ export declare function MetricsApiAxiosParamCreator_SearchEntitiesMetrics(worksp
|
|
|
72015
74491
|
* @param {string} objectId
|
|
72016
74492
|
* @param {JsonApiMetricInDocument} jsonApiMetricInDocument
|
|
72017
74493
|
* @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\').
|
|
72018
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
74494
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | '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.
|
|
72019
74495
|
* @param {*} [options] Override http request option.
|
|
72020
74496
|
* @param {Configuration} [configuration] Optional configuration.
|
|
72021
74497
|
* @throws {RequiredError}
|
|
72022
74498
|
*/
|
|
72023
|
-
export declare function MetricsApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
74499
|
+
export declare function MetricsApiAxiosParamCreator_UpdateEntityMetrics(workspaceId: string, objectId: string, jsonApiMetricInDocument: JsonApiMetricInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
72024
74500
|
/**
|
|
72025
74501
|
*
|
|
72026
74502
|
* @summary Post Metrics
|
|
@@ -72188,10 +74664,10 @@ export interface MetricsApiCreateEntityMetricsRequest {
|
|
|
72188
74664
|
readonly jsonApiMetricPostOptionalIdDocument: JsonApiMetricPostOptionalIdDocument;
|
|
72189
74665
|
/**
|
|
72190
74666
|
* 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.
|
|
72191
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74667
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
72192
74668
|
* @memberof MetricsApiCreateEntityMetrics
|
|
72193
74669
|
*/
|
|
72194
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74670
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
72195
74671
|
/**
|
|
72196
74672
|
* Include Meta objects.
|
|
72197
74673
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -72244,10 +74720,10 @@ export interface MetricsApiGetAllEntitiesMetricsRequest {
|
|
|
72244
74720
|
readonly filter?: string;
|
|
72245
74721
|
/**
|
|
72246
74722
|
* 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.
|
|
72247
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74723
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
72248
74724
|
* @memberof MetricsApiGetAllEntitiesMetrics
|
|
72249
74725
|
*/
|
|
72250
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74726
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
72251
74727
|
/**
|
|
72252
74728
|
* Zero-based page index (0..N)
|
|
72253
74729
|
* @type {number}
|
|
@@ -72305,10 +74781,10 @@ export interface MetricsApiGetEntityMetricsRequest {
|
|
|
72305
74781
|
readonly filter?: string;
|
|
72306
74782
|
/**
|
|
72307
74783
|
* 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.
|
|
72308
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74784
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
72309
74785
|
* @memberof MetricsApiGetEntityMetrics
|
|
72310
74786
|
*/
|
|
72311
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74787
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
72312
74788
|
/**
|
|
72313
74789
|
*
|
|
72314
74790
|
* @type {boolean}
|
|
@@ -72354,10 +74830,10 @@ export interface MetricsApiPatchEntityMetricsRequest {
|
|
|
72354
74830
|
readonly filter?: string;
|
|
72355
74831
|
/**
|
|
72356
74832
|
* 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.
|
|
72357
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74833
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
72358
74834
|
* @memberof MetricsApiPatchEntityMetrics
|
|
72359
74835
|
*/
|
|
72360
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74836
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
72361
74837
|
}
|
|
72362
74838
|
/**
|
|
72363
74839
|
* Request parameters for searchEntitiesMetrics operation in MetricsApi.
|
|
@@ -72422,10 +74898,10 @@ export interface MetricsApiUpdateEntityMetricsRequest {
|
|
|
72422
74898
|
readonly filter?: string;
|
|
72423
74899
|
/**
|
|
72424
74900
|
* 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.
|
|
72425
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
74901
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
72426
74902
|
* @memberof MetricsApiUpdateEntityMetrics
|
|
72427
74903
|
*/
|
|
72428
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
74904
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
72429
74905
|
}
|
|
72430
74906
|
/**
|
|
72431
74907
|
* MetricsApi - object-oriented interface
|
|
@@ -80603,13 +83079,13 @@ export declare class UserControllerApi extends BaseAPI implements UserController
|
|
|
80603
83079
|
* @summary Post User Data Filters
|
|
80604
83080
|
* @param {string} workspaceId
|
|
80605
83081
|
* @param {JsonApiUserDataFilterPostOptionalIdDocument} jsonApiUserDataFilterPostOptionalIdDocument
|
|
80606
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
83082
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
80607
83083
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
80608
83084
|
* @param {*} [options] Override http request option.
|
|
80609
83085
|
* @param {Configuration} [configuration] Optional configuration.
|
|
80610
83086
|
* @throws {RequiredError}
|
|
80611
83087
|
*/
|
|
80612
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
83088
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_CreateEntityUserDataFilters(workspaceId: string, jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
80613
83089
|
/**
|
|
80614
83090
|
*
|
|
80615
83091
|
* @summary Delete a User Data Filter
|
|
@@ -80626,7 +83102,7 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_DeleteEntit
|
|
|
80626
83102
|
* @param {string} workspaceId
|
|
80627
83103
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
80628
83104
|
* @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\').
|
|
80629
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
83105
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
80630
83106
|
* @param {number} [page] Zero-based page index (0..N)
|
|
80631
83107
|
* @param {number} [size] The size of the page to be returned
|
|
80632
83108
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -80636,21 +83112,21 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_DeleteEntit
|
|
|
80636
83112
|
* @param {Configuration} [configuration] Optional configuration.
|
|
80637
83113
|
* @throws {RequiredError}
|
|
80638
83114
|
*/
|
|
80639
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
83115
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_GetAllEntitiesUserDataFilters(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
80640
83116
|
/**
|
|
80641
83117
|
*
|
|
80642
83118
|
* @summary Get a User Data Filter
|
|
80643
83119
|
* @param {string} workspaceId
|
|
80644
83120
|
* @param {string} objectId
|
|
80645
83121
|
* @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\').
|
|
80646
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
83122
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
80647
83123
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
80648
83124
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
80649
83125
|
* @param {*} [options] Override http request option.
|
|
80650
83126
|
* @param {Configuration} [configuration] Optional configuration.
|
|
80651
83127
|
* @throws {RequiredError}
|
|
80652
83128
|
*/
|
|
80653
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
83129
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_GetEntityUserDataFilters(workspaceId: string, objectId: string, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
80654
83130
|
/**
|
|
80655
83131
|
*
|
|
80656
83132
|
* @summary Patch a User Data Filter
|
|
@@ -80658,12 +83134,12 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_GetEntityUs
|
|
|
80658
83134
|
* @param {string} objectId
|
|
80659
83135
|
* @param {JsonApiUserDataFilterPatchDocument} jsonApiUserDataFilterPatchDocument
|
|
80660
83136
|
* @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\').
|
|
80661
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
83137
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
80662
83138
|
* @param {*} [options] Override http request option.
|
|
80663
83139
|
* @param {Configuration} [configuration] Optional configuration.
|
|
80664
83140
|
* @throws {RequiredError}
|
|
80665
83141
|
*/
|
|
80666
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
83142
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_PatchEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterPatchDocument: JsonApiUserDataFilterPatchDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
80667
83143
|
/**
|
|
80668
83144
|
*
|
|
80669
83145
|
* @summary The search endpoint (beta)
|
|
@@ -80683,12 +83159,12 @@ export declare function UserDataFilterControllerApiAxiosParamCreator_SearchEntit
|
|
|
80683
83159
|
* @param {string} objectId
|
|
80684
83160
|
* @param {JsonApiUserDataFilterInDocument} jsonApiUserDataFilterInDocument
|
|
80685
83161
|
* @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\').
|
|
80686
|
-
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
83162
|
+
* @param {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | '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.
|
|
80687
83163
|
* @param {*} [options] Override http request option.
|
|
80688
83164
|
* @param {Configuration} [configuration] Optional configuration.
|
|
80689
83165
|
* @throws {RequiredError}
|
|
80690
83166
|
*/
|
|
80691
|
-
export declare function UserDataFilterControllerApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
83167
|
+
export declare function UserDataFilterControllerApiAxiosParamCreator_UpdateEntityUserDataFilters(workspaceId: string, objectId: string, jsonApiUserDataFilterInDocument: JsonApiUserDataFilterInDocument, filter?: string, include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
80692
83168
|
/**
|
|
80693
83169
|
*
|
|
80694
83170
|
* @summary Post User Data Filters
|
|
@@ -80856,10 +83332,10 @@ export interface UserDataFilterControllerApiCreateEntityUserDataFiltersRequest {
|
|
|
80856
83332
|
readonly jsonApiUserDataFilterPostOptionalIdDocument: JsonApiUserDataFilterPostOptionalIdDocument;
|
|
80857
83333
|
/**
|
|
80858
83334
|
* 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.
|
|
80859
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
83335
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
80860
83336
|
* @memberof UserDataFilterControllerApiCreateEntityUserDataFilters
|
|
80861
83337
|
*/
|
|
80862
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
83338
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
80863
83339
|
/**
|
|
80864
83340
|
* Include Meta objects.
|
|
80865
83341
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -80912,10 +83388,10 @@ export interface UserDataFilterControllerApiGetAllEntitiesUserDataFiltersRequest
|
|
|
80912
83388
|
readonly filter?: string;
|
|
80913
83389
|
/**
|
|
80914
83390
|
* 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.
|
|
80915
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
83391
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
80916
83392
|
* @memberof UserDataFilterControllerApiGetAllEntitiesUserDataFilters
|
|
80917
83393
|
*/
|
|
80918
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
83394
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
80919
83395
|
/**
|
|
80920
83396
|
* Zero-based page index (0..N)
|
|
80921
83397
|
* @type {number}
|
|
@@ -80973,10 +83449,10 @@ export interface UserDataFilterControllerApiGetEntityUserDataFiltersRequest {
|
|
|
80973
83449
|
readonly filter?: string;
|
|
80974
83450
|
/**
|
|
80975
83451
|
* 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.
|
|
80976
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
83452
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
80977
83453
|
* @memberof UserDataFilterControllerApiGetEntityUserDataFilters
|
|
80978
83454
|
*/
|
|
80979
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
83455
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
80980
83456
|
/**
|
|
80981
83457
|
*
|
|
80982
83458
|
* @type {boolean}
|
|
@@ -81022,10 +83498,10 @@ export interface UserDataFilterControllerApiPatchEntityUserDataFiltersRequest {
|
|
|
81022
83498
|
readonly filter?: string;
|
|
81023
83499
|
/**
|
|
81024
83500
|
* 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.
|
|
81025
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
83501
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
81026
83502
|
* @memberof UserDataFilterControllerApiPatchEntityUserDataFilters
|
|
81027
83503
|
*/
|
|
81028
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
83504
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
81029
83505
|
}
|
|
81030
83506
|
/**
|
|
81031
83507
|
* Request parameters for searchEntitiesUserDataFilters operation in UserDataFilterControllerApi.
|
|
@@ -81090,10 +83566,10 @@ export interface UserDataFilterControllerApiUpdateEntityUserDataFiltersRequest {
|
|
|
81090
83566
|
readonly filter?: string;
|
|
81091
83567
|
/**
|
|
81092
83568
|
* 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.
|
|
81093
|
-
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
83569
|
+
* @type {Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>}
|
|
81094
83570
|
* @memberof UserDataFilterControllerApiUpdateEntityUserDataFilters
|
|
81095
83571
|
*/
|
|
81096
|
-
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
83572
|
+
readonly include?: Array<'users' | 'userGroups' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'user' | 'userGroup' | 'ALL'>;
|
|
81097
83573
|
}
|
|
81098
83574
|
/**
|
|
81099
83575
|
* UserDataFilterControllerApi - object-oriented interface
|