@gooddata/api-client-tiger 10.1.0-alpha.1 → 10.1.0-alpha.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +2594 -1017
- package/esm/generated/afm-rest-api/api.d.ts +816 -24
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +716 -7
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +1129 -767
- package/esm/generated/export-json-api/api.d.ts +89 -89
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +42 -42
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +5 -5
- package/esm/generated/metadata-json-api/api.d.ts +1598 -990
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +644 -14
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +4551 -4511
- package/esm/generated/result-json-api/api.d.ts +501 -0
- package/esm/generated/result-json-api/api.d.ts.map +1 -1
- package/esm/generated/result-json-api/api.js +519 -0
- package/esm/generated/result-json-api/api.js.map +1 -1
- package/esm/generated/result-json-api/openapi-spec.json +187 -0
- package/esm/generated/scan-json-api/api.d.ts +343 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +102 -0
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +257 -0
- package/esm/index.d.ts +3 -3
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +3 -2
- package/esm/index.js.map +1 -1
- package/esm/metadataUtilities.d.ts +2 -2
- package/esm/metadataUtilities.d.ts.map +1 -1
- package/esm/metadataUtilities.js +1 -1
- package/esm/metadataUtilities.js.map +1 -1
- package/esm/organizationUtilities.d.ts +2 -2
- package/esm/organizationUtilities.d.ts.map +1 -1
- package/esm/organizationUtilities.js +1 -1
- package/esm/organizationUtilities.js.map +1 -1
- package/esm/result.d.ts +2 -2
- package/esm/result.d.ts.map +1 -1
- package/esm/result.js.map +1 -1
- package/package.json +3 -3
|
@@ -209,6 +209,7 @@ export const DeclarativeSettingTypeEnum = {
|
|
|
209
209
|
SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
|
|
210
210
|
OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
|
|
211
211
|
TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
|
|
212
|
+
OPENAI_CONFIG: "OPENAI_CONFIG",
|
|
212
213
|
};
|
|
213
214
|
export const DeclarativeSingleWorkspacePermissionNameEnum = {
|
|
214
215
|
MANAGE: "MANAGE",
|
|
@@ -791,6 +792,21 @@ export const JsonApiOrganizationSettingOutWithLinksTypeEnum = {
|
|
|
791
792
|
export const JsonApiOrganizationSettingPatchTypeEnum = {
|
|
792
793
|
ORGANIZATION_SETTING: "organizationSetting",
|
|
793
794
|
};
|
|
795
|
+
export const JsonApiOrganizationSettingPatchAttributesTypeEnum = {
|
|
796
|
+
TIMEZONE: "TIMEZONE",
|
|
797
|
+
ACTIVE_THEME: "ACTIVE_THEME",
|
|
798
|
+
ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE",
|
|
799
|
+
WHITE_LABELING: "WHITE_LABELING",
|
|
800
|
+
LOCALE: "LOCALE",
|
|
801
|
+
METADATA_LOCALE: "METADATA_LOCALE",
|
|
802
|
+
FORMAT_LOCALE: "FORMAT_LOCALE",
|
|
803
|
+
MAPBOX_TOKEN: "MAPBOX_TOKEN",
|
|
804
|
+
WEEK_START: "WEEK_START",
|
|
805
|
+
SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
|
|
806
|
+
OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
|
|
807
|
+
TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
|
|
808
|
+
OPENAI_CONFIG: "OPENAI_CONFIG",
|
|
809
|
+
};
|
|
794
810
|
export const JsonApiThemeInTypeEnum = {
|
|
795
811
|
THEME: "theme",
|
|
796
812
|
};
|
|
@@ -860,20 +876,6 @@ export const JsonApiUserPatchTypeEnum = {
|
|
|
860
876
|
export const JsonApiUserSettingInTypeEnum = {
|
|
861
877
|
USER_SETTING: "userSetting",
|
|
862
878
|
};
|
|
863
|
-
export const JsonApiUserSettingInAttributesTypeEnum = {
|
|
864
|
-
TIMEZONE: "TIMEZONE",
|
|
865
|
-
ACTIVE_THEME: "ACTIVE_THEME",
|
|
866
|
-
ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE",
|
|
867
|
-
WHITE_LABELING: "WHITE_LABELING",
|
|
868
|
-
LOCALE: "LOCALE",
|
|
869
|
-
METADATA_LOCALE: "METADATA_LOCALE",
|
|
870
|
-
FORMAT_LOCALE: "FORMAT_LOCALE",
|
|
871
|
-
MAPBOX_TOKEN: "MAPBOX_TOKEN",
|
|
872
|
-
WEEK_START: "WEEK_START",
|
|
873
|
-
SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
|
|
874
|
-
OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
|
|
875
|
-
TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
|
|
876
|
-
};
|
|
877
879
|
export const JsonApiUserSettingOutTypeEnum = {
|
|
878
880
|
USER_SETTING: "userSetting",
|
|
879
881
|
};
|
|
@@ -1038,6 +1040,7 @@ export const ResolvedSettingTypeEnum = {
|
|
|
1038
1040
|
SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
|
|
1039
1041
|
OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
|
|
1040
1042
|
TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
|
|
1043
|
+
OPENAI_CONFIG: "OPENAI_CONFIG",
|
|
1041
1044
|
};
|
|
1042
1045
|
export const RsaSpecificationKtyEnum = {
|
|
1043
1046
|
RSA: "RSA",
|
|
@@ -11953,6 +11956,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
11953
11956
|
},
|
|
11954
11957
|
/**
|
|
11955
11958
|
*
|
|
11959
|
+
* @summary Delete an Export Definition
|
|
11956
11960
|
* @param {string} workspaceId
|
|
11957
11961
|
* @param {string} objectId
|
|
11958
11962
|
* @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\').
|
|
@@ -13214,6 +13218,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
13214
13218
|
},
|
|
13215
13219
|
/**
|
|
13216
13220
|
*
|
|
13221
|
+
* @summary Get all Export Definitions
|
|
13217
13222
|
* @param {string} workspaceId
|
|
13218
13223
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
13219
13224
|
* @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\').
|
|
@@ -14893,6 +14898,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
14893
14898
|
},
|
|
14894
14899
|
/**
|
|
14895
14900
|
*
|
|
14901
|
+
* @summary Get an Export Definition
|
|
14896
14902
|
* @param {string} workspaceId
|
|
14897
14903
|
* @param {string} objectId
|
|
14898
14904
|
* @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\').
|
|
@@ -16202,6 +16208,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
16202
16208
|
},
|
|
16203
16209
|
/**
|
|
16204
16210
|
*
|
|
16211
|
+
* @summary Patch an Export Definition
|
|
16205
16212
|
* @param {string} workspaceId
|
|
16206
16213
|
* @param {string} objectId
|
|
16207
16214
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -17376,6 +17383,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
17376
17383
|
},
|
|
17377
17384
|
/**
|
|
17378
17385
|
*
|
|
17386
|
+
* @summary Put an Export Definition
|
|
17379
17387
|
* @param {string} workspaceId
|
|
17380
17388
|
* @param {string} objectId
|
|
17381
17389
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -18599,6 +18607,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
18599
18607
|
},
|
|
18600
18608
|
/**
|
|
18601
18609
|
*
|
|
18610
|
+
* @summary Delete an Export Definition
|
|
18602
18611
|
* @param {string} workspaceId
|
|
18603
18612
|
* @param {string} objectId
|
|
18604
18613
|
* @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\').
|
|
@@ -18991,6 +19000,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
18991
19000
|
},
|
|
18992
19001
|
/**
|
|
18993
19002
|
*
|
|
19003
|
+
* @summary Get all Export Definitions
|
|
18994
19004
|
* @param {string} workspaceId
|
|
18995
19005
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
18996
19006
|
* @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\').
|
|
@@ -19505,6 +19515,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
19505
19515
|
},
|
|
19506
19516
|
/**
|
|
19507
19517
|
*
|
|
19518
|
+
* @summary Get an Export Definition
|
|
19508
19519
|
* @param {string} workspaceId
|
|
19509
19520
|
* @param {string} objectId
|
|
19510
19521
|
* @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\').
|
|
@@ -19899,6 +19910,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
19899
19910
|
},
|
|
19900
19911
|
/**
|
|
19901
19912
|
*
|
|
19913
|
+
* @summary Patch an Export Definition
|
|
19902
19914
|
* @param {string} workspaceId
|
|
19903
19915
|
* @param {string} objectId
|
|
19904
19916
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -20223,6 +20235,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
20223
20235
|
},
|
|
20224
20236
|
/**
|
|
20225
20237
|
*
|
|
20238
|
+
* @summary Put an Export Definition
|
|
20226
20239
|
* @param {string} workspaceId
|
|
20227
20240
|
* @param {string} objectId
|
|
20228
20241
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -20831,6 +20844,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
20831
20844
|
},
|
|
20832
20845
|
/**
|
|
20833
20846
|
*
|
|
20847
|
+
* @summary Delete an Export Definition
|
|
20834
20848
|
* @param {EntitiesApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
20835
20849
|
* @param {*} [options] Override http request option.
|
|
20836
20850
|
* @throws {RequiredError}
|
|
@@ -21154,6 +21168,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
21154
21168
|
},
|
|
21155
21169
|
/**
|
|
21156
21170
|
*
|
|
21171
|
+
* @summary Get all Export Definitions
|
|
21157
21172
|
* @param {EntitiesApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
21158
21173
|
* @param {*} [options] Override http request option.
|
|
21159
21174
|
* @throws {RequiredError}
|
|
@@ -21543,6 +21558,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
21543
21558
|
},
|
|
21544
21559
|
/**
|
|
21545
21560
|
*
|
|
21561
|
+
* @summary Get an Export Definition
|
|
21546
21562
|
* @param {EntitiesApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
21547
21563
|
* @param {*} [options] Override http request option.
|
|
21548
21564
|
* @throws {RequiredError}
|
|
@@ -21878,6 +21894,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
21878
21894
|
},
|
|
21879
21895
|
/**
|
|
21880
21896
|
*
|
|
21897
|
+
* @summary Patch an Export Definition
|
|
21881
21898
|
* @param {EntitiesApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
21882
21899
|
* @param {*} [options] Override http request option.
|
|
21883
21900
|
* @throws {RequiredError}
|
|
@@ -22153,6 +22170,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
22153
22170
|
},
|
|
22154
22171
|
/**
|
|
22155
22172
|
*
|
|
22173
|
+
* @summary Put an Export Definition
|
|
22156
22174
|
* @param {EntitiesApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
22157
22175
|
* @param {*} [options] Override http request option.
|
|
22158
22176
|
* @throws {RequiredError}
|
|
@@ -22756,6 +22774,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
22756
22774
|
}
|
|
22757
22775
|
/**
|
|
22758
22776
|
*
|
|
22777
|
+
* @summary Delete an Export Definition
|
|
22759
22778
|
* @param {EntitiesApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
22760
22779
|
* @param {*} [options] Override http request option.
|
|
22761
22780
|
* @throws {RequiredError}
|
|
@@ -23106,6 +23125,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
23106
23125
|
}
|
|
23107
23126
|
/**
|
|
23108
23127
|
*
|
|
23128
|
+
* @summary Get all Export Definitions
|
|
23109
23129
|
* @param {EntitiesApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
23110
23130
|
* @param {*} [options] Override http request option.
|
|
23111
23131
|
* @throws {RequiredError}
|
|
@@ -23532,6 +23552,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
23532
23552
|
}
|
|
23533
23553
|
/**
|
|
23534
23554
|
*
|
|
23555
|
+
* @summary Get an Export Definition
|
|
23535
23556
|
* @param {EntitiesApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
23536
23557
|
* @param {*} [options] Override http request option.
|
|
23537
23558
|
* @throws {RequiredError}
|
|
@@ -23895,6 +23916,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
23895
23916
|
}
|
|
23896
23917
|
/**
|
|
23897
23918
|
*
|
|
23919
|
+
* @summary Patch an Export Definition
|
|
23898
23920
|
* @param {EntitiesApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
23899
23921
|
* @param {*} [options] Override http request option.
|
|
23900
23922
|
* @throws {RequiredError}
|
|
@@ -24193,6 +24215,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
24193
24215
|
}
|
|
24194
24216
|
/**
|
|
24195
24217
|
*
|
|
24218
|
+
* @summary Put an Export Definition
|
|
24196
24219
|
* @param {EntitiesApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
24197
24220
|
* @param {*} [options] Override http request option.
|
|
24198
24221
|
* @throws {RequiredError}
|
|
@@ -24729,6 +24752,593 @@ export class EntitlementApi extends BaseAPI {
|
|
|
24729
24752
|
.then((request) => request(this.axios, this.basePath));
|
|
24730
24753
|
}
|
|
24731
24754
|
}
|
|
24755
|
+
/**
|
|
24756
|
+
* ExportDefinitionsApi - axios parameter creator
|
|
24757
|
+
* @export
|
|
24758
|
+
*/
|
|
24759
|
+
export const ExportDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
24760
|
+
return {
|
|
24761
|
+
/**
|
|
24762
|
+
*
|
|
24763
|
+
* @summary Post Export Definitions
|
|
24764
|
+
* @param {string} workspaceId
|
|
24765
|
+
* @param {JsonApiExportDefinitionPostOptionalIdDocument} jsonApiExportDefinitionPostOptionalIdDocument
|
|
24766
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
24767
|
+
* @param {*} [options] Override http request option.
|
|
24768
|
+
* @throws {RequiredError}
|
|
24769
|
+
*/
|
|
24770
|
+
createEntityExportDefinitions: async (workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options = {}) => {
|
|
24771
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24772
|
+
assertParamExists("createEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24773
|
+
// verify required parameter 'jsonApiExportDefinitionPostOptionalIdDocument' is not null or undefined
|
|
24774
|
+
assertParamExists("createEntityExportDefinitions", "jsonApiExportDefinitionPostOptionalIdDocument", jsonApiExportDefinitionPostOptionalIdDocument);
|
|
24775
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
24776
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24777
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24778
|
+
let baseOptions;
|
|
24779
|
+
if (configuration) {
|
|
24780
|
+
baseOptions = configuration.baseOptions;
|
|
24781
|
+
}
|
|
24782
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
24783
|
+
const localVarHeaderParameter = {};
|
|
24784
|
+
const localVarQueryParameter = {};
|
|
24785
|
+
if (include) {
|
|
24786
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24787
|
+
}
|
|
24788
|
+
localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
|
|
24789
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24790
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24791
|
+
localVarRequestOptions.headers = {
|
|
24792
|
+
...localVarHeaderParameter,
|
|
24793
|
+
...headersFromBaseOptions,
|
|
24794
|
+
...options.headers,
|
|
24795
|
+
};
|
|
24796
|
+
const needsSerialization = typeof jsonApiExportDefinitionPostOptionalIdDocument !== "string" ||
|
|
24797
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
24798
|
+
localVarRequestOptions.data = needsSerialization
|
|
24799
|
+
? JSON.stringify(jsonApiExportDefinitionPostOptionalIdDocument !== undefined
|
|
24800
|
+
? jsonApiExportDefinitionPostOptionalIdDocument
|
|
24801
|
+
: {})
|
|
24802
|
+
: jsonApiExportDefinitionPostOptionalIdDocument || "";
|
|
24803
|
+
return {
|
|
24804
|
+
url: toPathString(localVarUrlObj),
|
|
24805
|
+
options: localVarRequestOptions,
|
|
24806
|
+
};
|
|
24807
|
+
},
|
|
24808
|
+
/**
|
|
24809
|
+
*
|
|
24810
|
+
* @summary Delete an Export Definition
|
|
24811
|
+
* @param {string} workspaceId
|
|
24812
|
+
* @param {string} objectId
|
|
24813
|
+
* @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\').
|
|
24814
|
+
* @param {*} [options] Override http request option.
|
|
24815
|
+
* @throws {RequiredError}
|
|
24816
|
+
*/
|
|
24817
|
+
deleteEntityExportDefinitions: async (workspaceId, objectId, filter, options = {}) => {
|
|
24818
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24819
|
+
assertParamExists("deleteEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24820
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
24821
|
+
assertParamExists("deleteEntityExportDefinitions", "objectId", objectId);
|
|
24822
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
24823
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
24824
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
24825
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24826
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24827
|
+
let baseOptions;
|
|
24828
|
+
if (configuration) {
|
|
24829
|
+
baseOptions = configuration.baseOptions;
|
|
24830
|
+
}
|
|
24831
|
+
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
24832
|
+
const localVarHeaderParameter = {};
|
|
24833
|
+
const localVarQueryParameter = {};
|
|
24834
|
+
if (filter !== undefined) {
|
|
24835
|
+
localVarQueryParameter["filter"] = filter;
|
|
24836
|
+
}
|
|
24837
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24838
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24839
|
+
localVarRequestOptions.headers = {
|
|
24840
|
+
...localVarHeaderParameter,
|
|
24841
|
+
...headersFromBaseOptions,
|
|
24842
|
+
...options.headers,
|
|
24843
|
+
};
|
|
24844
|
+
return {
|
|
24845
|
+
url: toPathString(localVarUrlObj),
|
|
24846
|
+
options: localVarRequestOptions,
|
|
24847
|
+
};
|
|
24848
|
+
},
|
|
24849
|
+
/**
|
|
24850
|
+
*
|
|
24851
|
+
* @summary Get all Export Definitions
|
|
24852
|
+
* @param {string} workspaceId
|
|
24853
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
24854
|
+
* @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\').
|
|
24855
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
24856
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
24857
|
+
* @param {number} [size] The size of the page to be returned
|
|
24858
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
24859
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24860
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24861
|
+
* @param {*} [options] Override http request option.
|
|
24862
|
+
* @throws {RequiredError}
|
|
24863
|
+
*/
|
|
24864
|
+
getAllEntitiesExportDefinitions: async (workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options = {}) => {
|
|
24865
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24866
|
+
assertParamExists("getAllEntitiesExportDefinitions", "workspaceId", workspaceId);
|
|
24867
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
24868
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24869
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24870
|
+
let baseOptions;
|
|
24871
|
+
if (configuration) {
|
|
24872
|
+
baseOptions = configuration.baseOptions;
|
|
24873
|
+
}
|
|
24874
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
24875
|
+
const localVarHeaderParameter = {};
|
|
24876
|
+
const localVarQueryParameter = {};
|
|
24877
|
+
if (origin !== undefined) {
|
|
24878
|
+
localVarQueryParameter["origin"] = origin;
|
|
24879
|
+
}
|
|
24880
|
+
if (filter !== undefined) {
|
|
24881
|
+
localVarQueryParameter["filter"] = filter;
|
|
24882
|
+
}
|
|
24883
|
+
if (include) {
|
|
24884
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24885
|
+
}
|
|
24886
|
+
if (page !== undefined) {
|
|
24887
|
+
localVarQueryParameter["page"] = page;
|
|
24888
|
+
}
|
|
24889
|
+
if (size !== undefined) {
|
|
24890
|
+
localVarQueryParameter["size"] = size;
|
|
24891
|
+
}
|
|
24892
|
+
if (sort) {
|
|
24893
|
+
localVarQueryParameter["sort"] = sort;
|
|
24894
|
+
}
|
|
24895
|
+
if (metaInclude) {
|
|
24896
|
+
localVarQueryParameter["metaInclude"] = Array.from(metaInclude).join(COLLECTION_FORMATS.csv);
|
|
24897
|
+
}
|
|
24898
|
+
if (xGDCVALIDATERELATIONS !== undefined && xGDCVALIDATERELATIONS !== null) {
|
|
24899
|
+
localVarHeaderParameter["X-GDC-VALIDATE-RELATIONS"] = String(JSON.stringify(xGDCVALIDATERELATIONS));
|
|
24900
|
+
}
|
|
24901
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24902
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24903
|
+
localVarRequestOptions.headers = {
|
|
24904
|
+
...localVarHeaderParameter,
|
|
24905
|
+
...headersFromBaseOptions,
|
|
24906
|
+
...options.headers,
|
|
24907
|
+
};
|
|
24908
|
+
return {
|
|
24909
|
+
url: toPathString(localVarUrlObj),
|
|
24910
|
+
options: localVarRequestOptions,
|
|
24911
|
+
};
|
|
24912
|
+
},
|
|
24913
|
+
/**
|
|
24914
|
+
*
|
|
24915
|
+
* @summary Get an Export Definition
|
|
24916
|
+
* @param {string} workspaceId
|
|
24917
|
+
* @param {string} objectId
|
|
24918
|
+
* @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\').
|
|
24919
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
24920
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24921
|
+
* @param {*} [options] Override http request option.
|
|
24922
|
+
* @throws {RequiredError}
|
|
24923
|
+
*/
|
|
24924
|
+
getEntityExportDefinitions: async (workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options = {}) => {
|
|
24925
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24926
|
+
assertParamExists("getEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24927
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
24928
|
+
assertParamExists("getEntityExportDefinitions", "objectId", objectId);
|
|
24929
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
24930
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
24931
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
24932
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24933
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24934
|
+
let baseOptions;
|
|
24935
|
+
if (configuration) {
|
|
24936
|
+
baseOptions = configuration.baseOptions;
|
|
24937
|
+
}
|
|
24938
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
24939
|
+
const localVarHeaderParameter = {};
|
|
24940
|
+
const localVarQueryParameter = {};
|
|
24941
|
+
if (filter !== undefined) {
|
|
24942
|
+
localVarQueryParameter["filter"] = filter;
|
|
24943
|
+
}
|
|
24944
|
+
if (include) {
|
|
24945
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24946
|
+
}
|
|
24947
|
+
if (xGDCVALIDATERELATIONS !== undefined && xGDCVALIDATERELATIONS !== null) {
|
|
24948
|
+
localVarHeaderParameter["X-GDC-VALIDATE-RELATIONS"] = String(JSON.stringify(xGDCVALIDATERELATIONS));
|
|
24949
|
+
}
|
|
24950
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24951
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24952
|
+
localVarRequestOptions.headers = {
|
|
24953
|
+
...localVarHeaderParameter,
|
|
24954
|
+
...headersFromBaseOptions,
|
|
24955
|
+
...options.headers,
|
|
24956
|
+
};
|
|
24957
|
+
return {
|
|
24958
|
+
url: toPathString(localVarUrlObj),
|
|
24959
|
+
options: localVarRequestOptions,
|
|
24960
|
+
};
|
|
24961
|
+
},
|
|
24962
|
+
/**
|
|
24963
|
+
*
|
|
24964
|
+
* @summary Patch an Export Definition
|
|
24965
|
+
* @param {string} workspaceId
|
|
24966
|
+
* @param {string} objectId
|
|
24967
|
+
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
24968
|
+
* @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\').
|
|
24969
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
24970
|
+
* @param {*} [options] Override http request option.
|
|
24971
|
+
* @throws {RequiredError}
|
|
24972
|
+
*/
|
|
24973
|
+
patchEntityExportDefinitions: async (workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options = {}) => {
|
|
24974
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24975
|
+
assertParamExists("patchEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24976
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
24977
|
+
assertParamExists("patchEntityExportDefinitions", "objectId", objectId);
|
|
24978
|
+
// verify required parameter 'jsonApiExportDefinitionPatchDocument' is not null or undefined
|
|
24979
|
+
assertParamExists("patchEntityExportDefinitions", "jsonApiExportDefinitionPatchDocument", jsonApiExportDefinitionPatchDocument);
|
|
24980
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
24981
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
24982
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
24983
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24984
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24985
|
+
let baseOptions;
|
|
24986
|
+
if (configuration) {
|
|
24987
|
+
baseOptions = configuration.baseOptions;
|
|
24988
|
+
}
|
|
24989
|
+
const localVarRequestOptions = { method: "PATCH", ...baseOptions, ...options };
|
|
24990
|
+
const localVarHeaderParameter = {};
|
|
24991
|
+
const localVarQueryParameter = {};
|
|
24992
|
+
if (filter !== undefined) {
|
|
24993
|
+
localVarQueryParameter["filter"] = filter;
|
|
24994
|
+
}
|
|
24995
|
+
if (include) {
|
|
24996
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24997
|
+
}
|
|
24998
|
+
localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
|
|
24999
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25000
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25001
|
+
localVarRequestOptions.headers = {
|
|
25002
|
+
...localVarHeaderParameter,
|
|
25003
|
+
...headersFromBaseOptions,
|
|
25004
|
+
...options.headers,
|
|
25005
|
+
};
|
|
25006
|
+
const needsSerialization = typeof jsonApiExportDefinitionPatchDocument !== "string" ||
|
|
25007
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
25008
|
+
localVarRequestOptions.data = needsSerialization
|
|
25009
|
+
? JSON.stringify(jsonApiExportDefinitionPatchDocument !== undefined
|
|
25010
|
+
? jsonApiExportDefinitionPatchDocument
|
|
25011
|
+
: {})
|
|
25012
|
+
: jsonApiExportDefinitionPatchDocument || "";
|
|
25013
|
+
return {
|
|
25014
|
+
url: toPathString(localVarUrlObj),
|
|
25015
|
+
options: localVarRequestOptions,
|
|
25016
|
+
};
|
|
25017
|
+
},
|
|
25018
|
+
/**
|
|
25019
|
+
*
|
|
25020
|
+
* @summary Put an Export Definition
|
|
25021
|
+
* @param {string} workspaceId
|
|
25022
|
+
* @param {string} objectId
|
|
25023
|
+
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
25024
|
+
* @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\').
|
|
25025
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
25026
|
+
* @param {*} [options] Override http request option.
|
|
25027
|
+
* @throws {RequiredError}
|
|
25028
|
+
*/
|
|
25029
|
+
updateEntityExportDefinitions: async (workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options = {}) => {
|
|
25030
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
25031
|
+
assertParamExists("updateEntityExportDefinitions", "workspaceId", workspaceId);
|
|
25032
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
25033
|
+
assertParamExists("updateEntityExportDefinitions", "objectId", objectId);
|
|
25034
|
+
// verify required parameter 'jsonApiExportDefinitionInDocument' is not null or undefined
|
|
25035
|
+
assertParamExists("updateEntityExportDefinitions", "jsonApiExportDefinitionInDocument", jsonApiExportDefinitionInDocument);
|
|
25036
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
25037
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
25038
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
25039
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25040
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25041
|
+
let baseOptions;
|
|
25042
|
+
if (configuration) {
|
|
25043
|
+
baseOptions = configuration.baseOptions;
|
|
25044
|
+
}
|
|
25045
|
+
const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
|
|
25046
|
+
const localVarHeaderParameter = {};
|
|
25047
|
+
const localVarQueryParameter = {};
|
|
25048
|
+
if (filter !== undefined) {
|
|
25049
|
+
localVarQueryParameter["filter"] = filter;
|
|
25050
|
+
}
|
|
25051
|
+
if (include) {
|
|
25052
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
25053
|
+
}
|
|
25054
|
+
localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
|
|
25055
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25056
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25057
|
+
localVarRequestOptions.headers = {
|
|
25058
|
+
...localVarHeaderParameter,
|
|
25059
|
+
...headersFromBaseOptions,
|
|
25060
|
+
...options.headers,
|
|
25061
|
+
};
|
|
25062
|
+
const needsSerialization = typeof jsonApiExportDefinitionInDocument !== "string" ||
|
|
25063
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
25064
|
+
localVarRequestOptions.data = needsSerialization
|
|
25065
|
+
? JSON.stringify(jsonApiExportDefinitionInDocument !== undefined
|
|
25066
|
+
? jsonApiExportDefinitionInDocument
|
|
25067
|
+
: {})
|
|
25068
|
+
: jsonApiExportDefinitionInDocument || "";
|
|
25069
|
+
return {
|
|
25070
|
+
url: toPathString(localVarUrlObj),
|
|
25071
|
+
options: localVarRequestOptions,
|
|
25072
|
+
};
|
|
25073
|
+
},
|
|
25074
|
+
};
|
|
25075
|
+
};
|
|
25076
|
+
/**
|
|
25077
|
+
* ExportDefinitionsApi - functional programming interface
|
|
25078
|
+
* @export
|
|
25079
|
+
*/
|
|
25080
|
+
export const ExportDefinitionsApiFp = function (configuration) {
|
|
25081
|
+
const localVarAxiosParamCreator = ExportDefinitionsApiAxiosParamCreator(configuration);
|
|
25082
|
+
return {
|
|
25083
|
+
/**
|
|
25084
|
+
*
|
|
25085
|
+
* @summary Post Export Definitions
|
|
25086
|
+
* @param {string} workspaceId
|
|
25087
|
+
* @param {JsonApiExportDefinitionPostOptionalIdDocument} jsonApiExportDefinitionPostOptionalIdDocument
|
|
25088
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
25089
|
+
* @param {*} [options] Override http request option.
|
|
25090
|
+
* @throws {RequiredError}
|
|
25091
|
+
*/
|
|
25092
|
+
async createEntityExportDefinitions(workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options) {
|
|
25093
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createEntityExportDefinitions(workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options);
|
|
25094
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25095
|
+
},
|
|
25096
|
+
/**
|
|
25097
|
+
*
|
|
25098
|
+
* @summary Delete an Export Definition
|
|
25099
|
+
* @param {string} workspaceId
|
|
25100
|
+
* @param {string} objectId
|
|
25101
|
+
* @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\').
|
|
25102
|
+
* @param {*} [options] Override http request option.
|
|
25103
|
+
* @throws {RequiredError}
|
|
25104
|
+
*/
|
|
25105
|
+
async deleteEntityExportDefinitions(workspaceId, objectId, filter, options) {
|
|
25106
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteEntityExportDefinitions(workspaceId, objectId, filter, options);
|
|
25107
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25108
|
+
},
|
|
25109
|
+
/**
|
|
25110
|
+
*
|
|
25111
|
+
* @summary Get all Export Definitions
|
|
25112
|
+
* @param {string} workspaceId
|
|
25113
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
25114
|
+
* @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\').
|
|
25115
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
25116
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
25117
|
+
* @param {number} [size] The size of the page to be returned
|
|
25118
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
25119
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25120
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
25121
|
+
* @param {*} [options] Override http request option.
|
|
25122
|
+
* @throws {RequiredError}
|
|
25123
|
+
*/
|
|
25124
|
+
async getAllEntitiesExportDefinitions(workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options) {
|
|
25125
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllEntitiesExportDefinitions(workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options);
|
|
25126
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25127
|
+
},
|
|
25128
|
+
/**
|
|
25129
|
+
*
|
|
25130
|
+
* @summary Get an Export Definition
|
|
25131
|
+
* @param {string} workspaceId
|
|
25132
|
+
* @param {string} objectId
|
|
25133
|
+
* @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\').
|
|
25134
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
25135
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25136
|
+
* @param {*} [options] Override http request option.
|
|
25137
|
+
* @throws {RequiredError}
|
|
25138
|
+
*/
|
|
25139
|
+
async getEntityExportDefinitions(workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options) {
|
|
25140
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getEntityExportDefinitions(workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options);
|
|
25141
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25142
|
+
},
|
|
25143
|
+
/**
|
|
25144
|
+
*
|
|
25145
|
+
* @summary Patch an Export Definition
|
|
25146
|
+
* @param {string} workspaceId
|
|
25147
|
+
* @param {string} objectId
|
|
25148
|
+
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
25149
|
+
* @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\').
|
|
25150
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
25151
|
+
* @param {*} [options] Override http request option.
|
|
25152
|
+
* @throws {RequiredError}
|
|
25153
|
+
*/
|
|
25154
|
+
async patchEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options) {
|
|
25155
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options);
|
|
25156
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25157
|
+
},
|
|
25158
|
+
/**
|
|
25159
|
+
*
|
|
25160
|
+
* @summary Put an Export Definition
|
|
25161
|
+
* @param {string} workspaceId
|
|
25162
|
+
* @param {string} objectId
|
|
25163
|
+
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
25164
|
+
* @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\').
|
|
25165
|
+
* @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | '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.
|
|
25166
|
+
* @param {*} [options] Override http request option.
|
|
25167
|
+
* @throws {RequiredError}
|
|
25168
|
+
*/
|
|
25169
|
+
async updateEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options) {
|
|
25170
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options);
|
|
25171
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25172
|
+
},
|
|
25173
|
+
};
|
|
25174
|
+
};
|
|
25175
|
+
/**
|
|
25176
|
+
* ExportDefinitionsApi - factory interface
|
|
25177
|
+
* @export
|
|
25178
|
+
*/
|
|
25179
|
+
export const ExportDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
25180
|
+
const localVarFp = ExportDefinitionsApiFp(configuration);
|
|
25181
|
+
return {
|
|
25182
|
+
/**
|
|
25183
|
+
*
|
|
25184
|
+
* @summary Post Export Definitions
|
|
25185
|
+
* @param {ExportDefinitionsApiCreateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25186
|
+
* @param {*} [options] Override http request option.
|
|
25187
|
+
* @throws {RequiredError}
|
|
25188
|
+
*/
|
|
25189
|
+
createEntityExportDefinitions(requestParameters, options) {
|
|
25190
|
+
return localVarFp
|
|
25191
|
+
.createEntityExportDefinitions(requestParameters.workspaceId, requestParameters.jsonApiExportDefinitionPostOptionalIdDocument, requestParameters.include, options)
|
|
25192
|
+
.then((request) => request(axios, basePath));
|
|
25193
|
+
},
|
|
25194
|
+
/**
|
|
25195
|
+
*
|
|
25196
|
+
* @summary Delete an Export Definition
|
|
25197
|
+
* @param {ExportDefinitionsApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25198
|
+
* @param {*} [options] Override http request option.
|
|
25199
|
+
* @throws {RequiredError}
|
|
25200
|
+
*/
|
|
25201
|
+
deleteEntityExportDefinitions(requestParameters, options) {
|
|
25202
|
+
return localVarFp
|
|
25203
|
+
.deleteEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, options)
|
|
25204
|
+
.then((request) => request(axios, basePath));
|
|
25205
|
+
},
|
|
25206
|
+
/**
|
|
25207
|
+
*
|
|
25208
|
+
* @summary Get all Export Definitions
|
|
25209
|
+
* @param {ExportDefinitionsApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
25210
|
+
* @param {*} [options] Override http request option.
|
|
25211
|
+
* @throws {RequiredError}
|
|
25212
|
+
*/
|
|
25213
|
+
getAllEntitiesExportDefinitions(requestParameters, options) {
|
|
25214
|
+
return localVarFp
|
|
25215
|
+
.getAllEntitiesExportDefinitions(requestParameters.workspaceId, requestParameters.origin, requestParameters.filter, requestParameters.include, requestParameters.page, requestParameters.size, requestParameters.sort, requestParameters.xGDCVALIDATERELATIONS, requestParameters.metaInclude, options)
|
|
25216
|
+
.then((request) => request(axios, basePath));
|
|
25217
|
+
},
|
|
25218
|
+
/**
|
|
25219
|
+
*
|
|
25220
|
+
* @summary Get an Export Definition
|
|
25221
|
+
* @param {ExportDefinitionsApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25222
|
+
* @param {*} [options] Override http request option.
|
|
25223
|
+
* @throws {RequiredError}
|
|
25224
|
+
*/
|
|
25225
|
+
getEntityExportDefinitions(requestParameters, options) {
|
|
25226
|
+
return localVarFp
|
|
25227
|
+
.getEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, requestParameters.include, requestParameters.xGDCVALIDATERELATIONS, options)
|
|
25228
|
+
.then((request) => request(axios, basePath));
|
|
25229
|
+
},
|
|
25230
|
+
/**
|
|
25231
|
+
*
|
|
25232
|
+
* @summary Patch an Export Definition
|
|
25233
|
+
* @param {ExportDefinitionsApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25234
|
+
* @param {*} [options] Override http request option.
|
|
25235
|
+
* @throws {RequiredError}
|
|
25236
|
+
*/
|
|
25237
|
+
patchEntityExportDefinitions(requestParameters, options) {
|
|
25238
|
+
return localVarFp
|
|
25239
|
+
.patchEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionPatchDocument, requestParameters.filter, requestParameters.include, options)
|
|
25240
|
+
.then((request) => request(axios, basePath));
|
|
25241
|
+
},
|
|
25242
|
+
/**
|
|
25243
|
+
*
|
|
25244
|
+
* @summary Put an Export Definition
|
|
25245
|
+
* @param {ExportDefinitionsApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25246
|
+
* @param {*} [options] Override http request option.
|
|
25247
|
+
* @throws {RequiredError}
|
|
25248
|
+
*/
|
|
25249
|
+
updateEntityExportDefinitions(requestParameters, options) {
|
|
25250
|
+
return localVarFp
|
|
25251
|
+
.updateEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionInDocument, requestParameters.filter, requestParameters.include, options)
|
|
25252
|
+
.then((request) => request(axios, basePath));
|
|
25253
|
+
},
|
|
25254
|
+
};
|
|
25255
|
+
};
|
|
25256
|
+
/**
|
|
25257
|
+
* ExportDefinitionsApi - object-oriented interface
|
|
25258
|
+
* @export
|
|
25259
|
+
* @class ExportDefinitionsApi
|
|
25260
|
+
* @extends {BaseAPI}
|
|
25261
|
+
*/
|
|
25262
|
+
export class ExportDefinitionsApi extends BaseAPI {
|
|
25263
|
+
/**
|
|
25264
|
+
*
|
|
25265
|
+
* @summary Post Export Definitions
|
|
25266
|
+
* @param {ExportDefinitionsApiCreateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25267
|
+
* @param {*} [options] Override http request option.
|
|
25268
|
+
* @throws {RequiredError}
|
|
25269
|
+
* @memberof ExportDefinitionsApi
|
|
25270
|
+
*/
|
|
25271
|
+
createEntityExportDefinitions(requestParameters, options) {
|
|
25272
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25273
|
+
.createEntityExportDefinitions(requestParameters.workspaceId, requestParameters.jsonApiExportDefinitionPostOptionalIdDocument, requestParameters.include, options)
|
|
25274
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25275
|
+
}
|
|
25276
|
+
/**
|
|
25277
|
+
*
|
|
25278
|
+
* @summary Delete an Export Definition
|
|
25279
|
+
* @param {ExportDefinitionsApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25280
|
+
* @param {*} [options] Override http request option.
|
|
25281
|
+
* @throws {RequiredError}
|
|
25282
|
+
* @memberof ExportDefinitionsApi
|
|
25283
|
+
*/
|
|
25284
|
+
deleteEntityExportDefinitions(requestParameters, options) {
|
|
25285
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25286
|
+
.deleteEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, options)
|
|
25287
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25288
|
+
}
|
|
25289
|
+
/**
|
|
25290
|
+
*
|
|
25291
|
+
* @summary Get all Export Definitions
|
|
25292
|
+
* @param {ExportDefinitionsApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
25293
|
+
* @param {*} [options] Override http request option.
|
|
25294
|
+
* @throws {RequiredError}
|
|
25295
|
+
* @memberof ExportDefinitionsApi
|
|
25296
|
+
*/
|
|
25297
|
+
getAllEntitiesExportDefinitions(requestParameters, options) {
|
|
25298
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25299
|
+
.getAllEntitiesExportDefinitions(requestParameters.workspaceId, requestParameters.origin, requestParameters.filter, requestParameters.include, requestParameters.page, requestParameters.size, requestParameters.sort, requestParameters.xGDCVALIDATERELATIONS, requestParameters.metaInclude, options)
|
|
25300
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25301
|
+
}
|
|
25302
|
+
/**
|
|
25303
|
+
*
|
|
25304
|
+
* @summary Get an Export Definition
|
|
25305
|
+
* @param {ExportDefinitionsApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25306
|
+
* @param {*} [options] Override http request option.
|
|
25307
|
+
* @throws {RequiredError}
|
|
25308
|
+
* @memberof ExportDefinitionsApi
|
|
25309
|
+
*/
|
|
25310
|
+
getEntityExportDefinitions(requestParameters, options) {
|
|
25311
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25312
|
+
.getEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, requestParameters.include, requestParameters.xGDCVALIDATERELATIONS, options)
|
|
25313
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25314
|
+
}
|
|
25315
|
+
/**
|
|
25316
|
+
*
|
|
25317
|
+
* @summary Patch an Export Definition
|
|
25318
|
+
* @param {ExportDefinitionsApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25319
|
+
* @param {*} [options] Override http request option.
|
|
25320
|
+
* @throws {RequiredError}
|
|
25321
|
+
* @memberof ExportDefinitionsApi
|
|
25322
|
+
*/
|
|
25323
|
+
patchEntityExportDefinitions(requestParameters, options) {
|
|
25324
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25325
|
+
.patchEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionPatchDocument, requestParameters.filter, requestParameters.include, options)
|
|
25326
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25327
|
+
}
|
|
25328
|
+
/**
|
|
25329
|
+
*
|
|
25330
|
+
* @summary Put an Export Definition
|
|
25331
|
+
* @param {ExportDefinitionsApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25332
|
+
* @param {*} [options] Override http request option.
|
|
25333
|
+
* @throws {RequiredError}
|
|
25334
|
+
* @memberof ExportDefinitionsApi
|
|
25335
|
+
*/
|
|
25336
|
+
updateEntityExportDefinitions(requestParameters, options) {
|
|
25337
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25338
|
+
.updateEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionInDocument, requestParameters.filter, requestParameters.include, options)
|
|
25339
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25340
|
+
}
|
|
25341
|
+
}
|
|
24732
25342
|
/**
|
|
24733
25343
|
* FactsApi - axios parameter creator
|
|
24734
25344
|
* @export
|
|
@@ -43648,6 +44258,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
43648
44258
|
},
|
|
43649
44259
|
/**
|
|
43650
44260
|
*
|
|
44261
|
+
* @summary Delete an Export Definition
|
|
43651
44262
|
* @param {string} workspaceId
|
|
43652
44263
|
* @param {string} objectId
|
|
43653
44264
|
* @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\').
|
|
@@ -44355,6 +44966,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
44355
44966
|
},
|
|
44356
44967
|
/**
|
|
44357
44968
|
*
|
|
44969
|
+
* @summary Get all Export Definitions
|
|
44358
44970
|
* @param {string} workspaceId
|
|
44359
44971
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
44360
44972
|
* @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\').
|
|
@@ -45304,6 +45916,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
45304
45916
|
},
|
|
45305
45917
|
/**
|
|
45306
45918
|
*
|
|
45919
|
+
* @summary Get an Export Definition
|
|
45307
45920
|
* @param {string} workspaceId
|
|
45308
45921
|
* @param {string} objectId
|
|
45309
45922
|
* @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\').
|
|
@@ -46045,6 +46658,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
46045
46658
|
},
|
|
46046
46659
|
/**
|
|
46047
46660
|
*
|
|
46661
|
+
* @summary Patch an Export Definition
|
|
46048
46662
|
* @param {string} workspaceId
|
|
46049
46663
|
* @param {string} objectId
|
|
46050
46664
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -46704,6 +47318,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
46704
47318
|
},
|
|
46705
47319
|
/**
|
|
46706
47320
|
*
|
|
47321
|
+
* @summary Put an Export Definition
|
|
46707
47322
|
* @param {string} workspaceId
|
|
46708
47323
|
* @param {string} objectId
|
|
46709
47324
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -47367,6 +47982,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
47367
47982
|
},
|
|
47368
47983
|
/**
|
|
47369
47984
|
*
|
|
47985
|
+
* @summary Delete an Export Definition
|
|
47370
47986
|
* @param {string} workspaceId
|
|
47371
47987
|
* @param {string} objectId
|
|
47372
47988
|
* @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\').
|
|
@@ -47583,6 +48199,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
47583
48199
|
},
|
|
47584
48200
|
/**
|
|
47585
48201
|
*
|
|
48202
|
+
* @summary Get all Export Definitions
|
|
47586
48203
|
* @param {string} workspaceId
|
|
47587
48204
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
47588
48205
|
* @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\').
|
|
@@ -47866,6 +48483,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
47866
48483
|
},
|
|
47867
48484
|
/**
|
|
47868
48485
|
*
|
|
48486
|
+
* @summary Get an Export Definition
|
|
47869
48487
|
* @param {string} workspaceId
|
|
47870
48488
|
* @param {string} objectId
|
|
47871
48489
|
* @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\').
|
|
@@ -48082,6 +48700,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
48082
48700
|
},
|
|
48083
48701
|
/**
|
|
48084
48702
|
*
|
|
48703
|
+
* @summary Patch an Export Definition
|
|
48085
48704
|
* @param {string} workspaceId
|
|
48086
48705
|
* @param {string} objectId
|
|
48087
48706
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -48259,6 +48878,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
48259
48878
|
},
|
|
48260
48879
|
/**
|
|
48261
48880
|
*
|
|
48881
|
+
* @summary Put an Export Definition
|
|
48262
48882
|
* @param {string} workspaceId
|
|
48263
48883
|
* @param {string} objectId
|
|
48264
48884
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -48578,6 +49198,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
48578
49198
|
},
|
|
48579
49199
|
/**
|
|
48580
49200
|
*
|
|
49201
|
+
* @summary Delete an Export Definition
|
|
48581
49202
|
* @param {WorkspaceObjectControllerApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
48582
49203
|
* @param {*} [options] Override http request option.
|
|
48583
49204
|
* @throws {RequiredError}
|
|
@@ -48745,6 +49366,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
48745
49366
|
},
|
|
48746
49367
|
/**
|
|
48747
49368
|
*
|
|
49369
|
+
* @summary Get all Export Definitions
|
|
48748
49370
|
* @param {WorkspaceObjectControllerApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
48749
49371
|
* @param {*} [options] Override http request option.
|
|
48750
49372
|
* @throws {RequiredError}
|
|
@@ -48936,6 +49558,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
48936
49558
|
},
|
|
48937
49559
|
/**
|
|
48938
49560
|
*
|
|
49561
|
+
* @summary Get an Export Definition
|
|
48939
49562
|
* @param {WorkspaceObjectControllerApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
48940
49563
|
* @param {*} [options] Override http request option.
|
|
48941
49564
|
* @throws {RequiredError}
|
|
@@ -49103,6 +49726,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
49103
49726
|
},
|
|
49104
49727
|
/**
|
|
49105
49728
|
*
|
|
49729
|
+
* @summary Patch an Export Definition
|
|
49106
49730
|
* @param {WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49107
49731
|
* @param {*} [options] Override http request option.
|
|
49108
49732
|
* @throws {RequiredError}
|
|
@@ -49246,6 +49870,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
49246
49870
|
},
|
|
49247
49871
|
/**
|
|
49248
49872
|
*
|
|
49873
|
+
* @summary Put an Export Definition
|
|
49249
49874
|
* @param {WorkspaceObjectControllerApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49250
49875
|
* @param {*} [options] Override http request option.
|
|
49251
49876
|
* @throws {RequiredError}
|
|
@@ -49558,6 +50183,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
49558
50183
|
}
|
|
49559
50184
|
/**
|
|
49560
50185
|
*
|
|
50186
|
+
* @summary Delete an Export Definition
|
|
49561
50187
|
* @param {WorkspaceObjectControllerApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49562
50188
|
* @param {*} [options] Override http request option.
|
|
49563
50189
|
* @throws {RequiredError}
|
|
@@ -49739,6 +50365,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
49739
50365
|
}
|
|
49740
50366
|
/**
|
|
49741
50367
|
*
|
|
50368
|
+
* @summary Get all Export Definitions
|
|
49742
50369
|
* @param {WorkspaceObjectControllerApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
49743
50370
|
* @param {*} [options] Override http request option.
|
|
49744
50371
|
* @throws {RequiredError}
|
|
@@ -49946,6 +50573,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
49946
50573
|
}
|
|
49947
50574
|
/**
|
|
49948
50575
|
*
|
|
50576
|
+
* @summary Get an Export Definition
|
|
49949
50577
|
* @param {WorkspaceObjectControllerApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49950
50578
|
* @param {*} [options] Override http request option.
|
|
49951
50579
|
* @throws {RequiredError}
|
|
@@ -50127,6 +50755,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
50127
50755
|
}
|
|
50128
50756
|
/**
|
|
50129
50757
|
*
|
|
50758
|
+
* @summary Patch an Export Definition
|
|
50130
50759
|
* @param {WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
50131
50760
|
* @param {*} [options] Override http request option.
|
|
50132
50761
|
* @throws {RequiredError}
|
|
@@ -50282,6 +50911,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
50282
50911
|
}
|
|
50283
50912
|
/**
|
|
50284
50913
|
*
|
|
50914
|
+
* @summary Put an Export Definition
|
|
50285
50915
|
* @param {WorkspaceObjectControllerApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
50286
50916
|
* @param {*} [options] Override http request option.
|
|
50287
50917
|
* @throws {RequiredError}
|