@gooddata/api-client-tiger 11.55.0-alpha.0 → 11.55.0-alpha.1
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 +549 -119
- package/esm/endpoints/entitiesObjects/index.d.ts +1 -1
- package/esm/endpoints/entitiesObjects/index.d.ts.map +1 -1
- package/esm/endpoints/entitiesObjects/index.js +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +1 -1
- package/esm/generated/ai-json-api/api.d.ts +20 -9
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +173 -0
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +192 -5
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +12 -4
- package/esm/generated/metadata-json-api/api.d.ts +112 -103
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +24 -24
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.js +1 -1
- package/esm/index.d.ts +2 -2
- package/esm/index.d.ts.map +1 -1
- package/package.json +7 -7
|
@@ -5011,11 +5011,12 @@ export declare function ActionsExportAxiosParamCreator_CreateDashboardExportRequ
|
|
|
5011
5011
|
* @summary (EXPERIMENTAL) Create image export request
|
|
5012
5012
|
* @param {string} workspaceId
|
|
5013
5013
|
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
5014
|
+
* @param {boolean} [xGdcDebug]
|
|
5014
5015
|
* @param {*} [options] Override http request option.
|
|
5015
5016
|
* @param {Configuration} [configuration] Optional configuration.
|
|
5016
5017
|
* @throws {RequiredError}
|
|
5017
5018
|
*/
|
|
5018
|
-
export declare function ActionsExportAxiosParamCreator_CreateImageExport(workspaceId: string, exportImageExportRequest: ExportImageExportRequest, options?: AxiosRequestConfig, configuration?: ExportConfiguration): Promise<ExportRequestArgs>;
|
|
5019
|
+
export declare function ActionsExportAxiosParamCreator_CreateImageExport(workspaceId: string, exportImageExportRequest: ExportImageExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: ExportConfiguration): Promise<ExportRequestArgs>;
|
|
5019
5020
|
|
|
5020
5021
|
/**
|
|
5021
5022
|
* An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
@@ -5195,6 +5196,12 @@ export declare interface ActionsExportCreateImageExportRequest {
|
|
|
5195
5196
|
* @memberof ActionsExportCreateImageExport
|
|
5196
5197
|
*/
|
|
5197
5198
|
readonly exportImageExportRequest: ExportImageExportRequest;
|
|
5199
|
+
/**
|
|
5200
|
+
*
|
|
5201
|
+
* @type {boolean}
|
|
5202
|
+
* @memberof ActionsExportCreateImageExport
|
|
5203
|
+
*/
|
|
5204
|
+
readonly xGdcDebug?: boolean;
|
|
5198
5205
|
}
|
|
5199
5206
|
|
|
5200
5207
|
/**
|
|
@@ -10353,7 +10360,7 @@ export declare interface AiConversationItemResponse {
|
|
|
10353
10360
|
'createdAt': string;
|
|
10354
10361
|
'detail'?: AiConversationItemResponseDetail | null;
|
|
10355
10362
|
/**
|
|
10356
|
-
* True for items streamed only as live progress and never persisted. Today that is each agent iteration\'s reasoning, which is
|
|
10363
|
+
* True for items streamed only as live progress and never persisted. Today that is each agent iteration\'s reasoning, which is folded at the end of the turn into a single merged reasoning item — the one that is persisted. Both carry the same text, so only one of them is ever delivered: the message stream carries the interim items as the turn runs, and replaying the conversation returns the merged item instead.
|
|
10357
10364
|
*/
|
|
10358
10365
|
'interim'?: boolean;
|
|
10359
10366
|
/**
|
|
@@ -10639,15 +10646,7 @@ export declare interface AiDashboardPatch {
|
|
|
10639
10646
|
* RFC 6902 JSON Patch operations against the relayed AAC dashboard document. A `test` operation guards each insert: if one fails, the dashboard moved and the change must be discarded rather than forced.
|
|
10640
10647
|
*/
|
|
10641
10648
|
'operations': Array<object | null>;
|
|
10642
|
-
/**
|
|
10643
|
-
* Identity of the proposal. A refinement re-proposes under the same ref, so when two items carry the same ref only the newest is a live proposal and the older one is superseded. Also the key to make applying the change idempotent.
|
|
10644
|
-
*/
|
|
10645
|
-
'ref': string;
|
|
10646
10649
|
'references'?: AiDashboardPatchReferences;
|
|
10647
|
-
/**
|
|
10648
|
-
* Id of the tab the operations target.
|
|
10649
|
-
*/
|
|
10650
|
-
'tab_id': string;
|
|
10651
10650
|
}
|
|
10652
10651
|
|
|
10653
10652
|
export declare interface AiDashboardPatchPart {
|
|
@@ -14110,6 +14109,12 @@ export declare interface AiUserContextRichTextWidgetDescriptor {
|
|
|
14110
14109
|
|
|
14111
14110
|
export declare type AiUserContextRichTextWidgetDescriptorWidgetTypeEnum = 'richText';
|
|
14112
14111
|
|
|
14112
|
+
export declare interface AiUserContextSwitcherVisualization {
|
|
14113
|
+
'resultId'?: string | null;
|
|
14114
|
+
'title'?: string | null;
|
|
14115
|
+
'visualizationId': string;
|
|
14116
|
+
}
|
|
14117
|
+
|
|
14113
14118
|
export declare interface AiUserContextView {
|
|
14114
14119
|
'dashboard'?: AiUserContextDashboard | null;
|
|
14115
14120
|
}
|
|
@@ -14119,7 +14124,14 @@ export declare interface AiUserContextVisualizationSwitcherWidgetDescriptor {
|
|
|
14119
14124
|
'filters'?: Array<AiVisualizationFilter> | null;
|
|
14120
14125
|
'resultId'?: string | null;
|
|
14121
14126
|
'title': string;
|
|
14127
|
+
/**
|
|
14128
|
+
* Deprecated: send `visualizations` instead, which additionally carries each visualization\'s title. Read only when `visualizations` is empty.
|
|
14129
|
+
*/
|
|
14122
14130
|
'visualizationIds'?: Array<string>;
|
|
14131
|
+
/**
|
|
14132
|
+
* The visualizations the switcher offers, including the active one. Supersedes `visualizationIds`: titles let the assistant name a switcher\'s visualizations instead of quoting bare ids.
|
|
14133
|
+
*/
|
|
14134
|
+
'visualizations'?: Array<AiUserContextSwitcherVisualization>;
|
|
14123
14135
|
'widgetId': string;
|
|
14124
14136
|
'widgetType': AiUserContextVisualizationSwitcherWidgetDescriptorWidgetTypeEnum;
|
|
14125
14137
|
}
|
|
@@ -14135,7 +14147,14 @@ export declare interface AiUserContextWidgetDescriptor {
|
|
|
14135
14147
|
'widgetType': AiUserContextWidgetDescriptorWidgetTypeEnum;
|
|
14136
14148
|
'content'?: string;
|
|
14137
14149
|
'activeVisualizationId': string;
|
|
14150
|
+
/**
|
|
14151
|
+
* Deprecated: send `visualizations` instead, which additionally carries each visualization\'s title. Read only when `visualizations` is empty.
|
|
14152
|
+
*/
|
|
14138
14153
|
'visualizationIds'?: Array<string>;
|
|
14154
|
+
/**
|
|
14155
|
+
* The visualizations the switcher offers, including the active one. Supersedes `visualizationIds`: titles let the assistant name a switcher\'s visualizations instead of quoting bare ids.
|
|
14156
|
+
*/
|
|
14157
|
+
'visualizations'?: Array<AiUserContextSwitcherVisualization>;
|
|
14139
14158
|
}
|
|
14140
14159
|
|
|
14141
14160
|
export declare type AiUserContextWidgetDescriptorWidgetTypeEnum = 'visualizationSwitcher';
|
|
@@ -21044,6 +21063,202 @@ export declare interface AutomationCompoundMeasureValueFilterCompoundMeasureValu
|
|
|
21044
21063
|
'treatNullValuesAs'?: number;
|
|
21045
21064
|
}
|
|
21046
21065
|
|
|
21066
|
+
/**
|
|
21067
|
+
* Conditional formatting for a table, with one entry per formatted column.
|
|
21068
|
+
*/
|
|
21069
|
+
export declare interface AutomationConditionalFormatting {
|
|
21070
|
+
/**
|
|
21071
|
+
* Whether the rules are applied when rendering.
|
|
21072
|
+
*/
|
|
21073
|
+
'enabled': boolean;
|
|
21074
|
+
/**
|
|
21075
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
21076
|
+
*/
|
|
21077
|
+
'rules': Array<AutomationConditionalFormattingRule>;
|
|
21078
|
+
}
|
|
21079
|
+
|
|
21080
|
+
/**
|
|
21081
|
+
* A fixed, inclusive date period.
|
|
21082
|
+
*/
|
|
21083
|
+
export declare interface AutomationConditionalFormattingAbsoluteDateValue {
|
|
21084
|
+
/**
|
|
21085
|
+
* `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.
|
|
21086
|
+
*/
|
|
21087
|
+
'from': string;
|
|
21088
|
+
/**
|
|
21089
|
+
* The value kind.
|
|
21090
|
+
*/
|
|
21091
|
+
'kind': AutomationConditionalFormattingAbsoluteDateValueKindEnum;
|
|
21092
|
+
/**
|
|
21093
|
+
* `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.
|
|
21094
|
+
*/
|
|
21095
|
+
'to': string;
|
|
21096
|
+
}
|
|
21097
|
+
|
|
21098
|
+
export declare type AutomationConditionalFormattingAbsoluteDateValueKindEnum = 'absoluteDate';
|
|
21099
|
+
|
|
21100
|
+
/**
|
|
21101
|
+
* An attribute column, addressed by its bucket item local identifier.
|
|
21102
|
+
*/
|
|
21103
|
+
export declare interface AutomationConditionalFormattingAttributeTarget {
|
|
21104
|
+
'attributeIdentifier': string;
|
|
21105
|
+
/**
|
|
21106
|
+
* The target kind.
|
|
21107
|
+
*/
|
|
21108
|
+
'kind': AutomationConditionalFormattingAttributeTargetKindEnum;
|
|
21109
|
+
}
|
|
21110
|
+
|
|
21111
|
+
export declare type AutomationConditionalFormattingAttributeTargetKindEnum = 'attribute';
|
|
21112
|
+
|
|
21113
|
+
/**
|
|
21114
|
+
* A condition and the formatting applied to cells matching it.
|
|
21115
|
+
*/
|
|
21116
|
+
export declare interface AutomationConditionalFormattingCondition {
|
|
21117
|
+
'format': AutomationConditionalFormattingFormat;
|
|
21118
|
+
/**
|
|
21119
|
+
* Client-assigned identifier, stable across edits.
|
|
21120
|
+
*/
|
|
21121
|
+
'id'?: string;
|
|
21122
|
+
/**
|
|
21123
|
+
* How a condition compares the cell value against its value.
|
|
21124
|
+
*/
|
|
21125
|
+
'operator': AutomationConditionalFormattingConditionOperatorEnum;
|
|
21126
|
+
'value': AutomationConditionalFormattingValue;
|
|
21127
|
+
}
|
|
21128
|
+
|
|
21129
|
+
export declare type AutomationConditionalFormattingConditionOperatorEnum = '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';
|
|
21130
|
+
|
|
21131
|
+
/**
|
|
21132
|
+
* Visual formatting applied to a matching cell.
|
|
21133
|
+
*/
|
|
21134
|
+
export declare interface AutomationConditionalFormattingFormat {
|
|
21135
|
+
/**
|
|
21136
|
+
* Background color as a hex triplet.
|
|
21137
|
+
*/
|
|
21138
|
+
'backgroundColor'?: string;
|
|
21139
|
+
/**
|
|
21140
|
+
* Text color as a hex triplet.
|
|
21141
|
+
*/
|
|
21142
|
+
'color'?: string;
|
|
21143
|
+
/**
|
|
21144
|
+
* Whether the formatting applies to the matching cell only, or to its whole row.
|
|
21145
|
+
*/
|
|
21146
|
+
'scope': AutomationConditionalFormattingFormatScopeEnum;
|
|
21147
|
+
}
|
|
21148
|
+
|
|
21149
|
+
export declare type AutomationConditionalFormattingFormatScopeEnum = 'cell' | 'row';
|
|
21150
|
+
|
|
21151
|
+
/**
|
|
21152
|
+
* @type AutomationConditionalFormattingLiteral
|
|
21153
|
+
* A string or a number, serialized in whichever form it was authored.
|
|
21154
|
+
*/
|
|
21155
|
+
export declare type AutomationConditionalFormattingLiteral = number | string;
|
|
21156
|
+
|
|
21157
|
+
/**
|
|
21158
|
+
* An inclusive numeric range.
|
|
21159
|
+
*/
|
|
21160
|
+
export declare interface AutomationConditionalFormattingLiteralRangeValue {
|
|
21161
|
+
'from': number;
|
|
21162
|
+
/**
|
|
21163
|
+
* The value kind.
|
|
21164
|
+
*/
|
|
21165
|
+
'kind': AutomationConditionalFormattingLiteralRangeValueKindEnum;
|
|
21166
|
+
'to': number;
|
|
21167
|
+
}
|
|
21168
|
+
|
|
21169
|
+
export declare type AutomationConditionalFormattingLiteralRangeValueKindEnum = 'literalRange';
|
|
21170
|
+
|
|
21171
|
+
/**
|
|
21172
|
+
* A single value compared against the cell value.
|
|
21173
|
+
*/
|
|
21174
|
+
export declare interface AutomationConditionalFormattingLiteralValue {
|
|
21175
|
+
/**
|
|
21176
|
+
* The value kind.
|
|
21177
|
+
*/
|
|
21178
|
+
'kind': AutomationConditionalFormattingLiteralValueKindEnum;
|
|
21179
|
+
'value': AutomationConditionalFormattingLiteral;
|
|
21180
|
+
}
|
|
21181
|
+
|
|
21182
|
+
export declare type AutomationConditionalFormattingLiteralValueKindEnum = 'literal';
|
|
21183
|
+
|
|
21184
|
+
/**
|
|
21185
|
+
* A measure column, addressed by its bucket item local identifier.
|
|
21186
|
+
*/
|
|
21187
|
+
export declare interface AutomationConditionalFormattingMeasureTarget {
|
|
21188
|
+
/**
|
|
21189
|
+
* The target kind.
|
|
21190
|
+
*/
|
|
21191
|
+
'kind': AutomationConditionalFormattingMeasureTargetKindEnum;
|
|
21192
|
+
'measureIdentifier': string;
|
|
21193
|
+
}
|
|
21194
|
+
|
|
21195
|
+
export declare type AutomationConditionalFormattingMeasureTargetKindEnum = 'measure';
|
|
21196
|
+
|
|
21197
|
+
/**
|
|
21198
|
+
* No value; used by operators that take none.
|
|
21199
|
+
*/
|
|
21200
|
+
export declare interface AutomationConditionalFormattingNoneValue {
|
|
21201
|
+
/**
|
|
21202
|
+
* The value kind.
|
|
21203
|
+
*/
|
|
21204
|
+
'kind': AutomationConditionalFormattingNoneValueKindEnum;
|
|
21205
|
+
}
|
|
21206
|
+
|
|
21207
|
+
export declare type AutomationConditionalFormattingNoneValueKindEnum = 'none';
|
|
21208
|
+
|
|
21209
|
+
/**
|
|
21210
|
+
* A date period relative to the moment of evaluation, resolved at render time.
|
|
21211
|
+
*/
|
|
21212
|
+
export declare interface AutomationConditionalFormattingRelativeDateValue {
|
|
21213
|
+
/**
|
|
21214
|
+
* Offset in periods; 0 is the current period, negative is the past.
|
|
21215
|
+
*/
|
|
21216
|
+
'from': number;
|
|
21217
|
+
/**
|
|
21218
|
+
* Granularity the offsets are counted in.
|
|
21219
|
+
*/
|
|
21220
|
+
'granularity': AutomationConditionalFormattingRelativeDateValueGranularityEnum;
|
|
21221
|
+
/**
|
|
21222
|
+
* The value kind.
|
|
21223
|
+
*/
|
|
21224
|
+
'kind': AutomationConditionalFormattingRelativeDateValueKindEnum;
|
|
21225
|
+
/**
|
|
21226
|
+
* Offset in periods, not lower than `from`.
|
|
21227
|
+
*/
|
|
21228
|
+
'to': number;
|
|
21229
|
+
}
|
|
21230
|
+
|
|
21231
|
+
export declare type AutomationConditionalFormattingRelativeDateValueGranularityEnum = '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';
|
|
21232
|
+
|
|
21233
|
+
export declare type AutomationConditionalFormattingRelativeDateValueKindEnum = 'relativeDate';
|
|
21234
|
+
|
|
21235
|
+
/**
|
|
21236
|
+
* Conditions applied to a single column.
|
|
21237
|
+
*/
|
|
21238
|
+
export declare interface AutomationConditionalFormattingRule {
|
|
21239
|
+
/**
|
|
21240
|
+
* Conditions evaluated in order; the first match wins.
|
|
21241
|
+
*/
|
|
21242
|
+
'conditions': Array<AutomationConditionalFormattingCondition>;
|
|
21243
|
+
/**
|
|
21244
|
+
* Client-assigned identifier, stable across edits.
|
|
21245
|
+
*/
|
|
21246
|
+
'id'?: string;
|
|
21247
|
+
'target': AutomationConditionalFormattingTarget;
|
|
21248
|
+
}
|
|
21249
|
+
|
|
21250
|
+
/**
|
|
21251
|
+
* @type AutomationConditionalFormattingTarget
|
|
21252
|
+
* Column a rule formats. The shape is selected by the `kind` property.
|
|
21253
|
+
*/
|
|
21254
|
+
export declare type AutomationConditionalFormattingTarget = AutomationConditionalFormattingAttributeTarget | AutomationConditionalFormattingMeasureTarget;
|
|
21255
|
+
|
|
21256
|
+
/**
|
|
21257
|
+
* @type AutomationConditionalFormattingValue
|
|
21258
|
+
* Value a condition compares against. The shape is selected by the `kind` property.
|
|
21259
|
+
*/
|
|
21260
|
+
export declare type AutomationConditionalFormattingValue = AutomationConditionalFormattingAbsoluteDateValue | AutomationConditionalFormattingLiteralRangeValue | AutomationConditionalFormattingLiteralValue | AutomationConditionalFormattingNoneValue | AutomationConditionalFormattingRelativeDateValue;
|
|
21261
|
+
|
|
21047
21262
|
export declare class AutomationConfiguration {
|
|
21048
21263
|
/**
|
|
21049
21264
|
* parameter for apiKey security
|
|
@@ -24685,6 +24900,7 @@ export declare interface AutomationTabularExportExecution {
|
|
|
24685
24900
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
24686
24901
|
*/
|
|
24687
24902
|
export declare interface AutomationTabularExportRequest {
|
|
24903
|
+
'conditionalFormatting'?: AutomationConditionalFormatting | null;
|
|
24688
24904
|
'customOverride'?: AutomationCustomOverride;
|
|
24689
24905
|
/**
|
|
24690
24906
|
* Execution result identifier.
|
|
@@ -26256,7 +26472,7 @@ export declare interface ConditionalFormattingRelativeDateValue {
|
|
|
26256
26472
|
'to': number;
|
|
26257
26473
|
}
|
|
26258
26474
|
|
|
26259
|
-
export declare type ConditionalFormattingRelativeDateValueGranularityEnum = '
|
|
26475
|
+
export declare type ConditionalFormattingRelativeDateValueGranularityEnum = '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';
|
|
26260
26476
|
|
|
26261
26477
|
export declare type ConditionalFormattingRelativeDateValueKindEnum = 'relativeDate';
|
|
26262
26478
|
|
|
@@ -44460,12 +44676,12 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityMemoryItems(wor
|
|
|
44460
44676
|
* @param {string} workspaceId
|
|
44461
44677
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
44462
44678
|
* @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.
|
|
44463
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
44679
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
44464
44680
|
* @param {*} [options] Override http request option.
|
|
44465
44681
|
* @param {Configuration} [configuration] Optional configuration.
|
|
44466
44682
|
* @throws {RequiredError}
|
|
44467
44683
|
*/
|
|
44468
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
44684
|
+
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<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
44469
44685
|
|
|
44470
44686
|
/**
|
|
44471
44687
|
*
|
|
@@ -44561,13 +44777,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityUserSettings(us
|
|
|
44561
44777
|
* @summary Post Visualization Objects
|
|
44562
44778
|
* @param {string} workspaceId
|
|
44563
44779
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
44564
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
44780
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
44565
44781
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
44566
44782
|
* @param {*} [options] Override http request option.
|
|
44567
44783
|
* @param {Configuration} [configuration] Optional configuration.
|
|
44568
44784
|
* @throws {RequiredError}
|
|
44569
44785
|
*/
|
|
44570
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
44786
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
44571
44787
|
|
|
44572
44788
|
/**
|
|
44573
44789
|
*
|
|
@@ -45489,12 +45705,12 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesMemoryItems(w
|
|
|
45489
45705
|
* @param {number} [size] The size of the page to be returned
|
|
45490
45706
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
45491
45707
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
45492
|
-
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
45708
|
+
* @param {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
45493
45709
|
* @param {*} [options] Override http request option.
|
|
45494
45710
|
* @param {Configuration} [configuration] Optional configuration.
|
|
45495
45711
|
* @throws {RequiredError}
|
|
45496
45712
|
*/
|
|
45497
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45713
|
+
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<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45498
45714
|
|
|
45499
45715
|
/**
|
|
45500
45716
|
*
|
|
@@ -45653,7 +45869,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserSettings(
|
|
|
45653
45869
|
* @param {string} workspaceId
|
|
45654
45870
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
45655
45871
|
* @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\').
|
|
45656
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
45872
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
45657
45873
|
* @param {number} [page] Zero-based page index (0..N)
|
|
45658
45874
|
* @param {number} [size] The size of the page to be returned
|
|
45659
45875
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -45663,7 +45879,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserSettings(
|
|
|
45663
45879
|
* @param {Configuration} [configuration] Optional configuration.
|
|
45664
45880
|
* @throws {RequiredError}
|
|
45665
45881
|
*/
|
|
45666
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45882
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
45667
45883
|
|
|
45668
45884
|
/**
|
|
45669
45885
|
*
|
|
@@ -46163,12 +46379,12 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityMemoryItems(worksp
|
|
|
46163
46379
|
* @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\').
|
|
46164
46380
|
* @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.
|
|
46165
46381
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46166
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46382
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46167
46383
|
* @param {*} [options] Override http request option.
|
|
46168
46384
|
* @param {Configuration} [configuration] Optional configuration.
|
|
46169
46385
|
* @throws {RequiredError}
|
|
46170
46386
|
*/
|
|
46171
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46387
|
+
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<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46172
46388
|
|
|
46173
46389
|
/**
|
|
46174
46390
|
*
|
|
@@ -46310,14 +46526,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityUserSettings(userI
|
|
|
46310
46526
|
* @param {string} workspaceId
|
|
46311
46527
|
* @param {string} objectId
|
|
46312
46528
|
* @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\').
|
|
46313
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
46529
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
46314
46530
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
46315
46531
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
46316
46532
|
* @param {*} [options] Override http request option.
|
|
46317
46533
|
* @param {Configuration} [configuration] Optional configuration.
|
|
46318
46534
|
* @throws {RequiredError}
|
|
46319
46535
|
*/
|
|
46320
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46536
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46321
46537
|
|
|
46322
46538
|
/**
|
|
46323
46539
|
*
|
|
@@ -46854,12 +47070,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityUsers(id: string
|
|
|
46854
47070
|
* @param {string} objectId
|
|
46855
47071
|
* @param {JsonApiVisualizationObjectPatchDocument} jsonApiVisualizationObjectPatchDocument
|
|
46856
47072
|
* @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\').
|
|
46857
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
47073
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
46858
47074
|
* @param {*} [options] Override http request option.
|
|
46859
47075
|
* @param {Configuration} [configuration] Optional configuration.
|
|
46860
47076
|
* @throws {RequiredError}
|
|
46861
47077
|
*/
|
|
46862
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
47078
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
46863
47079
|
|
|
46864
47080
|
/**
|
|
46865
47081
|
*
|
|
@@ -47637,12 +47853,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityUserSettings(us
|
|
|
47637
47853
|
* @param {string} objectId
|
|
47638
47854
|
* @param {JsonApiVisualizationObjectInDocument} jsonApiVisualizationObjectInDocument
|
|
47639
47855
|
* @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\').
|
|
47640
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
47856
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
47641
47857
|
* @param {*} [options] Override http request option.
|
|
47642
47858
|
* @param {Configuration} [configuration] Optional configuration.
|
|
47643
47859
|
* @throws {RequiredError}
|
|
47644
47860
|
*/
|
|
47645
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
47861
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
47646
47862
|
|
|
47647
47863
|
/**
|
|
47648
47864
|
*
|
|
@@ -48288,10 +48504,10 @@ export declare interface EntitiesApiCreateEntityMetricsRequest {
|
|
|
48288
48504
|
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48289
48505
|
/**
|
|
48290
48506
|
* Include Meta objects.
|
|
48291
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
48507
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
48292
48508
|
* @memberof EntitiesApiCreateEntityMetrics
|
|
48293
48509
|
*/
|
|
48294
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
48510
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
48295
48511
|
}
|
|
48296
48512
|
|
|
48297
48513
|
/**
|
|
@@ -48500,10 +48716,10 @@ export declare interface EntitiesApiCreateEntityVisualizationObjectsRequest {
|
|
|
48500
48716
|
readonly jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument;
|
|
48501
48717
|
/**
|
|
48502
48718
|
* 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.
|
|
48503
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
48719
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
48504
48720
|
* @memberof EntitiesApiCreateEntityVisualizationObjects
|
|
48505
48721
|
*/
|
|
48506
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48722
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48507
48723
|
/**
|
|
48508
48724
|
* Include Meta objects.
|
|
48509
48725
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -51136,10 +51352,10 @@ export declare interface EntitiesApiGetAllEntitiesMetricsRequest {
|
|
|
51136
51352
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
51137
51353
|
/**
|
|
51138
51354
|
* Include Meta objects.
|
|
51139
|
-
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
51355
|
+
* @type {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>}
|
|
51140
51356
|
* @memberof EntitiesApiGetAllEntitiesMetrics
|
|
51141
51357
|
*/
|
|
51142
|
-
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
51358
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>;
|
|
51143
51359
|
}
|
|
51144
51360
|
|
|
51145
51361
|
/**
|
|
@@ -51658,10 +51874,10 @@ export declare interface EntitiesApiGetAllEntitiesVisualizationObjectsRequest {
|
|
|
51658
51874
|
readonly filter?: string;
|
|
51659
51875
|
/**
|
|
51660
51876
|
* 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.
|
|
51661
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51877
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51662
51878
|
* @memberof EntitiesApiGetAllEntitiesVisualizationObjects
|
|
51663
51879
|
*/
|
|
51664
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51880
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51665
51881
|
/**
|
|
51666
51882
|
* Zero-based page index (0..N)
|
|
51667
51883
|
* @type {number}
|
|
@@ -53184,10 +53400,10 @@ export declare interface EntitiesApiGetEntityMetricsRequest {
|
|
|
53184
53400
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
53185
53401
|
/**
|
|
53186
53402
|
* Include Meta objects.
|
|
53187
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
53403
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
53188
53404
|
* @memberof EntitiesApiGetEntityMetrics
|
|
53189
53405
|
*/
|
|
53190
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
53406
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
53191
53407
|
}
|
|
53192
53408
|
|
|
53193
53409
|
/**
|
|
@@ -53554,10 +53770,10 @@ export declare interface EntitiesApiGetEntityVisualizationObjectsRequest {
|
|
|
53554
53770
|
readonly filter?: string;
|
|
53555
53771
|
/**
|
|
53556
53772
|
* 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.
|
|
53557
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
53773
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
53558
53774
|
* @memberof EntitiesApiGetEntityVisualizationObjects
|
|
53559
53775
|
*/
|
|
53560
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
53776
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
53561
53777
|
/**
|
|
53562
53778
|
*
|
|
53563
53779
|
* @type {boolean}
|
|
@@ -57811,10 +58027,10 @@ export declare interface EntitiesApiPatchEntityVisualizationObjectsRequest {
|
|
|
57811
58027
|
readonly filter?: string;
|
|
57812
58028
|
/**
|
|
57813
58029
|
* 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.
|
|
57814
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
58030
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
57815
58031
|
* @memberof EntitiesApiPatchEntityVisualizationObjects
|
|
57816
58032
|
*/
|
|
57817
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
58033
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
57818
58034
|
}
|
|
57819
58035
|
|
|
57820
58036
|
/**
|
|
@@ -59961,10 +60177,10 @@ export declare interface EntitiesApiUpdateEntityVisualizationObjectsRequest {
|
|
|
59961
60177
|
readonly filter?: string;
|
|
59962
60178
|
/**
|
|
59963
60179
|
* 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.
|
|
59964
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
60180
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
59965
60181
|
* @memberof EntitiesApiUpdateEntityVisualizationObjects
|
|
59966
60182
|
*/
|
|
59967
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
60183
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
59968
60184
|
}
|
|
59969
60185
|
|
|
59970
60186
|
/**
|
|
@@ -60969,7 +61185,7 @@ export declare interface ExportAfmObjectIdentifierCoreIdentifier {
|
|
|
60969
61185
|
'type': ExportAfmObjectIdentifierCoreIdentifierTypeEnum;
|
|
60970
61186
|
}
|
|
60971
61187
|
|
|
60972
|
-
export declare type ExportAfmObjectIdentifierCoreIdentifierTypeEnum = 'attribute' | 'label' | 'fact' | 'metric';
|
|
61188
|
+
export declare type ExportAfmObjectIdentifierCoreIdentifierTypeEnum = 'attribute' | 'label' | 'fact' | 'metric' | 'computedAttribute';
|
|
60973
61189
|
|
|
60974
61190
|
/**
|
|
60975
61191
|
* Reference to the date dataset to which the filter should be applied.
|
|
@@ -60990,7 +61206,7 @@ export declare interface ExportAfmObjectIdentifierIdentifier {
|
|
|
60990
61206
|
'type': ExportAfmObjectIdentifierIdentifierTypeEnum;
|
|
60991
61207
|
}
|
|
60992
61208
|
|
|
60993
|
-
export declare type ExportAfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
|
|
61209
|
+
export declare type ExportAfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'computedAttribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
|
|
60994
61210
|
|
|
60995
61211
|
export declare interface ExportAfmObjectIdentifierLabel {
|
|
60996
61212
|
'identifier': ExportAfmObjectIdentifierLabelIdentifier;
|
|
@@ -61001,7 +61217,7 @@ export declare interface ExportAfmObjectIdentifierLabelIdentifier {
|
|
|
61001
61217
|
'type': ExportAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
61002
61218
|
}
|
|
61003
61219
|
|
|
61004
|
-
export declare type ExportAfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
|
|
61220
|
+
export declare type ExportAfmObjectIdentifierLabelIdentifierTypeEnum = 'label' | 'computedAttribute';
|
|
61005
61221
|
|
|
61006
61222
|
/**
|
|
61007
61223
|
* Reference to the parameter.
|
|
@@ -61210,6 +61426,202 @@ export declare interface ExportCompoundMeasureValueFilterCompoundMeasureValueFil
|
|
|
61210
61426
|
'treatNullValuesAs'?: number;
|
|
61211
61427
|
}
|
|
61212
61428
|
|
|
61429
|
+
/**
|
|
61430
|
+
* Conditional formatting for a table, with one entry per formatted column.
|
|
61431
|
+
*/
|
|
61432
|
+
export declare interface ExportConditionalFormatting {
|
|
61433
|
+
/**
|
|
61434
|
+
* Whether the rules are applied when rendering.
|
|
61435
|
+
*/
|
|
61436
|
+
'enabled': boolean;
|
|
61437
|
+
/**
|
|
61438
|
+
* Rules evaluated in order; within a target, the first matching condition wins.
|
|
61439
|
+
*/
|
|
61440
|
+
'rules': Array<ExportConditionalFormattingRule>;
|
|
61441
|
+
}
|
|
61442
|
+
|
|
61443
|
+
/**
|
|
61444
|
+
* A fixed, inclusive date period.
|
|
61445
|
+
*/
|
|
61446
|
+
export declare interface ExportConditionalFormattingAbsoluteDateValue {
|
|
61447
|
+
/**
|
|
61448
|
+
* `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.
|
|
61449
|
+
*/
|
|
61450
|
+
'from': string;
|
|
61451
|
+
/**
|
|
61452
|
+
* The value kind.
|
|
61453
|
+
*/
|
|
61454
|
+
'kind': ExportConditionalFormattingAbsoluteDateValueKindEnum;
|
|
61455
|
+
/**
|
|
61456
|
+
* `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.
|
|
61457
|
+
*/
|
|
61458
|
+
'to': string;
|
|
61459
|
+
}
|
|
61460
|
+
|
|
61461
|
+
export declare type ExportConditionalFormattingAbsoluteDateValueKindEnum = 'absoluteDate';
|
|
61462
|
+
|
|
61463
|
+
/**
|
|
61464
|
+
* An attribute column, addressed by its bucket item local identifier.
|
|
61465
|
+
*/
|
|
61466
|
+
export declare interface ExportConditionalFormattingAttributeTarget {
|
|
61467
|
+
'attributeIdentifier': string;
|
|
61468
|
+
/**
|
|
61469
|
+
* The target kind.
|
|
61470
|
+
*/
|
|
61471
|
+
'kind': ExportConditionalFormattingAttributeTargetKindEnum;
|
|
61472
|
+
}
|
|
61473
|
+
|
|
61474
|
+
export declare type ExportConditionalFormattingAttributeTargetKindEnum = 'attribute';
|
|
61475
|
+
|
|
61476
|
+
/**
|
|
61477
|
+
* A condition and the formatting applied to cells matching it.
|
|
61478
|
+
*/
|
|
61479
|
+
export declare interface ExportConditionalFormattingCondition {
|
|
61480
|
+
'format': ExportConditionalFormattingFormat;
|
|
61481
|
+
/**
|
|
61482
|
+
* Client-assigned identifier, stable across edits.
|
|
61483
|
+
*/
|
|
61484
|
+
'id'?: string;
|
|
61485
|
+
/**
|
|
61486
|
+
* How a condition compares the cell value against its value.
|
|
61487
|
+
*/
|
|
61488
|
+
'operator': ExportConditionalFormattingConditionOperatorEnum;
|
|
61489
|
+
'value': ExportConditionalFormattingValue;
|
|
61490
|
+
}
|
|
61491
|
+
|
|
61492
|
+
export declare type ExportConditionalFormattingConditionOperatorEnum = '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';
|
|
61493
|
+
|
|
61494
|
+
/**
|
|
61495
|
+
* Visual formatting applied to a matching cell.
|
|
61496
|
+
*/
|
|
61497
|
+
export declare interface ExportConditionalFormattingFormat {
|
|
61498
|
+
/**
|
|
61499
|
+
* Background color as a hex triplet.
|
|
61500
|
+
*/
|
|
61501
|
+
'backgroundColor'?: string;
|
|
61502
|
+
/**
|
|
61503
|
+
* Text color as a hex triplet.
|
|
61504
|
+
*/
|
|
61505
|
+
'color'?: string;
|
|
61506
|
+
/**
|
|
61507
|
+
* Whether the formatting applies to the matching cell only, or to its whole row.
|
|
61508
|
+
*/
|
|
61509
|
+
'scope': ExportConditionalFormattingFormatScopeEnum;
|
|
61510
|
+
}
|
|
61511
|
+
|
|
61512
|
+
export declare type ExportConditionalFormattingFormatScopeEnum = 'cell' | 'row';
|
|
61513
|
+
|
|
61514
|
+
/**
|
|
61515
|
+
* @type ExportConditionalFormattingLiteral
|
|
61516
|
+
* A string or a number, serialized in whichever form it was authored.
|
|
61517
|
+
*/
|
|
61518
|
+
export declare type ExportConditionalFormattingLiteral = number | string;
|
|
61519
|
+
|
|
61520
|
+
/**
|
|
61521
|
+
* An inclusive numeric range.
|
|
61522
|
+
*/
|
|
61523
|
+
export declare interface ExportConditionalFormattingLiteralRangeValue {
|
|
61524
|
+
'from': number;
|
|
61525
|
+
/**
|
|
61526
|
+
* The value kind.
|
|
61527
|
+
*/
|
|
61528
|
+
'kind': ExportConditionalFormattingLiteralRangeValueKindEnum;
|
|
61529
|
+
'to': number;
|
|
61530
|
+
}
|
|
61531
|
+
|
|
61532
|
+
export declare type ExportConditionalFormattingLiteralRangeValueKindEnum = 'literalRange';
|
|
61533
|
+
|
|
61534
|
+
/**
|
|
61535
|
+
* A single value compared against the cell value.
|
|
61536
|
+
*/
|
|
61537
|
+
export declare interface ExportConditionalFormattingLiteralValue {
|
|
61538
|
+
/**
|
|
61539
|
+
* The value kind.
|
|
61540
|
+
*/
|
|
61541
|
+
'kind': ExportConditionalFormattingLiteralValueKindEnum;
|
|
61542
|
+
'value': ExportConditionalFormattingLiteral;
|
|
61543
|
+
}
|
|
61544
|
+
|
|
61545
|
+
export declare type ExportConditionalFormattingLiteralValueKindEnum = 'literal';
|
|
61546
|
+
|
|
61547
|
+
/**
|
|
61548
|
+
* A measure column, addressed by its bucket item local identifier.
|
|
61549
|
+
*/
|
|
61550
|
+
export declare interface ExportConditionalFormattingMeasureTarget {
|
|
61551
|
+
/**
|
|
61552
|
+
* The target kind.
|
|
61553
|
+
*/
|
|
61554
|
+
'kind': ExportConditionalFormattingMeasureTargetKindEnum;
|
|
61555
|
+
'measureIdentifier': string;
|
|
61556
|
+
}
|
|
61557
|
+
|
|
61558
|
+
export declare type ExportConditionalFormattingMeasureTargetKindEnum = 'measure';
|
|
61559
|
+
|
|
61560
|
+
/**
|
|
61561
|
+
* No value; used by operators that take none.
|
|
61562
|
+
*/
|
|
61563
|
+
export declare interface ExportConditionalFormattingNoneValue {
|
|
61564
|
+
/**
|
|
61565
|
+
* The value kind.
|
|
61566
|
+
*/
|
|
61567
|
+
'kind': ExportConditionalFormattingNoneValueKindEnum;
|
|
61568
|
+
}
|
|
61569
|
+
|
|
61570
|
+
export declare type ExportConditionalFormattingNoneValueKindEnum = 'none';
|
|
61571
|
+
|
|
61572
|
+
/**
|
|
61573
|
+
* A date period relative to the moment of evaluation, resolved at render time.
|
|
61574
|
+
*/
|
|
61575
|
+
export declare interface ExportConditionalFormattingRelativeDateValue {
|
|
61576
|
+
/**
|
|
61577
|
+
* Offset in periods; 0 is the current period, negative is the past.
|
|
61578
|
+
*/
|
|
61579
|
+
'from': number;
|
|
61580
|
+
/**
|
|
61581
|
+
* Granularity the offsets are counted in.
|
|
61582
|
+
*/
|
|
61583
|
+
'granularity': ExportConditionalFormattingRelativeDateValueGranularityEnum;
|
|
61584
|
+
/**
|
|
61585
|
+
* The value kind.
|
|
61586
|
+
*/
|
|
61587
|
+
'kind': ExportConditionalFormattingRelativeDateValueKindEnum;
|
|
61588
|
+
/**
|
|
61589
|
+
* Offset in periods, not lower than `from`.
|
|
61590
|
+
*/
|
|
61591
|
+
'to': number;
|
|
61592
|
+
}
|
|
61593
|
+
|
|
61594
|
+
export declare type ExportConditionalFormattingRelativeDateValueGranularityEnum = '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';
|
|
61595
|
+
|
|
61596
|
+
export declare type ExportConditionalFormattingRelativeDateValueKindEnum = 'relativeDate';
|
|
61597
|
+
|
|
61598
|
+
/**
|
|
61599
|
+
* Conditions applied to a single column.
|
|
61600
|
+
*/
|
|
61601
|
+
export declare interface ExportConditionalFormattingRule {
|
|
61602
|
+
/**
|
|
61603
|
+
* Conditions evaluated in order; the first match wins.
|
|
61604
|
+
*/
|
|
61605
|
+
'conditions': Array<ExportConditionalFormattingCondition>;
|
|
61606
|
+
/**
|
|
61607
|
+
* Client-assigned identifier, stable across edits.
|
|
61608
|
+
*/
|
|
61609
|
+
'id'?: string;
|
|
61610
|
+
'target': ExportConditionalFormattingTarget;
|
|
61611
|
+
}
|
|
61612
|
+
|
|
61613
|
+
/**
|
|
61614
|
+
* @type ExportConditionalFormattingTarget
|
|
61615
|
+
* Column a rule formats. The shape is selected by the `kind` property.
|
|
61616
|
+
*/
|
|
61617
|
+
export declare type ExportConditionalFormattingTarget = ExportConditionalFormattingAttributeTarget | ExportConditionalFormattingMeasureTarget;
|
|
61618
|
+
|
|
61619
|
+
/**
|
|
61620
|
+
* @type ExportConditionalFormattingValue
|
|
61621
|
+
* Value a condition compares against. The shape is selected by the `kind` property.
|
|
61622
|
+
*/
|
|
61623
|
+
export declare type ExportConditionalFormattingValue = ExportConditionalFormattingAbsoluteDateValue | ExportConditionalFormattingLiteralRangeValue | ExportConditionalFormattingLiteralValue | ExportConditionalFormattingNoneValue | ExportConditionalFormattingRelativeDateValue;
|
|
61624
|
+
|
|
61213
61625
|
export declare class ExportConfiguration {
|
|
61214
61626
|
/**
|
|
61215
61627
|
* parameter for apiKey security
|
|
@@ -63414,6 +63826,7 @@ export declare interface ExportTabularExportExecution {
|
|
|
63414
63826
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
63415
63827
|
*/
|
|
63416
63828
|
export declare interface ExportTabularExportRequest {
|
|
63829
|
+
'conditionalFormatting'?: ExportConditionalFormatting | null;
|
|
63417
63830
|
'customOverride'?: ExportCustomOverride;
|
|
63418
63831
|
/**
|
|
63419
63832
|
* Execution result identifier.
|
|
@@ -70697,11 +71110,12 @@ export declare function ImageExportExport_GetImageExportMetadata(axios: AxiosIns
|
|
|
70697
71110
|
* @summary (EXPERIMENTAL) Create image export request
|
|
70698
71111
|
* @param {string} workspaceId
|
|
70699
71112
|
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
71113
|
+
* @param {boolean} [xGdcDebug]
|
|
70700
71114
|
* @param {*} [options] Override http request option.
|
|
70701
71115
|
* @param {Configuration} [configuration] Optional configuration.
|
|
70702
71116
|
* @throws {RequiredError}
|
|
70703
71117
|
*/
|
|
70704
|
-
export declare function ImageExportExportAxiosParamCreator_CreateImageExport(workspaceId: string, exportImageExportRequest: ExportImageExportRequest, options?: AxiosRequestConfig, configuration?: ExportConfiguration): Promise<ExportRequestArgs>;
|
|
71118
|
+
export declare function ImageExportExportAxiosParamCreator_CreateImageExport(workspaceId: string, exportImageExportRequest: ExportImageExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: ExportConfiguration): Promise<ExportRequestArgs>;
|
|
70705
71119
|
|
|
70706
71120
|
/**
|
|
70707
71121
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
@@ -70743,6 +71157,12 @@ export declare interface ImageExportExportCreateImageExportRequest {
|
|
|
70743
71157
|
* @memberof ImageExportExportCreateImageExport
|
|
70744
71158
|
*/
|
|
70745
71159
|
readonly exportImageExportRequest: ExportImageExportRequest;
|
|
71160
|
+
/**
|
|
71161
|
+
*
|
|
71162
|
+
* @type {boolean}
|
|
71163
|
+
* @memberof ImageExportExportCreateImageExport
|
|
71164
|
+
*/
|
|
71165
|
+
readonly xGdcDebug?: boolean;
|
|
70746
71166
|
}
|
|
70747
71167
|
|
|
70748
71168
|
/**
|
|
@@ -79125,6 +79545,10 @@ export declare interface JsonApiMetricOutListMeta {
|
|
|
79125
79545
|
|
|
79126
79546
|
export declare interface JsonApiMetricOutMeta {
|
|
79127
79547
|
'origin'?: JsonApiMetricOutMetaOrigin;
|
|
79548
|
+
/**
|
|
79549
|
+
* List of valid permissions for a logged-in user.
|
|
79550
|
+
*/
|
|
79551
|
+
'permissions'?: Array<JsonApiMetricOutMetaPermissionsEnum>;
|
|
79128
79552
|
}
|
|
79129
79553
|
|
|
79130
79554
|
export declare interface JsonApiMetricOutMetaOrigin {
|
|
@@ -79140,6 +79564,8 @@ export declare interface JsonApiMetricOutMetaOrigin {
|
|
|
79140
79564
|
|
|
79141
79565
|
export declare type JsonApiMetricOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
79142
79566
|
|
|
79567
|
+
export declare type JsonApiMetricOutMetaPermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
|
|
79568
|
+
|
|
79143
79569
|
export declare interface JsonApiMetricOutRelationships {
|
|
79144
79570
|
'attributes'?: JsonApiMetricOutRelationshipsAttributes;
|
|
79145
79571
|
'certifiedBy'?: JsonApiMetricOutRelationshipsCertifiedBy;
|
|
@@ -81462,15 +81888,10 @@ export declare interface JsonApiVisualizationObjectOutDocument {
|
|
|
81462
81888
|
/**
|
|
81463
81889
|
* Included resources
|
|
81464
81890
|
*/
|
|
81465
|
-
'included'?: Array<
|
|
81891
|
+
'included'?: Array<JsonApiComputedAttributeOutIncludes>;
|
|
81466
81892
|
'links'?: ObjectLinks;
|
|
81467
81893
|
}
|
|
81468
81894
|
|
|
81469
|
-
/**
|
|
81470
|
-
* @type JsonApiVisualizationObjectOutIncludes
|
|
81471
|
-
*/
|
|
81472
|
-
export declare type JsonApiVisualizationObjectOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
81473
|
-
|
|
81474
81895
|
/**
|
|
81475
81896
|
* A JSON:API document with a list of resources
|
|
81476
81897
|
*/
|
|
@@ -81479,7 +81900,7 @@ export declare interface JsonApiVisualizationObjectOutList {
|
|
|
81479
81900
|
/**
|
|
81480
81901
|
* Included resources
|
|
81481
81902
|
*/
|
|
81482
|
-
'included'?: Array<
|
|
81903
|
+
'included'?: Array<JsonApiComputedAttributeOutIncludes>;
|
|
81483
81904
|
'links'?: ListLinks;
|
|
81484
81905
|
'meta'?: JsonApiVisualizationObjectOutListMeta;
|
|
81485
81906
|
}
|
|
@@ -81508,6 +81929,7 @@ export declare type JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum = 'NAT
|
|
|
81508
81929
|
export declare interface JsonApiVisualizationObjectOutRelationships {
|
|
81509
81930
|
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
81510
81931
|
'certifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCertifiedBy;
|
|
81932
|
+
'computedAttributes'?: JsonApiVisualizationObjectOutRelationshipsComputedAttributes;
|
|
81511
81933
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
81512
81934
|
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
81513
81935
|
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
@@ -81528,6 +81950,13 @@ export declare interface JsonApiVisualizationObjectOutRelationshipsCertifiedBy {
|
|
|
81528
81950
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
81529
81951
|
}
|
|
81530
81952
|
|
|
81953
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsComputedAttributes {
|
|
81954
|
+
/**
|
|
81955
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
81956
|
+
*/
|
|
81957
|
+
'data': Array<JsonApiComputedAttributeLinkage>;
|
|
81958
|
+
}
|
|
81959
|
+
|
|
81531
81960
|
export declare interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
81532
81961
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
81533
81962
|
}
|
|
@@ -91972,12 +92401,12 @@ export declare function MetricControllerApi_UpdateEntityMetrics(axios: AxiosInst
|
|
|
91972
92401
|
* @param {string} workspaceId
|
|
91973
92402
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
91974
92403
|
* @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.
|
|
91975
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92404
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
91976
92405
|
* @param {*} [options] Override http request option.
|
|
91977
92406
|
* @param {Configuration} [configuration] Optional configuration.
|
|
91978
92407
|
* @throws {RequiredError}
|
|
91979
92408
|
*/
|
|
91980
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92409
|
+
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<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
91981
92410
|
|
|
91982
92411
|
/**
|
|
91983
92412
|
*
|
|
@@ -92001,12 +92430,12 @@ export declare function MetricControllerApiAxiosParamCreator_DeleteEntityMetrics
|
|
|
92001
92430
|
* @param {number} [size] The size of the page to be returned
|
|
92002
92431
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
92003
92432
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92004
|
-
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92433
|
+
* @param {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92005
92434
|
* @param {*} [options] Override http request option.
|
|
92006
92435
|
* @param {Configuration} [configuration] Optional configuration.
|
|
92007
92436
|
* @throws {RequiredError}
|
|
92008
92437
|
*/
|
|
92009
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92438
|
+
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<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92010
92439
|
|
|
92011
92440
|
/**
|
|
92012
92441
|
*
|
|
@@ -92016,12 +92445,12 @@ export declare function MetricControllerApiAxiosParamCreator_GetAllEntitiesMetri
|
|
|
92016
92445
|
* @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\').
|
|
92017
92446
|
* @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.
|
|
92018
92447
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92019
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92448
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92020
92449
|
* @param {*} [options] Override http request option.
|
|
92021
92450
|
* @param {Configuration} [configuration] Optional configuration.
|
|
92022
92451
|
* @throws {RequiredError}
|
|
92023
92452
|
*/
|
|
92024
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92453
|
+
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<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92025
92454
|
|
|
92026
92455
|
/**
|
|
92027
92456
|
*
|
|
@@ -92090,10 +92519,10 @@ export declare interface MetricControllerApiCreateEntityMetricsRequest {
|
|
|
92090
92519
|
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
92091
92520
|
/**
|
|
92092
92521
|
* Include Meta objects.
|
|
92093
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
92522
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
92094
92523
|
* @memberof MetricControllerApiCreateEntityMetrics
|
|
92095
92524
|
*/
|
|
92096
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
92525
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
92097
92526
|
}
|
|
92098
92527
|
|
|
92099
92528
|
/**
|
|
@@ -92172,10 +92601,10 @@ export declare interface MetricControllerApiGetAllEntitiesMetricsRequest {
|
|
|
92172
92601
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
92173
92602
|
/**
|
|
92174
92603
|
* Include Meta objects.
|
|
92175
|
-
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
92604
|
+
* @type {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>}
|
|
92176
92605
|
* @memberof MetricControllerApiGetAllEntitiesMetrics
|
|
92177
92606
|
*/
|
|
92178
|
-
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
92607
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>;
|
|
92179
92608
|
}
|
|
92180
92609
|
|
|
92181
92610
|
/**
|
|
@@ -92216,10 +92645,10 @@ export declare interface MetricControllerApiGetEntityMetricsRequest {
|
|
|
92216
92645
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
92217
92646
|
/**
|
|
92218
92647
|
* Include Meta objects.
|
|
92219
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
92648
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
92220
92649
|
* @memberof MetricControllerApiGetEntityMetrics
|
|
92221
92650
|
*/
|
|
92222
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
92651
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
92223
92652
|
}
|
|
92224
92653
|
|
|
92225
92654
|
/**
|
|
@@ -92615,12 +93044,12 @@ export declare function MetricsApi_UpdateEntityMetrics(axios: AxiosInstance, bas
|
|
|
92615
93044
|
* @param {string} workspaceId
|
|
92616
93045
|
* @param {JsonApiMetricPostOptionalIdDocument} jsonApiMetricPostOptionalIdDocument
|
|
92617
93046
|
* @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.
|
|
92618
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93047
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92619
93048
|
* @param {*} [options] Override http request option.
|
|
92620
93049
|
* @param {Configuration} [configuration] Optional configuration.
|
|
92621
93050
|
* @throws {RequiredError}
|
|
92622
93051
|
*/
|
|
92623
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
93052
|
+
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<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92624
93053
|
|
|
92625
93054
|
/**
|
|
92626
93055
|
*
|
|
@@ -92644,12 +93073,12 @@ export declare function MetricsApiAxiosParamCreator_DeleteEntityMetrics(workspac
|
|
|
92644
93073
|
* @param {number} [size] The size of the page to be returned
|
|
92645
93074
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
92646
93075
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92647
|
-
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93076
|
+
* @param {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92648
93077
|
* @param {*} [options] Override http request option.
|
|
92649
93078
|
* @param {Configuration} [configuration] Optional configuration.
|
|
92650
93079
|
* @throws {RequiredError}
|
|
92651
93080
|
*/
|
|
92652
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
93081
|
+
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<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92653
93082
|
|
|
92654
93083
|
/**
|
|
92655
93084
|
*
|
|
@@ -92659,12 +93088,12 @@ export declare function MetricsApiAxiosParamCreator_GetAllEntitiesMetrics(worksp
|
|
|
92659
93088
|
* @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\').
|
|
92660
93089
|
* @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.
|
|
92661
93090
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92662
|
-
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93091
|
+
* @param {Array<'permissions' | 'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92663
93092
|
* @param {*} [options] Override http request option.
|
|
92664
93093
|
* @param {Configuration} [configuration] Optional configuration.
|
|
92665
93094
|
* @throws {RequiredError}
|
|
92666
93095
|
*/
|
|
92667
|
-
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?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
93096
|
+
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<'permissions' | 'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
92668
93097
|
|
|
92669
93098
|
/**
|
|
92670
93099
|
*
|
|
@@ -92733,10 +93162,10 @@ export declare interface MetricsApiCreateEntityMetricsRequest {
|
|
|
92733
93162
|
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'computedAttributes' | 'metrics' | 'datasets' | 'parameters' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
92734
93163
|
/**
|
|
92735
93164
|
* Include Meta objects.
|
|
92736
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
93165
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
92737
93166
|
* @memberof MetricsApiCreateEntityMetrics
|
|
92738
93167
|
*/
|
|
92739
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
93168
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
92740
93169
|
}
|
|
92741
93170
|
|
|
92742
93171
|
/**
|
|
@@ -92815,10 +93244,10 @@ export declare interface MetricsApiGetAllEntitiesMetricsRequest {
|
|
|
92815
93244
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
92816
93245
|
/**
|
|
92817
93246
|
* Include Meta objects.
|
|
92818
|
-
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
93247
|
+
* @type {Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>}
|
|
92819
93248
|
* @memberof MetricsApiGetAllEntitiesMetrics
|
|
92820
93249
|
*/
|
|
92821
|
-
readonly metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>;
|
|
93250
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'page' | 'all' | 'ALL'>;
|
|
92822
93251
|
}
|
|
92823
93252
|
|
|
92824
93253
|
/**
|
|
@@ -92859,10 +93288,10 @@ export declare interface MetricsApiGetEntityMetricsRequest {
|
|
|
92859
93288
|
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
92860
93289
|
/**
|
|
92861
93290
|
* Include Meta objects.
|
|
92862
|
-
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
93291
|
+
* @type {Array<'permissions' | 'origin' | 'all' | 'ALL'>}
|
|
92863
93292
|
* @memberof MetricsApiGetEntityMetrics
|
|
92864
93293
|
*/
|
|
92865
|
-
readonly metaInclude?: Array<'origin' | 'all' | 'ALL'>;
|
|
93294
|
+
readonly metaInclude?: Array<'permissions' | 'origin' | 'all' | 'ALL'>;
|
|
92866
93295
|
}
|
|
92867
93296
|
|
|
92868
93297
|
/**
|
|
@@ -102511,6 +102940,7 @@ export declare interface TabularExportExportInterface {
|
|
|
102511
102940
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
102512
102941
|
*/
|
|
102513
102942
|
export declare interface TabularExportRequest {
|
|
102943
|
+
'conditionalFormatting'?: ConditionalFormatting | null;
|
|
102514
102944
|
'customOverride'?: CustomOverride;
|
|
102515
102945
|
/**
|
|
102516
102946
|
* Execution result identifier.
|
|
@@ -108876,7 +109306,7 @@ export declare interface ValidateByItem {
|
|
|
108876
109306
|
*/
|
|
108877
109307
|
'id': string;
|
|
108878
109308
|
/**
|
|
108879
|
-
* Specifies entity type which could be label, attribute, fact, or metric.
|
|
109309
|
+
* Specifies entity type which could be label, attribute, computedAttribute, fact, or metric.
|
|
108880
109310
|
*/
|
|
108881
109311
|
'type': string;
|
|
108882
109312
|
}
|
|
@@ -109317,13 +109747,13 @@ export declare function VisualizationObjectApi_UpdateEntityVisualizationObjects(
|
|
|
109317
109747
|
* @summary Post Visualization Objects
|
|
109318
109748
|
* @param {string} workspaceId
|
|
109319
109749
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
109320
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
109750
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109321
109751
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
109322
109752
|
* @param {*} [options] Override http request option.
|
|
109323
109753
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109324
109754
|
* @throws {RequiredError}
|
|
109325
109755
|
*/
|
|
109326
|
-
export declare function VisualizationObjectApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109756
|
+
export declare function VisualizationObjectApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109327
109757
|
|
|
109328
109758
|
/**
|
|
109329
109759
|
*
|
|
@@ -109342,7 +109772,7 @@ export declare function VisualizationObjectApiAxiosParamCreator_DeleteEntityVisu
|
|
|
109342
109772
|
* @param {string} workspaceId
|
|
109343
109773
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
109344
109774
|
* @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\').
|
|
109345
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
109775
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109346
109776
|
* @param {number} [page] Zero-based page index (0..N)
|
|
109347
109777
|
* @param {number} [size] The size of the page to be returned
|
|
109348
109778
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -109352,7 +109782,7 @@ export declare function VisualizationObjectApiAxiosParamCreator_DeleteEntityVisu
|
|
|
109352
109782
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109353
109783
|
* @throws {RequiredError}
|
|
109354
109784
|
*/
|
|
109355
|
-
export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109785
|
+
export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109356
109786
|
|
|
109357
109787
|
/**
|
|
109358
109788
|
*
|
|
@@ -109360,14 +109790,14 @@ export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVi
|
|
|
109360
109790
|
* @param {string} workspaceId
|
|
109361
109791
|
* @param {string} objectId
|
|
109362
109792
|
* @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\').
|
|
109363
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
109793
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109364
109794
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
109365
109795
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
109366
109796
|
* @param {*} [options] Override http request option.
|
|
109367
109797
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109368
109798
|
* @throws {RequiredError}
|
|
109369
109799
|
*/
|
|
109370
|
-
export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109800
|
+
export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109371
109801
|
|
|
109372
109802
|
/**
|
|
109373
109803
|
*
|
|
@@ -109376,12 +109806,12 @@ export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisuali
|
|
|
109376
109806
|
* @param {string} objectId
|
|
109377
109807
|
* @param {JsonApiVisualizationObjectPatchDocument} jsonApiVisualizationObjectPatchDocument
|
|
109378
109808
|
* @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\').
|
|
109379
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
109809
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109380
109810
|
* @param {*} [options] Override http request option.
|
|
109381
109811
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109382
109812
|
* @throws {RequiredError}
|
|
109383
109813
|
*/
|
|
109384
|
-
export declare function VisualizationObjectApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109814
|
+
export declare function VisualizationObjectApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109385
109815
|
|
|
109386
109816
|
/**
|
|
109387
109817
|
*
|
|
@@ -109403,12 +109833,12 @@ export declare function VisualizationObjectApiAxiosParamCreator_SearchEntitiesVi
|
|
|
109403
109833
|
* @param {string} objectId
|
|
109404
109834
|
* @param {JsonApiVisualizationObjectInDocument} jsonApiVisualizationObjectInDocument
|
|
109405
109835
|
* @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\').
|
|
109406
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
109836
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109407
109837
|
* @param {*} [options] Override http request option.
|
|
109408
109838
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109409
109839
|
* @throws {RequiredError}
|
|
109410
109840
|
*/
|
|
109411
|
-
export declare function VisualizationObjectApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109841
|
+
export declare function VisualizationObjectApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109412
109842
|
|
|
109413
109843
|
/**
|
|
109414
109844
|
* Request parameters for createEntityVisualizationObjects operation in VisualizationObjectApi.
|
|
@@ -109430,10 +109860,10 @@ export declare interface VisualizationObjectApiCreateEntityVisualizationObjectsR
|
|
|
109430
109860
|
readonly jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument;
|
|
109431
109861
|
/**
|
|
109432
109862
|
* 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.
|
|
109433
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109863
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109434
109864
|
* @memberof VisualizationObjectApiCreateEntityVisualizationObjects
|
|
109435
109865
|
*/
|
|
109436
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109866
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109437
109867
|
/**
|
|
109438
109868
|
* Include Meta objects.
|
|
109439
109869
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -109488,10 +109918,10 @@ export declare interface VisualizationObjectApiGetAllEntitiesVisualizationObject
|
|
|
109488
109918
|
readonly filter?: string;
|
|
109489
109919
|
/**
|
|
109490
109920
|
* 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.
|
|
109491
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109921
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109492
109922
|
* @memberof VisualizationObjectApiGetAllEntitiesVisualizationObjects
|
|
109493
109923
|
*/
|
|
109494
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109924
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109495
109925
|
/**
|
|
109496
109926
|
* Zero-based page index (0..N)
|
|
109497
109927
|
* @type {number}
|
|
@@ -109550,10 +109980,10 @@ export declare interface VisualizationObjectApiGetEntityVisualizationObjectsRequ
|
|
|
109550
109980
|
readonly filter?: string;
|
|
109551
109981
|
/**
|
|
109552
109982
|
* 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.
|
|
109553
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109983
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109554
109984
|
* @memberof VisualizationObjectApiGetEntityVisualizationObjects
|
|
109555
109985
|
*/
|
|
109556
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109986
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109557
109987
|
/**
|
|
109558
109988
|
*
|
|
109559
109989
|
* @type {boolean}
|
|
@@ -109671,10 +110101,10 @@ export declare interface VisualizationObjectApiPatchEntityVisualizationObjectsRe
|
|
|
109671
110101
|
readonly filter?: string;
|
|
109672
110102
|
/**
|
|
109673
110103
|
* 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.
|
|
109674
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110104
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109675
110105
|
* @memberof VisualizationObjectApiPatchEntityVisualizationObjects
|
|
109676
110106
|
*/
|
|
109677
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110107
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109678
110108
|
}
|
|
109679
110109
|
|
|
109680
110110
|
/**
|
|
@@ -109741,10 +110171,10 @@ export declare interface VisualizationObjectApiUpdateEntityVisualizationObjectsR
|
|
|
109741
110171
|
readonly filter?: string;
|
|
109742
110172
|
/**
|
|
109743
110173
|
* 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.
|
|
109744
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110174
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
109745
110175
|
* @memberof VisualizationObjectApiUpdateEntityVisualizationObjects
|
|
109746
110176
|
*/
|
|
109747
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110177
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
109748
110178
|
}
|
|
109749
110179
|
|
|
109750
110180
|
/**
|
|
@@ -109908,13 +110338,13 @@ export declare function VisualizationObjectControllerApi_UpdateEntityVisualizati
|
|
|
109908
110338
|
* @summary Post Visualization Objects
|
|
109909
110339
|
* @param {string} workspaceId
|
|
109910
110340
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
109911
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
110341
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109912
110342
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
109913
110343
|
* @param {*} [options] Override http request option.
|
|
109914
110344
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109915
110345
|
* @throws {RequiredError}
|
|
109916
110346
|
*/
|
|
109917
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
110347
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109918
110348
|
|
|
109919
110349
|
/**
|
|
109920
110350
|
*
|
|
@@ -109933,7 +110363,7 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Delete
|
|
|
109933
110363
|
* @param {string} workspaceId
|
|
109934
110364
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
109935
110365
|
* @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\').
|
|
109936
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
110366
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109937
110367
|
* @param {number} [page] Zero-based page index (0..N)
|
|
109938
110368
|
* @param {number} [size] The size of the page to be returned
|
|
109939
110369
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -109943,7 +110373,7 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Delete
|
|
|
109943
110373
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109944
110374
|
* @throws {RequiredError}
|
|
109945
110375
|
*/
|
|
109946
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
110376
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109947
110377
|
|
|
109948
110378
|
/**
|
|
109949
110379
|
*
|
|
@@ -109951,14 +110381,14 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAll
|
|
|
109951
110381
|
* @param {string} workspaceId
|
|
109952
110382
|
* @param {string} objectId
|
|
109953
110383
|
* @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\').
|
|
109954
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
110384
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109955
110385
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
109956
110386
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
109957
110387
|
* @param {*} [options] Override http request option.
|
|
109958
110388
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109959
110389
|
* @throws {RequiredError}
|
|
109960
110390
|
*/
|
|
109961
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
110391
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109962
110392
|
|
|
109963
110393
|
/**
|
|
109964
110394
|
*
|
|
@@ -109967,12 +110397,12 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEnt
|
|
|
109967
110397
|
* @param {string} objectId
|
|
109968
110398
|
* @param {JsonApiVisualizationObjectPatchDocument} jsonApiVisualizationObjectPatchDocument
|
|
109969
110399
|
* @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\').
|
|
109970
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
110400
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109971
110401
|
* @param {*} [options] Override http request option.
|
|
109972
110402
|
* @param {Configuration} [configuration] Optional configuration.
|
|
109973
110403
|
* @throws {RequiredError}
|
|
109974
110404
|
*/
|
|
109975
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
110405
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
109976
110406
|
|
|
109977
110407
|
/**
|
|
109978
110408
|
*
|
|
@@ -109994,12 +110424,12 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Search
|
|
|
109994
110424
|
* @param {string} objectId
|
|
109995
110425
|
* @param {JsonApiVisualizationObjectInDocument} jsonApiVisualizationObjectInDocument
|
|
109996
110426
|
* @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\').
|
|
109997
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | '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.
|
|
110427
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | '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.
|
|
109998
110428
|
* @param {*} [options] Override http request option.
|
|
109999
110429
|
* @param {Configuration} [configuration] Optional configuration.
|
|
110000
110430
|
* @throws {RequiredError}
|
|
110001
110431
|
*/
|
|
110002
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
110432
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
110003
110433
|
|
|
110004
110434
|
/**
|
|
110005
110435
|
* Request parameters for createEntityVisualizationObjects operation in VisualizationObjectControllerApi.
|
|
@@ -110021,10 +110451,10 @@ export declare interface VisualizationObjectControllerApiCreateEntityVisualizati
|
|
|
110021
110451
|
readonly jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument;
|
|
110022
110452
|
/**
|
|
110023
110453
|
* 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.
|
|
110024
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110454
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110025
110455
|
* @memberof VisualizationObjectControllerApiCreateEntityVisualizationObjects
|
|
110026
110456
|
*/
|
|
110027
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110457
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110028
110458
|
/**
|
|
110029
110459
|
* Include Meta objects.
|
|
110030
110460
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -110079,10 +110509,10 @@ export declare interface VisualizationObjectControllerApiGetAllEntitiesVisualiza
|
|
|
110079
110509
|
readonly filter?: string;
|
|
110080
110510
|
/**
|
|
110081
110511
|
* 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.
|
|
110082
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110512
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110083
110513
|
* @memberof VisualizationObjectControllerApiGetAllEntitiesVisualizationObjects
|
|
110084
110514
|
*/
|
|
110085
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110515
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110086
110516
|
/**
|
|
110087
110517
|
* Zero-based page index (0..N)
|
|
110088
110518
|
* @type {number}
|
|
@@ -110141,10 +110571,10 @@ export declare interface VisualizationObjectControllerApiGetEntityVisualizationO
|
|
|
110141
110571
|
readonly filter?: string;
|
|
110142
110572
|
/**
|
|
110143
110573
|
* 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.
|
|
110144
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110574
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110145
110575
|
* @memberof VisualizationObjectControllerApiGetEntityVisualizationObjects
|
|
110146
110576
|
*/
|
|
110147
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110577
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110148
110578
|
/**
|
|
110149
110579
|
*
|
|
110150
110580
|
* @type {boolean}
|
|
@@ -110262,10 +110692,10 @@ export declare interface VisualizationObjectControllerApiPatchEntityVisualizatio
|
|
|
110262
110692
|
readonly filter?: string;
|
|
110263
110693
|
/**
|
|
110264
110694
|
* 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.
|
|
110265
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110695
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110266
110696
|
* @memberof VisualizationObjectControllerApiPatchEntityVisualizationObjects
|
|
110267
110697
|
*/
|
|
110268
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110698
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110269
110699
|
}
|
|
110270
110700
|
|
|
110271
110701
|
/**
|
|
@@ -110332,10 +110762,10 @@ export declare interface VisualizationObjectControllerApiUpdateEntityVisualizati
|
|
|
110332
110762
|
readonly filter?: string;
|
|
110333
110763
|
/**
|
|
110334
110764
|
* 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.
|
|
110335
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110765
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
110336
110766
|
* @memberof VisualizationObjectControllerApiUpdateEntityVisualizationObjects
|
|
110337
110767
|
*/
|
|
110338
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110768
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'computedAttributes' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
110339
110769
|
}
|
|
110340
110770
|
|
|
110341
110771
|
export declare interface VisualizationObjectExecution {
|