@gooddata/api-client-tiger 11.11.0-alpha.4 → 11.11.0-alpha.6
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 +1648 -536
- package/esm/generated/afm-rest-api/api.d.ts +13 -0
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +24 -0
- package/esm/generated/automation-json-api/api.d.ts +2 -2
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +2 -2
- package/esm/generated/metadata-json-api/api.d.ts +1531 -486
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +984 -0
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +10039 -9501
- package/package.json +4 -4
|
@@ -145,12 +145,12 @@ export interface AnomalyDetection {
|
|
|
145
145
|
*/
|
|
146
146
|
sensitivity?: AnomalyDetectionSensitivityEnum;
|
|
147
147
|
/**
|
|
148
|
-
* Date granularity for anomaly detection. Only time-based granularities are supported (
|
|
148
|
+
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
149
149
|
*/
|
|
150
150
|
granularity: AnomalyDetectionGranularityEnum;
|
|
151
151
|
}
|
|
152
152
|
export type AnomalyDetectionSensitivityEnum = "LOW" | "MEDIUM" | "HIGH";
|
|
153
|
-
export type AnomalyDetectionGranularityEnum = "
|
|
153
|
+
export type AnomalyDetectionGranularityEnum = "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR";
|
|
154
154
|
export interface AnomalyDetectionWrapper {
|
|
155
155
|
anomaly: AnomalyDetection;
|
|
156
156
|
}
|
|
@@ -1810,7 +1810,7 @@ export interface DeclarativeSetting {
|
|
|
1810
1810
|
*/
|
|
1811
1811
|
type?: DeclarativeSettingTypeEnum;
|
|
1812
1812
|
}
|
|
1813
|
-
export type DeclarativeSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE";
|
|
1813
|
+
export type DeclarativeSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE" | "ENABLE_AI_ON_DATA";
|
|
1814
1814
|
export interface DeclarativeSingleWorkspacePermission {
|
|
1815
1815
|
/**
|
|
1816
1816
|
* Permission name.
|
|
@@ -2449,6 +2449,9 @@ export interface GeoAreaConfig {
|
|
|
2449
2449
|
collection: GeoCollection;
|
|
2450
2450
|
}
|
|
2451
2451
|
export interface GeoCollection {
|
|
2452
|
+
/**
|
|
2453
|
+
* Geo collection identifier.
|
|
2454
|
+
*/
|
|
2452
2455
|
id: string;
|
|
2453
2456
|
}
|
|
2454
2457
|
/**
|
|
@@ -2611,7 +2614,7 @@ export interface JsonApiAggregatedFactOut {
|
|
|
2611
2614
|
* API identifier of an object
|
|
2612
2615
|
*/
|
|
2613
2616
|
id: string;
|
|
2614
|
-
meta?:
|
|
2617
|
+
meta?: JsonApiDatasetOutMeta;
|
|
2615
2618
|
attributes: JsonApiAggregatedFactOutAttributes;
|
|
2616
2619
|
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
2617
2620
|
}
|
|
@@ -2666,7 +2669,7 @@ export interface JsonApiAggregatedFactOutWithLinks {
|
|
|
2666
2669
|
* API identifier of an object
|
|
2667
2670
|
*/
|
|
2668
2671
|
id: string;
|
|
2669
|
-
meta?:
|
|
2672
|
+
meta?: JsonApiDatasetOutMeta;
|
|
2670
2673
|
attributes: JsonApiAggregatedFactOutAttributes;
|
|
2671
2674
|
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
2672
2675
|
links?: ObjectLinks;
|
|
@@ -2756,7 +2759,7 @@ export interface JsonApiAnalyticalDashboardOutMeta {
|
|
|
2756
2759
|
* List of valid permissions for a logged-in user.
|
|
2757
2760
|
*/
|
|
2758
2761
|
permissions?: Array<JsonApiAnalyticalDashboardOutMetaPermissionsEnum>;
|
|
2759
|
-
origin?:
|
|
2762
|
+
origin?: JsonApiDatasetOutMetaOrigin;
|
|
2760
2763
|
accessInfo?: JsonApiAnalyticalDashboardOutMetaAccessInfo;
|
|
2761
2764
|
}
|
|
2762
2765
|
export type JsonApiAnalyticalDashboardOutMetaPermissionsEnum = "EDIT" | "SHARE" | "VIEW";
|
|
@@ -2766,25 +2769,14 @@ export interface JsonApiAnalyticalDashboardOutMetaAccessInfo {
|
|
|
2766
2769
|
*/
|
|
2767
2770
|
private: boolean;
|
|
2768
2771
|
}
|
|
2769
|
-
export interface JsonApiAnalyticalDashboardOutMetaOrigin {
|
|
2770
|
-
/**
|
|
2771
|
-
* defines type of the origin of the entity
|
|
2772
|
-
*/
|
|
2773
|
-
originType: JsonApiAnalyticalDashboardOutMetaOriginOriginTypeEnum;
|
|
2774
|
-
/**
|
|
2775
|
-
* defines id of the workspace where the entity comes from
|
|
2776
|
-
*/
|
|
2777
|
-
originId: string;
|
|
2778
|
-
}
|
|
2779
|
-
export type JsonApiAnalyticalDashboardOutMetaOriginOriginTypeEnum = "NATIVE" | "PARENT";
|
|
2780
2772
|
export interface JsonApiAnalyticalDashboardOutRelationships {
|
|
2781
|
-
createdBy?:
|
|
2782
|
-
modifiedBy?:
|
|
2773
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
2774
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
2783
2775
|
visualizationObjects?: JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects;
|
|
2784
2776
|
analyticalDashboards?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
2785
|
-
labels?:
|
|
2786
|
-
metrics?:
|
|
2787
|
-
datasets?:
|
|
2777
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
2778
|
+
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
2779
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
2788
2780
|
filterContexts?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
2789
2781
|
dashboardPlugins?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
2790
2782
|
}
|
|
@@ -2794,39 +2786,18 @@ export interface JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards
|
|
|
2794
2786
|
*/
|
|
2795
2787
|
data: Array<JsonApiAnalyticalDashboardLinkage>;
|
|
2796
2788
|
}
|
|
2797
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsCreatedBy {
|
|
2798
|
-
data: JsonApiUserIdentifierLinkage | null;
|
|
2799
|
-
}
|
|
2800
2789
|
export interface JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins {
|
|
2801
2790
|
/**
|
|
2802
2791
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2803
2792
|
*/
|
|
2804
2793
|
data: Array<JsonApiDashboardPluginLinkage>;
|
|
2805
2794
|
}
|
|
2806
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsDatasets {
|
|
2807
|
-
/**
|
|
2808
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2809
|
-
*/
|
|
2810
|
-
data: Array<JsonApiDatasetLinkage>;
|
|
2811
|
-
}
|
|
2812
2795
|
export interface JsonApiAnalyticalDashboardOutRelationshipsFilterContexts {
|
|
2813
2796
|
/**
|
|
2814
2797
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2815
2798
|
*/
|
|
2816
2799
|
data: Array<JsonApiFilterContextLinkage>;
|
|
2817
2800
|
}
|
|
2818
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsLabels {
|
|
2819
|
-
/**
|
|
2820
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2821
|
-
*/
|
|
2822
|
-
data: Array<JsonApiLabelLinkage>;
|
|
2823
|
-
}
|
|
2824
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsMetrics {
|
|
2825
|
-
/**
|
|
2826
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2827
|
-
*/
|
|
2828
|
-
data: Array<JsonApiMetricLinkage>;
|
|
2829
|
-
}
|
|
2830
2801
|
export interface JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects {
|
|
2831
2802
|
/**
|
|
2832
2803
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -3005,7 +2976,7 @@ export interface JsonApiAttributeHierarchyOut {
|
|
|
3005
2976
|
* API identifier of an object
|
|
3006
2977
|
*/
|
|
3007
2978
|
id: string;
|
|
3008
|
-
meta?:
|
|
2979
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3009
2980
|
attributes?: JsonApiAttributeHierarchyOutAttributes;
|
|
3010
2981
|
relationships?: JsonApiAttributeHierarchyOutRelationships;
|
|
3011
2982
|
}
|
|
@@ -3047,8 +3018,8 @@ export interface JsonApiAttributeHierarchyOutList {
|
|
|
3047
3018
|
included?: Array<JsonApiAttributeHierarchyOutIncludes>;
|
|
3048
3019
|
}
|
|
3049
3020
|
export interface JsonApiAttributeHierarchyOutRelationships {
|
|
3050
|
-
createdBy?:
|
|
3051
|
-
modifiedBy?:
|
|
3021
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3022
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3052
3023
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
3053
3024
|
}
|
|
3054
3025
|
export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
@@ -3060,7 +3031,7 @@ export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
|
3060
3031
|
* API identifier of an object
|
|
3061
3032
|
*/
|
|
3062
3033
|
id: string;
|
|
3063
|
-
meta?:
|
|
3034
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3064
3035
|
attributes?: JsonApiAttributeHierarchyOutAttributes;
|
|
3065
3036
|
relationships?: JsonApiAttributeHierarchyOutRelationships;
|
|
3066
3037
|
links?: ObjectLinks;
|
|
@@ -3104,7 +3075,7 @@ export interface JsonApiAttributeOut {
|
|
|
3104
3075
|
* API identifier of an object
|
|
3105
3076
|
*/
|
|
3106
3077
|
id: string;
|
|
3107
|
-
meta?:
|
|
3078
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3108
3079
|
attributes?: JsonApiAttributeOutAttributes;
|
|
3109
3080
|
relationships?: JsonApiAttributeOutRelationships;
|
|
3110
3081
|
}
|
|
@@ -3152,7 +3123,7 @@ export interface JsonApiAttributeOutList {
|
|
|
3152
3123
|
export interface JsonApiAttributeOutRelationships {
|
|
3153
3124
|
dataset?: JsonApiFactOutRelationshipsDataset;
|
|
3154
3125
|
defaultView?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
3155
|
-
labels?:
|
|
3126
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
3156
3127
|
attributeHierarchies?: JsonApiAttributeOutRelationshipsAttributeHierarchies;
|
|
3157
3128
|
}
|
|
3158
3129
|
export interface JsonApiAttributeOutRelationshipsAttributeHierarchies {
|
|
@@ -3173,12 +3144,40 @@ export interface JsonApiAttributeOutWithLinks {
|
|
|
3173
3144
|
* API identifier of an object
|
|
3174
3145
|
*/
|
|
3175
3146
|
id: string;
|
|
3176
|
-
meta?:
|
|
3147
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3177
3148
|
attributes?: JsonApiAttributeOutAttributes;
|
|
3178
3149
|
relationships?: JsonApiAttributeOutRelationships;
|
|
3179
3150
|
links?: ObjectLinks;
|
|
3180
3151
|
}
|
|
3181
3152
|
export type JsonApiAttributeOutWithLinksTypeEnum = "attribute";
|
|
3153
|
+
/**
|
|
3154
|
+
* JSON:API representation of patching attribute entity.
|
|
3155
|
+
*/
|
|
3156
|
+
export interface JsonApiAttributePatch {
|
|
3157
|
+
/**
|
|
3158
|
+
* Object type
|
|
3159
|
+
*/
|
|
3160
|
+
type: JsonApiAttributePatchTypeEnum;
|
|
3161
|
+
/**
|
|
3162
|
+
* API identifier of an object
|
|
3163
|
+
*/
|
|
3164
|
+
id: string;
|
|
3165
|
+
attributes?: JsonApiAttributePatchAttributes;
|
|
3166
|
+
relationships?: JsonApiAttributePatchRelationships;
|
|
3167
|
+
}
|
|
3168
|
+
export type JsonApiAttributePatchTypeEnum = "attribute";
|
|
3169
|
+
export interface JsonApiAttributePatchAttributes {
|
|
3170
|
+
title?: string;
|
|
3171
|
+
description?: string;
|
|
3172
|
+
tags?: Array<string>;
|
|
3173
|
+
locale?: string;
|
|
3174
|
+
}
|
|
3175
|
+
export interface JsonApiAttributePatchDocument {
|
|
3176
|
+
data: JsonApiAttributePatch;
|
|
3177
|
+
}
|
|
3178
|
+
export interface JsonApiAttributePatchRelationships {
|
|
3179
|
+
defaultView?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
3180
|
+
}
|
|
3182
3181
|
/**
|
|
3183
3182
|
* JSON:API representation of automation entity.
|
|
3184
3183
|
*/
|
|
@@ -3204,7 +3203,7 @@ export interface JsonApiAutomationInAttributes {
|
|
|
3204
3203
|
* Additional details to be included in the automated message.
|
|
3205
3204
|
*/
|
|
3206
3205
|
details?: object;
|
|
3207
|
-
metadata?:
|
|
3206
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
3208
3207
|
/**
|
|
3209
3208
|
* Current state of the automation.
|
|
3210
3209
|
*/
|
|
@@ -3213,18 +3212,18 @@ export interface JsonApiAutomationInAttributes {
|
|
|
3213
3212
|
* Specify automation evaluation mode.
|
|
3214
3213
|
*/
|
|
3215
3214
|
evaluationMode?: JsonApiAutomationInAttributesEvaluationModeEnum;
|
|
3216
|
-
schedule?:
|
|
3217
|
-
alert?:
|
|
3218
|
-
tabularExports?: Array<
|
|
3219
|
-
visualExports?: Array<
|
|
3220
|
-
imageExports?: Array<
|
|
3221
|
-
rawExports?: Array<
|
|
3222
|
-
slidesExports?: Array<
|
|
3223
|
-
dashboardTabularExports?: Array<
|
|
3215
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
3216
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
3217
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
3218
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
3219
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
3220
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
3221
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
3222
|
+
dashboardTabularExports?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3224
3223
|
/**
|
|
3225
3224
|
* External recipients of the automation action results.
|
|
3226
3225
|
*/
|
|
3227
|
-
externalRecipients?: Array<
|
|
3226
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
3228
3227
|
}
|
|
3229
3228
|
export type JsonApiAutomationInAttributesStateEnum = "ACTIVE" | "PAUSED";
|
|
3230
3229
|
export type JsonApiAutomationInAttributesEvaluationModeEnum = "SHARED" | "PER_RECIPIENT";
|
|
@@ -3232,10 +3231,10 @@ export interface JsonApiAutomationInDocument {
|
|
|
3232
3231
|
data: JsonApiAutomationIn;
|
|
3233
3232
|
}
|
|
3234
3233
|
export interface JsonApiAutomationInRelationships {
|
|
3235
|
-
notificationChannel?:
|
|
3234
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
3236
3235
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
3237
|
-
exportDefinitions?:
|
|
3238
|
-
recipients?:
|
|
3236
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
3237
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
3239
3238
|
}
|
|
3240
3239
|
/**
|
|
3241
3240
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
@@ -3257,11 +3256,105 @@ export interface JsonApiAutomationOut {
|
|
|
3257
3256
|
* API identifier of an object
|
|
3258
3257
|
*/
|
|
3259
3258
|
id: string;
|
|
3260
|
-
meta?:
|
|
3261
|
-
attributes?:
|
|
3259
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3260
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
3262
3261
|
relationships?: JsonApiAutomationOutRelationships;
|
|
3263
3262
|
}
|
|
3264
3263
|
export type JsonApiAutomationOutTypeEnum = "automation";
|
|
3264
|
+
export interface JsonApiAutomationOutAttributes {
|
|
3265
|
+
title?: string;
|
|
3266
|
+
description?: string;
|
|
3267
|
+
tags?: Array<string>;
|
|
3268
|
+
areRelationsValid?: boolean;
|
|
3269
|
+
/**
|
|
3270
|
+
* Additional details to be included in the automated message.
|
|
3271
|
+
*/
|
|
3272
|
+
details?: object;
|
|
3273
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
3274
|
+
/**
|
|
3275
|
+
* Current state of the automation.
|
|
3276
|
+
*/
|
|
3277
|
+
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
3278
|
+
/**
|
|
3279
|
+
* Specify automation evaluation mode.
|
|
3280
|
+
*/
|
|
3281
|
+
evaluationMode?: JsonApiAutomationOutAttributesEvaluationModeEnum;
|
|
3282
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
3283
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
3284
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
3285
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
3286
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
3287
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
3288
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
3289
|
+
dashboardTabularExports?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3290
|
+
/**
|
|
3291
|
+
* External recipients of the automation action results.
|
|
3292
|
+
*/
|
|
3293
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
3294
|
+
createdAt?: string;
|
|
3295
|
+
modifiedAt?: string;
|
|
3296
|
+
}
|
|
3297
|
+
export type JsonApiAutomationOutAttributesStateEnum = "ACTIVE" | "PAUSED";
|
|
3298
|
+
export type JsonApiAutomationOutAttributesEvaluationModeEnum = "SHARED" | "PER_RECIPIENT";
|
|
3299
|
+
export interface JsonApiAutomationOutAttributesAlert {
|
|
3300
|
+
execution: AlertAfm;
|
|
3301
|
+
condition: AlertCondition;
|
|
3302
|
+
/**
|
|
3303
|
+
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
3304
|
+
*/
|
|
3305
|
+
trigger?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
3306
|
+
}
|
|
3307
|
+
export type JsonApiAutomationOutAttributesAlertTriggerEnum = "ALWAYS" | "ONCE";
|
|
3308
|
+
export interface JsonApiAutomationOutAttributesDashboardTabularExportsInner {
|
|
3309
|
+
requestPayload: DashboardTabularExportRequestV2;
|
|
3310
|
+
}
|
|
3311
|
+
export interface JsonApiAutomationOutAttributesExternalRecipientsInner {
|
|
3312
|
+
/**
|
|
3313
|
+
* E-mail address to send notifications from.
|
|
3314
|
+
*/
|
|
3315
|
+
email: string;
|
|
3316
|
+
}
|
|
3317
|
+
export interface JsonApiAutomationOutAttributesImageExportsInner {
|
|
3318
|
+
requestPayload: ImageExportRequest;
|
|
3319
|
+
}
|
|
3320
|
+
/**
|
|
3321
|
+
* Additional information for the automation.
|
|
3322
|
+
*/
|
|
3323
|
+
export interface JsonApiAutomationOutAttributesMetadata {
|
|
3324
|
+
[key: string]: any;
|
|
3325
|
+
widget?: string;
|
|
3326
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
3327
|
+
}
|
|
3328
|
+
export interface JsonApiAutomationOutAttributesRawExportsInner {
|
|
3329
|
+
requestPayload: RawExportAutomationRequest;
|
|
3330
|
+
}
|
|
3331
|
+
export interface JsonApiAutomationOutAttributesSchedule {
|
|
3332
|
+
/**
|
|
3333
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
3334
|
+
*/
|
|
3335
|
+
cron: string;
|
|
3336
|
+
/**
|
|
3337
|
+
* Human-readable description of the cron expression.
|
|
3338
|
+
*/
|
|
3339
|
+
cronDescription?: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* Timezone in which the schedule is defined.
|
|
3342
|
+
*/
|
|
3343
|
+
timezone: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
3346
|
+
*/
|
|
3347
|
+
firstRun?: string;
|
|
3348
|
+
}
|
|
3349
|
+
export interface JsonApiAutomationOutAttributesSlidesExportsInner {
|
|
3350
|
+
requestPayload: SlidesExportRequest;
|
|
3351
|
+
}
|
|
3352
|
+
export interface JsonApiAutomationOutAttributesTabularExportsInner {
|
|
3353
|
+
requestPayload: TabularExportRequest;
|
|
3354
|
+
}
|
|
3355
|
+
export interface JsonApiAutomationOutAttributesVisualExportsInner {
|
|
3356
|
+
requestPayload: VisualExportRequest;
|
|
3357
|
+
}
|
|
3265
3358
|
export interface JsonApiAutomationOutDocument {
|
|
3266
3359
|
data: JsonApiAutomationOut;
|
|
3267
3360
|
links?: ObjectLinks;
|
|
@@ -3287,13 +3380,34 @@ export interface JsonApiAutomationOutList {
|
|
|
3287
3380
|
included?: Array<JsonApiAutomationOutIncludes>;
|
|
3288
3381
|
}
|
|
3289
3382
|
export interface JsonApiAutomationOutRelationships {
|
|
3290
|
-
notificationChannel?:
|
|
3383
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
3291
3384
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
3292
|
-
createdBy?:
|
|
3293
|
-
modifiedBy?:
|
|
3294
|
-
exportDefinitions?:
|
|
3295
|
-
recipients?:
|
|
3296
|
-
automationResults?:
|
|
3385
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3386
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3387
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
3388
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
3389
|
+
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
3390
|
+
}
|
|
3391
|
+
export interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
3392
|
+
/**
|
|
3393
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3394
|
+
*/
|
|
3395
|
+
data: Array<JsonApiAutomationResultLinkage>;
|
|
3396
|
+
}
|
|
3397
|
+
export interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
3398
|
+
/**
|
|
3399
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3400
|
+
*/
|
|
3401
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
3402
|
+
}
|
|
3403
|
+
export interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
3404
|
+
data: JsonApiNotificationChannelLinkage | null;
|
|
3405
|
+
}
|
|
3406
|
+
export interface JsonApiAutomationOutRelationshipsRecipients {
|
|
3407
|
+
/**
|
|
3408
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3409
|
+
*/
|
|
3410
|
+
data: Array<JsonApiUserLinkage>;
|
|
3297
3411
|
}
|
|
3298
3412
|
export interface JsonApiAutomationOutWithLinks {
|
|
3299
3413
|
/**
|
|
@@ -3304,8 +3418,8 @@ export interface JsonApiAutomationOutWithLinks {
|
|
|
3304
3418
|
* API identifier of an object
|
|
3305
3419
|
*/
|
|
3306
3420
|
id: string;
|
|
3307
|
-
meta?:
|
|
3308
|
-
attributes?:
|
|
3421
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3422
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
3309
3423
|
relationships?: JsonApiAutomationOutRelationships;
|
|
3310
3424
|
links?: ObjectLinks;
|
|
3311
3425
|
}
|
|
@@ -3497,16 +3611,9 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
3497
3611
|
* API identifier of an object
|
|
3498
3612
|
*/
|
|
3499
3613
|
id: string;
|
|
3500
|
-
attributes?:
|
|
3614
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
3501
3615
|
}
|
|
3502
3616
|
export type JsonApiCookieSecurityConfigurationInTypeEnum = "cookieSecurityConfiguration";
|
|
3503
|
-
export interface JsonApiCookieSecurityConfigurationInAttributes {
|
|
3504
|
-
lastRotation?: string;
|
|
3505
|
-
/**
|
|
3506
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
3507
|
-
*/
|
|
3508
|
-
rotationInterval?: string;
|
|
3509
|
-
}
|
|
3510
3617
|
export interface JsonApiCookieSecurityConfigurationInDocument {
|
|
3511
3618
|
data: JsonApiCookieSecurityConfigurationIn;
|
|
3512
3619
|
}
|
|
@@ -3522,7 +3629,7 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
3522
3629
|
* API identifier of an object
|
|
3523
3630
|
*/
|
|
3524
3631
|
id: string;
|
|
3525
|
-
attributes?:
|
|
3632
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
3526
3633
|
}
|
|
3527
3634
|
export type JsonApiCookieSecurityConfigurationOutTypeEnum = "cookieSecurityConfiguration";
|
|
3528
3635
|
export interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
@@ -3541,9 +3648,16 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
3541
3648
|
* API identifier of an object
|
|
3542
3649
|
*/
|
|
3543
3650
|
id: string;
|
|
3544
|
-
attributes?:
|
|
3651
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
3545
3652
|
}
|
|
3546
3653
|
export type JsonApiCookieSecurityConfigurationPatchTypeEnum = "cookieSecurityConfiguration";
|
|
3654
|
+
export interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
3655
|
+
lastRotation?: string;
|
|
3656
|
+
/**
|
|
3657
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
3658
|
+
*/
|
|
3659
|
+
rotationInterval?: string;
|
|
3660
|
+
}
|
|
3547
3661
|
export interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
3548
3662
|
data: JsonApiCookieSecurityConfigurationPatch;
|
|
3549
3663
|
}
|
|
@@ -3659,7 +3773,7 @@ export interface JsonApiCustomApplicationSettingOut {
|
|
|
3659
3773
|
* API identifier of an object
|
|
3660
3774
|
*/
|
|
3661
3775
|
id: string;
|
|
3662
|
-
meta?:
|
|
3776
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3663
3777
|
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
3664
3778
|
}
|
|
3665
3779
|
export type JsonApiCustomApplicationSettingOutTypeEnum = "customApplicationSetting";
|
|
@@ -3691,7 +3805,7 @@ export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
3691
3805
|
* API identifier of an object
|
|
3692
3806
|
*/
|
|
3693
3807
|
id: string;
|
|
3694
|
-
meta?:
|
|
3808
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3695
3809
|
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
3696
3810
|
links?: ObjectLinks;
|
|
3697
3811
|
}
|
|
@@ -3751,19 +3865,9 @@ export interface JsonApiDashboardPluginIn {
|
|
|
3751
3865
|
* API identifier of an object
|
|
3752
3866
|
*/
|
|
3753
3867
|
id: string;
|
|
3754
|
-
attributes?:
|
|
3868
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
3755
3869
|
}
|
|
3756
3870
|
export type JsonApiDashboardPluginInTypeEnum = "dashboardPlugin";
|
|
3757
|
-
export interface JsonApiDashboardPluginInAttributes {
|
|
3758
|
-
title?: string;
|
|
3759
|
-
description?: string;
|
|
3760
|
-
tags?: Array<string>;
|
|
3761
|
-
areRelationsValid?: boolean;
|
|
3762
|
-
/**
|
|
3763
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
3764
|
-
*/
|
|
3765
|
-
content?: object;
|
|
3766
|
-
}
|
|
3767
3871
|
export interface JsonApiDashboardPluginInDocument {
|
|
3768
3872
|
data: JsonApiDashboardPluginIn;
|
|
3769
3873
|
}
|
|
@@ -3787,7 +3891,7 @@ export interface JsonApiDashboardPluginOut {
|
|
|
3787
3891
|
* API identifier of an object
|
|
3788
3892
|
*/
|
|
3789
3893
|
id: string;
|
|
3790
|
-
meta?:
|
|
3894
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3791
3895
|
attributes?: JsonApiDashboardPluginOutAttributes;
|
|
3792
3896
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
3793
3897
|
}
|
|
@@ -3825,8 +3929,8 @@ export interface JsonApiDashboardPluginOutList {
|
|
|
3825
3929
|
included?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
3826
3930
|
}
|
|
3827
3931
|
export interface JsonApiDashboardPluginOutRelationships {
|
|
3828
|
-
createdBy?:
|
|
3829
|
-
modifiedBy?:
|
|
3932
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3933
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3830
3934
|
}
|
|
3831
3935
|
export interface JsonApiDashboardPluginOutWithLinks {
|
|
3832
3936
|
/**
|
|
@@ -3837,7 +3941,7 @@ export interface JsonApiDashboardPluginOutWithLinks {
|
|
|
3837
3941
|
* API identifier of an object
|
|
3838
3942
|
*/
|
|
3839
3943
|
id: string;
|
|
3840
|
-
meta?:
|
|
3944
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3841
3945
|
attributes?: JsonApiDashboardPluginOutAttributes;
|
|
3842
3946
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
3843
3947
|
links?: ObjectLinks;
|
|
@@ -3855,7 +3959,7 @@ export interface JsonApiDashboardPluginPatch {
|
|
|
3855
3959
|
* API identifier of an object
|
|
3856
3960
|
*/
|
|
3857
3961
|
id: string;
|
|
3858
|
-
attributes?:
|
|
3962
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
3859
3963
|
}
|
|
3860
3964
|
export type JsonApiDashboardPluginPatchTypeEnum = "dashboardPlugin";
|
|
3861
3965
|
export interface JsonApiDashboardPluginPatchDocument {
|
|
@@ -3873,9 +3977,19 @@ export interface JsonApiDashboardPluginPostOptionalId {
|
|
|
3873
3977
|
* API identifier of an object
|
|
3874
3978
|
*/
|
|
3875
3979
|
id?: string;
|
|
3876
|
-
attributes?:
|
|
3980
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
3877
3981
|
}
|
|
3878
3982
|
export type JsonApiDashboardPluginPostOptionalIdTypeEnum = "dashboardPlugin";
|
|
3983
|
+
export interface JsonApiDashboardPluginPostOptionalIdAttributes {
|
|
3984
|
+
title?: string;
|
|
3985
|
+
description?: string;
|
|
3986
|
+
tags?: Array<string>;
|
|
3987
|
+
areRelationsValid?: boolean;
|
|
3988
|
+
/**
|
|
3989
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
3990
|
+
*/
|
|
3991
|
+
content?: object;
|
|
3992
|
+
}
|
|
3879
3993
|
export interface JsonApiDashboardPluginPostOptionalIdDocument {
|
|
3880
3994
|
data: JsonApiDashboardPluginPostOptionalId;
|
|
3881
3995
|
}
|
|
@@ -4193,7 +4307,7 @@ export interface JsonApiDatasetOut {
|
|
|
4193
4307
|
* API identifier of an object
|
|
4194
4308
|
*/
|
|
4195
4309
|
id: string;
|
|
4196
|
-
meta?:
|
|
4310
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4197
4311
|
attributes: JsonApiDatasetOutAttributes;
|
|
4198
4312
|
relationships?: JsonApiDatasetOutRelationships;
|
|
4199
4313
|
}
|
|
@@ -4272,11 +4386,25 @@ export interface JsonApiDatasetOutList {
|
|
|
4272
4386
|
*/
|
|
4273
4387
|
included?: Array<JsonApiDatasetOutIncludes>;
|
|
4274
4388
|
}
|
|
4389
|
+
export interface JsonApiDatasetOutMeta {
|
|
4390
|
+
origin?: JsonApiDatasetOutMetaOrigin;
|
|
4391
|
+
}
|
|
4392
|
+
export interface JsonApiDatasetOutMetaOrigin {
|
|
4393
|
+
/**
|
|
4394
|
+
* defines type of the origin of the entity
|
|
4395
|
+
*/
|
|
4396
|
+
originType: JsonApiDatasetOutMetaOriginOriginTypeEnum;
|
|
4397
|
+
/**
|
|
4398
|
+
* defines id of the workspace where the entity comes from
|
|
4399
|
+
*/
|
|
4400
|
+
originId: string;
|
|
4401
|
+
}
|
|
4402
|
+
export type JsonApiDatasetOutMetaOriginOriginTypeEnum = "NATIVE" | "PARENT";
|
|
4275
4403
|
export interface JsonApiDatasetOutRelationships {
|
|
4276
4404
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
4277
4405
|
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
4278
4406
|
aggregatedFacts?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
4279
|
-
references?:
|
|
4407
|
+
references?: JsonApiDatasetOutRelationshipsReferences;
|
|
4280
4408
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
4281
4409
|
}
|
|
4282
4410
|
export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
@@ -4297,6 +4425,12 @@ export interface JsonApiDatasetOutRelationshipsFacts {
|
|
|
4297
4425
|
*/
|
|
4298
4426
|
data: Array<JsonApiFactLinkage>;
|
|
4299
4427
|
}
|
|
4428
|
+
export interface JsonApiDatasetOutRelationshipsReferences {
|
|
4429
|
+
/**
|
|
4430
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4431
|
+
*/
|
|
4432
|
+
data: Array<JsonApiDatasetLinkage>;
|
|
4433
|
+
}
|
|
4300
4434
|
export interface JsonApiDatasetOutRelationshipsWorkspaceDataFilters {
|
|
4301
4435
|
/**
|
|
4302
4436
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -4312,12 +4446,35 @@ export interface JsonApiDatasetOutWithLinks {
|
|
|
4312
4446
|
* API identifier of an object
|
|
4313
4447
|
*/
|
|
4314
4448
|
id: string;
|
|
4315
|
-
meta?:
|
|
4449
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4316
4450
|
attributes: JsonApiDatasetOutAttributes;
|
|
4317
4451
|
relationships?: JsonApiDatasetOutRelationships;
|
|
4318
4452
|
links?: ObjectLinks;
|
|
4319
4453
|
}
|
|
4320
4454
|
export type JsonApiDatasetOutWithLinksTypeEnum = "dataset";
|
|
4455
|
+
/**
|
|
4456
|
+
* JSON:API representation of patching dataset entity.
|
|
4457
|
+
*/
|
|
4458
|
+
export interface JsonApiDatasetPatch {
|
|
4459
|
+
/**
|
|
4460
|
+
* Object type
|
|
4461
|
+
*/
|
|
4462
|
+
type: JsonApiDatasetPatchTypeEnum;
|
|
4463
|
+
/**
|
|
4464
|
+
* API identifier of an object
|
|
4465
|
+
*/
|
|
4466
|
+
id: string;
|
|
4467
|
+
attributes?: JsonApiDatasetPatchAttributes;
|
|
4468
|
+
}
|
|
4469
|
+
export type JsonApiDatasetPatchTypeEnum = "dataset";
|
|
4470
|
+
export interface JsonApiDatasetPatchAttributes {
|
|
4471
|
+
title?: string;
|
|
4472
|
+
description?: string;
|
|
4473
|
+
tags?: Array<string>;
|
|
4474
|
+
}
|
|
4475
|
+
export interface JsonApiDatasetPatchDocument {
|
|
4476
|
+
data: JsonApiDatasetPatch;
|
|
4477
|
+
}
|
|
4321
4478
|
/**
|
|
4322
4479
|
* JSON:API representation of entitlement entity.
|
|
4323
4480
|
*/
|
|
@@ -4374,24 +4531,13 @@ export interface JsonApiExportDefinitionIn {
|
|
|
4374
4531
|
* API identifier of an object
|
|
4375
4532
|
*/
|
|
4376
4533
|
id: string;
|
|
4377
|
-
attributes?:
|
|
4378
|
-
relationships?:
|
|
4534
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
4535
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
4379
4536
|
}
|
|
4380
4537
|
export type JsonApiExportDefinitionInTypeEnum = "exportDefinition";
|
|
4381
|
-
export interface JsonApiExportDefinitionInAttributes {
|
|
4382
|
-
title?: string;
|
|
4383
|
-
description?: string;
|
|
4384
|
-
tags?: Array<string>;
|
|
4385
|
-
requestPayload?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
4386
|
-
areRelationsValid?: boolean;
|
|
4387
|
-
}
|
|
4388
4538
|
export interface JsonApiExportDefinitionInDocument {
|
|
4389
4539
|
data: JsonApiExportDefinitionIn;
|
|
4390
4540
|
}
|
|
4391
|
-
export interface JsonApiExportDefinitionInRelationships {
|
|
4392
|
-
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
4393
|
-
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
4394
|
-
}
|
|
4395
4541
|
/**
|
|
4396
4542
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
4397
4543
|
*/
|
|
@@ -4412,7 +4558,7 @@ export interface JsonApiExportDefinitionOut {
|
|
|
4412
4558
|
* API identifier of an object
|
|
4413
4559
|
*/
|
|
4414
4560
|
id: string;
|
|
4415
|
-
meta?:
|
|
4561
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4416
4562
|
attributes?: JsonApiExportDefinitionOutAttributes;
|
|
4417
4563
|
relationships?: JsonApiExportDefinitionOutRelationships;
|
|
4418
4564
|
}
|
|
@@ -4455,15 +4601,12 @@ export interface JsonApiExportDefinitionOutList {
|
|
|
4455
4601
|
*/
|
|
4456
4602
|
included?: Array<JsonApiExportDefinitionOutIncludes>;
|
|
4457
4603
|
}
|
|
4458
|
-
export interface JsonApiExportDefinitionOutMeta {
|
|
4459
|
-
origin?: JsonApiAnalyticalDashboardOutMetaOrigin;
|
|
4460
|
-
}
|
|
4461
4604
|
export interface JsonApiExportDefinitionOutRelationships {
|
|
4462
4605
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
4463
4606
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
4464
4607
|
automation?: JsonApiExportDefinitionOutRelationshipsAutomation;
|
|
4465
|
-
createdBy?:
|
|
4466
|
-
modifiedBy?:
|
|
4608
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
4609
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
4467
4610
|
}
|
|
4468
4611
|
export interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
4469
4612
|
data: JsonApiAnalyticalDashboardLinkage | null;
|
|
@@ -4483,7 +4626,7 @@ export interface JsonApiExportDefinitionOutWithLinks {
|
|
|
4483
4626
|
* API identifier of an object
|
|
4484
4627
|
*/
|
|
4485
4628
|
id: string;
|
|
4486
|
-
meta?:
|
|
4629
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4487
4630
|
attributes?: JsonApiExportDefinitionOutAttributes;
|
|
4488
4631
|
relationships?: JsonApiExportDefinitionOutRelationships;
|
|
4489
4632
|
links?: ObjectLinks;
|
|
@@ -4501,8 +4644,8 @@ export interface JsonApiExportDefinitionPatch {
|
|
|
4501
4644
|
* API identifier of an object
|
|
4502
4645
|
*/
|
|
4503
4646
|
id: string;
|
|
4504
|
-
attributes?:
|
|
4505
|
-
relationships?:
|
|
4647
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
4648
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
4506
4649
|
}
|
|
4507
4650
|
export type JsonApiExportDefinitionPatchTypeEnum = "exportDefinition";
|
|
4508
4651
|
export interface JsonApiExportDefinitionPatchDocument {
|
|
@@ -4520,13 +4663,24 @@ export interface JsonApiExportDefinitionPostOptionalId {
|
|
|
4520
4663
|
* API identifier of an object
|
|
4521
4664
|
*/
|
|
4522
4665
|
id?: string;
|
|
4523
|
-
attributes?:
|
|
4524
|
-
relationships?:
|
|
4666
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
4667
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
4525
4668
|
}
|
|
4526
4669
|
export type JsonApiExportDefinitionPostOptionalIdTypeEnum = "exportDefinition";
|
|
4670
|
+
export interface JsonApiExportDefinitionPostOptionalIdAttributes {
|
|
4671
|
+
title?: string;
|
|
4672
|
+
description?: string;
|
|
4673
|
+
tags?: Array<string>;
|
|
4674
|
+
requestPayload?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
4675
|
+
areRelationsValid?: boolean;
|
|
4676
|
+
}
|
|
4527
4677
|
export interface JsonApiExportDefinitionPostOptionalIdDocument {
|
|
4528
4678
|
data: JsonApiExportDefinitionPostOptionalId;
|
|
4529
4679
|
}
|
|
4680
|
+
export interface JsonApiExportDefinitionPostOptionalIdRelationships {
|
|
4681
|
+
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
4682
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
4683
|
+
}
|
|
4530
4684
|
/**
|
|
4531
4685
|
* JSON:API representation of exportTemplate entity.
|
|
4532
4686
|
*/
|
|
@@ -4682,7 +4836,7 @@ export interface JsonApiFactOut {
|
|
|
4682
4836
|
* API identifier of an object
|
|
4683
4837
|
*/
|
|
4684
4838
|
id: string;
|
|
4685
|
-
meta?:
|
|
4839
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4686
4840
|
attributes?: JsonApiFactOutAttributes;
|
|
4687
4841
|
relationships?: JsonApiFactOutRelationships;
|
|
4688
4842
|
}
|
|
@@ -4732,12 +4886,30 @@ export interface JsonApiFactOutWithLinks {
|
|
|
4732
4886
|
* API identifier of an object
|
|
4733
4887
|
*/
|
|
4734
4888
|
id: string;
|
|
4735
|
-
meta?:
|
|
4889
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4736
4890
|
attributes?: JsonApiFactOutAttributes;
|
|
4737
4891
|
relationships?: JsonApiFactOutRelationships;
|
|
4738
4892
|
links?: ObjectLinks;
|
|
4739
4893
|
}
|
|
4740
4894
|
export type JsonApiFactOutWithLinksTypeEnum = "fact";
|
|
4895
|
+
/**
|
|
4896
|
+
* JSON:API representation of patching fact entity.
|
|
4897
|
+
*/
|
|
4898
|
+
export interface JsonApiFactPatch {
|
|
4899
|
+
/**
|
|
4900
|
+
* Object type
|
|
4901
|
+
*/
|
|
4902
|
+
type: JsonApiFactPatchTypeEnum;
|
|
4903
|
+
/**
|
|
4904
|
+
* API identifier of an object
|
|
4905
|
+
*/
|
|
4906
|
+
id: string;
|
|
4907
|
+
attributes?: JsonApiDatasetPatchAttributes;
|
|
4908
|
+
}
|
|
4909
|
+
export type JsonApiFactPatchTypeEnum = "fact";
|
|
4910
|
+
export interface JsonApiFactPatchDocument {
|
|
4911
|
+
data: JsonApiFactPatch;
|
|
4912
|
+
}
|
|
4741
4913
|
/**
|
|
4742
4914
|
* JSON:API representation of filterContext entity.
|
|
4743
4915
|
*/
|
|
@@ -4776,7 +4948,7 @@ export interface JsonApiFilterContextOut {
|
|
|
4776
4948
|
* API identifier of an object
|
|
4777
4949
|
*/
|
|
4778
4950
|
id: string;
|
|
4779
|
-
meta?:
|
|
4951
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4780
4952
|
attributes: JsonApiFilterContextOutAttributes;
|
|
4781
4953
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
4782
4954
|
}
|
|
@@ -4817,8 +4989,8 @@ export interface JsonApiFilterContextOutList {
|
|
|
4817
4989
|
}
|
|
4818
4990
|
export interface JsonApiFilterContextOutRelationships {
|
|
4819
4991
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
4820
|
-
datasets?:
|
|
4821
|
-
labels?:
|
|
4992
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
4993
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
4822
4994
|
}
|
|
4823
4995
|
export interface JsonApiFilterContextOutWithLinks {
|
|
4824
4996
|
/**
|
|
@@ -4829,7 +5001,7 @@ export interface JsonApiFilterContextOutWithLinks {
|
|
|
4829
5001
|
* API identifier of an object
|
|
4830
5002
|
*/
|
|
4831
5003
|
id: string;
|
|
4832
|
-
meta?:
|
|
5004
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4833
5005
|
attributes: JsonApiFilterContextOutAttributes;
|
|
4834
5006
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
4835
5007
|
links?: ObjectLinks;
|
|
@@ -4946,10 +5118,7 @@ export interface JsonApiFilterViewOutList {
|
|
|
4946
5118
|
}
|
|
4947
5119
|
export interface JsonApiFilterViewOutRelationships {
|
|
4948
5120
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
4949
|
-
user?:
|
|
4950
|
-
}
|
|
4951
|
-
export interface JsonApiFilterViewOutRelationshipsUser {
|
|
4952
|
-
data: JsonApiUserLinkage | null;
|
|
5121
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
4953
5122
|
}
|
|
4954
5123
|
export interface JsonApiFilterViewOutWithLinks {
|
|
4955
5124
|
/**
|
|
@@ -5010,60 +5179,9 @@ export interface JsonApiIdentityProviderIn {
|
|
|
5010
5179
|
* API identifier of an object
|
|
5011
5180
|
*/
|
|
5012
5181
|
id: string;
|
|
5013
|
-
attributes?:
|
|
5182
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
5014
5183
|
}
|
|
5015
5184
|
export type JsonApiIdentityProviderInTypeEnum = "identityProvider";
|
|
5016
|
-
export interface JsonApiIdentityProviderInAttributes {
|
|
5017
|
-
/**
|
|
5018
|
-
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
5019
|
-
*/
|
|
5020
|
-
identifiers?: Array<string>;
|
|
5021
|
-
/**
|
|
5022
|
-
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
5023
|
-
*/
|
|
5024
|
-
customClaimMapping?: {
|
|
5025
|
-
[key: string]: string;
|
|
5026
|
-
};
|
|
5027
|
-
/**
|
|
5028
|
-
* Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
|
|
5029
|
-
*/
|
|
5030
|
-
samlMetadata?: string;
|
|
5031
|
-
/**
|
|
5032
|
-
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5033
|
-
*/
|
|
5034
|
-
oauthClientId?: string;
|
|
5035
|
-
/**
|
|
5036
|
-
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5037
|
-
*/
|
|
5038
|
-
oauthClientSecret?: string;
|
|
5039
|
-
/**
|
|
5040
|
-
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5041
|
-
*/
|
|
5042
|
-
oauthIssuerLocation?: string;
|
|
5043
|
-
/**
|
|
5044
|
-
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
5045
|
-
*/
|
|
5046
|
-
oauthIssuerId?: string;
|
|
5047
|
-
/**
|
|
5048
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
5049
|
-
*/
|
|
5050
|
-
oauthSubjectIdClaim?: string;
|
|
5051
|
-
/**
|
|
5052
|
-
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
5053
|
-
*/
|
|
5054
|
-
oauthCustomAuthAttributes?: {
|
|
5055
|
-
[key: string]: string;
|
|
5056
|
-
};
|
|
5057
|
-
/**
|
|
5058
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
5059
|
-
*/
|
|
5060
|
-
oauthCustomScopes?: Array<string> | null;
|
|
5061
|
-
/**
|
|
5062
|
-
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
5063
|
-
*/
|
|
5064
|
-
idpType?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
|
|
5065
|
-
}
|
|
5066
|
-
export type JsonApiIdentityProviderInAttributesIdpTypeEnum = "MANAGED_IDP" | "FIM_IDP" | "DEX_IDP" | "CUSTOM_IDP";
|
|
5067
5185
|
export interface JsonApiIdentityProviderInDocument {
|
|
5068
5186
|
data: JsonApiIdentityProviderIn;
|
|
5069
5187
|
}
|
|
@@ -5170,9 +5288,60 @@ export interface JsonApiIdentityProviderPatch {
|
|
|
5170
5288
|
* API identifier of an object
|
|
5171
5289
|
*/
|
|
5172
5290
|
id: string;
|
|
5173
|
-
attributes?:
|
|
5291
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
5174
5292
|
}
|
|
5175
5293
|
export type JsonApiIdentityProviderPatchTypeEnum = "identityProvider";
|
|
5294
|
+
export interface JsonApiIdentityProviderPatchAttributes {
|
|
5295
|
+
/**
|
|
5296
|
+
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
5297
|
+
*/
|
|
5298
|
+
identifiers?: Array<string>;
|
|
5299
|
+
/**
|
|
5300
|
+
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
5301
|
+
*/
|
|
5302
|
+
customClaimMapping?: {
|
|
5303
|
+
[key: string]: string;
|
|
5304
|
+
};
|
|
5305
|
+
/**
|
|
5306
|
+
* Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
|
|
5307
|
+
*/
|
|
5308
|
+
samlMetadata?: string;
|
|
5309
|
+
/**
|
|
5310
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5311
|
+
*/
|
|
5312
|
+
oauthClientId?: string;
|
|
5313
|
+
/**
|
|
5314
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5315
|
+
*/
|
|
5316
|
+
oauthClientSecret?: string;
|
|
5317
|
+
/**
|
|
5318
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5319
|
+
*/
|
|
5320
|
+
oauthIssuerLocation?: string;
|
|
5321
|
+
/**
|
|
5322
|
+
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
5323
|
+
*/
|
|
5324
|
+
oauthIssuerId?: string;
|
|
5325
|
+
/**
|
|
5326
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
5327
|
+
*/
|
|
5328
|
+
oauthSubjectIdClaim?: string;
|
|
5329
|
+
/**
|
|
5330
|
+
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
5331
|
+
*/
|
|
5332
|
+
oauthCustomAuthAttributes?: {
|
|
5333
|
+
[key: string]: string;
|
|
5334
|
+
};
|
|
5335
|
+
/**
|
|
5336
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
5337
|
+
*/
|
|
5338
|
+
oauthCustomScopes?: Array<string> | null;
|
|
5339
|
+
/**
|
|
5340
|
+
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
5341
|
+
*/
|
|
5342
|
+
idpType?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
5343
|
+
}
|
|
5344
|
+
export type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = "MANAGED_IDP" | "FIM_IDP" | "DEX_IDP" | "CUSTOM_IDP";
|
|
5176
5345
|
export interface JsonApiIdentityProviderPatchDocument {
|
|
5177
5346
|
data: JsonApiIdentityProviderPatch;
|
|
5178
5347
|
}
|
|
@@ -5275,7 +5444,7 @@ export interface JsonApiLabelOut {
|
|
|
5275
5444
|
* API identifier of an object
|
|
5276
5445
|
*/
|
|
5277
5446
|
id: string;
|
|
5278
|
-
meta?:
|
|
5447
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5279
5448
|
attributes?: JsonApiLabelOutAttributes;
|
|
5280
5449
|
relationships?: JsonApiLabelOutRelationships;
|
|
5281
5450
|
}
|
|
@@ -5341,12 +5510,37 @@ export interface JsonApiLabelOutWithLinks {
|
|
|
5341
5510
|
* API identifier of an object
|
|
5342
5511
|
*/
|
|
5343
5512
|
id: string;
|
|
5344
|
-
meta?:
|
|
5513
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5345
5514
|
attributes?: JsonApiLabelOutAttributes;
|
|
5346
5515
|
relationships?: JsonApiLabelOutRelationships;
|
|
5347
5516
|
links?: ObjectLinks;
|
|
5348
5517
|
}
|
|
5349
5518
|
export type JsonApiLabelOutWithLinksTypeEnum = "label";
|
|
5519
|
+
/**
|
|
5520
|
+
* JSON:API representation of patching label entity.
|
|
5521
|
+
*/
|
|
5522
|
+
export interface JsonApiLabelPatch {
|
|
5523
|
+
/**
|
|
5524
|
+
* Object type
|
|
5525
|
+
*/
|
|
5526
|
+
type: JsonApiLabelPatchTypeEnum;
|
|
5527
|
+
/**
|
|
5528
|
+
* API identifier of an object
|
|
5529
|
+
*/
|
|
5530
|
+
id: string;
|
|
5531
|
+
attributes?: JsonApiLabelPatchAttributes;
|
|
5532
|
+
}
|
|
5533
|
+
export type JsonApiLabelPatchTypeEnum = "label";
|
|
5534
|
+
export interface JsonApiLabelPatchAttributes {
|
|
5535
|
+
title?: string;
|
|
5536
|
+
description?: string;
|
|
5537
|
+
tags?: Array<string>;
|
|
5538
|
+
locale?: string;
|
|
5539
|
+
translations?: Array<JsonApiLabelOutAttributesTranslationsInner>;
|
|
5540
|
+
}
|
|
5541
|
+
export interface JsonApiLabelPatchDocument {
|
|
5542
|
+
data: JsonApiLabelPatch;
|
|
5543
|
+
}
|
|
5350
5544
|
/**
|
|
5351
5545
|
* JSON:API representation of llmEndpoint entity.
|
|
5352
5546
|
*/
|
|
@@ -5512,32 +5706,9 @@ export interface JsonApiMemoryItemIn {
|
|
|
5512
5706
|
* API identifier of an object
|
|
5513
5707
|
*/
|
|
5514
5708
|
id: string;
|
|
5515
|
-
attributes:
|
|
5709
|
+
attributes: JsonApiMemoryItemPostOptionalIdAttributes;
|
|
5516
5710
|
}
|
|
5517
5711
|
export type JsonApiMemoryItemInTypeEnum = "memoryItem";
|
|
5518
|
-
export interface JsonApiMemoryItemInAttributes {
|
|
5519
|
-
title?: string;
|
|
5520
|
-
description?: string;
|
|
5521
|
-
tags?: Array<string>;
|
|
5522
|
-
areRelationsValid?: boolean;
|
|
5523
|
-
/**
|
|
5524
|
-
* Strategy defining when the memory item should be applied
|
|
5525
|
-
*/
|
|
5526
|
-
strategy: JsonApiMemoryItemInAttributesStrategyEnum;
|
|
5527
|
-
/**
|
|
5528
|
-
* The text that will be injected into the system prompt
|
|
5529
|
-
*/
|
|
5530
|
-
instruction: string;
|
|
5531
|
-
/**
|
|
5532
|
-
* Set of unique strings used for semantic similarity filtering
|
|
5533
|
-
*/
|
|
5534
|
-
keywords?: Array<string>;
|
|
5535
|
-
/**
|
|
5536
|
-
* Whether memory item is disabled
|
|
5537
|
-
*/
|
|
5538
|
-
isDisabled?: boolean;
|
|
5539
|
-
}
|
|
5540
|
-
export type JsonApiMemoryItemInAttributesStrategyEnum = "ALWAYS" | "AUTO";
|
|
5541
5712
|
export interface JsonApiMemoryItemInDocument {
|
|
5542
5713
|
data: JsonApiMemoryItemIn;
|
|
5543
5714
|
}
|
|
@@ -5553,7 +5724,7 @@ export interface JsonApiMemoryItemOut {
|
|
|
5553
5724
|
* API identifier of an object
|
|
5554
5725
|
*/
|
|
5555
5726
|
id: string;
|
|
5556
|
-
meta?:
|
|
5727
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5557
5728
|
attributes: JsonApiMemoryItemOutAttributes;
|
|
5558
5729
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
5559
5730
|
}
|
|
@@ -5612,7 +5783,7 @@ export interface JsonApiMemoryItemOutWithLinks {
|
|
|
5612
5783
|
* API identifier of an object
|
|
5613
5784
|
*/
|
|
5614
5785
|
id: string;
|
|
5615
|
-
meta?:
|
|
5786
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5616
5787
|
attributes: JsonApiMemoryItemOutAttributes;
|
|
5617
5788
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
5618
5789
|
links?: ObjectLinks;
|
|
@@ -5671,9 +5842,32 @@ export interface JsonApiMemoryItemPostOptionalId {
|
|
|
5671
5842
|
* API identifier of an object
|
|
5672
5843
|
*/
|
|
5673
5844
|
id?: string;
|
|
5674
|
-
attributes:
|
|
5845
|
+
attributes: JsonApiMemoryItemPostOptionalIdAttributes;
|
|
5675
5846
|
}
|
|
5676
5847
|
export type JsonApiMemoryItemPostOptionalIdTypeEnum = "memoryItem";
|
|
5848
|
+
export interface JsonApiMemoryItemPostOptionalIdAttributes {
|
|
5849
|
+
title?: string;
|
|
5850
|
+
description?: string;
|
|
5851
|
+
tags?: Array<string>;
|
|
5852
|
+
areRelationsValid?: boolean;
|
|
5853
|
+
/**
|
|
5854
|
+
* Strategy defining when the memory item should be applied
|
|
5855
|
+
*/
|
|
5856
|
+
strategy: JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum;
|
|
5857
|
+
/**
|
|
5858
|
+
* The text that will be injected into the system prompt
|
|
5859
|
+
*/
|
|
5860
|
+
instruction: string;
|
|
5861
|
+
/**
|
|
5862
|
+
* Set of unique strings used for semantic similarity filtering
|
|
5863
|
+
*/
|
|
5864
|
+
keywords?: Array<string>;
|
|
5865
|
+
/**
|
|
5866
|
+
* Whether memory item is disabled
|
|
5867
|
+
*/
|
|
5868
|
+
isDisabled?: boolean;
|
|
5869
|
+
}
|
|
5870
|
+
export type JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum = "ALWAYS" | "AUTO";
|
|
5677
5871
|
export interface JsonApiMemoryItemPostOptionalIdDocument {
|
|
5678
5872
|
data: JsonApiMemoryItemPostOptionalId;
|
|
5679
5873
|
}
|
|
@@ -5689,17 +5883,9 @@ export interface JsonApiMetricIn {
|
|
|
5689
5883
|
* API identifier of an object
|
|
5690
5884
|
*/
|
|
5691
5885
|
id: string;
|
|
5692
|
-
attributes:
|
|
5886
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
5693
5887
|
}
|
|
5694
5888
|
export type JsonApiMetricInTypeEnum = "metric";
|
|
5695
|
-
export interface JsonApiMetricInAttributes {
|
|
5696
|
-
title?: string;
|
|
5697
|
-
description?: string;
|
|
5698
|
-
tags?: Array<string>;
|
|
5699
|
-
areRelationsValid?: boolean;
|
|
5700
|
-
content: JsonApiMetricOutAttributesContent;
|
|
5701
|
-
isHidden?: boolean;
|
|
5702
|
-
}
|
|
5703
5889
|
export interface JsonApiMetricInDocument {
|
|
5704
5890
|
data: JsonApiMetricIn;
|
|
5705
5891
|
}
|
|
@@ -5723,7 +5909,7 @@ export interface JsonApiMetricOut {
|
|
|
5723
5909
|
* API identifier of an object
|
|
5724
5910
|
*/
|
|
5725
5911
|
id: string;
|
|
5726
|
-
meta?:
|
|
5912
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5727
5913
|
attributes: JsonApiMetricOutAttributes;
|
|
5728
5914
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
5729
5915
|
}
|
|
@@ -5780,7 +5966,7 @@ export interface JsonApiMetricOutWithLinks {
|
|
|
5780
5966
|
* API identifier of an object
|
|
5781
5967
|
*/
|
|
5782
5968
|
id: string;
|
|
5783
|
-
meta?:
|
|
5969
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5784
5970
|
attributes: JsonApiMetricOutAttributes;
|
|
5785
5971
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
5786
5972
|
links?: ObjectLinks;
|
|
@@ -5824,9 +6010,17 @@ export interface JsonApiMetricPostOptionalId {
|
|
|
5824
6010
|
* API identifier of an object
|
|
5825
6011
|
*/
|
|
5826
6012
|
id?: string;
|
|
5827
|
-
attributes:
|
|
6013
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
5828
6014
|
}
|
|
5829
6015
|
export type JsonApiMetricPostOptionalIdTypeEnum = "metric";
|
|
6016
|
+
export interface JsonApiMetricPostOptionalIdAttributes {
|
|
6017
|
+
title?: string;
|
|
6018
|
+
description?: string;
|
|
6019
|
+
tags?: Array<string>;
|
|
6020
|
+
areRelationsValid?: boolean;
|
|
6021
|
+
content: JsonApiMetricOutAttributesContent;
|
|
6022
|
+
isHidden?: boolean;
|
|
6023
|
+
}
|
|
5830
6024
|
export interface JsonApiMetricPostOptionalIdDocument {
|
|
5831
6025
|
data: JsonApiMetricPostOptionalId;
|
|
5832
6026
|
}
|
|
@@ -5893,37 +6087,9 @@ export interface JsonApiNotificationChannelIn {
|
|
|
5893
6087
|
* API identifier of an object
|
|
5894
6088
|
*/
|
|
5895
6089
|
id: string;
|
|
5896
|
-
attributes?:
|
|
6090
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
5897
6091
|
}
|
|
5898
6092
|
export type JsonApiNotificationChannelInTypeEnum = "notificationChannel";
|
|
5899
|
-
export interface JsonApiNotificationChannelInAttributes {
|
|
5900
|
-
name?: string | null;
|
|
5901
|
-
description?: string | null;
|
|
5902
|
-
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
5903
|
-
/**
|
|
5904
|
-
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
5905
|
-
*/
|
|
5906
|
-
customDashboardUrl?: string;
|
|
5907
|
-
/**
|
|
5908
|
-
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
5909
|
-
*/
|
|
5910
|
-
dashboardLinkVisibility?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
|
|
5911
|
-
/**
|
|
5912
|
-
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
5913
|
-
*/
|
|
5914
|
-
notificationSource?: string;
|
|
5915
|
-
/**
|
|
5916
|
-
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
5917
|
-
*/
|
|
5918
|
-
allowedRecipients?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
|
|
5919
|
-
/**
|
|
5920
|
-
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
5921
|
-
*/
|
|
5922
|
-
inPlatformNotification?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
|
|
5923
|
-
}
|
|
5924
|
-
export type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = "HIDDEN" | "INTERNAL_ONLY" | "ALL";
|
|
5925
|
-
export type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = "CREATOR" | "INTERNAL" | "EXTERNAL";
|
|
5926
|
-
export type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = "DISABLED" | "ENABLED";
|
|
5927
6093
|
export interface JsonApiNotificationChannelInDocument {
|
|
5928
6094
|
data: JsonApiNotificationChannelIn;
|
|
5929
6095
|
}
|
|
@@ -6022,9 +6188,37 @@ export interface JsonApiNotificationChannelPatch {
|
|
|
6022
6188
|
* API identifier of an object
|
|
6023
6189
|
*/
|
|
6024
6190
|
id: string;
|
|
6025
|
-
attributes?:
|
|
6191
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
6026
6192
|
}
|
|
6027
6193
|
export type JsonApiNotificationChannelPatchTypeEnum = "notificationChannel";
|
|
6194
|
+
export interface JsonApiNotificationChannelPatchAttributes {
|
|
6195
|
+
name?: string | null;
|
|
6196
|
+
description?: string | null;
|
|
6197
|
+
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
6198
|
+
/**
|
|
6199
|
+
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
6200
|
+
*/
|
|
6201
|
+
customDashboardUrl?: string;
|
|
6202
|
+
/**
|
|
6203
|
+
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
6204
|
+
*/
|
|
6205
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
|
|
6206
|
+
/**
|
|
6207
|
+
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
6208
|
+
*/
|
|
6209
|
+
notificationSource?: string;
|
|
6210
|
+
/**
|
|
6211
|
+
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
6212
|
+
*/
|
|
6213
|
+
allowedRecipients?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
|
|
6214
|
+
/**
|
|
6215
|
+
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
6216
|
+
*/
|
|
6217
|
+
inPlatformNotification?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
|
|
6218
|
+
}
|
|
6219
|
+
export type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = "HIDDEN" | "INTERNAL_ONLY" | "ALL";
|
|
6220
|
+
export type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = "CREATOR" | "INTERNAL" | "EXTERNAL";
|
|
6221
|
+
export type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = "DISABLED" | "ENABLED";
|
|
6028
6222
|
export interface JsonApiNotificationChannelPatchDocument {
|
|
6029
6223
|
data: JsonApiNotificationChannelPatch;
|
|
6030
6224
|
}
|
|
@@ -6040,7 +6234,7 @@ export interface JsonApiNotificationChannelPostOptionalId {
|
|
|
6040
6234
|
* API identifier of an object
|
|
6041
6235
|
*/
|
|
6042
6236
|
id?: string;
|
|
6043
|
-
attributes?:
|
|
6237
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
6044
6238
|
}
|
|
6045
6239
|
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = "notificationChannel";
|
|
6046
6240
|
export interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
@@ -6058,33 +6252,13 @@ export interface JsonApiOrganizationIn {
|
|
|
6058
6252
|
* API identifier of an object
|
|
6059
6253
|
*/
|
|
6060
6254
|
id: string;
|
|
6061
|
-
attributes?:
|
|
6062
|
-
relationships?:
|
|
6255
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
6256
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
6063
6257
|
}
|
|
6064
6258
|
export type JsonApiOrganizationInTypeEnum = "organization";
|
|
6065
|
-
export interface JsonApiOrganizationInAttributes {
|
|
6066
|
-
name?: string | null;
|
|
6067
|
-
hostname?: string;
|
|
6068
|
-
allowedOrigins?: Array<string>;
|
|
6069
|
-
/**
|
|
6070
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
6071
|
-
* @deprecated
|
|
6072
|
-
*/
|
|
6073
|
-
earlyAccess?: string | null;
|
|
6074
|
-
/**
|
|
6075
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
6076
|
-
*/
|
|
6077
|
-
earlyAccessValues?: Array<string> | null;
|
|
6078
|
-
}
|
|
6079
6259
|
export interface JsonApiOrganizationInDocument {
|
|
6080
6260
|
data: JsonApiOrganizationIn;
|
|
6081
6261
|
}
|
|
6082
|
-
export interface JsonApiOrganizationInRelationships {
|
|
6083
|
-
identityProvider?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
6084
|
-
}
|
|
6085
|
-
export interface JsonApiOrganizationInRelationshipsIdentityProvider {
|
|
6086
|
-
data: JsonApiIdentityProviderLinkage | null;
|
|
6087
|
-
}
|
|
6088
6262
|
/**
|
|
6089
6263
|
* JSON:API representation of organization entity.
|
|
6090
6264
|
*/
|
|
@@ -6142,9 +6316,15 @@ export interface JsonApiOrganizationOutMeta {
|
|
|
6142
6316
|
}
|
|
6143
6317
|
export type JsonApiOrganizationOutMetaPermissionsEnum = "MANAGE" | "SELF_CREATE_TOKEN";
|
|
6144
6318
|
export interface JsonApiOrganizationOutRelationships {
|
|
6145
|
-
bootstrapUser?:
|
|
6146
|
-
bootstrapUserGroup?:
|
|
6147
|
-
identityProvider?:
|
|
6319
|
+
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
6320
|
+
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
6321
|
+
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
6322
|
+
}
|
|
6323
|
+
export interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
6324
|
+
data: JsonApiUserLinkage | null;
|
|
6325
|
+
}
|
|
6326
|
+
export interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
6327
|
+
data: JsonApiUserGroupLinkage | null;
|
|
6148
6328
|
}
|
|
6149
6329
|
/**
|
|
6150
6330
|
* JSON:API representation of patching organization entity.
|
|
@@ -6158,13 +6338,33 @@ export interface JsonApiOrganizationPatch {
|
|
|
6158
6338
|
* API identifier of an object
|
|
6159
6339
|
*/
|
|
6160
6340
|
id: string;
|
|
6161
|
-
attributes?:
|
|
6162
|
-
relationships?:
|
|
6341
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
6342
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
6163
6343
|
}
|
|
6164
6344
|
export type JsonApiOrganizationPatchTypeEnum = "organization";
|
|
6345
|
+
export interface JsonApiOrganizationPatchAttributes {
|
|
6346
|
+
name?: string | null;
|
|
6347
|
+
hostname?: string;
|
|
6348
|
+
allowedOrigins?: Array<string>;
|
|
6349
|
+
/**
|
|
6350
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
6351
|
+
* @deprecated
|
|
6352
|
+
*/
|
|
6353
|
+
earlyAccess?: string | null;
|
|
6354
|
+
/**
|
|
6355
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
6356
|
+
*/
|
|
6357
|
+
earlyAccessValues?: Array<string> | null;
|
|
6358
|
+
}
|
|
6165
6359
|
export interface JsonApiOrganizationPatchDocument {
|
|
6166
6360
|
data: JsonApiOrganizationPatch;
|
|
6167
6361
|
}
|
|
6362
|
+
export interface JsonApiOrganizationPatchRelationships {
|
|
6363
|
+
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
6364
|
+
}
|
|
6365
|
+
export interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
6366
|
+
data: JsonApiIdentityProviderLinkage | null;
|
|
6367
|
+
}
|
|
6168
6368
|
/**
|
|
6169
6369
|
* JSON:API representation of organizationSetting entity.
|
|
6170
6370
|
*/
|
|
@@ -6177,7 +6377,7 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
6177
6377
|
* API identifier of an object
|
|
6178
6378
|
*/
|
|
6179
6379
|
id: string;
|
|
6180
|
-
attributes?:
|
|
6380
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6181
6381
|
}
|
|
6182
6382
|
export type JsonApiOrganizationSettingInTypeEnum = "organizationSetting";
|
|
6183
6383
|
export interface JsonApiOrganizationSettingInDocument {
|
|
@@ -6195,17 +6395,9 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
6195
6395
|
* API identifier of an object
|
|
6196
6396
|
*/
|
|
6197
6397
|
id: string;
|
|
6198
|
-
attributes?:
|
|
6398
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6199
6399
|
}
|
|
6200
6400
|
export type JsonApiOrganizationSettingOutTypeEnum = "organizationSetting";
|
|
6201
|
-
export interface JsonApiOrganizationSettingOutAttributes {
|
|
6202
|
-
/**
|
|
6203
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
6204
|
-
*/
|
|
6205
|
-
content?: object;
|
|
6206
|
-
type?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
6207
|
-
}
|
|
6208
|
-
export type JsonApiOrganizationSettingOutAttributesTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE";
|
|
6209
6401
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
6210
6402
|
data: JsonApiOrganizationSettingOut;
|
|
6211
6403
|
links?: ObjectLinks;
|
|
@@ -6227,7 +6419,7 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
6227
6419
|
* API identifier of an object
|
|
6228
6420
|
*/
|
|
6229
6421
|
id: string;
|
|
6230
|
-
attributes?:
|
|
6422
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6231
6423
|
links?: ObjectLinks;
|
|
6232
6424
|
}
|
|
6233
6425
|
export type JsonApiOrganizationSettingOutWithLinksTypeEnum = "organizationSetting";
|
|
@@ -6243,7 +6435,7 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
6243
6435
|
* API identifier of an object
|
|
6244
6436
|
*/
|
|
6245
6437
|
id: string;
|
|
6246
|
-
attributes?:
|
|
6438
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6247
6439
|
}
|
|
6248
6440
|
export type JsonApiOrganizationSettingPatchTypeEnum = "organizationSetting";
|
|
6249
6441
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -6338,16 +6530,12 @@ export interface JsonApiUserDataFilterIn {
|
|
|
6338
6530
|
*/
|
|
6339
6531
|
id: string;
|
|
6340
6532
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
6341
|
-
relationships?:
|
|
6533
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
6342
6534
|
}
|
|
6343
6535
|
export type JsonApiUserDataFilterInTypeEnum = "userDataFilter";
|
|
6344
6536
|
export interface JsonApiUserDataFilterInDocument {
|
|
6345
6537
|
data: JsonApiUserDataFilterIn;
|
|
6346
6538
|
}
|
|
6347
|
-
export interface JsonApiUserDataFilterInRelationships {
|
|
6348
|
-
user?: JsonApiFilterViewOutRelationshipsUser;
|
|
6349
|
-
userGroup?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
6350
|
-
}
|
|
6351
6539
|
/**
|
|
6352
6540
|
* JSON:API representation of userDataFilter entity.
|
|
6353
6541
|
*/
|
|
@@ -6360,7 +6548,7 @@ export interface JsonApiUserDataFilterOut {
|
|
|
6360
6548
|
* API identifier of an object
|
|
6361
6549
|
*/
|
|
6362
6550
|
id: string;
|
|
6363
|
-
meta?:
|
|
6551
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6364
6552
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
6365
6553
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
6366
6554
|
}
|
|
@@ -6397,16 +6585,13 @@ export interface JsonApiUserDataFilterOutList {
|
|
|
6397
6585
|
included?: Array<JsonApiUserDataFilterOutIncludes>;
|
|
6398
6586
|
}
|
|
6399
6587
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
6400
|
-
user?:
|
|
6401
|
-
userGroup?:
|
|
6588
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
6589
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
6402
6590
|
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
6403
6591
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
6404
|
-
labels?:
|
|
6405
|
-
metrics?:
|
|
6406
|
-
datasets?:
|
|
6407
|
-
}
|
|
6408
|
-
export interface JsonApiUserDataFilterOutRelationshipsUserGroup {
|
|
6409
|
-
data: JsonApiUserGroupLinkage | null;
|
|
6592
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
6593
|
+
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
6594
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
6410
6595
|
}
|
|
6411
6596
|
export interface JsonApiUserDataFilterOutWithLinks {
|
|
6412
6597
|
/**
|
|
@@ -6417,7 +6602,7 @@ export interface JsonApiUserDataFilterOutWithLinks {
|
|
|
6417
6602
|
* API identifier of an object
|
|
6418
6603
|
*/
|
|
6419
6604
|
id: string;
|
|
6420
|
-
meta?:
|
|
6605
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6421
6606
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
6422
6607
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
6423
6608
|
links?: ObjectLinks;
|
|
@@ -6436,7 +6621,7 @@ export interface JsonApiUserDataFilterPatch {
|
|
|
6436
6621
|
*/
|
|
6437
6622
|
id: string;
|
|
6438
6623
|
attributes: JsonApiUserDataFilterPatchAttributes;
|
|
6439
|
-
relationships?:
|
|
6624
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
6440
6625
|
}
|
|
6441
6626
|
export type JsonApiUserDataFilterPatchTypeEnum = "userDataFilter";
|
|
6442
6627
|
export interface JsonApiUserDataFilterPatchAttributes {
|
|
@@ -6462,12 +6647,16 @@ export interface JsonApiUserDataFilterPostOptionalId {
|
|
|
6462
6647
|
*/
|
|
6463
6648
|
id?: string;
|
|
6464
6649
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
6465
|
-
relationships?:
|
|
6650
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
6466
6651
|
}
|
|
6467
6652
|
export type JsonApiUserDataFilterPostOptionalIdTypeEnum = "userDataFilter";
|
|
6468
6653
|
export interface JsonApiUserDataFilterPostOptionalIdDocument {
|
|
6469
6654
|
data: JsonApiUserDataFilterPostOptionalId;
|
|
6470
6655
|
}
|
|
6656
|
+
export interface JsonApiUserDataFilterPostOptionalIdRelationships {
|
|
6657
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
6658
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
6659
|
+
}
|
|
6471
6660
|
/**
|
|
6472
6661
|
* JSON:API representation of userGroup entity.
|
|
6473
6662
|
*/
|
|
@@ -6535,13 +6724,7 @@ export interface JsonApiUserGroupOutList {
|
|
|
6535
6724
|
included?: Array<JsonApiUserGroupOutWithLinks>;
|
|
6536
6725
|
}
|
|
6537
6726
|
export interface JsonApiUserGroupOutRelationships {
|
|
6538
|
-
parents?:
|
|
6539
|
-
}
|
|
6540
|
-
export interface JsonApiUserGroupOutRelationshipsParents {
|
|
6541
|
-
/**
|
|
6542
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
6543
|
-
*/
|
|
6544
|
-
data: Array<JsonApiUserGroupLinkage>;
|
|
6727
|
+
parents?: JsonApiUserOutRelationshipsUserGroups;
|
|
6545
6728
|
}
|
|
6546
6729
|
export interface JsonApiUserGroupOutWithLinks {
|
|
6547
6730
|
/**
|
|
@@ -6699,7 +6882,13 @@ export interface JsonApiUserOutList {
|
|
|
6699
6882
|
included?: Array<JsonApiUserGroupOutWithLinks>;
|
|
6700
6883
|
}
|
|
6701
6884
|
export interface JsonApiUserOutRelationships {
|
|
6702
|
-
userGroups?:
|
|
6885
|
+
userGroups?: JsonApiUserOutRelationshipsUserGroups;
|
|
6886
|
+
}
|
|
6887
|
+
export interface JsonApiUserOutRelationshipsUserGroups {
|
|
6888
|
+
/**
|
|
6889
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
6890
|
+
*/
|
|
6891
|
+
data: Array<JsonApiUserGroupLinkage>;
|
|
6703
6892
|
}
|
|
6704
6893
|
export interface JsonApiUserOutWithLinks {
|
|
6705
6894
|
/**
|
|
@@ -6746,7 +6935,7 @@ export interface JsonApiUserSettingIn {
|
|
|
6746
6935
|
* API identifier of an object
|
|
6747
6936
|
*/
|
|
6748
6937
|
id: string;
|
|
6749
|
-
attributes?:
|
|
6938
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6750
6939
|
}
|
|
6751
6940
|
export type JsonApiUserSettingInTypeEnum = "userSetting";
|
|
6752
6941
|
export interface JsonApiUserSettingInDocument {
|
|
@@ -6764,7 +6953,7 @@ export interface JsonApiUserSettingOut {
|
|
|
6764
6953
|
* API identifier of an object
|
|
6765
6954
|
*/
|
|
6766
6955
|
id: string;
|
|
6767
|
-
attributes?:
|
|
6956
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6768
6957
|
}
|
|
6769
6958
|
export type JsonApiUserSettingOutTypeEnum = "userSetting";
|
|
6770
6959
|
export interface JsonApiUserSettingOutDocument {
|
|
@@ -6788,7 +6977,7 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
6788
6977
|
* API identifier of an object
|
|
6789
6978
|
*/
|
|
6790
6979
|
id: string;
|
|
6791
|
-
attributes?:
|
|
6980
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
6792
6981
|
links?: ObjectLinks;
|
|
6793
6982
|
}
|
|
6794
6983
|
export type JsonApiUserSettingOutWithLinksTypeEnum = "userSetting";
|
|
@@ -6804,20 +6993,9 @@ export interface JsonApiVisualizationObjectIn {
|
|
|
6804
6993
|
* API identifier of an object
|
|
6805
6994
|
*/
|
|
6806
6995
|
id: string;
|
|
6807
|
-
attributes:
|
|
6996
|
+
attributes: JsonApiVisualizationObjectPostOptionalIdAttributes;
|
|
6808
6997
|
}
|
|
6809
6998
|
export type JsonApiVisualizationObjectInTypeEnum = "visualizationObject";
|
|
6810
|
-
export interface JsonApiVisualizationObjectInAttributes {
|
|
6811
|
-
title?: string;
|
|
6812
|
-
description?: string;
|
|
6813
|
-
tags?: Array<string>;
|
|
6814
|
-
areRelationsValid?: boolean;
|
|
6815
|
-
/**
|
|
6816
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
6817
|
-
*/
|
|
6818
|
-
content: object;
|
|
6819
|
-
isHidden?: boolean;
|
|
6820
|
-
}
|
|
6821
6999
|
export interface JsonApiVisualizationObjectInDocument {
|
|
6822
7000
|
data: JsonApiVisualizationObjectIn;
|
|
6823
7001
|
}
|
|
@@ -6841,7 +7019,7 @@ export interface JsonApiVisualizationObjectOut {
|
|
|
6841
7019
|
* API identifier of an object
|
|
6842
7020
|
*/
|
|
6843
7021
|
id: string;
|
|
6844
|
-
meta?:
|
|
7022
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6845
7023
|
attributes: JsonApiVisualizationObjectOutAttributes;
|
|
6846
7024
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
6847
7025
|
}
|
|
@@ -6880,13 +7058,28 @@ export interface JsonApiVisualizationObjectOutList {
|
|
|
6880
7058
|
included?: Array<JsonApiMetricOutIncludes>;
|
|
6881
7059
|
}
|
|
6882
7060
|
export interface JsonApiVisualizationObjectOutRelationships {
|
|
6883
|
-
createdBy?:
|
|
6884
|
-
modifiedBy?:
|
|
7061
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7062
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
6885
7063
|
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
6886
7064
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
6887
|
-
labels?:
|
|
6888
|
-
metrics?:
|
|
6889
|
-
datasets?:
|
|
7065
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
7066
|
+
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
7067
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
7068
|
+
}
|
|
7069
|
+
export interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
7070
|
+
data: JsonApiUserIdentifierLinkage | null;
|
|
7071
|
+
}
|
|
7072
|
+
export interface JsonApiVisualizationObjectOutRelationshipsLabels {
|
|
7073
|
+
/**
|
|
7074
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7075
|
+
*/
|
|
7076
|
+
data: Array<JsonApiLabelLinkage>;
|
|
7077
|
+
}
|
|
7078
|
+
export interface JsonApiVisualizationObjectOutRelationshipsMetrics {
|
|
7079
|
+
/**
|
|
7080
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7081
|
+
*/
|
|
7082
|
+
data: Array<JsonApiMetricLinkage>;
|
|
6890
7083
|
}
|
|
6891
7084
|
export interface JsonApiVisualizationObjectOutWithLinks {
|
|
6892
7085
|
/**
|
|
@@ -6897,7 +7090,7 @@ export interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
6897
7090
|
* API identifier of an object
|
|
6898
7091
|
*/
|
|
6899
7092
|
id: string;
|
|
6900
|
-
meta?:
|
|
7093
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6901
7094
|
attributes: JsonApiVisualizationObjectOutAttributes;
|
|
6902
7095
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
6903
7096
|
links?: ObjectLinks;
|
|
@@ -6944,9 +7137,20 @@ export interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
6944
7137
|
* API identifier of an object
|
|
6945
7138
|
*/
|
|
6946
7139
|
id?: string;
|
|
6947
|
-
attributes:
|
|
7140
|
+
attributes: JsonApiVisualizationObjectPostOptionalIdAttributes;
|
|
6948
7141
|
}
|
|
6949
7142
|
export type JsonApiVisualizationObjectPostOptionalIdTypeEnum = "visualizationObject";
|
|
7143
|
+
export interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
7144
|
+
title?: string;
|
|
7145
|
+
description?: string;
|
|
7146
|
+
tags?: Array<string>;
|
|
7147
|
+
areRelationsValid?: boolean;
|
|
7148
|
+
/**
|
|
7149
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
7150
|
+
*/
|
|
7151
|
+
content: object;
|
|
7152
|
+
isHidden?: boolean;
|
|
7153
|
+
}
|
|
6950
7154
|
export interface JsonApiVisualizationObjectPostOptionalIdDocument {
|
|
6951
7155
|
data: JsonApiVisualizationObjectPostOptionalId;
|
|
6952
7156
|
}
|
|
@@ -6962,104 +7166,10 @@ export interface JsonApiWorkspaceAutomationOut {
|
|
|
6962
7166
|
* API identifier of an object
|
|
6963
7167
|
*/
|
|
6964
7168
|
id: string;
|
|
6965
|
-
attributes?:
|
|
7169
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
6966
7170
|
relationships?: JsonApiWorkspaceAutomationOutRelationships;
|
|
6967
7171
|
}
|
|
6968
7172
|
export type JsonApiWorkspaceAutomationOutTypeEnum = "workspaceAutomation";
|
|
6969
|
-
export interface JsonApiWorkspaceAutomationOutAttributes {
|
|
6970
|
-
title?: string;
|
|
6971
|
-
description?: string;
|
|
6972
|
-
tags?: Array<string>;
|
|
6973
|
-
areRelationsValid?: boolean;
|
|
6974
|
-
/**
|
|
6975
|
-
* Additional details to be included in the automated message.
|
|
6976
|
-
*/
|
|
6977
|
-
details?: object;
|
|
6978
|
-
metadata?: JsonApiWorkspaceAutomationOutAttributesMetadata | null;
|
|
6979
|
-
/**
|
|
6980
|
-
* Current state of the automation.
|
|
6981
|
-
*/
|
|
6982
|
-
state?: JsonApiWorkspaceAutomationOutAttributesStateEnum;
|
|
6983
|
-
/**
|
|
6984
|
-
* Specify automation evaluation mode.
|
|
6985
|
-
*/
|
|
6986
|
-
evaluationMode?: JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum;
|
|
6987
|
-
schedule?: JsonApiWorkspaceAutomationOutAttributesSchedule;
|
|
6988
|
-
alert?: JsonApiWorkspaceAutomationOutAttributesAlert;
|
|
6989
|
-
tabularExports?: Array<JsonApiWorkspaceAutomationOutAttributesTabularExportsInner>;
|
|
6990
|
-
visualExports?: Array<JsonApiWorkspaceAutomationOutAttributesVisualExportsInner>;
|
|
6991
|
-
imageExports?: Array<JsonApiWorkspaceAutomationOutAttributesImageExportsInner>;
|
|
6992
|
-
rawExports?: Array<JsonApiWorkspaceAutomationOutAttributesRawExportsInner>;
|
|
6993
|
-
slidesExports?: Array<JsonApiWorkspaceAutomationOutAttributesSlidesExportsInner>;
|
|
6994
|
-
dashboardTabularExports?: Array<JsonApiWorkspaceAutomationOutAttributesDashboardTabularExportsInner>;
|
|
6995
|
-
/**
|
|
6996
|
-
* External recipients of the automation action results.
|
|
6997
|
-
*/
|
|
6998
|
-
externalRecipients?: Array<JsonApiWorkspaceAutomationOutAttributesExternalRecipientsInner>;
|
|
6999
|
-
createdAt?: string;
|
|
7000
|
-
modifiedAt?: string;
|
|
7001
|
-
}
|
|
7002
|
-
export type JsonApiWorkspaceAutomationOutAttributesStateEnum = "ACTIVE" | "PAUSED";
|
|
7003
|
-
export type JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum = "SHARED" | "PER_RECIPIENT";
|
|
7004
|
-
export interface JsonApiWorkspaceAutomationOutAttributesAlert {
|
|
7005
|
-
execution: AlertAfm;
|
|
7006
|
-
condition: AlertCondition;
|
|
7007
|
-
/**
|
|
7008
|
-
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
7009
|
-
*/
|
|
7010
|
-
trigger?: JsonApiWorkspaceAutomationOutAttributesAlertTriggerEnum;
|
|
7011
|
-
}
|
|
7012
|
-
export type JsonApiWorkspaceAutomationOutAttributesAlertTriggerEnum = "ALWAYS" | "ONCE";
|
|
7013
|
-
export interface JsonApiWorkspaceAutomationOutAttributesDashboardTabularExportsInner {
|
|
7014
|
-
requestPayload: DashboardTabularExportRequestV2;
|
|
7015
|
-
}
|
|
7016
|
-
export interface JsonApiWorkspaceAutomationOutAttributesExternalRecipientsInner {
|
|
7017
|
-
/**
|
|
7018
|
-
* E-mail address to send notifications from.
|
|
7019
|
-
*/
|
|
7020
|
-
email: string;
|
|
7021
|
-
}
|
|
7022
|
-
export interface JsonApiWorkspaceAutomationOutAttributesImageExportsInner {
|
|
7023
|
-
requestPayload: ImageExportRequest;
|
|
7024
|
-
}
|
|
7025
|
-
/**
|
|
7026
|
-
* Additional information for the automation.
|
|
7027
|
-
*/
|
|
7028
|
-
export interface JsonApiWorkspaceAutomationOutAttributesMetadata {
|
|
7029
|
-
[key: string]: any;
|
|
7030
|
-
widget?: string;
|
|
7031
|
-
visibleFilters?: Array<VisibleFilter>;
|
|
7032
|
-
}
|
|
7033
|
-
export interface JsonApiWorkspaceAutomationOutAttributesRawExportsInner {
|
|
7034
|
-
requestPayload: RawExportAutomationRequest;
|
|
7035
|
-
}
|
|
7036
|
-
export interface JsonApiWorkspaceAutomationOutAttributesSchedule {
|
|
7037
|
-
/**
|
|
7038
|
-
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
7039
|
-
*/
|
|
7040
|
-
cron: string;
|
|
7041
|
-
/**
|
|
7042
|
-
* Human-readable description of the cron expression.
|
|
7043
|
-
*/
|
|
7044
|
-
cronDescription?: string;
|
|
7045
|
-
/**
|
|
7046
|
-
* Timezone in which the schedule is defined.
|
|
7047
|
-
*/
|
|
7048
|
-
timezone: string;
|
|
7049
|
-
/**
|
|
7050
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
7051
|
-
*/
|
|
7052
|
-
firstRun?: string;
|
|
7053
|
-
}
|
|
7054
|
-
export interface JsonApiWorkspaceAutomationOutAttributesSlidesExportsInner {
|
|
7055
|
-
requestPayload: SlidesExportRequest;
|
|
7056
|
-
}
|
|
7057
|
-
export interface JsonApiWorkspaceAutomationOutAttributesTabularExportsInner {
|
|
7058
|
-
requestPayload: TabularExportRequest;
|
|
7059
|
-
}
|
|
7060
|
-
export interface JsonApiWorkspaceAutomationOutAttributesVisualExportsInner {
|
|
7061
|
-
requestPayload: VisualExportRequest;
|
|
7062
|
-
}
|
|
7063
7173
|
/**
|
|
7064
7174
|
* @type JsonApiWorkspaceAutomationOutIncludes
|
|
7065
7175
|
*/
|
|
@@ -7081,34 +7191,13 @@ export interface JsonApiWorkspaceAutomationOutListMeta {
|
|
|
7081
7191
|
}
|
|
7082
7192
|
export interface JsonApiWorkspaceAutomationOutRelationships {
|
|
7083
7193
|
workspace?: JsonApiWorkspaceOutRelationshipsParent;
|
|
7084
|
-
notificationChannel?:
|
|
7194
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
7085
7195
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
7086
|
-
createdBy?:
|
|
7087
|
-
modifiedBy?:
|
|
7088
|
-
exportDefinitions?:
|
|
7089
|
-
recipients?:
|
|
7090
|
-
automationResults?:
|
|
7091
|
-
}
|
|
7092
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsAutomationResults {
|
|
7093
|
-
/**
|
|
7094
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7095
|
-
*/
|
|
7096
|
-
data: Array<JsonApiAutomationResultLinkage>;
|
|
7097
|
-
}
|
|
7098
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsExportDefinitions {
|
|
7099
|
-
/**
|
|
7100
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7101
|
-
*/
|
|
7102
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
7103
|
-
}
|
|
7104
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsNotificationChannel {
|
|
7105
|
-
data: JsonApiNotificationChannelLinkage | null;
|
|
7106
|
-
}
|
|
7107
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsRecipients {
|
|
7108
|
-
/**
|
|
7109
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7110
|
-
*/
|
|
7111
|
-
data: Array<JsonApiUserLinkage>;
|
|
7196
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7197
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7198
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
7199
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
7200
|
+
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
7112
7201
|
}
|
|
7113
7202
|
export interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
7114
7203
|
/**
|
|
@@ -7119,7 +7208,7 @@ export interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
|
7119
7208
|
* API identifier of an object
|
|
7120
7209
|
*/
|
|
7121
7210
|
id: string;
|
|
7122
|
-
attributes?:
|
|
7211
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
7123
7212
|
relationships?: JsonApiWorkspaceAutomationOutRelationships;
|
|
7124
7213
|
links?: ObjectLinks;
|
|
7125
7214
|
}
|
|
@@ -7163,7 +7252,7 @@ export interface JsonApiWorkspaceDataFilterOut {
|
|
|
7163
7252
|
* API identifier of an object
|
|
7164
7253
|
*/
|
|
7165
7254
|
id: string;
|
|
7166
|
-
meta?:
|
|
7255
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7167
7256
|
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
7168
7257
|
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
7169
7258
|
}
|
|
@@ -7211,7 +7300,7 @@ export interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
7211
7300
|
* API identifier of an object
|
|
7212
7301
|
*/
|
|
7213
7302
|
id: string;
|
|
7214
|
-
meta?:
|
|
7303
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7215
7304
|
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
7216
7305
|
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
7217
7306
|
links?: ObjectLinks;
|
|
@@ -7275,7 +7364,7 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
7275
7364
|
* API identifier of an object
|
|
7276
7365
|
*/
|
|
7277
7366
|
id: string;
|
|
7278
|
-
meta?:
|
|
7367
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7279
7368
|
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
7280
7369
|
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
7281
7370
|
}
|
|
@@ -7320,7 +7409,7 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
7320
7409
|
* API identifier of an object
|
|
7321
7410
|
*/
|
|
7322
7411
|
id: string;
|
|
7323
|
-
meta?:
|
|
7412
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7324
7413
|
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
7325
7414
|
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
7326
7415
|
links?: ObjectLinks;
|
|
@@ -7529,7 +7618,7 @@ export interface JsonApiWorkspaceSettingIn {
|
|
|
7529
7618
|
* API identifier of an object
|
|
7530
7619
|
*/
|
|
7531
7620
|
id: string;
|
|
7532
|
-
attributes?:
|
|
7621
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7533
7622
|
}
|
|
7534
7623
|
export type JsonApiWorkspaceSettingInTypeEnum = "workspaceSetting";
|
|
7535
7624
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -7547,10 +7636,18 @@ export interface JsonApiWorkspaceSettingOut {
|
|
|
7547
7636
|
* API identifier of an object
|
|
7548
7637
|
*/
|
|
7549
7638
|
id: string;
|
|
7550
|
-
meta?:
|
|
7551
|
-
attributes?:
|
|
7639
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7640
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7552
7641
|
}
|
|
7553
7642
|
export type JsonApiWorkspaceSettingOutTypeEnum = "workspaceSetting";
|
|
7643
|
+
export interface JsonApiWorkspaceSettingOutAttributes {
|
|
7644
|
+
/**
|
|
7645
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7646
|
+
*/
|
|
7647
|
+
content?: object;
|
|
7648
|
+
type?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
7649
|
+
}
|
|
7650
|
+
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE" | "ENABLE_AI_ON_DATA";
|
|
7554
7651
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
7555
7652
|
data: JsonApiWorkspaceSettingOut;
|
|
7556
7653
|
links?: ObjectLinks;
|
|
@@ -7572,8 +7669,8 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
7572
7669
|
* API identifier of an object
|
|
7573
7670
|
*/
|
|
7574
7671
|
id: string;
|
|
7575
|
-
meta?:
|
|
7576
|
-
attributes?:
|
|
7672
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7673
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7577
7674
|
links?: ObjectLinks;
|
|
7578
7675
|
}
|
|
7579
7676
|
export type JsonApiWorkspaceSettingOutWithLinksTypeEnum = "workspaceSetting";
|
|
@@ -7589,7 +7686,7 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
7589
7686
|
* API identifier of an object
|
|
7590
7687
|
*/
|
|
7591
7688
|
id: string;
|
|
7592
|
-
attributes?:
|
|
7689
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7593
7690
|
}
|
|
7594
7691
|
export type JsonApiWorkspaceSettingPatchTypeEnum = "workspaceSetting";
|
|
7595
7692
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -7607,7 +7704,7 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
7607
7704
|
* API identifier of an object
|
|
7608
7705
|
*/
|
|
7609
7706
|
id?: string;
|
|
7610
|
-
attributes?:
|
|
7707
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7611
7708
|
}
|
|
7612
7709
|
export type JsonApiWorkspaceSettingPostOptionalIdTypeEnum = "workspaceSetting";
|
|
7613
7710
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
@@ -8138,7 +8235,7 @@ export interface ResolvedSetting {
|
|
|
8138
8235
|
*/
|
|
8139
8236
|
type?: ResolvedSettingTypeEnum;
|
|
8140
8237
|
}
|
|
8141
|
-
export type ResolvedSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE";
|
|
8238
|
+
export type ResolvedSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE" | "ENABLE_AI_ON_DATA";
|
|
8142
8239
|
export interface RsaSpecification {
|
|
8143
8240
|
kty: RsaSpecificationKtyEnum;
|
|
8144
8241
|
alg: RsaSpecificationAlgEnum;
|
|
@@ -12764,6 +12861,19 @@ export declare function AttributesApiAxiosParamCreator_GetAllEntitiesAttributes(
|
|
|
12764
12861
|
* @throws {RequiredError}
|
|
12765
12862
|
*/
|
|
12766
12863
|
export declare function AttributesApiAxiosParamCreator_GetEntityAttributes(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
12864
|
+
/**
|
|
12865
|
+
*
|
|
12866
|
+
* @summary Patch an Attribute (beta)
|
|
12867
|
+
* @param {string} workspaceId
|
|
12868
|
+
* @param {string} objectId
|
|
12869
|
+
* @param {JsonApiAttributePatchDocument} jsonApiAttributePatchDocument
|
|
12870
|
+
* @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\').
|
|
12871
|
+
* @param {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | '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.
|
|
12872
|
+
* @param {*} [options] Override http request option.
|
|
12873
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
12874
|
+
* @throws {RequiredError}
|
|
12875
|
+
*/
|
|
12876
|
+
export declare function AttributesApiAxiosParamCreator_PatchEntityAttributes(workspaceId: string, objectId: string, jsonApiAttributePatchDocument: JsonApiAttributePatchDocument, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
12767
12877
|
/**
|
|
12768
12878
|
*
|
|
12769
12879
|
* @summary Get all Attributes
|
|
@@ -12786,6 +12896,17 @@ export declare function AttributesApi_GetAllEntitiesAttributes(axios: AxiosInsta
|
|
|
12786
12896
|
* @throws {RequiredError}
|
|
12787
12897
|
*/
|
|
12788
12898
|
export declare function AttributesApi_GetEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: AttributesApiGetEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
12899
|
+
/**
|
|
12900
|
+
*
|
|
12901
|
+
* @summary Patch an Attribute (beta)
|
|
12902
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
12903
|
+
* @param {string} basePath Base path.
|
|
12904
|
+
* @param {AttributesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
12905
|
+
* @param {*} [options] Override http request option.
|
|
12906
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
12907
|
+
* @throws {RequiredError}
|
|
12908
|
+
*/
|
|
12909
|
+
export declare function AttributesApi_PatchEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: AttributesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
12789
12910
|
/**
|
|
12790
12911
|
* AttributesApi - interface
|
|
12791
12912
|
* @export
|
|
@@ -12810,6 +12931,15 @@ export interface AttributesApiInterface {
|
|
|
12810
12931
|
* @memberof AttributesApiInterface
|
|
12811
12932
|
*/
|
|
12812
12933
|
getEntityAttributes(requestParameters: AttributesApiGetEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
12934
|
+
/**
|
|
12935
|
+
*
|
|
12936
|
+
* @summary Patch an Attribute (beta)
|
|
12937
|
+
* @param {AttributesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
12938
|
+
* @param {*} [options] Override http request option.
|
|
12939
|
+
* @throws {RequiredError}
|
|
12940
|
+
* @memberof AttributesApiInterface
|
|
12941
|
+
*/
|
|
12942
|
+
patchEntityAttributes(requestParameters: AttributesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
12813
12943
|
}
|
|
12814
12944
|
/**
|
|
12815
12945
|
* Request parameters for getAllEntitiesAttributes operation in AttributesApi.
|
|
@@ -12915,6 +13045,43 @@ export interface AttributesApiGetEntityAttributesRequest {
|
|
|
12915
13045
|
*/
|
|
12916
13046
|
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
12917
13047
|
}
|
|
13048
|
+
/**
|
|
13049
|
+
* Request parameters for patchEntityAttributes operation in AttributesApi.
|
|
13050
|
+
* @export
|
|
13051
|
+
* @interface AttributesApiPatchEntityAttributesRequest
|
|
13052
|
+
*/
|
|
13053
|
+
export interface AttributesApiPatchEntityAttributesRequest {
|
|
13054
|
+
/**
|
|
13055
|
+
*
|
|
13056
|
+
* @type {string}
|
|
13057
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
13058
|
+
*/
|
|
13059
|
+
readonly workspaceId: string;
|
|
13060
|
+
/**
|
|
13061
|
+
*
|
|
13062
|
+
* @type {string}
|
|
13063
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
13064
|
+
*/
|
|
13065
|
+
readonly objectId: string;
|
|
13066
|
+
/**
|
|
13067
|
+
*
|
|
13068
|
+
* @type {JsonApiAttributePatchDocument}
|
|
13069
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
13070
|
+
*/
|
|
13071
|
+
readonly jsonApiAttributePatchDocument: JsonApiAttributePatchDocument;
|
|
13072
|
+
/**
|
|
13073
|
+
* 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\').
|
|
13074
|
+
* @type {string}
|
|
13075
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
13076
|
+
*/
|
|
13077
|
+
readonly filter?: string;
|
|
13078
|
+
/**
|
|
13079
|
+
* 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.
|
|
13080
|
+
* @type {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | 'ALL'>}
|
|
13081
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
13082
|
+
*/
|
|
13083
|
+
readonly include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">;
|
|
13084
|
+
}
|
|
12918
13085
|
/**
|
|
12919
13086
|
* AttributesApi - object-oriented interface
|
|
12920
13087
|
* @export
|
|
@@ -12940,6 +13107,15 @@ export declare class AttributesApi extends BaseAPI implements AttributesApiInter
|
|
|
12940
13107
|
* @memberof AttributesApi
|
|
12941
13108
|
*/
|
|
12942
13109
|
getEntityAttributes(requestParameters: AttributesApiGetEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
13110
|
+
/**
|
|
13111
|
+
*
|
|
13112
|
+
* @summary Patch an Attribute (beta)
|
|
13113
|
+
* @param {AttributesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
13114
|
+
* @param {*} [options] Override http request option.
|
|
13115
|
+
* @throws {RequiredError}
|
|
13116
|
+
* @memberof AttributesApi
|
|
13117
|
+
*/
|
|
13118
|
+
patchEntityAttributes(requestParameters: AttributesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
12943
13119
|
}
|
|
12944
13120
|
/**
|
|
12945
13121
|
*
|
|
@@ -18225,6 +18401,19 @@ export declare function DatasetsApiAxiosParamCreator_GetAllEntitiesDatasets(work
|
|
|
18225
18401
|
* @throws {RequiredError}
|
|
18226
18402
|
*/
|
|
18227
18403
|
export declare function DatasetsApiAxiosParamCreator_GetEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18404
|
+
/**
|
|
18405
|
+
*
|
|
18406
|
+
* @summary Patch a Dataset (beta)
|
|
18407
|
+
* @param {string} workspaceId
|
|
18408
|
+
* @param {string} objectId
|
|
18409
|
+
* @param {JsonApiDatasetPatchDocument} jsonApiDatasetPatchDocument
|
|
18410
|
+
* @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\').
|
|
18411
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
18412
|
+
* @param {*} [options] Override http request option.
|
|
18413
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
18414
|
+
* @throws {RequiredError}
|
|
18415
|
+
*/
|
|
18416
|
+
export declare function DatasetsApiAxiosParamCreator_PatchEntityDatasets(workspaceId: string, objectId: string, jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
18228
18417
|
/**
|
|
18229
18418
|
*
|
|
18230
18419
|
* @summary Get all Datasets
|
|
@@ -18247,6 +18436,17 @@ export declare function DatasetsApi_GetAllEntitiesDatasets(axios: AxiosInstance,
|
|
|
18247
18436
|
* @throws {RequiredError}
|
|
18248
18437
|
*/
|
|
18249
18438
|
export declare function DatasetsApi_GetEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: DatasetsApiGetEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
18439
|
+
/**
|
|
18440
|
+
*
|
|
18441
|
+
* @summary Patch a Dataset (beta)
|
|
18442
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
18443
|
+
* @param {string} basePath Base path.
|
|
18444
|
+
* @param {DatasetsApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
18445
|
+
* @param {*} [options] Override http request option.
|
|
18446
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
18447
|
+
* @throws {RequiredError}
|
|
18448
|
+
*/
|
|
18449
|
+
export declare function DatasetsApi_PatchEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: DatasetsApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
18250
18450
|
/**
|
|
18251
18451
|
* DatasetsApi - interface
|
|
18252
18452
|
* @export
|
|
@@ -18271,6 +18471,15 @@ export interface DatasetsApiInterface {
|
|
|
18271
18471
|
* @memberof DatasetsApiInterface
|
|
18272
18472
|
*/
|
|
18273
18473
|
getEntityDatasets(requestParameters: DatasetsApiGetEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
18474
|
+
/**
|
|
18475
|
+
*
|
|
18476
|
+
* @summary Patch a Dataset (beta)
|
|
18477
|
+
* @param {DatasetsApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
18478
|
+
* @param {*} [options] Override http request option.
|
|
18479
|
+
* @throws {RequiredError}
|
|
18480
|
+
* @memberof DatasetsApiInterface
|
|
18481
|
+
*/
|
|
18482
|
+
patchEntityDatasets(requestParameters: DatasetsApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
18274
18483
|
}
|
|
18275
18484
|
/**
|
|
18276
18485
|
* Request parameters for getAllEntitiesDatasets operation in DatasetsApi.
|
|
@@ -18376,6 +18585,43 @@ export interface DatasetsApiGetEntityDatasetsRequest {
|
|
|
18376
18585
|
*/
|
|
18377
18586
|
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
18378
18587
|
}
|
|
18588
|
+
/**
|
|
18589
|
+
* Request parameters for patchEntityDatasets operation in DatasetsApi.
|
|
18590
|
+
* @export
|
|
18591
|
+
* @interface DatasetsApiPatchEntityDatasetsRequest
|
|
18592
|
+
*/
|
|
18593
|
+
export interface DatasetsApiPatchEntityDatasetsRequest {
|
|
18594
|
+
/**
|
|
18595
|
+
*
|
|
18596
|
+
* @type {string}
|
|
18597
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
18598
|
+
*/
|
|
18599
|
+
readonly workspaceId: string;
|
|
18600
|
+
/**
|
|
18601
|
+
*
|
|
18602
|
+
* @type {string}
|
|
18603
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
18604
|
+
*/
|
|
18605
|
+
readonly objectId: string;
|
|
18606
|
+
/**
|
|
18607
|
+
*
|
|
18608
|
+
* @type {JsonApiDatasetPatchDocument}
|
|
18609
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
18610
|
+
*/
|
|
18611
|
+
readonly jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument;
|
|
18612
|
+
/**
|
|
18613
|
+
* 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\').
|
|
18614
|
+
* @type {string}
|
|
18615
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
18616
|
+
*/
|
|
18617
|
+
readonly filter?: string;
|
|
18618
|
+
/**
|
|
18619
|
+
* 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.
|
|
18620
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
18621
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
18622
|
+
*/
|
|
18623
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
18624
|
+
}
|
|
18379
18625
|
/**
|
|
18380
18626
|
* DatasetsApi - object-oriented interface
|
|
18381
18627
|
* @export
|
|
@@ -18401,6 +18647,15 @@ export declare class DatasetsApi extends BaseAPI implements DatasetsApiInterface
|
|
|
18401
18647
|
* @memberof DatasetsApi
|
|
18402
18648
|
*/
|
|
18403
18649
|
getEntityDatasets(requestParameters: DatasetsApiGetEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
18650
|
+
/**
|
|
18651
|
+
*
|
|
18652
|
+
* @summary Patch a Dataset (beta)
|
|
18653
|
+
* @param {DatasetsApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
18654
|
+
* @param {*} [options] Override http request option.
|
|
18655
|
+
* @throws {RequiredError}
|
|
18656
|
+
* @memberof DatasetsApi
|
|
18657
|
+
*/
|
|
18658
|
+
patchEntityDatasets(requestParameters: DatasetsApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
18404
18659
|
}
|
|
18405
18660
|
/**
|
|
18406
18661
|
* Computes the dependent entities graph
|
|
@@ -20305,6 +20560,19 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityAnalyticalDashbo
|
|
|
20305
20560
|
* @throws {RequiredError}
|
|
20306
20561
|
*/
|
|
20307
20562
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityAttributeHierarchies(workspaceId: string, objectId: string, jsonApiAttributeHierarchyPatchDocument: JsonApiAttributeHierarchyPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20563
|
+
/**
|
|
20564
|
+
*
|
|
20565
|
+
* @summary Patch an Attribute (beta)
|
|
20566
|
+
* @param {string} workspaceId
|
|
20567
|
+
* @param {string} objectId
|
|
20568
|
+
* @param {JsonApiAttributePatchDocument} jsonApiAttributePatchDocument
|
|
20569
|
+
* @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\').
|
|
20570
|
+
* @param {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | '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.
|
|
20571
|
+
* @param {*} [options] Override http request option.
|
|
20572
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20573
|
+
* @throws {RequiredError}
|
|
20574
|
+
*/
|
|
20575
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityAttributes(workspaceId: string, objectId: string, jsonApiAttributePatchDocument: JsonApiAttributePatchDocument, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20308
20576
|
/**
|
|
20309
20577
|
*
|
|
20310
20578
|
* @summary Patch an Automation
|
|
@@ -20387,6 +20655,19 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityDashboardPlugins
|
|
|
20387
20655
|
* @throws {RequiredError}
|
|
20388
20656
|
*/
|
|
20389
20657
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityDataSources(id: string, jsonApiDataSourcePatchDocument: JsonApiDataSourcePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20658
|
+
/**
|
|
20659
|
+
*
|
|
20660
|
+
* @summary Patch a Dataset (beta)
|
|
20661
|
+
* @param {string} workspaceId
|
|
20662
|
+
* @param {string} objectId
|
|
20663
|
+
* @param {JsonApiDatasetPatchDocument} jsonApiDatasetPatchDocument
|
|
20664
|
+
* @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\').
|
|
20665
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
20666
|
+
* @param {*} [options] Override http request option.
|
|
20667
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20668
|
+
* @throws {RequiredError}
|
|
20669
|
+
*/
|
|
20670
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityDatasets(workspaceId: string, objectId: string, jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20390
20671
|
/**
|
|
20391
20672
|
*
|
|
20392
20673
|
* @summary Patch an Export Definition
|
|
@@ -20411,6 +20692,19 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityExportDefinition
|
|
|
20411
20692
|
* @throws {RequiredError}
|
|
20412
20693
|
*/
|
|
20413
20694
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityExportTemplates(id: string, jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20695
|
+
/**
|
|
20696
|
+
*
|
|
20697
|
+
* @summary Patch a Fact (beta)
|
|
20698
|
+
* @param {string} workspaceId
|
|
20699
|
+
* @param {string} objectId
|
|
20700
|
+
* @param {JsonApiFactPatchDocument} jsonApiFactPatchDocument
|
|
20701
|
+
* @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\').
|
|
20702
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
20703
|
+
* @param {*} [options] Override http request option.
|
|
20704
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20705
|
+
* @throws {RequiredError}
|
|
20706
|
+
*/
|
|
20707
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityFacts(workspaceId: string, objectId: string, jsonApiFactPatchDocument: JsonApiFactPatchDocument, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20414
20708
|
/**
|
|
20415
20709
|
*
|
|
20416
20710
|
* @summary Patch a Context Filter
|
|
@@ -20459,6 +20753,19 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityIdentityProvider
|
|
|
20459
20753
|
* @throws {RequiredError}
|
|
20460
20754
|
*/
|
|
20461
20755
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityJwks(id: string, jsonApiJwkPatchDocument: JsonApiJwkPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20756
|
+
/**
|
|
20757
|
+
*
|
|
20758
|
+
* @summary Patch a Label (beta)
|
|
20759
|
+
* @param {string} workspaceId
|
|
20760
|
+
* @param {string} objectId
|
|
20761
|
+
* @param {JsonApiLabelPatchDocument} jsonApiLabelPatchDocument
|
|
20762
|
+
* @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\').
|
|
20763
|
+
* @param {Array<'attributes' | 'attribute' | '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.
|
|
20764
|
+
* @param {*} [options] Override http request option.
|
|
20765
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
20766
|
+
* @throws {RequiredError}
|
|
20767
|
+
*/
|
|
20768
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityLabels(workspaceId: string, objectId: string, jsonApiLabelPatchDocument: JsonApiLabelPatchDocument, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
20462
20769
|
/**
|
|
20463
20770
|
*
|
|
20464
20771
|
* @summary Patch LLM endpoint entity
|
|
@@ -22861,6 +23168,17 @@ export declare function EntitiesApi_PatchEntityAnalyticalDashboards(axios: Axios
|
|
|
22861
23168
|
* @throws {RequiredError}
|
|
22862
23169
|
*/
|
|
22863
23170
|
export declare function EntitiesApi_PatchEntityAttributeHierarchies(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
23171
|
+
/**
|
|
23172
|
+
*
|
|
23173
|
+
* @summary Patch an Attribute (beta)
|
|
23174
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23175
|
+
* @param {string} basePath Base path.
|
|
23176
|
+
* @param {EntitiesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
23177
|
+
* @param {*} [options] Override http request option.
|
|
23178
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23179
|
+
* @throws {RequiredError}
|
|
23180
|
+
*/
|
|
23181
|
+
export declare function EntitiesApi_PatchEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
22864
23182
|
/**
|
|
22865
23183
|
*
|
|
22866
23184
|
* @summary Patch an Automation
|
|
@@ -22938,6 +23256,17 @@ export declare function EntitiesApi_PatchEntityDashboardPlugins(axios: AxiosInst
|
|
|
22938
23256
|
* @throws {RequiredError}
|
|
22939
23257
|
*/
|
|
22940
23258
|
export declare function EntitiesApi_PatchEntityDataSources(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityDataSourcesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
23259
|
+
/**
|
|
23260
|
+
*
|
|
23261
|
+
* @summary Patch a Dataset (beta)
|
|
23262
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23263
|
+
* @param {string} basePath Base path.
|
|
23264
|
+
* @param {EntitiesApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
23265
|
+
* @param {*} [options] Override http request option.
|
|
23266
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23267
|
+
* @throws {RequiredError}
|
|
23268
|
+
*/
|
|
23269
|
+
export declare function EntitiesApi_PatchEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
22941
23270
|
/**
|
|
22942
23271
|
*
|
|
22943
23272
|
* @summary Patch an Export Definition
|
|
@@ -22960,6 +23289,17 @@ export declare function EntitiesApi_PatchEntityExportDefinitions(axios: AxiosIns
|
|
|
22960
23289
|
* @throws {RequiredError}
|
|
22961
23290
|
*/
|
|
22962
23291
|
export declare function EntitiesApi_PatchEntityExportTemplates(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
23292
|
+
/**
|
|
23293
|
+
*
|
|
23294
|
+
* @summary Patch a Fact (beta)
|
|
23295
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23296
|
+
* @param {string} basePath Base path.
|
|
23297
|
+
* @param {EntitiesApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
23298
|
+
* @param {*} [options] Override http request option.
|
|
23299
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23300
|
+
* @throws {RequiredError}
|
|
23301
|
+
*/
|
|
23302
|
+
export declare function EntitiesApi_PatchEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityFactsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiFactOutDocument>;
|
|
22963
23303
|
/**
|
|
22964
23304
|
*
|
|
22965
23305
|
* @summary Patch a Context Filter
|
|
@@ -23004,6 +23344,17 @@ export declare function EntitiesApi_PatchEntityIdentityProviders(axios: AxiosIns
|
|
|
23004
23344
|
* @throws {RequiredError}
|
|
23005
23345
|
*/
|
|
23006
23346
|
export declare function EntitiesApi_PatchEntityJwks(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityJwksRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiJwkOutDocument>;
|
|
23347
|
+
/**
|
|
23348
|
+
*
|
|
23349
|
+
* @summary Patch a Label (beta)
|
|
23350
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23351
|
+
* @param {string} basePath Base path.
|
|
23352
|
+
* @param {EntitiesApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
23353
|
+
* @param {*} [options] Override http request option.
|
|
23354
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23355
|
+
* @throws {RequiredError}
|
|
23356
|
+
*/
|
|
23357
|
+
export declare function EntitiesApi_PatchEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
23007
23358
|
/**
|
|
23008
23359
|
*
|
|
23009
23360
|
* @summary Patch LLM endpoint entity
|
|
@@ -25049,6 +25400,15 @@ export interface EntitiesApiInterface {
|
|
|
25049
25400
|
* @memberof EntitiesApiInterface
|
|
25050
25401
|
*/
|
|
25051
25402
|
patchEntityAttributeHierarchies(requestParameters: EntitiesApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
25403
|
+
/**
|
|
25404
|
+
*
|
|
25405
|
+
* @summary Patch an Attribute (beta)
|
|
25406
|
+
* @param {EntitiesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
25407
|
+
* @param {*} [options] Override http request option.
|
|
25408
|
+
* @throws {RequiredError}
|
|
25409
|
+
* @memberof EntitiesApiInterface
|
|
25410
|
+
*/
|
|
25411
|
+
patchEntityAttributes(requestParameters: EntitiesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
25052
25412
|
/**
|
|
25053
25413
|
*
|
|
25054
25414
|
* @summary Patch an Automation
|
|
@@ -25112,6 +25472,15 @@ export interface EntitiesApiInterface {
|
|
|
25112
25472
|
* @memberof EntitiesApiInterface
|
|
25113
25473
|
*/
|
|
25114
25474
|
patchEntityDataSources(requestParameters: EntitiesApiPatchEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
25475
|
+
/**
|
|
25476
|
+
*
|
|
25477
|
+
* @summary Patch a Dataset (beta)
|
|
25478
|
+
* @param {EntitiesApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
25479
|
+
* @param {*} [options] Override http request option.
|
|
25480
|
+
* @throws {RequiredError}
|
|
25481
|
+
* @memberof EntitiesApiInterface
|
|
25482
|
+
*/
|
|
25483
|
+
patchEntityDatasets(requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
25115
25484
|
/**
|
|
25116
25485
|
*
|
|
25117
25486
|
* @summary Patch an Export Definition
|
|
@@ -25130,6 +25499,15 @@ export interface EntitiesApiInterface {
|
|
|
25130
25499
|
* @memberof EntitiesApiInterface
|
|
25131
25500
|
*/
|
|
25132
25501
|
patchEntityExportTemplates(requestParameters: EntitiesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
25502
|
+
/**
|
|
25503
|
+
*
|
|
25504
|
+
* @summary Patch a Fact (beta)
|
|
25505
|
+
* @param {EntitiesApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
25506
|
+
* @param {*} [options] Override http request option.
|
|
25507
|
+
* @throws {RequiredError}
|
|
25508
|
+
* @memberof EntitiesApiInterface
|
|
25509
|
+
*/
|
|
25510
|
+
patchEntityFacts(requestParameters: EntitiesApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
25133
25511
|
/**
|
|
25134
25512
|
*
|
|
25135
25513
|
* @summary Patch a Context Filter
|
|
@@ -25166,6 +25544,15 @@ export interface EntitiesApiInterface {
|
|
|
25166
25544
|
* @memberof EntitiesApiInterface
|
|
25167
25545
|
*/
|
|
25168
25546
|
patchEntityJwks(requestParameters: EntitiesApiPatchEntityJwksRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiJwkOutDocument>;
|
|
25547
|
+
/**
|
|
25548
|
+
*
|
|
25549
|
+
* @summary Patch a Label (beta)
|
|
25550
|
+
* @param {EntitiesApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
25551
|
+
* @param {*} [options] Override http request option.
|
|
25552
|
+
* @throws {RequiredError}
|
|
25553
|
+
* @memberof EntitiesApiInterface
|
|
25554
|
+
*/
|
|
25555
|
+
patchEntityLabels(requestParameters: EntitiesApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
25169
25556
|
/**
|
|
25170
25557
|
*
|
|
25171
25558
|
* @summary Patch LLM endpoint entity
|
|
@@ -30495,6 +30882,43 @@ export interface EntitiesApiPatchEntityAttributeHierarchiesRequest {
|
|
|
30495
30882
|
*/
|
|
30496
30883
|
readonly include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">;
|
|
30497
30884
|
}
|
|
30885
|
+
/**
|
|
30886
|
+
* Request parameters for patchEntityAttributes operation in EntitiesApi.
|
|
30887
|
+
* @export
|
|
30888
|
+
* @interface EntitiesApiPatchEntityAttributesRequest
|
|
30889
|
+
*/
|
|
30890
|
+
export interface EntitiesApiPatchEntityAttributesRequest {
|
|
30891
|
+
/**
|
|
30892
|
+
*
|
|
30893
|
+
* @type {string}
|
|
30894
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
30895
|
+
*/
|
|
30896
|
+
readonly workspaceId: string;
|
|
30897
|
+
/**
|
|
30898
|
+
*
|
|
30899
|
+
* @type {string}
|
|
30900
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
30901
|
+
*/
|
|
30902
|
+
readonly objectId: string;
|
|
30903
|
+
/**
|
|
30904
|
+
*
|
|
30905
|
+
* @type {JsonApiAttributePatchDocument}
|
|
30906
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
30907
|
+
*/
|
|
30908
|
+
readonly jsonApiAttributePatchDocument: JsonApiAttributePatchDocument;
|
|
30909
|
+
/**
|
|
30910
|
+
* 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\').
|
|
30911
|
+
* @type {string}
|
|
30912
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
30913
|
+
*/
|
|
30914
|
+
readonly filter?: string;
|
|
30915
|
+
/**
|
|
30916
|
+
* 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.
|
|
30917
|
+
* @type {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | 'ALL'>}
|
|
30918
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
30919
|
+
*/
|
|
30920
|
+
readonly include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">;
|
|
30921
|
+
}
|
|
30498
30922
|
/**
|
|
30499
30923
|
* Request parameters for patchEntityAutomations operation in EntitiesApi.
|
|
30500
30924
|
* @export
|
|
@@ -30700,6 +31124,43 @@ export interface EntitiesApiPatchEntityDataSourcesRequest {
|
|
|
30700
31124
|
*/
|
|
30701
31125
|
readonly filter?: string;
|
|
30702
31126
|
}
|
|
31127
|
+
/**
|
|
31128
|
+
* Request parameters for patchEntityDatasets operation in EntitiesApi.
|
|
31129
|
+
* @export
|
|
31130
|
+
* @interface EntitiesApiPatchEntityDatasetsRequest
|
|
31131
|
+
*/
|
|
31132
|
+
export interface EntitiesApiPatchEntityDatasetsRequest {
|
|
31133
|
+
/**
|
|
31134
|
+
*
|
|
31135
|
+
* @type {string}
|
|
31136
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
31137
|
+
*/
|
|
31138
|
+
readonly workspaceId: string;
|
|
31139
|
+
/**
|
|
31140
|
+
*
|
|
31141
|
+
* @type {string}
|
|
31142
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
31143
|
+
*/
|
|
31144
|
+
readonly objectId: string;
|
|
31145
|
+
/**
|
|
31146
|
+
*
|
|
31147
|
+
* @type {JsonApiDatasetPatchDocument}
|
|
31148
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
31149
|
+
*/
|
|
31150
|
+
readonly jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument;
|
|
31151
|
+
/**
|
|
31152
|
+
* 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\').
|
|
31153
|
+
* @type {string}
|
|
31154
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
31155
|
+
*/
|
|
31156
|
+
readonly filter?: string;
|
|
31157
|
+
/**
|
|
31158
|
+
* 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.
|
|
31159
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
31160
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
31161
|
+
*/
|
|
31162
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
31163
|
+
}
|
|
30703
31164
|
/**
|
|
30704
31165
|
* Request parameters for patchEntityExportDefinitions operation in EntitiesApi.
|
|
30705
31166
|
* @export
|
|
@@ -30762,6 +31223,43 @@ export interface EntitiesApiPatchEntityExportTemplatesRequest {
|
|
|
30762
31223
|
*/
|
|
30763
31224
|
readonly filter?: string;
|
|
30764
31225
|
}
|
|
31226
|
+
/**
|
|
31227
|
+
* Request parameters for patchEntityFacts operation in EntitiesApi.
|
|
31228
|
+
* @export
|
|
31229
|
+
* @interface EntitiesApiPatchEntityFactsRequest
|
|
31230
|
+
*/
|
|
31231
|
+
export interface EntitiesApiPatchEntityFactsRequest {
|
|
31232
|
+
/**
|
|
31233
|
+
*
|
|
31234
|
+
* @type {string}
|
|
31235
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
31236
|
+
*/
|
|
31237
|
+
readonly workspaceId: string;
|
|
31238
|
+
/**
|
|
31239
|
+
*
|
|
31240
|
+
* @type {string}
|
|
31241
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
31242
|
+
*/
|
|
31243
|
+
readonly objectId: string;
|
|
31244
|
+
/**
|
|
31245
|
+
*
|
|
31246
|
+
* @type {JsonApiFactPatchDocument}
|
|
31247
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
31248
|
+
*/
|
|
31249
|
+
readonly jsonApiFactPatchDocument: JsonApiFactPatchDocument;
|
|
31250
|
+
/**
|
|
31251
|
+
* 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\').
|
|
31252
|
+
* @type {string}
|
|
31253
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
31254
|
+
*/
|
|
31255
|
+
readonly filter?: string;
|
|
31256
|
+
/**
|
|
31257
|
+
* 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.
|
|
31258
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
31259
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
31260
|
+
*/
|
|
31261
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
31262
|
+
}
|
|
30765
31263
|
/**
|
|
30766
31264
|
* Request parameters for patchEntityFilterContexts operation in EntitiesApi.
|
|
30767
31265
|
* @export
|
|
@@ -30886,6 +31384,43 @@ export interface EntitiesApiPatchEntityJwksRequest {
|
|
|
30886
31384
|
*/
|
|
30887
31385
|
readonly filter?: string;
|
|
30888
31386
|
}
|
|
31387
|
+
/**
|
|
31388
|
+
* Request parameters for patchEntityLabels operation in EntitiesApi.
|
|
31389
|
+
* @export
|
|
31390
|
+
* @interface EntitiesApiPatchEntityLabelsRequest
|
|
31391
|
+
*/
|
|
31392
|
+
export interface EntitiesApiPatchEntityLabelsRequest {
|
|
31393
|
+
/**
|
|
31394
|
+
*
|
|
31395
|
+
* @type {string}
|
|
31396
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
31397
|
+
*/
|
|
31398
|
+
readonly workspaceId: string;
|
|
31399
|
+
/**
|
|
31400
|
+
*
|
|
31401
|
+
* @type {string}
|
|
31402
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
31403
|
+
*/
|
|
31404
|
+
readonly objectId: string;
|
|
31405
|
+
/**
|
|
31406
|
+
*
|
|
31407
|
+
* @type {JsonApiLabelPatchDocument}
|
|
31408
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
31409
|
+
*/
|
|
31410
|
+
readonly jsonApiLabelPatchDocument: JsonApiLabelPatchDocument;
|
|
31411
|
+
/**
|
|
31412
|
+
* 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\').
|
|
31413
|
+
* @type {string}
|
|
31414
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
31415
|
+
*/
|
|
31416
|
+
readonly filter?: string;
|
|
31417
|
+
/**
|
|
31418
|
+
* 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.
|
|
31419
|
+
* @type {Array<'attributes' | 'attribute' | 'ALL'>}
|
|
31420
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
31421
|
+
*/
|
|
31422
|
+
readonly include?: Array<"attributes" | "attribute" | "ALL">;
|
|
31423
|
+
}
|
|
30889
31424
|
/**
|
|
30890
31425
|
* Request parameters for patchEntityLlmEndpoints operation in EntitiesApi.
|
|
30891
31426
|
* @export
|
|
@@ -34299,6 +34834,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
34299
34834
|
* @memberof EntitiesApi
|
|
34300
34835
|
*/
|
|
34301
34836
|
patchEntityAttributeHierarchies(requestParameters: EntitiesApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
34837
|
+
/**
|
|
34838
|
+
*
|
|
34839
|
+
* @summary Patch an Attribute (beta)
|
|
34840
|
+
* @param {EntitiesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
34841
|
+
* @param {*} [options] Override http request option.
|
|
34842
|
+
* @throws {RequiredError}
|
|
34843
|
+
* @memberof EntitiesApi
|
|
34844
|
+
*/
|
|
34845
|
+
patchEntityAttributes(requestParameters: EntitiesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
34302
34846
|
/**
|
|
34303
34847
|
*
|
|
34304
34848
|
* @summary Patch an Automation
|
|
@@ -34362,6 +34906,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
34362
34906
|
* @memberof EntitiesApi
|
|
34363
34907
|
*/
|
|
34364
34908
|
patchEntityDataSources(requestParameters: EntitiesApiPatchEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
34909
|
+
/**
|
|
34910
|
+
*
|
|
34911
|
+
* @summary Patch a Dataset (beta)
|
|
34912
|
+
* @param {EntitiesApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
34913
|
+
* @param {*} [options] Override http request option.
|
|
34914
|
+
* @throws {RequiredError}
|
|
34915
|
+
* @memberof EntitiesApi
|
|
34916
|
+
*/
|
|
34917
|
+
patchEntityDatasets(requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
34365
34918
|
/**
|
|
34366
34919
|
*
|
|
34367
34920
|
* @summary Patch an Export Definition
|
|
@@ -34380,6 +34933,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
34380
34933
|
* @memberof EntitiesApi
|
|
34381
34934
|
*/
|
|
34382
34935
|
patchEntityExportTemplates(requestParameters: EntitiesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
34936
|
+
/**
|
|
34937
|
+
*
|
|
34938
|
+
* @summary Patch a Fact (beta)
|
|
34939
|
+
* @param {EntitiesApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
34940
|
+
* @param {*} [options] Override http request option.
|
|
34941
|
+
* @throws {RequiredError}
|
|
34942
|
+
* @memberof EntitiesApi
|
|
34943
|
+
*/
|
|
34944
|
+
patchEntityFacts(requestParameters: EntitiesApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
34383
34945
|
/**
|
|
34384
34946
|
*
|
|
34385
34947
|
* @summary Patch a Context Filter
|
|
@@ -34416,6 +34978,15 @@ export declare class EntitiesApi extends BaseAPI implements EntitiesApiInterface
|
|
|
34416
34978
|
* @memberof EntitiesApi
|
|
34417
34979
|
*/
|
|
34418
34980
|
patchEntityJwks(requestParameters: EntitiesApiPatchEntityJwksRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiJwkOutDocument>;
|
|
34981
|
+
/**
|
|
34982
|
+
*
|
|
34983
|
+
* @summary Patch a Label (beta)
|
|
34984
|
+
* @param {EntitiesApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
34985
|
+
* @param {*} [options] Override http request option.
|
|
34986
|
+
* @throws {RequiredError}
|
|
34987
|
+
* @memberof EntitiesApi
|
|
34988
|
+
*/
|
|
34989
|
+
patchEntityLabels(requestParameters: EntitiesApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
34419
34990
|
/**
|
|
34420
34991
|
*
|
|
34421
34992
|
* @summary Patch LLM endpoint entity
|
|
@@ -36179,6 +36750,19 @@ export declare function FactsApiAxiosParamCreator_GetAllEntitiesFacts(workspaceI
|
|
|
36179
36750
|
* @throws {RequiredError}
|
|
36180
36751
|
*/
|
|
36181
36752
|
export declare function FactsApiAxiosParamCreator_GetEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36753
|
+
/**
|
|
36754
|
+
*
|
|
36755
|
+
* @summary Patch a Fact (beta)
|
|
36756
|
+
* @param {string} workspaceId
|
|
36757
|
+
* @param {string} objectId
|
|
36758
|
+
* @param {JsonApiFactPatchDocument} jsonApiFactPatchDocument
|
|
36759
|
+
* @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\').
|
|
36760
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
36761
|
+
* @param {*} [options] Override http request option.
|
|
36762
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
36763
|
+
* @throws {RequiredError}
|
|
36764
|
+
*/
|
|
36765
|
+
export declare function FactsApiAxiosParamCreator_PatchEntityFacts(workspaceId: string, objectId: string, jsonApiFactPatchDocument: JsonApiFactPatchDocument, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36182
36766
|
/**
|
|
36183
36767
|
*
|
|
36184
36768
|
* @summary Get all Facts
|
|
@@ -36201,6 +36785,17 @@ export declare function FactsApi_GetAllEntitiesFacts(axios: AxiosInstance, baseP
|
|
|
36201
36785
|
* @throws {RequiredError}
|
|
36202
36786
|
*/
|
|
36203
36787
|
export declare function FactsApi_GetEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: FactsApiGetEntityFactsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiFactOutDocument>;
|
|
36788
|
+
/**
|
|
36789
|
+
*
|
|
36790
|
+
* @summary Patch a Fact (beta)
|
|
36791
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
36792
|
+
* @param {string} basePath Base path.
|
|
36793
|
+
* @param {FactsApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
36794
|
+
* @param {*} [options] Override http request option.
|
|
36795
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
36796
|
+
* @throws {RequiredError}
|
|
36797
|
+
*/
|
|
36798
|
+
export declare function FactsApi_PatchEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: FactsApiPatchEntityFactsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiFactOutDocument>;
|
|
36204
36799
|
/**
|
|
36205
36800
|
* FactsApi - interface
|
|
36206
36801
|
* @export
|
|
@@ -36225,6 +36820,15 @@ export interface FactsApiInterface {
|
|
|
36225
36820
|
* @memberof FactsApiInterface
|
|
36226
36821
|
*/
|
|
36227
36822
|
getEntityFacts(requestParameters: FactsApiGetEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
36823
|
+
/**
|
|
36824
|
+
*
|
|
36825
|
+
* @summary Patch a Fact (beta)
|
|
36826
|
+
* @param {FactsApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
36827
|
+
* @param {*} [options] Override http request option.
|
|
36828
|
+
* @throws {RequiredError}
|
|
36829
|
+
* @memberof FactsApiInterface
|
|
36830
|
+
*/
|
|
36831
|
+
patchEntityFacts(requestParameters: FactsApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
36228
36832
|
}
|
|
36229
36833
|
/**
|
|
36230
36834
|
* Request parameters for getAllEntitiesFacts operation in FactsApi.
|
|
@@ -36330,6 +36934,43 @@ export interface FactsApiGetEntityFactsRequest {
|
|
|
36330
36934
|
*/
|
|
36331
36935
|
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
36332
36936
|
}
|
|
36937
|
+
/**
|
|
36938
|
+
* Request parameters for patchEntityFacts operation in FactsApi.
|
|
36939
|
+
* @export
|
|
36940
|
+
* @interface FactsApiPatchEntityFactsRequest
|
|
36941
|
+
*/
|
|
36942
|
+
export interface FactsApiPatchEntityFactsRequest {
|
|
36943
|
+
/**
|
|
36944
|
+
*
|
|
36945
|
+
* @type {string}
|
|
36946
|
+
* @memberof FactsApiPatchEntityFacts
|
|
36947
|
+
*/
|
|
36948
|
+
readonly workspaceId: string;
|
|
36949
|
+
/**
|
|
36950
|
+
*
|
|
36951
|
+
* @type {string}
|
|
36952
|
+
* @memberof FactsApiPatchEntityFacts
|
|
36953
|
+
*/
|
|
36954
|
+
readonly objectId: string;
|
|
36955
|
+
/**
|
|
36956
|
+
*
|
|
36957
|
+
* @type {JsonApiFactPatchDocument}
|
|
36958
|
+
* @memberof FactsApiPatchEntityFacts
|
|
36959
|
+
*/
|
|
36960
|
+
readonly jsonApiFactPatchDocument: JsonApiFactPatchDocument;
|
|
36961
|
+
/**
|
|
36962
|
+
* 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\').
|
|
36963
|
+
* @type {string}
|
|
36964
|
+
* @memberof FactsApiPatchEntityFacts
|
|
36965
|
+
*/
|
|
36966
|
+
readonly filter?: string;
|
|
36967
|
+
/**
|
|
36968
|
+
* 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.
|
|
36969
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
36970
|
+
* @memberof FactsApiPatchEntityFacts
|
|
36971
|
+
*/
|
|
36972
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
36973
|
+
}
|
|
36333
36974
|
/**
|
|
36334
36975
|
* FactsApi - object-oriented interface
|
|
36335
36976
|
* @export
|
|
@@ -36355,6 +36996,15 @@ export declare class FactsApi extends BaseAPI implements FactsApiInterface {
|
|
|
36355
36996
|
* @memberof FactsApi
|
|
36356
36997
|
*/
|
|
36357
36998
|
getEntityFacts(requestParameters: FactsApiGetEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
36999
|
+
/**
|
|
37000
|
+
*
|
|
37001
|
+
* @summary Patch a Fact (beta)
|
|
37002
|
+
* @param {FactsApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
37003
|
+
* @param {*} [options] Override http request option.
|
|
37004
|
+
* @throws {RequiredError}
|
|
37005
|
+
* @memberof FactsApi
|
|
37006
|
+
*/
|
|
37007
|
+
patchEntityFacts(requestParameters: FactsApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
36358
37008
|
}
|
|
36359
37009
|
/**
|
|
36360
37010
|
*
|
|
@@ -38742,6 +39392,19 @@ export declare function LabelsApiAxiosParamCreator_GetAllEntitiesLabels(workspac
|
|
|
38742
39392
|
* @throws {RequiredError}
|
|
38743
39393
|
*/
|
|
38744
39394
|
export declare function LabelsApiAxiosParamCreator_GetEntityLabels(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39395
|
+
/**
|
|
39396
|
+
*
|
|
39397
|
+
* @summary Patch a Label (beta)
|
|
39398
|
+
* @param {string} workspaceId
|
|
39399
|
+
* @param {string} objectId
|
|
39400
|
+
* @param {JsonApiLabelPatchDocument} jsonApiLabelPatchDocument
|
|
39401
|
+
* @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\').
|
|
39402
|
+
* @param {Array<'attributes' | 'attribute' | '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.
|
|
39403
|
+
* @param {*} [options] Override http request option.
|
|
39404
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
39405
|
+
* @throws {RequiredError}
|
|
39406
|
+
*/
|
|
39407
|
+
export declare function LabelsApiAxiosParamCreator_PatchEntityLabels(workspaceId: string, objectId: string, jsonApiLabelPatchDocument: JsonApiLabelPatchDocument, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38745
39408
|
/**
|
|
38746
39409
|
*
|
|
38747
39410
|
* @summary Get all Labels
|
|
@@ -38764,6 +39427,17 @@ export declare function LabelsApi_GetAllEntitiesLabels(axios: AxiosInstance, bas
|
|
|
38764
39427
|
* @throws {RequiredError}
|
|
38765
39428
|
*/
|
|
38766
39429
|
export declare function LabelsApi_GetEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: LabelsApiGetEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
39430
|
+
/**
|
|
39431
|
+
*
|
|
39432
|
+
* @summary Patch a Label (beta)
|
|
39433
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
39434
|
+
* @param {string} basePath Base path.
|
|
39435
|
+
* @param {LabelsApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
39436
|
+
* @param {*} [options] Override http request option.
|
|
39437
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
39438
|
+
* @throws {RequiredError}
|
|
39439
|
+
*/
|
|
39440
|
+
export declare function LabelsApi_PatchEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: LabelsApiPatchEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
38767
39441
|
/**
|
|
38768
39442
|
* LabelsApi - interface
|
|
38769
39443
|
* @export
|
|
@@ -38788,6 +39462,15 @@ export interface LabelsApiInterface {
|
|
|
38788
39462
|
* @memberof LabelsApiInterface
|
|
38789
39463
|
*/
|
|
38790
39464
|
getEntityLabels(requestParameters: LabelsApiGetEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
39465
|
+
/**
|
|
39466
|
+
*
|
|
39467
|
+
* @summary Patch a Label (beta)
|
|
39468
|
+
* @param {LabelsApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
39469
|
+
* @param {*} [options] Override http request option.
|
|
39470
|
+
* @throws {RequiredError}
|
|
39471
|
+
* @memberof LabelsApiInterface
|
|
39472
|
+
*/
|
|
39473
|
+
patchEntityLabels(requestParameters: LabelsApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
38791
39474
|
}
|
|
38792
39475
|
/**
|
|
38793
39476
|
* Request parameters for getAllEntitiesLabels operation in LabelsApi.
|
|
@@ -38893,6 +39576,43 @@ export interface LabelsApiGetEntityLabelsRequest {
|
|
|
38893
39576
|
*/
|
|
38894
39577
|
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
38895
39578
|
}
|
|
39579
|
+
/**
|
|
39580
|
+
* Request parameters for patchEntityLabels operation in LabelsApi.
|
|
39581
|
+
* @export
|
|
39582
|
+
* @interface LabelsApiPatchEntityLabelsRequest
|
|
39583
|
+
*/
|
|
39584
|
+
export interface LabelsApiPatchEntityLabelsRequest {
|
|
39585
|
+
/**
|
|
39586
|
+
*
|
|
39587
|
+
* @type {string}
|
|
39588
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
39589
|
+
*/
|
|
39590
|
+
readonly workspaceId: string;
|
|
39591
|
+
/**
|
|
39592
|
+
*
|
|
39593
|
+
* @type {string}
|
|
39594
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
39595
|
+
*/
|
|
39596
|
+
readonly objectId: string;
|
|
39597
|
+
/**
|
|
39598
|
+
*
|
|
39599
|
+
* @type {JsonApiLabelPatchDocument}
|
|
39600
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
39601
|
+
*/
|
|
39602
|
+
readonly jsonApiLabelPatchDocument: JsonApiLabelPatchDocument;
|
|
39603
|
+
/**
|
|
39604
|
+
* 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\').
|
|
39605
|
+
* @type {string}
|
|
39606
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
39607
|
+
*/
|
|
39608
|
+
readonly filter?: string;
|
|
39609
|
+
/**
|
|
39610
|
+
* 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.
|
|
39611
|
+
* @type {Array<'attributes' | 'attribute' | 'ALL'>}
|
|
39612
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
39613
|
+
*/
|
|
39614
|
+
readonly include?: Array<"attributes" | "attribute" | "ALL">;
|
|
39615
|
+
}
|
|
38896
39616
|
/**
|
|
38897
39617
|
* LabelsApi - object-oriented interface
|
|
38898
39618
|
* @export
|
|
@@ -38918,6 +39638,15 @@ export declare class LabelsApi extends BaseAPI implements LabelsApiInterface {
|
|
|
38918
39638
|
* @memberof LabelsApi
|
|
38919
39639
|
*/
|
|
38920
39640
|
getEntityLabels(requestParameters: LabelsApiGetEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
39641
|
+
/**
|
|
39642
|
+
*
|
|
39643
|
+
* @summary Patch a Label (beta)
|
|
39644
|
+
* @param {LabelsApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
39645
|
+
* @param {*} [options] Override http request option.
|
|
39646
|
+
* @throws {RequiredError}
|
|
39647
|
+
* @memberof LabelsApi
|
|
39648
|
+
*/
|
|
39649
|
+
patchEntityLabels(requestParameters: LabelsApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
38921
39650
|
}
|
|
38922
39651
|
/**
|
|
38923
39652
|
* Retrieve current analytics model of the workspace.
|
|
@@ -55668,6 +56397,19 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
55668
56397
|
* @throws {RequiredError}
|
|
55669
56398
|
*/
|
|
55670
56399
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityAttributeHierarchies(workspaceId: string, objectId: string, jsonApiAttributeHierarchyPatchDocument: JsonApiAttributeHierarchyPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
56400
|
+
/**
|
|
56401
|
+
*
|
|
56402
|
+
* @summary Patch an Attribute (beta)
|
|
56403
|
+
* @param {string} workspaceId
|
|
56404
|
+
* @param {string} objectId
|
|
56405
|
+
* @param {JsonApiAttributePatchDocument} jsonApiAttributePatchDocument
|
|
56406
|
+
* @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\').
|
|
56407
|
+
* @param {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | '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.
|
|
56408
|
+
* @param {*} [options] Override http request option.
|
|
56409
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
56410
|
+
* @throws {RequiredError}
|
|
56411
|
+
*/
|
|
56412
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityAttributes(workspaceId: string, objectId: string, jsonApiAttributePatchDocument: JsonApiAttributePatchDocument, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
55671
56413
|
/**
|
|
55672
56414
|
*
|
|
55673
56415
|
* @summary Patch an Automation
|
|
@@ -55706,6 +56448,19 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
55706
56448
|
* @throws {RequiredError}
|
|
55707
56449
|
*/
|
|
55708
56450
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityDashboardPlugins(workspaceId: string, objectId: string, jsonApiDashboardPluginPatchDocument: JsonApiDashboardPluginPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
56451
|
+
/**
|
|
56452
|
+
*
|
|
56453
|
+
* @summary Patch a Dataset (beta)
|
|
56454
|
+
* @param {string} workspaceId
|
|
56455
|
+
* @param {string} objectId
|
|
56456
|
+
* @param {JsonApiDatasetPatchDocument} jsonApiDatasetPatchDocument
|
|
56457
|
+
* @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\').
|
|
56458
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
56459
|
+
* @param {*} [options] Override http request option.
|
|
56460
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
56461
|
+
* @throws {RequiredError}
|
|
56462
|
+
*/
|
|
56463
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityDatasets(workspaceId: string, objectId: string, jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
55709
56464
|
/**
|
|
55710
56465
|
*
|
|
55711
56466
|
* @summary Patch an Export Definition
|
|
@@ -55719,6 +56474,19 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
55719
56474
|
* @throws {RequiredError}
|
|
55720
56475
|
*/
|
|
55721
56476
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityExportDefinitions(workspaceId: string, objectId: string, jsonApiExportDefinitionPatchDocument: JsonApiExportDefinitionPatchDocument, filter?: string, include?: Array<"visualizationObjects" | "analyticalDashboards" | "automations" | "userIdentifiers" | "visualizationObject" | "analyticalDashboard" | "automation" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
56477
|
+
/**
|
|
56478
|
+
*
|
|
56479
|
+
* @summary Patch a Fact (beta)
|
|
56480
|
+
* @param {string} workspaceId
|
|
56481
|
+
* @param {string} objectId
|
|
56482
|
+
* @param {JsonApiFactPatchDocument} jsonApiFactPatchDocument
|
|
56483
|
+
* @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\').
|
|
56484
|
+
* @param {Array<'datasets' | 'dataset' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
56485
|
+
* @param {*} [options] Override http request option.
|
|
56486
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
56487
|
+
* @throws {RequiredError}
|
|
56488
|
+
*/
|
|
56489
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityFacts(workspaceId: string, objectId: string, jsonApiFactPatchDocument: JsonApiFactPatchDocument, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
55722
56490
|
/**
|
|
55723
56491
|
*
|
|
55724
56492
|
* @summary Patch a Context Filter
|
|
@@ -55745,6 +56513,19 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
55745
56513
|
* @throws {RequiredError}
|
|
55746
56514
|
*/
|
|
55747
56515
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityFilterViews(workspaceId: string, objectId: string, jsonApiFilterViewPatchDocument: JsonApiFilterViewPatchDocument, filter?: string, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
56516
|
+
/**
|
|
56517
|
+
*
|
|
56518
|
+
* @summary Patch a Label (beta)
|
|
56519
|
+
* @param {string} workspaceId
|
|
56520
|
+
* @param {string} objectId
|
|
56521
|
+
* @param {JsonApiLabelPatchDocument} jsonApiLabelPatchDocument
|
|
56522
|
+
* @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\').
|
|
56523
|
+
* @param {Array<'attributes' | 'attribute' | '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.
|
|
56524
|
+
* @param {*} [options] Override http request option.
|
|
56525
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
56526
|
+
* @throws {RequiredError}
|
|
56527
|
+
*/
|
|
56528
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityLabels(workspaceId: string, objectId: string, jsonApiLabelPatchDocument: JsonApiLabelPatchDocument, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
55748
56529
|
/**
|
|
55749
56530
|
*
|
|
55750
56531
|
* @param {string} workspaceId
|
|
@@ -57063,6 +57844,17 @@ export declare function WorkspaceObjectControllerApi_PatchEntityAnalyticalDashbo
|
|
|
57063
57844
|
* @throws {RequiredError}
|
|
57064
57845
|
*/
|
|
57065
57846
|
export declare function WorkspaceObjectControllerApi_PatchEntityAttributeHierarchies(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
57847
|
+
/**
|
|
57848
|
+
*
|
|
57849
|
+
* @summary Patch an Attribute (beta)
|
|
57850
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
57851
|
+
* @param {string} basePath Base path.
|
|
57852
|
+
* @param {WorkspaceObjectControllerApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
57853
|
+
* @param {*} [options] Override http request option.
|
|
57854
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
57855
|
+
* @throws {RequiredError}
|
|
57856
|
+
*/
|
|
57857
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
57066
57858
|
/**
|
|
57067
57859
|
*
|
|
57068
57860
|
* @summary Patch an Automation
|
|
@@ -57096,6 +57888,17 @@ export declare function WorkspaceObjectControllerApi_PatchEntityCustomApplicatio
|
|
|
57096
57888
|
* @throws {RequiredError}
|
|
57097
57889
|
*/
|
|
57098
57890
|
export declare function WorkspaceObjectControllerApi_PatchEntityDashboardPlugins(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
57891
|
+
/**
|
|
57892
|
+
*
|
|
57893
|
+
* @summary Patch a Dataset (beta)
|
|
57894
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
57895
|
+
* @param {string} basePath Base path.
|
|
57896
|
+
* @param {WorkspaceObjectControllerApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
57897
|
+
* @param {*} [options] Override http request option.
|
|
57898
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
57899
|
+
* @throws {RequiredError}
|
|
57900
|
+
*/
|
|
57901
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
57099
57902
|
/**
|
|
57100
57903
|
*
|
|
57101
57904
|
* @summary Patch an Export Definition
|
|
@@ -57107,6 +57910,17 @@ export declare function WorkspaceObjectControllerApi_PatchEntityDashboardPlugins
|
|
|
57107
57910
|
* @throws {RequiredError}
|
|
57108
57911
|
*/
|
|
57109
57912
|
export declare function WorkspaceObjectControllerApi_PatchEntityExportDefinitions(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiExportDefinitionOutDocument>;
|
|
57913
|
+
/**
|
|
57914
|
+
*
|
|
57915
|
+
* @summary Patch a Fact (beta)
|
|
57916
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
57917
|
+
* @param {string} basePath Base path.
|
|
57918
|
+
* @param {WorkspaceObjectControllerApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
57919
|
+
* @param {*} [options] Override http request option.
|
|
57920
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
57921
|
+
* @throws {RequiredError}
|
|
57922
|
+
*/
|
|
57923
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityFactsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiFactOutDocument>;
|
|
57110
57924
|
/**
|
|
57111
57925
|
*
|
|
57112
57926
|
* @summary Patch a Context Filter
|
|
@@ -57129,6 +57943,17 @@ export declare function WorkspaceObjectControllerApi_PatchEntityFilterContexts(a
|
|
|
57129
57943
|
* @throws {RequiredError}
|
|
57130
57944
|
*/
|
|
57131
57945
|
export declare function WorkspaceObjectControllerApi_PatchEntityFilterViews(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
57946
|
+
/**
|
|
57947
|
+
*
|
|
57948
|
+
* @summary Patch a Label (beta)
|
|
57949
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
57950
|
+
* @param {string} basePath Base path.
|
|
57951
|
+
* @param {WorkspaceObjectControllerApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
57952
|
+
* @param {*} [options] Override http request option.
|
|
57953
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
57954
|
+
* @throws {RequiredError}
|
|
57955
|
+
*/
|
|
57956
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
57132
57957
|
/**
|
|
57133
57958
|
*
|
|
57134
57959
|
* @param {AxiosInstance} axios Axios instance.
|
|
@@ -58247,6 +59072,15 @@ export interface WorkspaceObjectControllerApiInterface {
|
|
|
58247
59072
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
58248
59073
|
*/
|
|
58249
59074
|
patchEntityAttributeHierarchies(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
59075
|
+
/**
|
|
59076
|
+
*
|
|
59077
|
+
* @summary Patch an Attribute (beta)
|
|
59078
|
+
* @param {WorkspaceObjectControllerApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
59079
|
+
* @param {*} [options] Override http request option.
|
|
59080
|
+
* @throws {RequiredError}
|
|
59081
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
59082
|
+
*/
|
|
59083
|
+
patchEntityAttributes(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
58250
59084
|
/**
|
|
58251
59085
|
*
|
|
58252
59086
|
* @summary Patch an Automation
|
|
@@ -58274,6 +59108,15 @@ export interface WorkspaceObjectControllerApiInterface {
|
|
|
58274
59108
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
58275
59109
|
*/
|
|
58276
59110
|
patchEntityDashboardPlugins(requestParameters: WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
59111
|
+
/**
|
|
59112
|
+
*
|
|
59113
|
+
* @summary Patch a Dataset (beta)
|
|
59114
|
+
* @param {WorkspaceObjectControllerApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
59115
|
+
* @param {*} [options] Override http request option.
|
|
59116
|
+
* @throws {RequiredError}
|
|
59117
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
59118
|
+
*/
|
|
59119
|
+
patchEntityDatasets(requestParameters: WorkspaceObjectControllerApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
58277
59120
|
/**
|
|
58278
59121
|
*
|
|
58279
59122
|
* @summary Patch an Export Definition
|
|
@@ -58283,6 +59126,15 @@ export interface WorkspaceObjectControllerApiInterface {
|
|
|
58283
59126
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
58284
59127
|
*/
|
|
58285
59128
|
patchEntityExportDefinitions(requestParameters: WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportDefinitionOutDocument>;
|
|
59129
|
+
/**
|
|
59130
|
+
*
|
|
59131
|
+
* @summary Patch a Fact (beta)
|
|
59132
|
+
* @param {WorkspaceObjectControllerApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
59133
|
+
* @param {*} [options] Override http request option.
|
|
59134
|
+
* @throws {RequiredError}
|
|
59135
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
59136
|
+
*/
|
|
59137
|
+
patchEntityFacts(requestParameters: WorkspaceObjectControllerApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
58286
59138
|
/**
|
|
58287
59139
|
*
|
|
58288
59140
|
* @summary Patch a Context Filter
|
|
@@ -58301,6 +59153,15 @@ export interface WorkspaceObjectControllerApiInterface {
|
|
|
58301
59153
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
58302
59154
|
*/
|
|
58303
59155
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
59156
|
+
/**
|
|
59157
|
+
*
|
|
59158
|
+
* @summary Patch a Label (beta)
|
|
59159
|
+
* @param {WorkspaceObjectControllerApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
59160
|
+
* @param {*} [options] Override http request option.
|
|
59161
|
+
* @throws {RequiredError}
|
|
59162
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
59163
|
+
*/
|
|
59164
|
+
patchEntityLabels(requestParameters: WorkspaceObjectControllerApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
58304
59165
|
/**
|
|
58305
59166
|
*
|
|
58306
59167
|
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
@@ -61632,6 +62493,43 @@ export interface WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequ
|
|
|
61632
62493
|
*/
|
|
61633
62494
|
readonly include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">;
|
|
61634
62495
|
}
|
|
62496
|
+
/**
|
|
62497
|
+
* Request parameters for patchEntityAttributes operation in WorkspaceObjectControllerApi.
|
|
62498
|
+
* @export
|
|
62499
|
+
* @interface WorkspaceObjectControllerApiPatchEntityAttributesRequest
|
|
62500
|
+
*/
|
|
62501
|
+
export interface WorkspaceObjectControllerApiPatchEntityAttributesRequest {
|
|
62502
|
+
/**
|
|
62503
|
+
*
|
|
62504
|
+
* @type {string}
|
|
62505
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
62506
|
+
*/
|
|
62507
|
+
readonly workspaceId: string;
|
|
62508
|
+
/**
|
|
62509
|
+
*
|
|
62510
|
+
* @type {string}
|
|
62511
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
62512
|
+
*/
|
|
62513
|
+
readonly objectId: string;
|
|
62514
|
+
/**
|
|
62515
|
+
*
|
|
62516
|
+
* @type {JsonApiAttributePatchDocument}
|
|
62517
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
62518
|
+
*/
|
|
62519
|
+
readonly jsonApiAttributePatchDocument: JsonApiAttributePatchDocument;
|
|
62520
|
+
/**
|
|
62521
|
+
* 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\').
|
|
62522
|
+
* @type {string}
|
|
62523
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
62524
|
+
*/
|
|
62525
|
+
readonly filter?: string;
|
|
62526
|
+
/**
|
|
62527
|
+
* 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.
|
|
62528
|
+
* @type {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | 'ALL'>}
|
|
62529
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
62530
|
+
*/
|
|
62531
|
+
readonly include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">;
|
|
62532
|
+
}
|
|
61635
62533
|
/**
|
|
61636
62534
|
* Request parameters for patchEntityAutomations operation in WorkspaceObjectControllerApi.
|
|
61637
62535
|
* @export
|
|
@@ -61737,6 +62635,43 @@ export interface WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest
|
|
|
61737
62635
|
*/
|
|
61738
62636
|
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
61739
62637
|
}
|
|
62638
|
+
/**
|
|
62639
|
+
* Request parameters for patchEntityDatasets operation in WorkspaceObjectControllerApi.
|
|
62640
|
+
* @export
|
|
62641
|
+
* @interface WorkspaceObjectControllerApiPatchEntityDatasetsRequest
|
|
62642
|
+
*/
|
|
62643
|
+
export interface WorkspaceObjectControllerApiPatchEntityDatasetsRequest {
|
|
62644
|
+
/**
|
|
62645
|
+
*
|
|
62646
|
+
* @type {string}
|
|
62647
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
62648
|
+
*/
|
|
62649
|
+
readonly workspaceId: string;
|
|
62650
|
+
/**
|
|
62651
|
+
*
|
|
62652
|
+
* @type {string}
|
|
62653
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
62654
|
+
*/
|
|
62655
|
+
readonly objectId: string;
|
|
62656
|
+
/**
|
|
62657
|
+
*
|
|
62658
|
+
* @type {JsonApiDatasetPatchDocument}
|
|
62659
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
62660
|
+
*/
|
|
62661
|
+
readonly jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument;
|
|
62662
|
+
/**
|
|
62663
|
+
* 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\').
|
|
62664
|
+
* @type {string}
|
|
62665
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
62666
|
+
*/
|
|
62667
|
+
readonly filter?: string;
|
|
62668
|
+
/**
|
|
62669
|
+
* 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.
|
|
62670
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
62671
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
62672
|
+
*/
|
|
62673
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
62674
|
+
}
|
|
61740
62675
|
/**
|
|
61741
62676
|
* Request parameters for patchEntityExportDefinitions operation in WorkspaceObjectControllerApi.
|
|
61742
62677
|
* @export
|
|
@@ -61774,6 +62709,43 @@ export interface WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest
|
|
|
61774
62709
|
*/
|
|
61775
62710
|
readonly include?: Array<"visualizationObjects" | "analyticalDashboards" | "automations" | "userIdentifiers" | "visualizationObject" | "analyticalDashboard" | "automation" | "createdBy" | "modifiedBy" | "ALL">;
|
|
61776
62711
|
}
|
|
62712
|
+
/**
|
|
62713
|
+
* Request parameters for patchEntityFacts operation in WorkspaceObjectControllerApi.
|
|
62714
|
+
* @export
|
|
62715
|
+
* @interface WorkspaceObjectControllerApiPatchEntityFactsRequest
|
|
62716
|
+
*/
|
|
62717
|
+
export interface WorkspaceObjectControllerApiPatchEntityFactsRequest {
|
|
62718
|
+
/**
|
|
62719
|
+
*
|
|
62720
|
+
* @type {string}
|
|
62721
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
62722
|
+
*/
|
|
62723
|
+
readonly workspaceId: string;
|
|
62724
|
+
/**
|
|
62725
|
+
*
|
|
62726
|
+
* @type {string}
|
|
62727
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
62728
|
+
*/
|
|
62729
|
+
readonly objectId: string;
|
|
62730
|
+
/**
|
|
62731
|
+
*
|
|
62732
|
+
* @type {JsonApiFactPatchDocument}
|
|
62733
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
62734
|
+
*/
|
|
62735
|
+
readonly jsonApiFactPatchDocument: JsonApiFactPatchDocument;
|
|
62736
|
+
/**
|
|
62737
|
+
* 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\').
|
|
62738
|
+
* @type {string}
|
|
62739
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
62740
|
+
*/
|
|
62741
|
+
readonly filter?: string;
|
|
62742
|
+
/**
|
|
62743
|
+
* 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.
|
|
62744
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
62745
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
62746
|
+
*/
|
|
62747
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
62748
|
+
}
|
|
61777
62749
|
/**
|
|
61778
62750
|
* Request parameters for patchEntityFilterContexts operation in WorkspaceObjectControllerApi.
|
|
61779
62751
|
* @export
|
|
@@ -61848,6 +62820,43 @@ export interface WorkspaceObjectControllerApiPatchEntityFilterViewsRequest {
|
|
|
61848
62820
|
*/
|
|
61849
62821
|
readonly include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">;
|
|
61850
62822
|
}
|
|
62823
|
+
/**
|
|
62824
|
+
* Request parameters for patchEntityLabels operation in WorkspaceObjectControllerApi.
|
|
62825
|
+
* @export
|
|
62826
|
+
* @interface WorkspaceObjectControllerApiPatchEntityLabelsRequest
|
|
62827
|
+
*/
|
|
62828
|
+
export interface WorkspaceObjectControllerApiPatchEntityLabelsRequest {
|
|
62829
|
+
/**
|
|
62830
|
+
*
|
|
62831
|
+
* @type {string}
|
|
62832
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
62833
|
+
*/
|
|
62834
|
+
readonly workspaceId: string;
|
|
62835
|
+
/**
|
|
62836
|
+
*
|
|
62837
|
+
* @type {string}
|
|
62838
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
62839
|
+
*/
|
|
62840
|
+
readonly objectId: string;
|
|
62841
|
+
/**
|
|
62842
|
+
*
|
|
62843
|
+
* @type {JsonApiLabelPatchDocument}
|
|
62844
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
62845
|
+
*/
|
|
62846
|
+
readonly jsonApiLabelPatchDocument: JsonApiLabelPatchDocument;
|
|
62847
|
+
/**
|
|
62848
|
+
* 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\').
|
|
62849
|
+
* @type {string}
|
|
62850
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
62851
|
+
*/
|
|
62852
|
+
readonly filter?: string;
|
|
62853
|
+
/**
|
|
62854
|
+
* 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.
|
|
62855
|
+
* @type {Array<'attributes' | 'attribute' | 'ALL'>}
|
|
62856
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
62857
|
+
*/
|
|
62858
|
+
readonly include?: Array<"attributes" | "attribute" | "ALL">;
|
|
62859
|
+
}
|
|
61851
62860
|
/**
|
|
61852
62861
|
* Request parameters for patchEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
61853
62862
|
* @export
|
|
@@ -63944,6 +64953,15 @@ export declare class WorkspaceObjectControllerApi extends BaseAPI implements Wor
|
|
|
63944
64953
|
* @memberof WorkspaceObjectControllerApi
|
|
63945
64954
|
*/
|
|
63946
64955
|
patchEntityAttributeHierarchies(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
64956
|
+
/**
|
|
64957
|
+
*
|
|
64958
|
+
* @summary Patch an Attribute (beta)
|
|
64959
|
+
* @param {WorkspaceObjectControllerApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
64960
|
+
* @param {*} [options] Override http request option.
|
|
64961
|
+
* @throws {RequiredError}
|
|
64962
|
+
* @memberof WorkspaceObjectControllerApi
|
|
64963
|
+
*/
|
|
64964
|
+
patchEntityAttributes(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
63947
64965
|
/**
|
|
63948
64966
|
*
|
|
63949
64967
|
* @summary Patch an Automation
|
|
@@ -63971,6 +64989,15 @@ export declare class WorkspaceObjectControllerApi extends BaseAPI implements Wor
|
|
|
63971
64989
|
* @memberof WorkspaceObjectControllerApi
|
|
63972
64990
|
*/
|
|
63973
64991
|
patchEntityDashboardPlugins(requestParameters: WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
64992
|
+
/**
|
|
64993
|
+
*
|
|
64994
|
+
* @summary Patch a Dataset (beta)
|
|
64995
|
+
* @param {WorkspaceObjectControllerApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
64996
|
+
* @param {*} [options] Override http request option.
|
|
64997
|
+
* @throws {RequiredError}
|
|
64998
|
+
* @memberof WorkspaceObjectControllerApi
|
|
64999
|
+
*/
|
|
65000
|
+
patchEntityDatasets(requestParameters: WorkspaceObjectControllerApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
63974
65001
|
/**
|
|
63975
65002
|
*
|
|
63976
65003
|
* @summary Patch an Export Definition
|
|
@@ -63980,6 +65007,15 @@ export declare class WorkspaceObjectControllerApi extends BaseAPI implements Wor
|
|
|
63980
65007
|
* @memberof WorkspaceObjectControllerApi
|
|
63981
65008
|
*/
|
|
63982
65009
|
patchEntityExportDefinitions(requestParameters: WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportDefinitionOutDocument>;
|
|
65010
|
+
/**
|
|
65011
|
+
*
|
|
65012
|
+
* @summary Patch a Fact (beta)
|
|
65013
|
+
* @param {WorkspaceObjectControllerApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
65014
|
+
* @param {*} [options] Override http request option.
|
|
65015
|
+
* @throws {RequiredError}
|
|
65016
|
+
* @memberof WorkspaceObjectControllerApi
|
|
65017
|
+
*/
|
|
65018
|
+
patchEntityFacts(requestParameters: WorkspaceObjectControllerApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
63983
65019
|
/**
|
|
63984
65020
|
*
|
|
63985
65021
|
* @summary Patch a Context Filter
|
|
@@ -63998,6 +65034,15 @@ export declare class WorkspaceObjectControllerApi extends BaseAPI implements Wor
|
|
|
63998
65034
|
* @memberof WorkspaceObjectControllerApi
|
|
63999
65035
|
*/
|
|
64000
65036
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
65037
|
+
/**
|
|
65038
|
+
*
|
|
65039
|
+
* @summary Patch a Label (beta)
|
|
65040
|
+
* @param {WorkspaceObjectControllerApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
65041
|
+
* @param {*} [options] Override http request option.
|
|
65042
|
+
* @throws {RequiredError}
|
|
65043
|
+
* @memberof WorkspaceObjectControllerApi
|
|
65044
|
+
*/
|
|
65045
|
+
patchEntityLabels(requestParameters: WorkspaceObjectControllerApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
64001
65046
|
/**
|
|
64002
65047
|
*
|
|
64003
65048
|
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|