@gooddata/api-client-tiger 10.1.0-alpha.3 → 10.1.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +2320 -1030
- package/esm/generated/afm-rest-api/api.d.ts +440 -2
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +375 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +828 -625
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +12 -1
- package/esm/generated/auth-json-api/api.js.map +1 -1
- 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 +54 -43
- 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 +1609 -1002
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +641 -1
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/base.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/base.js +13 -1
- package/esm/generated/metadata-json-api/base.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +4819 -4788
- package/esm/generated/result-json-api/api.d.ts +157 -0
- package/esm/generated/result-json-api/api.d.ts.map +1 -1
- package/esm/generated/result-json-api/api.js +151 -1
- package/esm/generated/result-json-api/api.js.map +1 -1
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.js +13 -1
- package/esm/generated/result-json-api/base.js.map +1 -1
- package/esm/generated/result-json-api/openapi-spec.json +73 -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 +114 -1
- 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
|
@@ -1,4 +1,15 @@
|
|
|
1
|
-
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* OpenAPI definition
|
|
4
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: v0
|
|
7
|
+
*
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
2
13
|
import globalAxios from "axios";
|
|
3
14
|
// Some imports not used depending on template conditions, we also need prettier-ignore so that the import does not get split and ts-ignore still works
|
|
4
15
|
// prettier-ignore
|
|
@@ -24,6 +35,7 @@ export const ApiEntitlementNameEnum = {
|
|
|
24
35
|
WHITE_LABELING: "WhiteLabeling",
|
|
25
36
|
WORKSPACE_COUNT: "WorkspaceCount",
|
|
26
37
|
USER_TELEMETRY_DISABLED: "UserTelemetryDisabled",
|
|
38
|
+
EXPERIMENTAL_FEATURES: "ExperimentalFeatures",
|
|
27
39
|
};
|
|
28
40
|
export const AssigneeIdentifierTypeEnum = {
|
|
29
41
|
USER: "user",
|
|
@@ -285,6 +297,7 @@ export const EntitlementsRequestEntitlementsNameEnum = {
|
|
|
285
297
|
WHITE_LABELING: "WhiteLabeling",
|
|
286
298
|
WORKSPACE_COUNT: "WorkspaceCount",
|
|
287
299
|
USER_TELEMETRY_DISABLED: "UserTelemetryDisabled",
|
|
300
|
+
EXPERIMENTAL_FEATURES: "ExperimentalFeatures",
|
|
288
301
|
};
|
|
289
302
|
export const EntityIdentifierTypeEnum = {
|
|
290
303
|
ANALYTICAL_DASHBOARD: "analyticalDashboard",
|
|
@@ -11953,6 +11966,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
11953
11966
|
},
|
|
11954
11967
|
/**
|
|
11955
11968
|
*
|
|
11969
|
+
* @summary Delete an Export Definition
|
|
11956
11970
|
* @param {string} workspaceId
|
|
11957
11971
|
* @param {string} objectId
|
|
11958
11972
|
* @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 +13228,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
13214
13228
|
},
|
|
13215
13229
|
/**
|
|
13216
13230
|
*
|
|
13231
|
+
* @summary Get all Export Definitions
|
|
13217
13232
|
* @param {string} workspaceId
|
|
13218
13233
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
13219
13234
|
* @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 +14908,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
14893
14908
|
},
|
|
14894
14909
|
/**
|
|
14895
14910
|
*
|
|
14911
|
+
* @summary Get an Export Definition
|
|
14896
14912
|
* @param {string} workspaceId
|
|
14897
14913
|
* @param {string} objectId
|
|
14898
14914
|
* @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 +16218,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
16202
16218
|
},
|
|
16203
16219
|
/**
|
|
16204
16220
|
*
|
|
16221
|
+
* @summary Patch an Export Definition
|
|
16205
16222
|
* @param {string} workspaceId
|
|
16206
16223
|
* @param {string} objectId
|
|
16207
16224
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -17376,6 +17393,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
|
|
|
17376
17393
|
},
|
|
17377
17394
|
/**
|
|
17378
17395
|
*
|
|
17396
|
+
* @summary Put an Export Definition
|
|
17379
17397
|
* @param {string} workspaceId
|
|
17380
17398
|
* @param {string} objectId
|
|
17381
17399
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -18599,6 +18617,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
18599
18617
|
},
|
|
18600
18618
|
/**
|
|
18601
18619
|
*
|
|
18620
|
+
* @summary Delete an Export Definition
|
|
18602
18621
|
* @param {string} workspaceId
|
|
18603
18622
|
* @param {string} objectId
|
|
18604
18623
|
* @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 +19010,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
18991
19010
|
},
|
|
18992
19011
|
/**
|
|
18993
19012
|
*
|
|
19013
|
+
* @summary Get all Export Definitions
|
|
18994
19014
|
* @param {string} workspaceId
|
|
18995
19015
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
18996
19016
|
* @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 +19525,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
19505
19525
|
},
|
|
19506
19526
|
/**
|
|
19507
19527
|
*
|
|
19528
|
+
* @summary Get an Export Definition
|
|
19508
19529
|
* @param {string} workspaceId
|
|
19509
19530
|
* @param {string} objectId
|
|
19510
19531
|
* @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 +19920,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
19899
19920
|
},
|
|
19900
19921
|
/**
|
|
19901
19922
|
*
|
|
19923
|
+
* @summary Patch an Export Definition
|
|
19902
19924
|
* @param {string} workspaceId
|
|
19903
19925
|
* @param {string} objectId
|
|
19904
19926
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -20223,6 +20245,7 @@ export const EntitiesApiFp = function (configuration) {
|
|
|
20223
20245
|
},
|
|
20224
20246
|
/**
|
|
20225
20247
|
*
|
|
20248
|
+
* @summary Put an Export Definition
|
|
20226
20249
|
* @param {string} workspaceId
|
|
20227
20250
|
* @param {string} objectId
|
|
20228
20251
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -20831,6 +20854,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
20831
20854
|
},
|
|
20832
20855
|
/**
|
|
20833
20856
|
*
|
|
20857
|
+
* @summary Delete an Export Definition
|
|
20834
20858
|
* @param {EntitiesApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
20835
20859
|
* @param {*} [options] Override http request option.
|
|
20836
20860
|
* @throws {RequiredError}
|
|
@@ -21154,6 +21178,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
21154
21178
|
},
|
|
21155
21179
|
/**
|
|
21156
21180
|
*
|
|
21181
|
+
* @summary Get all Export Definitions
|
|
21157
21182
|
* @param {EntitiesApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
21158
21183
|
* @param {*} [options] Override http request option.
|
|
21159
21184
|
* @throws {RequiredError}
|
|
@@ -21543,6 +21568,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
21543
21568
|
},
|
|
21544
21569
|
/**
|
|
21545
21570
|
*
|
|
21571
|
+
* @summary Get an Export Definition
|
|
21546
21572
|
* @param {EntitiesApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
21547
21573
|
* @param {*} [options] Override http request option.
|
|
21548
21574
|
* @throws {RequiredError}
|
|
@@ -21878,6 +21904,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
21878
21904
|
},
|
|
21879
21905
|
/**
|
|
21880
21906
|
*
|
|
21907
|
+
* @summary Patch an Export Definition
|
|
21881
21908
|
* @param {EntitiesApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
21882
21909
|
* @param {*} [options] Override http request option.
|
|
21883
21910
|
* @throws {RequiredError}
|
|
@@ -22153,6 +22180,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
|
|
|
22153
22180
|
},
|
|
22154
22181
|
/**
|
|
22155
22182
|
*
|
|
22183
|
+
* @summary Put an Export Definition
|
|
22156
22184
|
* @param {EntitiesApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
22157
22185
|
* @param {*} [options] Override http request option.
|
|
22158
22186
|
* @throws {RequiredError}
|
|
@@ -22756,6 +22784,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
22756
22784
|
}
|
|
22757
22785
|
/**
|
|
22758
22786
|
*
|
|
22787
|
+
* @summary Delete an Export Definition
|
|
22759
22788
|
* @param {EntitiesApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
22760
22789
|
* @param {*} [options] Override http request option.
|
|
22761
22790
|
* @throws {RequiredError}
|
|
@@ -23106,6 +23135,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
23106
23135
|
}
|
|
23107
23136
|
/**
|
|
23108
23137
|
*
|
|
23138
|
+
* @summary Get all Export Definitions
|
|
23109
23139
|
* @param {EntitiesApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
23110
23140
|
* @param {*} [options] Override http request option.
|
|
23111
23141
|
* @throws {RequiredError}
|
|
@@ -23532,6 +23562,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
23532
23562
|
}
|
|
23533
23563
|
/**
|
|
23534
23564
|
*
|
|
23565
|
+
* @summary Get an Export Definition
|
|
23535
23566
|
* @param {EntitiesApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
23536
23567
|
* @param {*} [options] Override http request option.
|
|
23537
23568
|
* @throws {RequiredError}
|
|
@@ -23895,6 +23926,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
23895
23926
|
}
|
|
23896
23927
|
/**
|
|
23897
23928
|
*
|
|
23929
|
+
* @summary Patch an Export Definition
|
|
23898
23930
|
* @param {EntitiesApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
23899
23931
|
* @param {*} [options] Override http request option.
|
|
23900
23932
|
* @throws {RequiredError}
|
|
@@ -24193,6 +24225,7 @@ export class EntitiesApi extends BaseAPI {
|
|
|
24193
24225
|
}
|
|
24194
24226
|
/**
|
|
24195
24227
|
*
|
|
24228
|
+
* @summary Put an Export Definition
|
|
24196
24229
|
* @param {EntitiesApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
24197
24230
|
* @param {*} [options] Override http request option.
|
|
24198
24231
|
* @throws {RequiredError}
|
|
@@ -24729,6 +24762,593 @@ export class EntitlementApi extends BaseAPI {
|
|
|
24729
24762
|
.then((request) => request(this.axios, this.basePath));
|
|
24730
24763
|
}
|
|
24731
24764
|
}
|
|
24765
|
+
/**
|
|
24766
|
+
* ExportDefinitionsApi - axios parameter creator
|
|
24767
|
+
* @export
|
|
24768
|
+
*/
|
|
24769
|
+
export const ExportDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
24770
|
+
return {
|
|
24771
|
+
/**
|
|
24772
|
+
*
|
|
24773
|
+
* @summary Post Export Definitions
|
|
24774
|
+
* @param {string} workspaceId
|
|
24775
|
+
* @param {JsonApiExportDefinitionPostOptionalIdDocument} jsonApiExportDefinitionPostOptionalIdDocument
|
|
24776
|
+
* @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.
|
|
24777
|
+
* @param {*} [options] Override http request option.
|
|
24778
|
+
* @throws {RequiredError}
|
|
24779
|
+
*/
|
|
24780
|
+
createEntityExportDefinitions: async (workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options = {}) => {
|
|
24781
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24782
|
+
assertParamExists("createEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24783
|
+
// verify required parameter 'jsonApiExportDefinitionPostOptionalIdDocument' is not null or undefined
|
|
24784
|
+
assertParamExists("createEntityExportDefinitions", "jsonApiExportDefinitionPostOptionalIdDocument", jsonApiExportDefinitionPostOptionalIdDocument);
|
|
24785
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
24786
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24787
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24788
|
+
let baseOptions;
|
|
24789
|
+
if (configuration) {
|
|
24790
|
+
baseOptions = configuration.baseOptions;
|
|
24791
|
+
}
|
|
24792
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
24793
|
+
const localVarHeaderParameter = {};
|
|
24794
|
+
const localVarQueryParameter = {};
|
|
24795
|
+
if (include) {
|
|
24796
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24797
|
+
}
|
|
24798
|
+
localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
|
|
24799
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24800
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24801
|
+
localVarRequestOptions.headers = {
|
|
24802
|
+
...localVarHeaderParameter,
|
|
24803
|
+
...headersFromBaseOptions,
|
|
24804
|
+
...options.headers,
|
|
24805
|
+
};
|
|
24806
|
+
const needsSerialization = typeof jsonApiExportDefinitionPostOptionalIdDocument !== "string" ||
|
|
24807
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
24808
|
+
localVarRequestOptions.data = needsSerialization
|
|
24809
|
+
? JSON.stringify(jsonApiExportDefinitionPostOptionalIdDocument !== undefined
|
|
24810
|
+
? jsonApiExportDefinitionPostOptionalIdDocument
|
|
24811
|
+
: {})
|
|
24812
|
+
: jsonApiExportDefinitionPostOptionalIdDocument || "";
|
|
24813
|
+
return {
|
|
24814
|
+
url: toPathString(localVarUrlObj),
|
|
24815
|
+
options: localVarRequestOptions,
|
|
24816
|
+
};
|
|
24817
|
+
},
|
|
24818
|
+
/**
|
|
24819
|
+
*
|
|
24820
|
+
* @summary Delete an Export Definition
|
|
24821
|
+
* @param {string} workspaceId
|
|
24822
|
+
* @param {string} objectId
|
|
24823
|
+
* @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\').
|
|
24824
|
+
* @param {*} [options] Override http request option.
|
|
24825
|
+
* @throws {RequiredError}
|
|
24826
|
+
*/
|
|
24827
|
+
deleteEntityExportDefinitions: async (workspaceId, objectId, filter, options = {}) => {
|
|
24828
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24829
|
+
assertParamExists("deleteEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24830
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
24831
|
+
assertParamExists("deleteEntityExportDefinitions", "objectId", objectId);
|
|
24832
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
24833
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
24834
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
24835
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24836
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24837
|
+
let baseOptions;
|
|
24838
|
+
if (configuration) {
|
|
24839
|
+
baseOptions = configuration.baseOptions;
|
|
24840
|
+
}
|
|
24841
|
+
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
24842
|
+
const localVarHeaderParameter = {};
|
|
24843
|
+
const localVarQueryParameter = {};
|
|
24844
|
+
if (filter !== undefined) {
|
|
24845
|
+
localVarQueryParameter["filter"] = filter;
|
|
24846
|
+
}
|
|
24847
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24848
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24849
|
+
localVarRequestOptions.headers = {
|
|
24850
|
+
...localVarHeaderParameter,
|
|
24851
|
+
...headersFromBaseOptions,
|
|
24852
|
+
...options.headers,
|
|
24853
|
+
};
|
|
24854
|
+
return {
|
|
24855
|
+
url: toPathString(localVarUrlObj),
|
|
24856
|
+
options: localVarRequestOptions,
|
|
24857
|
+
};
|
|
24858
|
+
},
|
|
24859
|
+
/**
|
|
24860
|
+
*
|
|
24861
|
+
* @summary Get all Export Definitions
|
|
24862
|
+
* @param {string} workspaceId
|
|
24863
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
24864
|
+
* @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\').
|
|
24865
|
+
* @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.
|
|
24866
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
24867
|
+
* @param {number} [size] The size of the page to be returned
|
|
24868
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
24869
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24870
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24871
|
+
* @param {*} [options] Override http request option.
|
|
24872
|
+
* @throws {RequiredError}
|
|
24873
|
+
*/
|
|
24874
|
+
getAllEntitiesExportDefinitions: async (workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options = {}) => {
|
|
24875
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24876
|
+
assertParamExists("getAllEntitiesExportDefinitions", "workspaceId", workspaceId);
|
|
24877
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
24878
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24879
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24880
|
+
let baseOptions;
|
|
24881
|
+
if (configuration) {
|
|
24882
|
+
baseOptions = configuration.baseOptions;
|
|
24883
|
+
}
|
|
24884
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
24885
|
+
const localVarHeaderParameter = {};
|
|
24886
|
+
const localVarQueryParameter = {};
|
|
24887
|
+
if (origin !== undefined) {
|
|
24888
|
+
localVarQueryParameter["origin"] = origin;
|
|
24889
|
+
}
|
|
24890
|
+
if (filter !== undefined) {
|
|
24891
|
+
localVarQueryParameter["filter"] = filter;
|
|
24892
|
+
}
|
|
24893
|
+
if (include) {
|
|
24894
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24895
|
+
}
|
|
24896
|
+
if (page !== undefined) {
|
|
24897
|
+
localVarQueryParameter["page"] = page;
|
|
24898
|
+
}
|
|
24899
|
+
if (size !== undefined) {
|
|
24900
|
+
localVarQueryParameter["size"] = size;
|
|
24901
|
+
}
|
|
24902
|
+
if (sort) {
|
|
24903
|
+
localVarQueryParameter["sort"] = sort;
|
|
24904
|
+
}
|
|
24905
|
+
if (metaInclude) {
|
|
24906
|
+
localVarQueryParameter["metaInclude"] = Array.from(metaInclude).join(COLLECTION_FORMATS.csv);
|
|
24907
|
+
}
|
|
24908
|
+
if (xGDCVALIDATERELATIONS !== undefined && xGDCVALIDATERELATIONS !== null) {
|
|
24909
|
+
localVarHeaderParameter["X-GDC-VALIDATE-RELATIONS"] = String(JSON.stringify(xGDCVALIDATERELATIONS));
|
|
24910
|
+
}
|
|
24911
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24912
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24913
|
+
localVarRequestOptions.headers = {
|
|
24914
|
+
...localVarHeaderParameter,
|
|
24915
|
+
...headersFromBaseOptions,
|
|
24916
|
+
...options.headers,
|
|
24917
|
+
};
|
|
24918
|
+
return {
|
|
24919
|
+
url: toPathString(localVarUrlObj),
|
|
24920
|
+
options: localVarRequestOptions,
|
|
24921
|
+
};
|
|
24922
|
+
},
|
|
24923
|
+
/**
|
|
24924
|
+
*
|
|
24925
|
+
* @summary Get an Export Definition
|
|
24926
|
+
* @param {string} workspaceId
|
|
24927
|
+
* @param {string} objectId
|
|
24928
|
+
* @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\').
|
|
24929
|
+
* @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.
|
|
24930
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24931
|
+
* @param {*} [options] Override http request option.
|
|
24932
|
+
* @throws {RequiredError}
|
|
24933
|
+
*/
|
|
24934
|
+
getEntityExportDefinitions: async (workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options = {}) => {
|
|
24935
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24936
|
+
assertParamExists("getEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24937
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
24938
|
+
assertParamExists("getEntityExportDefinitions", "objectId", objectId);
|
|
24939
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
24940
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
24941
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
24942
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24943
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24944
|
+
let baseOptions;
|
|
24945
|
+
if (configuration) {
|
|
24946
|
+
baseOptions = configuration.baseOptions;
|
|
24947
|
+
}
|
|
24948
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
24949
|
+
const localVarHeaderParameter = {};
|
|
24950
|
+
const localVarQueryParameter = {};
|
|
24951
|
+
if (filter !== undefined) {
|
|
24952
|
+
localVarQueryParameter["filter"] = filter;
|
|
24953
|
+
}
|
|
24954
|
+
if (include) {
|
|
24955
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
24956
|
+
}
|
|
24957
|
+
if (xGDCVALIDATERELATIONS !== undefined && xGDCVALIDATERELATIONS !== null) {
|
|
24958
|
+
localVarHeaderParameter["X-GDC-VALIDATE-RELATIONS"] = String(JSON.stringify(xGDCVALIDATERELATIONS));
|
|
24959
|
+
}
|
|
24960
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24961
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24962
|
+
localVarRequestOptions.headers = {
|
|
24963
|
+
...localVarHeaderParameter,
|
|
24964
|
+
...headersFromBaseOptions,
|
|
24965
|
+
...options.headers,
|
|
24966
|
+
};
|
|
24967
|
+
return {
|
|
24968
|
+
url: toPathString(localVarUrlObj),
|
|
24969
|
+
options: localVarRequestOptions,
|
|
24970
|
+
};
|
|
24971
|
+
},
|
|
24972
|
+
/**
|
|
24973
|
+
*
|
|
24974
|
+
* @summary Patch an Export Definition
|
|
24975
|
+
* @param {string} workspaceId
|
|
24976
|
+
* @param {string} objectId
|
|
24977
|
+
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
24978
|
+
* @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\').
|
|
24979
|
+
* @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.
|
|
24980
|
+
* @param {*} [options] Override http request option.
|
|
24981
|
+
* @throws {RequiredError}
|
|
24982
|
+
*/
|
|
24983
|
+
patchEntityExportDefinitions: async (workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options = {}) => {
|
|
24984
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
24985
|
+
assertParamExists("patchEntityExportDefinitions", "workspaceId", workspaceId);
|
|
24986
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
24987
|
+
assertParamExists("patchEntityExportDefinitions", "objectId", objectId);
|
|
24988
|
+
// verify required parameter 'jsonApiExportDefinitionPatchDocument' is not null or undefined
|
|
24989
|
+
assertParamExists("patchEntityExportDefinitions", "jsonApiExportDefinitionPatchDocument", jsonApiExportDefinitionPatchDocument);
|
|
24990
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
24991
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
24992
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
24993
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24994
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24995
|
+
let baseOptions;
|
|
24996
|
+
if (configuration) {
|
|
24997
|
+
baseOptions = configuration.baseOptions;
|
|
24998
|
+
}
|
|
24999
|
+
const localVarRequestOptions = { method: "PATCH", ...baseOptions, ...options };
|
|
25000
|
+
const localVarHeaderParameter = {};
|
|
25001
|
+
const localVarQueryParameter = {};
|
|
25002
|
+
if (filter !== undefined) {
|
|
25003
|
+
localVarQueryParameter["filter"] = filter;
|
|
25004
|
+
}
|
|
25005
|
+
if (include) {
|
|
25006
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
25007
|
+
}
|
|
25008
|
+
localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
|
|
25009
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25010
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25011
|
+
localVarRequestOptions.headers = {
|
|
25012
|
+
...localVarHeaderParameter,
|
|
25013
|
+
...headersFromBaseOptions,
|
|
25014
|
+
...options.headers,
|
|
25015
|
+
};
|
|
25016
|
+
const needsSerialization = typeof jsonApiExportDefinitionPatchDocument !== "string" ||
|
|
25017
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
25018
|
+
localVarRequestOptions.data = needsSerialization
|
|
25019
|
+
? JSON.stringify(jsonApiExportDefinitionPatchDocument !== undefined
|
|
25020
|
+
? jsonApiExportDefinitionPatchDocument
|
|
25021
|
+
: {})
|
|
25022
|
+
: jsonApiExportDefinitionPatchDocument || "";
|
|
25023
|
+
return {
|
|
25024
|
+
url: toPathString(localVarUrlObj),
|
|
25025
|
+
options: localVarRequestOptions,
|
|
25026
|
+
};
|
|
25027
|
+
},
|
|
25028
|
+
/**
|
|
25029
|
+
*
|
|
25030
|
+
* @summary Put an Export Definition
|
|
25031
|
+
* @param {string} workspaceId
|
|
25032
|
+
* @param {string} objectId
|
|
25033
|
+
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
25034
|
+
* @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\').
|
|
25035
|
+
* @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.
|
|
25036
|
+
* @param {*} [options] Override http request option.
|
|
25037
|
+
* @throws {RequiredError}
|
|
25038
|
+
*/
|
|
25039
|
+
updateEntityExportDefinitions: async (workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options = {}) => {
|
|
25040
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
25041
|
+
assertParamExists("updateEntityExportDefinitions", "workspaceId", workspaceId);
|
|
25042
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
25043
|
+
assertParamExists("updateEntityExportDefinitions", "objectId", objectId);
|
|
25044
|
+
// verify required parameter 'jsonApiExportDefinitionInDocument' is not null or undefined
|
|
25045
|
+
assertParamExists("updateEntityExportDefinitions", "jsonApiExportDefinitionInDocument", jsonApiExportDefinitionInDocument);
|
|
25046
|
+
const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
|
|
25047
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
25048
|
+
.replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
|
|
25049
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25050
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25051
|
+
let baseOptions;
|
|
25052
|
+
if (configuration) {
|
|
25053
|
+
baseOptions = configuration.baseOptions;
|
|
25054
|
+
}
|
|
25055
|
+
const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
|
|
25056
|
+
const localVarHeaderParameter = {};
|
|
25057
|
+
const localVarQueryParameter = {};
|
|
25058
|
+
if (filter !== undefined) {
|
|
25059
|
+
localVarQueryParameter["filter"] = filter;
|
|
25060
|
+
}
|
|
25061
|
+
if (include) {
|
|
25062
|
+
localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
|
|
25063
|
+
}
|
|
25064
|
+
localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
|
|
25065
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25066
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25067
|
+
localVarRequestOptions.headers = {
|
|
25068
|
+
...localVarHeaderParameter,
|
|
25069
|
+
...headersFromBaseOptions,
|
|
25070
|
+
...options.headers,
|
|
25071
|
+
};
|
|
25072
|
+
const needsSerialization = typeof jsonApiExportDefinitionInDocument !== "string" ||
|
|
25073
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
25074
|
+
localVarRequestOptions.data = needsSerialization
|
|
25075
|
+
? JSON.stringify(jsonApiExportDefinitionInDocument !== undefined
|
|
25076
|
+
? jsonApiExportDefinitionInDocument
|
|
25077
|
+
: {})
|
|
25078
|
+
: jsonApiExportDefinitionInDocument || "";
|
|
25079
|
+
return {
|
|
25080
|
+
url: toPathString(localVarUrlObj),
|
|
25081
|
+
options: localVarRequestOptions,
|
|
25082
|
+
};
|
|
25083
|
+
},
|
|
25084
|
+
};
|
|
25085
|
+
};
|
|
25086
|
+
/**
|
|
25087
|
+
* ExportDefinitionsApi - functional programming interface
|
|
25088
|
+
* @export
|
|
25089
|
+
*/
|
|
25090
|
+
export const ExportDefinitionsApiFp = function (configuration) {
|
|
25091
|
+
const localVarAxiosParamCreator = ExportDefinitionsApiAxiosParamCreator(configuration);
|
|
25092
|
+
return {
|
|
25093
|
+
/**
|
|
25094
|
+
*
|
|
25095
|
+
* @summary Post Export Definitions
|
|
25096
|
+
* @param {string} workspaceId
|
|
25097
|
+
* @param {JsonApiExportDefinitionPostOptionalIdDocument} jsonApiExportDefinitionPostOptionalIdDocument
|
|
25098
|
+
* @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.
|
|
25099
|
+
* @param {*} [options] Override http request option.
|
|
25100
|
+
* @throws {RequiredError}
|
|
25101
|
+
*/
|
|
25102
|
+
async createEntityExportDefinitions(workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options) {
|
|
25103
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createEntityExportDefinitions(workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options);
|
|
25104
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25105
|
+
},
|
|
25106
|
+
/**
|
|
25107
|
+
*
|
|
25108
|
+
* @summary Delete an Export Definition
|
|
25109
|
+
* @param {string} workspaceId
|
|
25110
|
+
* @param {string} objectId
|
|
25111
|
+
* @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\').
|
|
25112
|
+
* @param {*} [options] Override http request option.
|
|
25113
|
+
* @throws {RequiredError}
|
|
25114
|
+
*/
|
|
25115
|
+
async deleteEntityExportDefinitions(workspaceId, objectId, filter, options) {
|
|
25116
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteEntityExportDefinitions(workspaceId, objectId, filter, options);
|
|
25117
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25118
|
+
},
|
|
25119
|
+
/**
|
|
25120
|
+
*
|
|
25121
|
+
* @summary Get all Export Definitions
|
|
25122
|
+
* @param {string} workspaceId
|
|
25123
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
25124
|
+
* @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\').
|
|
25125
|
+
* @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.
|
|
25126
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
25127
|
+
* @param {number} [size] The size of the page to be returned
|
|
25128
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
25129
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25130
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
25131
|
+
* @param {*} [options] Override http request option.
|
|
25132
|
+
* @throws {RequiredError}
|
|
25133
|
+
*/
|
|
25134
|
+
async getAllEntitiesExportDefinitions(workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options) {
|
|
25135
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllEntitiesExportDefinitions(workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options);
|
|
25136
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25137
|
+
},
|
|
25138
|
+
/**
|
|
25139
|
+
*
|
|
25140
|
+
* @summary Get an Export Definition
|
|
25141
|
+
* @param {string} workspaceId
|
|
25142
|
+
* @param {string} objectId
|
|
25143
|
+
* @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\').
|
|
25144
|
+
* @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.
|
|
25145
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
25146
|
+
* @param {*} [options] Override http request option.
|
|
25147
|
+
* @throws {RequiredError}
|
|
25148
|
+
*/
|
|
25149
|
+
async getEntityExportDefinitions(workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options) {
|
|
25150
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getEntityExportDefinitions(workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options);
|
|
25151
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25152
|
+
},
|
|
25153
|
+
/**
|
|
25154
|
+
*
|
|
25155
|
+
* @summary Patch an Export Definition
|
|
25156
|
+
* @param {string} workspaceId
|
|
25157
|
+
* @param {string} objectId
|
|
25158
|
+
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
25159
|
+
* @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\').
|
|
25160
|
+
* @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.
|
|
25161
|
+
* @param {*} [options] Override http request option.
|
|
25162
|
+
* @throws {RequiredError}
|
|
25163
|
+
*/
|
|
25164
|
+
async patchEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options) {
|
|
25165
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options);
|
|
25166
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25167
|
+
},
|
|
25168
|
+
/**
|
|
25169
|
+
*
|
|
25170
|
+
* @summary Put an Export Definition
|
|
25171
|
+
* @param {string} workspaceId
|
|
25172
|
+
* @param {string} objectId
|
|
25173
|
+
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
25174
|
+
* @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\').
|
|
25175
|
+
* @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.
|
|
25176
|
+
* @param {*} [options] Override http request option.
|
|
25177
|
+
* @throws {RequiredError}
|
|
25178
|
+
*/
|
|
25179
|
+
async updateEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options) {
|
|
25180
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options);
|
|
25181
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25182
|
+
},
|
|
25183
|
+
};
|
|
25184
|
+
};
|
|
25185
|
+
/**
|
|
25186
|
+
* ExportDefinitionsApi - factory interface
|
|
25187
|
+
* @export
|
|
25188
|
+
*/
|
|
25189
|
+
export const ExportDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
25190
|
+
const localVarFp = ExportDefinitionsApiFp(configuration);
|
|
25191
|
+
return {
|
|
25192
|
+
/**
|
|
25193
|
+
*
|
|
25194
|
+
* @summary Post Export Definitions
|
|
25195
|
+
* @param {ExportDefinitionsApiCreateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25196
|
+
* @param {*} [options] Override http request option.
|
|
25197
|
+
* @throws {RequiredError}
|
|
25198
|
+
*/
|
|
25199
|
+
createEntityExportDefinitions(requestParameters, options) {
|
|
25200
|
+
return localVarFp
|
|
25201
|
+
.createEntityExportDefinitions(requestParameters.workspaceId, requestParameters.jsonApiExportDefinitionPostOptionalIdDocument, requestParameters.include, options)
|
|
25202
|
+
.then((request) => request(axios, basePath));
|
|
25203
|
+
},
|
|
25204
|
+
/**
|
|
25205
|
+
*
|
|
25206
|
+
* @summary Delete an Export Definition
|
|
25207
|
+
* @param {ExportDefinitionsApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25208
|
+
* @param {*} [options] Override http request option.
|
|
25209
|
+
* @throws {RequiredError}
|
|
25210
|
+
*/
|
|
25211
|
+
deleteEntityExportDefinitions(requestParameters, options) {
|
|
25212
|
+
return localVarFp
|
|
25213
|
+
.deleteEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, options)
|
|
25214
|
+
.then((request) => request(axios, basePath));
|
|
25215
|
+
},
|
|
25216
|
+
/**
|
|
25217
|
+
*
|
|
25218
|
+
* @summary Get all Export Definitions
|
|
25219
|
+
* @param {ExportDefinitionsApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
25220
|
+
* @param {*} [options] Override http request option.
|
|
25221
|
+
* @throws {RequiredError}
|
|
25222
|
+
*/
|
|
25223
|
+
getAllEntitiesExportDefinitions(requestParameters, options) {
|
|
25224
|
+
return localVarFp
|
|
25225
|
+
.getAllEntitiesExportDefinitions(requestParameters.workspaceId, requestParameters.origin, requestParameters.filter, requestParameters.include, requestParameters.page, requestParameters.size, requestParameters.sort, requestParameters.xGDCVALIDATERELATIONS, requestParameters.metaInclude, options)
|
|
25226
|
+
.then((request) => request(axios, basePath));
|
|
25227
|
+
},
|
|
25228
|
+
/**
|
|
25229
|
+
*
|
|
25230
|
+
* @summary Get an Export Definition
|
|
25231
|
+
* @param {ExportDefinitionsApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25232
|
+
* @param {*} [options] Override http request option.
|
|
25233
|
+
* @throws {RequiredError}
|
|
25234
|
+
*/
|
|
25235
|
+
getEntityExportDefinitions(requestParameters, options) {
|
|
25236
|
+
return localVarFp
|
|
25237
|
+
.getEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, requestParameters.include, requestParameters.xGDCVALIDATERELATIONS, options)
|
|
25238
|
+
.then((request) => request(axios, basePath));
|
|
25239
|
+
},
|
|
25240
|
+
/**
|
|
25241
|
+
*
|
|
25242
|
+
* @summary Patch an Export Definition
|
|
25243
|
+
* @param {ExportDefinitionsApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25244
|
+
* @param {*} [options] Override http request option.
|
|
25245
|
+
* @throws {RequiredError}
|
|
25246
|
+
*/
|
|
25247
|
+
patchEntityExportDefinitions(requestParameters, options) {
|
|
25248
|
+
return localVarFp
|
|
25249
|
+
.patchEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionPatchDocument, requestParameters.filter, requestParameters.include, options)
|
|
25250
|
+
.then((request) => request(axios, basePath));
|
|
25251
|
+
},
|
|
25252
|
+
/**
|
|
25253
|
+
*
|
|
25254
|
+
* @summary Put an Export Definition
|
|
25255
|
+
* @param {ExportDefinitionsApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25256
|
+
* @param {*} [options] Override http request option.
|
|
25257
|
+
* @throws {RequiredError}
|
|
25258
|
+
*/
|
|
25259
|
+
updateEntityExportDefinitions(requestParameters, options) {
|
|
25260
|
+
return localVarFp
|
|
25261
|
+
.updateEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionInDocument, requestParameters.filter, requestParameters.include, options)
|
|
25262
|
+
.then((request) => request(axios, basePath));
|
|
25263
|
+
},
|
|
25264
|
+
};
|
|
25265
|
+
};
|
|
25266
|
+
/**
|
|
25267
|
+
* ExportDefinitionsApi - object-oriented interface
|
|
25268
|
+
* @export
|
|
25269
|
+
* @class ExportDefinitionsApi
|
|
25270
|
+
* @extends {BaseAPI}
|
|
25271
|
+
*/
|
|
25272
|
+
export class ExportDefinitionsApi extends BaseAPI {
|
|
25273
|
+
/**
|
|
25274
|
+
*
|
|
25275
|
+
* @summary Post Export Definitions
|
|
25276
|
+
* @param {ExportDefinitionsApiCreateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25277
|
+
* @param {*} [options] Override http request option.
|
|
25278
|
+
* @throws {RequiredError}
|
|
25279
|
+
* @memberof ExportDefinitionsApi
|
|
25280
|
+
*/
|
|
25281
|
+
createEntityExportDefinitions(requestParameters, options) {
|
|
25282
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25283
|
+
.createEntityExportDefinitions(requestParameters.workspaceId, requestParameters.jsonApiExportDefinitionPostOptionalIdDocument, requestParameters.include, options)
|
|
25284
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25285
|
+
}
|
|
25286
|
+
/**
|
|
25287
|
+
*
|
|
25288
|
+
* @summary Delete an Export Definition
|
|
25289
|
+
* @param {ExportDefinitionsApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25290
|
+
* @param {*} [options] Override http request option.
|
|
25291
|
+
* @throws {RequiredError}
|
|
25292
|
+
* @memberof ExportDefinitionsApi
|
|
25293
|
+
*/
|
|
25294
|
+
deleteEntityExportDefinitions(requestParameters, options) {
|
|
25295
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25296
|
+
.deleteEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, options)
|
|
25297
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25298
|
+
}
|
|
25299
|
+
/**
|
|
25300
|
+
*
|
|
25301
|
+
* @summary Get all Export Definitions
|
|
25302
|
+
* @param {ExportDefinitionsApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
25303
|
+
* @param {*} [options] Override http request option.
|
|
25304
|
+
* @throws {RequiredError}
|
|
25305
|
+
* @memberof ExportDefinitionsApi
|
|
25306
|
+
*/
|
|
25307
|
+
getAllEntitiesExportDefinitions(requestParameters, options) {
|
|
25308
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25309
|
+
.getAllEntitiesExportDefinitions(requestParameters.workspaceId, requestParameters.origin, requestParameters.filter, requestParameters.include, requestParameters.page, requestParameters.size, requestParameters.sort, requestParameters.xGDCVALIDATERELATIONS, requestParameters.metaInclude, options)
|
|
25310
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25311
|
+
}
|
|
25312
|
+
/**
|
|
25313
|
+
*
|
|
25314
|
+
* @summary Get an Export Definition
|
|
25315
|
+
* @param {ExportDefinitionsApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25316
|
+
* @param {*} [options] Override http request option.
|
|
25317
|
+
* @throws {RequiredError}
|
|
25318
|
+
* @memberof ExportDefinitionsApi
|
|
25319
|
+
*/
|
|
25320
|
+
getEntityExportDefinitions(requestParameters, options) {
|
|
25321
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25322
|
+
.getEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, requestParameters.include, requestParameters.xGDCVALIDATERELATIONS, options)
|
|
25323
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25324
|
+
}
|
|
25325
|
+
/**
|
|
25326
|
+
*
|
|
25327
|
+
* @summary Patch an Export Definition
|
|
25328
|
+
* @param {ExportDefinitionsApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25329
|
+
* @param {*} [options] Override http request option.
|
|
25330
|
+
* @throws {RequiredError}
|
|
25331
|
+
* @memberof ExportDefinitionsApi
|
|
25332
|
+
*/
|
|
25333
|
+
patchEntityExportDefinitions(requestParameters, options) {
|
|
25334
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25335
|
+
.patchEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionPatchDocument, requestParameters.filter, requestParameters.include, options)
|
|
25336
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25337
|
+
}
|
|
25338
|
+
/**
|
|
25339
|
+
*
|
|
25340
|
+
* @summary Put an Export Definition
|
|
25341
|
+
* @param {ExportDefinitionsApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
25342
|
+
* @param {*} [options] Override http request option.
|
|
25343
|
+
* @throws {RequiredError}
|
|
25344
|
+
* @memberof ExportDefinitionsApi
|
|
25345
|
+
*/
|
|
25346
|
+
updateEntityExportDefinitions(requestParameters, options) {
|
|
25347
|
+
return ExportDefinitionsApiFp(this.configuration)
|
|
25348
|
+
.updateEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionInDocument, requestParameters.filter, requestParameters.include, options)
|
|
25349
|
+
.then((request) => request(this.axios, this.basePath));
|
|
25350
|
+
}
|
|
25351
|
+
}
|
|
24732
25352
|
/**
|
|
24733
25353
|
* FactsApi - axios parameter creator
|
|
24734
25354
|
* @export
|
|
@@ -43648,6 +44268,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
43648
44268
|
},
|
|
43649
44269
|
/**
|
|
43650
44270
|
*
|
|
44271
|
+
* @summary Delete an Export Definition
|
|
43651
44272
|
* @param {string} workspaceId
|
|
43652
44273
|
* @param {string} objectId
|
|
43653
44274
|
* @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 +44976,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
44355
44976
|
},
|
|
44356
44977
|
/**
|
|
44357
44978
|
*
|
|
44979
|
+
* @summary Get all Export Definitions
|
|
44358
44980
|
* @param {string} workspaceId
|
|
44359
44981
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
44360
44982
|
* @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 +45926,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
45304
45926
|
},
|
|
45305
45927
|
/**
|
|
45306
45928
|
*
|
|
45929
|
+
* @summary Get an Export Definition
|
|
45307
45930
|
* @param {string} workspaceId
|
|
45308
45931
|
* @param {string} objectId
|
|
45309
45932
|
* @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 +46668,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
46045
46668
|
},
|
|
46046
46669
|
/**
|
|
46047
46670
|
*
|
|
46671
|
+
* @summary Patch an Export Definition
|
|
46048
46672
|
* @param {string} workspaceId
|
|
46049
46673
|
* @param {string} objectId
|
|
46050
46674
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -46704,6 +47328,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
|
|
|
46704
47328
|
},
|
|
46705
47329
|
/**
|
|
46706
47330
|
*
|
|
47331
|
+
* @summary Put an Export Definition
|
|
46707
47332
|
* @param {string} workspaceId
|
|
46708
47333
|
* @param {string} objectId
|
|
46709
47334
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -47367,6 +47992,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
47367
47992
|
},
|
|
47368
47993
|
/**
|
|
47369
47994
|
*
|
|
47995
|
+
* @summary Delete an Export Definition
|
|
47370
47996
|
* @param {string} workspaceId
|
|
47371
47997
|
* @param {string} objectId
|
|
47372
47998
|
* @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 +48209,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
47583
48209
|
},
|
|
47584
48210
|
/**
|
|
47585
48211
|
*
|
|
48212
|
+
* @summary Get all Export Definitions
|
|
47586
48213
|
* @param {string} workspaceId
|
|
47587
48214
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
47588
48215
|
* @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 +48493,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
47866
48493
|
},
|
|
47867
48494
|
/**
|
|
47868
48495
|
*
|
|
48496
|
+
* @summary Get an Export Definition
|
|
47869
48497
|
* @param {string} workspaceId
|
|
47870
48498
|
* @param {string} objectId
|
|
47871
48499
|
* @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 +48710,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
48082
48710
|
},
|
|
48083
48711
|
/**
|
|
48084
48712
|
*
|
|
48713
|
+
* @summary Patch an Export Definition
|
|
48085
48714
|
* @param {string} workspaceId
|
|
48086
48715
|
* @param {string} objectId
|
|
48087
48716
|
* @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
|
|
@@ -48259,6 +48888,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
|
|
|
48259
48888
|
},
|
|
48260
48889
|
/**
|
|
48261
48890
|
*
|
|
48891
|
+
* @summary Put an Export Definition
|
|
48262
48892
|
* @param {string} workspaceId
|
|
48263
48893
|
* @param {string} objectId
|
|
48264
48894
|
* @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
|
|
@@ -48578,6 +49208,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
48578
49208
|
},
|
|
48579
49209
|
/**
|
|
48580
49210
|
*
|
|
49211
|
+
* @summary Delete an Export Definition
|
|
48581
49212
|
* @param {WorkspaceObjectControllerApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
48582
49213
|
* @param {*} [options] Override http request option.
|
|
48583
49214
|
* @throws {RequiredError}
|
|
@@ -48745,6 +49376,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
48745
49376
|
},
|
|
48746
49377
|
/**
|
|
48747
49378
|
*
|
|
49379
|
+
* @summary Get all Export Definitions
|
|
48748
49380
|
* @param {WorkspaceObjectControllerApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
48749
49381
|
* @param {*} [options] Override http request option.
|
|
48750
49382
|
* @throws {RequiredError}
|
|
@@ -48936,6 +49568,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
48936
49568
|
},
|
|
48937
49569
|
/**
|
|
48938
49570
|
*
|
|
49571
|
+
* @summary Get an Export Definition
|
|
48939
49572
|
* @param {WorkspaceObjectControllerApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
48940
49573
|
* @param {*} [options] Override http request option.
|
|
48941
49574
|
* @throws {RequiredError}
|
|
@@ -49103,6 +49736,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
49103
49736
|
},
|
|
49104
49737
|
/**
|
|
49105
49738
|
*
|
|
49739
|
+
* @summary Patch an Export Definition
|
|
49106
49740
|
* @param {WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49107
49741
|
* @param {*} [options] Override http request option.
|
|
49108
49742
|
* @throws {RequiredError}
|
|
@@ -49246,6 +49880,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
|
|
|
49246
49880
|
},
|
|
49247
49881
|
/**
|
|
49248
49882
|
*
|
|
49883
|
+
* @summary Put an Export Definition
|
|
49249
49884
|
* @param {WorkspaceObjectControllerApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49250
49885
|
* @param {*} [options] Override http request option.
|
|
49251
49886
|
* @throws {RequiredError}
|
|
@@ -49558,6 +50193,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
49558
50193
|
}
|
|
49559
50194
|
/**
|
|
49560
50195
|
*
|
|
50196
|
+
* @summary Delete an Export Definition
|
|
49561
50197
|
* @param {WorkspaceObjectControllerApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49562
50198
|
* @param {*} [options] Override http request option.
|
|
49563
50199
|
* @throws {RequiredError}
|
|
@@ -49739,6 +50375,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
49739
50375
|
}
|
|
49740
50376
|
/**
|
|
49741
50377
|
*
|
|
50378
|
+
* @summary Get all Export Definitions
|
|
49742
50379
|
* @param {WorkspaceObjectControllerApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
|
|
49743
50380
|
* @param {*} [options] Override http request option.
|
|
49744
50381
|
* @throws {RequiredError}
|
|
@@ -49946,6 +50583,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
49946
50583
|
}
|
|
49947
50584
|
/**
|
|
49948
50585
|
*
|
|
50586
|
+
* @summary Get an Export Definition
|
|
49949
50587
|
* @param {WorkspaceObjectControllerApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
49950
50588
|
* @param {*} [options] Override http request option.
|
|
49951
50589
|
* @throws {RequiredError}
|
|
@@ -50127,6 +50765,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
50127
50765
|
}
|
|
50128
50766
|
/**
|
|
50129
50767
|
*
|
|
50768
|
+
* @summary Patch an Export Definition
|
|
50130
50769
|
* @param {WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
50131
50770
|
* @param {*} [options] Override http request option.
|
|
50132
50771
|
* @throws {RequiredError}
|
|
@@ -50282,6 +50921,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
|
|
|
50282
50921
|
}
|
|
50283
50922
|
/**
|
|
50284
50923
|
*
|
|
50924
|
+
* @summary Put an Export Definition
|
|
50285
50925
|
* @param {WorkspaceObjectControllerApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
|
|
50286
50926
|
* @param {*} [options] Override http request option.
|
|
50287
50927
|
* @throws {RequiredError}
|