@gooddata/api-client-tiger 11.66.0-alpha.1 → 11.67.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +50 -13
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts +1 -1
- package/esm/gd-tiger-model/AnalyticalDashboardModelV2.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +94 -84
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +15 -15
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -236,27 +236,6 @@ export interface AllTimeDateFilterAllTimeDateFilter {
|
|
|
236
236
|
}
|
|
237
237
|
export type AllTimeDateFilterAllTimeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
238
238
|
export type AllTimeDateFilterAllTimeDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
239
|
-
/**
|
|
240
|
-
* Amplitude service.
|
|
241
|
-
*/
|
|
242
|
-
export interface AmplitudeService {
|
|
243
|
-
/**
|
|
244
|
-
* API key for AI project - intended for frontend use.
|
|
245
|
-
*/
|
|
246
|
-
'aiProjectApiKey': string;
|
|
247
|
-
/**
|
|
248
|
-
* Amplitude endpoint URL.
|
|
249
|
-
*/
|
|
250
|
-
'endpoint': string;
|
|
251
|
-
/**
|
|
252
|
-
* API key for GoodData common project - used by backend.
|
|
253
|
-
*/
|
|
254
|
-
'gdCommonApiKey': string;
|
|
255
|
-
/**
|
|
256
|
-
* Optional reporting endpoint for proxying telemetry events.
|
|
257
|
-
*/
|
|
258
|
-
'reportingEndpoint'?: string;
|
|
259
|
-
}
|
|
260
239
|
/**
|
|
261
240
|
* List of users who created catalog objects in the workspace hierarchy.
|
|
262
241
|
*/
|
|
@@ -11772,7 +11751,7 @@ export interface JsonApiPublisherDocumentOutDocument {
|
|
|
11772
11751
|
/**
|
|
11773
11752
|
* Included resources
|
|
11774
11753
|
*/
|
|
11775
|
-
'included'?: Array<
|
|
11754
|
+
'included'?: Array<JsonApiPublisherDocumentOutIncludes>;
|
|
11776
11755
|
'links'?: ObjectLinks;
|
|
11777
11756
|
'meta'?: JsonApiPublisherDocumentOutDocumentMeta;
|
|
11778
11757
|
}
|
|
@@ -11782,6 +11761,10 @@ export interface JsonApiPublisherDocumentOutDocumentMeta {
|
|
|
11782
11761
|
*/
|
|
11783
11762
|
'restricted'?: Array<RestrictedObject>;
|
|
11784
11763
|
}
|
|
11764
|
+
/**
|
|
11765
|
+
* @type JsonApiPublisherDocumentOutIncludes
|
|
11766
|
+
*/
|
|
11767
|
+
export type JsonApiPublisherDocumentOutIncludes = JsonApiDatasetOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiVisualizationObjectOutWithLinks;
|
|
11785
11768
|
/**
|
|
11786
11769
|
* A JSON:API document with a list of resources
|
|
11787
11770
|
*/
|
|
@@ -11790,7 +11773,7 @@ export interface JsonApiPublisherDocumentOutList {
|
|
|
11790
11773
|
/**
|
|
11791
11774
|
* Included resources
|
|
11792
11775
|
*/
|
|
11793
|
-
'included'?: Array<
|
|
11776
|
+
'included'?: Array<JsonApiPublisherDocumentOutIncludes>;
|
|
11794
11777
|
'links'?: ListLinks;
|
|
11795
11778
|
'meta'?: JsonApiPublisherDocumentOutListMeta;
|
|
11796
11779
|
}
|
|
@@ -11817,14 +11800,42 @@ export interface JsonApiPublisherDocumentOutMetaOrigin {
|
|
|
11817
11800
|
export type JsonApiPublisherDocumentOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
11818
11801
|
export interface JsonApiPublisherDocumentOutRelationships {
|
|
11819
11802
|
'createdBy'?: JsonApiPublisherDocumentOutRelationshipsCreatedBy;
|
|
11803
|
+
'datasets'?: JsonApiPublisherDocumentOutRelationshipsDatasets;
|
|
11804
|
+
'labels'?: JsonApiPublisherDocumentOutRelationshipsLabels;
|
|
11805
|
+
'metrics'?: JsonApiPublisherDocumentOutRelationshipsMetrics;
|
|
11820
11806
|
'modifiedBy'?: JsonApiPublisherDocumentOutRelationshipsModifiedBy;
|
|
11807
|
+
'visualizationObjects'?: JsonApiPublisherDocumentOutRelationshipsVisualizationObjects;
|
|
11821
11808
|
}
|
|
11822
11809
|
export interface JsonApiPublisherDocumentOutRelationshipsCreatedBy {
|
|
11823
11810
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
11824
11811
|
}
|
|
11812
|
+
export interface JsonApiPublisherDocumentOutRelationshipsDatasets {
|
|
11813
|
+
/**
|
|
11814
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11815
|
+
*/
|
|
11816
|
+
'data': Array<JsonApiDatasetLinkage>;
|
|
11817
|
+
}
|
|
11818
|
+
export interface JsonApiPublisherDocumentOutRelationshipsLabels {
|
|
11819
|
+
/**
|
|
11820
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11821
|
+
*/
|
|
11822
|
+
'data': Array<JsonApiLabelLinkage>;
|
|
11823
|
+
}
|
|
11824
|
+
export interface JsonApiPublisherDocumentOutRelationshipsMetrics {
|
|
11825
|
+
/**
|
|
11826
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11827
|
+
*/
|
|
11828
|
+
'data': Array<JsonApiMetricLinkage>;
|
|
11829
|
+
}
|
|
11825
11830
|
export interface JsonApiPublisherDocumentOutRelationshipsModifiedBy {
|
|
11826
11831
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
11827
11832
|
}
|
|
11833
|
+
export interface JsonApiPublisherDocumentOutRelationshipsVisualizationObjects {
|
|
11834
|
+
/**
|
|
11835
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11836
|
+
*/
|
|
11837
|
+
'data': Array<JsonApiVisualizationObjectLinkage>;
|
|
11838
|
+
}
|
|
11828
11839
|
export interface JsonApiPublisherDocumentOutWithLinks {
|
|
11829
11840
|
'attributes': JsonApiPublisherDocumentOutAttributes;
|
|
11830
11841
|
/**
|
|
@@ -17002,7 +17013,6 @@ export interface TelemetryContext {
|
|
|
17002
17013
|
* Available telemetry services.
|
|
17003
17014
|
*/
|
|
17004
17015
|
export interface TelemetryServices {
|
|
17005
|
-
'amplitude'?: AmplitudeService;
|
|
17006
17016
|
'matomo'?: MatomoService;
|
|
17007
17017
|
'openTelemetry'?: OpenTelemetryService;
|
|
17008
17018
|
}
|
|
@@ -38555,13 +38565,13 @@ export declare class DependencyGraphApi extends BaseAPI implements DependencyGra
|
|
|
38555
38565
|
* @summary Post Document
|
|
38556
38566
|
* @param {string} workspaceId
|
|
38557
38567
|
* @param {JsonApiPublisherDocumentPostOptionalIdDocument} jsonApiPublisherDocumentPostOptionalIdDocument
|
|
38558
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
38568
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
38559
38569
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38560
38570
|
* @param {*} [options] Override http request option.
|
|
38561
38571
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38562
38572
|
* @throws {RequiredError}
|
|
38563
38573
|
*/
|
|
38564
|
-
export declare function DocumentControllerApiAxiosParamCreator_CreateEntityDocuments(workspaceId: string, jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38574
|
+
export declare function DocumentControllerApiAxiosParamCreator_CreateEntityDocuments(workspaceId: string, jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38565
38575
|
/**
|
|
38566
38576
|
*
|
|
38567
38577
|
* @summary Delete a Document
|
|
@@ -38588,7 +38598,7 @@ export declare function DocumentControllerApiAxiosParamCreator_DeleteEntityDocum
|
|
|
38588
38598
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38589
38599
|
* @throws {RequiredError}
|
|
38590
38600
|
*/
|
|
38591
|
-
export declare function DocumentControllerApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38601
|
+
export declare function DocumentControllerApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38592
38602
|
/**
|
|
38593
38603
|
*
|
|
38594
38604
|
* @summary Get a Document
|
|
@@ -38602,7 +38612,7 @@ export declare function DocumentControllerApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
38602
38612
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38603
38613
|
* @throws {RequiredError}
|
|
38604
38614
|
*/
|
|
38605
|
-
export declare function DocumentControllerApiAxiosParamCreator_GetEntityDocuments(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38615
|
+
export declare function DocumentControllerApiAxiosParamCreator_GetEntityDocuments(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38606
38616
|
/**
|
|
38607
38617
|
*
|
|
38608
38618
|
* @summary Patch a Document
|
|
@@ -38610,12 +38620,12 @@ export declare function DocumentControllerApiAxiosParamCreator_GetEntityDocument
|
|
|
38610
38620
|
* @param {string} objectId
|
|
38611
38621
|
* @param {JsonApiPublisherDocumentPatchDocument} jsonApiPublisherDocumentPatchDocument
|
|
38612
38622
|
* @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\').
|
|
38613
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
38623
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
38614
38624
|
* @param {*} [options] Override http request option.
|
|
38615
38625
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38616
38626
|
* @throws {RequiredError}
|
|
38617
38627
|
*/
|
|
38618
|
-
export declare function DocumentControllerApiAxiosParamCreator_PatchEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38628
|
+
export declare function DocumentControllerApiAxiosParamCreator_PatchEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38619
38629
|
/**
|
|
38620
38630
|
*
|
|
38621
38631
|
* @summary Put a Document
|
|
@@ -38623,12 +38633,12 @@ export declare function DocumentControllerApiAxiosParamCreator_PatchEntityDocume
|
|
|
38623
38633
|
* @param {string} objectId
|
|
38624
38634
|
* @param {JsonApiPublisherDocumentInDocument} jsonApiPublisherDocumentInDocument
|
|
38625
38635
|
* @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\').
|
|
38626
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
38636
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
38627
38637
|
* @param {*} [options] Override http request option.
|
|
38628
38638
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38629
38639
|
* @throws {RequiredError}
|
|
38630
38640
|
*/
|
|
38631
|
-
export declare function DocumentControllerApiAxiosParamCreator_UpdateEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38641
|
+
export declare function DocumentControllerApiAxiosParamCreator_UpdateEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38632
38642
|
/**
|
|
38633
38643
|
*
|
|
38634
38644
|
* @summary Post Document
|
|
@@ -38776,10 +38786,10 @@ export interface DocumentControllerApiCreateEntityDocumentsRequest {
|
|
|
38776
38786
|
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
38777
38787
|
/**
|
|
38778
38788
|
* 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.
|
|
38779
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38789
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38780
38790
|
* @memberof DocumentControllerApiCreateEntityDocuments
|
|
38781
38791
|
*/
|
|
38782
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38792
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38783
38793
|
/**
|
|
38784
38794
|
* Include Meta objects.
|
|
38785
38795
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -38832,10 +38842,10 @@ export interface DocumentControllerApiGetAllEntitiesDocumentsRequest {
|
|
|
38832
38842
|
readonly filter?: string;
|
|
38833
38843
|
/**
|
|
38834
38844
|
* 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.
|
|
38835
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38845
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38836
38846
|
* @memberof DocumentControllerApiGetAllEntitiesDocuments
|
|
38837
38847
|
*/
|
|
38838
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38848
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38839
38849
|
/**
|
|
38840
38850
|
* Zero-based page index (0..N)
|
|
38841
38851
|
* @type {number}
|
|
@@ -38893,10 +38903,10 @@ export interface DocumentControllerApiGetEntityDocumentsRequest {
|
|
|
38893
38903
|
readonly filter?: string;
|
|
38894
38904
|
/**
|
|
38895
38905
|
* 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.
|
|
38896
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38906
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38897
38907
|
* @memberof DocumentControllerApiGetEntityDocuments
|
|
38898
38908
|
*/
|
|
38899
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38909
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38900
38910
|
/**
|
|
38901
38911
|
*
|
|
38902
38912
|
* @type {boolean}
|
|
@@ -38942,10 +38952,10 @@ export interface DocumentControllerApiPatchEntityDocumentsRequest {
|
|
|
38942
38952
|
readonly filter?: string;
|
|
38943
38953
|
/**
|
|
38944
38954
|
* 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.
|
|
38945
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38955
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38946
38956
|
* @memberof DocumentControllerApiPatchEntityDocuments
|
|
38947
38957
|
*/
|
|
38948
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38958
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38949
38959
|
}
|
|
38950
38960
|
/**
|
|
38951
38961
|
* Request parameters for updateEntityDocuments operation in DocumentControllerApi.
|
|
@@ -38979,10 +38989,10 @@ export interface DocumentControllerApiUpdateEntityDocumentsRequest {
|
|
|
38979
38989
|
readonly filter?: string;
|
|
38980
38990
|
/**
|
|
38981
38991
|
* 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.
|
|
38982
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38992
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38983
38993
|
* @memberof DocumentControllerApiUpdateEntityDocuments
|
|
38984
38994
|
*/
|
|
38985
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38995
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38986
38996
|
}
|
|
38987
38997
|
/**
|
|
38988
38998
|
* DocumentControllerApi - object-oriented interface
|
|
@@ -39074,7 +39084,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_DeleteEnt
|
|
|
39074
39084
|
* @param {string} workspaceId
|
|
39075
39085
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
39076
39086
|
* @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\').
|
|
39077
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
39087
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
39078
39088
|
* @param {number} [page] Zero-based page index (0..N)
|
|
39079
39089
|
* @param {number} [size] The size of the page to be returned
|
|
39080
39090
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -39091,7 +39101,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_GetAllEnt
|
|
|
39091
39101
|
* @param {string} workspaceId
|
|
39092
39102
|
* @param {string} objectId
|
|
39093
39103
|
* @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\').
|
|
39094
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
39104
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
39095
39105
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39096
39106
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39097
39107
|
* @param {*} [options] Override http request option.
|
|
@@ -39705,13 +39715,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityDocumentTemplat
|
|
|
39705
39715
|
* @summary Post Document
|
|
39706
39716
|
* @param {string} workspaceId
|
|
39707
39717
|
* @param {JsonApiPublisherDocumentPostOptionalIdDocument} jsonApiPublisherDocumentPostOptionalIdDocument
|
|
39708
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
39718
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
39709
39719
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39710
39720
|
* @param {*} [options] Override http request option.
|
|
39711
39721
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39712
39722
|
* @throws {RequiredError}
|
|
39713
39723
|
*/
|
|
39714
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityDocuments(workspaceId: string, jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39724
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityDocuments(workspaceId: string, jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39715
39725
|
/**
|
|
39716
39726
|
*
|
|
39717
39727
|
* @summary Post Export Definitions
|
|
@@ -40835,7 +40845,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesDocumentTempl
|
|
|
40835
40845
|
* @param {Configuration} [configuration] Optional configuration.
|
|
40836
40846
|
* @throws {RequiredError}
|
|
40837
40847
|
*/
|
|
40838
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40848
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40839
40849
|
/**
|
|
40840
40850
|
* Space of the shared interest
|
|
40841
40851
|
* @summary Get Entitlements
|
|
@@ -41160,7 +41170,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesParameters(wo
|
|
|
41160
41170
|
* @param {string} workspaceId
|
|
41161
41171
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
41162
41172
|
* @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\').
|
|
41163
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
41173
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
41164
41174
|
* @param {number} [page] Zero-based page index (0..N)
|
|
41165
41175
|
* @param {number} [size] The size of the page to be returned
|
|
41166
41176
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -41691,7 +41701,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityDocumentTemplates(
|
|
|
41691
41701
|
* @param {Configuration} [configuration] Optional configuration.
|
|
41692
41702
|
* @throws {RequiredError}
|
|
41693
41703
|
*/
|
|
41694
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityDocuments(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
41704
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityDocuments(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
41695
41705
|
/**
|
|
41696
41706
|
* Space of the shared interest
|
|
41697
41707
|
* @summary Get Entitlement entity
|
|
@@ -41991,7 +42001,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityReportTemplates(wo
|
|
|
41991
42001
|
* @param {string} workspaceId
|
|
41992
42002
|
* @param {string} objectId
|
|
41993
42003
|
* @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\').
|
|
41994
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
42004
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
41995
42005
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
41996
42006
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
41997
42007
|
* @param {*} [options] Override http request option.
|
|
@@ -42380,12 +42390,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityDocumentTemplate
|
|
|
42380
42390
|
* @param {string} objectId
|
|
42381
42391
|
* @param {JsonApiPublisherDocumentPatchDocument} jsonApiPublisherDocumentPatchDocument
|
|
42382
42392
|
* @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\').
|
|
42383
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
42393
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
42384
42394
|
* @param {*} [options] Override http request option.
|
|
42385
42395
|
* @param {Configuration} [configuration] Optional configuration.
|
|
42386
42396
|
* @throws {RequiredError}
|
|
42387
42397
|
*/
|
|
42388
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
42398
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
42389
42399
|
/**
|
|
42390
42400
|
*
|
|
42391
42401
|
* @summary Patch an Export Definition
|
|
@@ -43265,12 +43275,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityDocumentTemplat
|
|
|
43265
43275
|
* @param {string} objectId
|
|
43266
43276
|
* @param {JsonApiPublisherDocumentInDocument} jsonApiPublisherDocumentInDocument
|
|
43267
43277
|
* @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\').
|
|
43268
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
43278
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
43269
43279
|
* @param {*} [options] Override http request option.
|
|
43270
43280
|
* @param {Configuration} [configuration] Optional configuration.
|
|
43271
43281
|
* @throws {RequiredError}
|
|
43272
43282
|
*/
|
|
43273
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
43283
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
43274
43284
|
/**
|
|
43275
43285
|
*
|
|
43276
43286
|
* @summary Put an Export Definition
|
|
@@ -50850,10 +50860,10 @@ export interface EntitiesApiCreateEntityDocumentsRequest {
|
|
|
50850
50860
|
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
50851
50861
|
/**
|
|
50852
50862
|
* 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.
|
|
50853
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50863
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50854
50864
|
* @memberof EntitiesApiCreateEntityDocuments
|
|
50855
50865
|
*/
|
|
50856
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50866
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50857
50867
|
/**
|
|
50858
50868
|
* Include Meta objects.
|
|
50859
50869
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -53422,10 +53432,10 @@ export interface EntitiesApiGetAllEntitiesDocumentsRequest {
|
|
|
53422
53432
|
readonly filter?: string;
|
|
53423
53433
|
/**
|
|
53424
53434
|
* 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.
|
|
53425
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
53435
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
53426
53436
|
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
53427
53437
|
*/
|
|
53428
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53438
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53429
53439
|
/**
|
|
53430
53440
|
* Zero-based page index (0..N)
|
|
53431
53441
|
* @type {number}
|
|
@@ -56061,10 +56071,10 @@ export interface EntitiesApiGetEntityDocumentsRequest {
|
|
|
56061
56071
|
readonly filter?: string;
|
|
56062
56072
|
/**
|
|
56063
56073
|
* 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.
|
|
56064
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56074
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56065
56075
|
* @memberof EntitiesApiGetEntityDocuments
|
|
56066
56076
|
*/
|
|
56067
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56077
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56068
56078
|
/**
|
|
56069
56079
|
*
|
|
56070
56080
|
* @type {boolean}
|
|
@@ -57900,10 +57910,10 @@ export interface EntitiesApiPatchEntityDocumentsRequest {
|
|
|
57900
57910
|
readonly filter?: string;
|
|
57901
57911
|
/**
|
|
57902
57912
|
* 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.
|
|
57903
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
57913
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
57904
57914
|
* @memberof EntitiesApiPatchEntityDocuments
|
|
57905
57915
|
*/
|
|
57906
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
57916
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
57907
57917
|
}
|
|
57908
57918
|
/**
|
|
57909
57919
|
* Request parameters for patchEntityExportDefinitions operation in EntitiesApi.
|
|
@@ -60217,10 +60227,10 @@ export interface EntitiesApiUpdateEntityDocumentsRequest {
|
|
|
60217
60227
|
readonly filter?: string;
|
|
60218
60228
|
/**
|
|
60219
60229
|
* 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.
|
|
60220
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
60230
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
60221
60231
|
* @memberof EntitiesApiUpdateEntityDocuments
|
|
60222
60232
|
*/
|
|
60223
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
60233
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
60224
60234
|
}
|
|
60225
60235
|
/**
|
|
60226
60236
|
* Request parameters for updateEntityExportDefinitions operation in EntitiesApi.
|
|
@@ -89986,13 +89996,13 @@ export declare function PublisherDocumentsApiAxiosParamCreator_CreateEntityDocum
|
|
|
89986
89996
|
* @summary Post Document
|
|
89987
89997
|
* @param {string} workspaceId
|
|
89988
89998
|
* @param {JsonApiPublisherDocumentPostOptionalIdDocument} jsonApiPublisherDocumentPostOptionalIdDocument
|
|
89989
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
89999
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
89990
90000
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
89991
90001
|
* @param {*} [options] Override http request option.
|
|
89992
90002
|
* @param {Configuration} [configuration] Optional configuration.
|
|
89993
90003
|
* @throws {RequiredError}
|
|
89994
90004
|
*/
|
|
89995
|
-
export declare function PublisherDocumentsApiAxiosParamCreator_CreateEntityDocuments(workspaceId: string, jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90005
|
+
export declare function PublisherDocumentsApiAxiosParamCreator_CreateEntityDocuments(workspaceId: string, jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
89996
90006
|
/**
|
|
89997
90007
|
*
|
|
89998
90008
|
* @summary Post Page Template
|
|
@@ -90068,7 +90078,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
90068
90078
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90069
90079
|
* @throws {RequiredError}
|
|
90070
90080
|
*/
|
|
90071
|
-
export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90081
|
+
export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDocuments(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90072
90082
|
/**
|
|
90073
90083
|
*
|
|
90074
90084
|
* @summary Get all Page Templates
|
|
@@ -90113,7 +90123,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetEntityDocument
|
|
|
90113
90123
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90114
90124
|
* @throws {RequiredError}
|
|
90115
90125
|
*/
|
|
90116
|
-
export declare function PublisherDocumentsApiAxiosParamCreator_GetEntityDocuments(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90126
|
+
export declare function PublisherDocumentsApiAxiosParamCreator_GetEntityDocuments(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90117
90127
|
/**
|
|
90118
90128
|
*
|
|
90119
90129
|
* @summary Get a Page Template
|
|
@@ -90148,12 +90158,12 @@ export declare function PublisherDocumentsApiAxiosParamCreator_PatchEntityDocume
|
|
|
90148
90158
|
* @param {string} objectId
|
|
90149
90159
|
* @param {JsonApiPublisherDocumentPatchDocument} jsonApiPublisherDocumentPatchDocument
|
|
90150
90160
|
* @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\').
|
|
90151
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
90161
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
90152
90162
|
* @param {*} [options] Override http request option.
|
|
90153
90163
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90154
90164
|
* @throws {RequiredError}
|
|
90155
90165
|
*/
|
|
90156
|
-
export declare function PublisherDocumentsApiAxiosParamCreator_PatchEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90166
|
+
export declare function PublisherDocumentsApiAxiosParamCreator_PatchEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentPatchDocument: JsonApiPublisherDocumentPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90157
90167
|
/**
|
|
90158
90168
|
*
|
|
90159
90169
|
* @summary Patch a Page Template
|
|
@@ -90187,12 +90197,12 @@ export declare function PublisherDocumentsApiAxiosParamCreator_UpdateEntityDocum
|
|
|
90187
90197
|
* @param {string} objectId
|
|
90188
90198
|
* @param {JsonApiPublisherDocumentInDocument} jsonApiPublisherDocumentInDocument
|
|
90189
90199
|
* @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\').
|
|
90190
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
90200
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
90191
90201
|
* @param {*} [options] Override http request option.
|
|
90192
90202
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90193
90203
|
* @throws {RequiredError}
|
|
90194
90204
|
*/
|
|
90195
|
-
export declare function PublisherDocumentsApiAxiosParamCreator_UpdateEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90205
|
+
export declare function PublisherDocumentsApiAxiosParamCreator_UpdateEntityDocuments(workspaceId: string, objectId: string, jsonApiPublisherDocumentInDocument: JsonApiPublisherDocumentInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
90196
90206
|
/**
|
|
90197
90207
|
*
|
|
90198
90208
|
* @summary Put a Page Template
|
|
@@ -90624,10 +90634,10 @@ export interface PublisherDocumentsApiCreateEntityDocumentsRequest {
|
|
|
90624
90634
|
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
90625
90635
|
/**
|
|
90626
90636
|
* 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.
|
|
90627
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90637
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90628
90638
|
* @memberof PublisherDocumentsApiCreateEntityDocuments
|
|
90629
90639
|
*/
|
|
90630
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90640
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90631
90641
|
/**
|
|
90632
90642
|
* Include Meta objects.
|
|
90633
90643
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -90810,10 +90820,10 @@ export interface PublisherDocumentsApiGetAllEntitiesDocumentsRequest {
|
|
|
90810
90820
|
readonly filter?: string;
|
|
90811
90821
|
/**
|
|
90812
90822
|
* 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.
|
|
90813
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90823
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90814
90824
|
* @memberof PublisherDocumentsApiGetAllEntitiesDocuments
|
|
90815
90825
|
*/
|
|
90816
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90826
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90817
90827
|
/**
|
|
90818
90828
|
* Zero-based page index (0..N)
|
|
90819
90829
|
* @type {number}
|
|
@@ -90975,10 +90985,10 @@ export interface PublisherDocumentsApiGetEntityDocumentsRequest {
|
|
|
90975
90985
|
readonly filter?: string;
|
|
90976
90986
|
/**
|
|
90977
90987
|
* 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.
|
|
90978
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90988
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90979
90989
|
* @memberof PublisherDocumentsApiGetEntityDocuments
|
|
90980
90990
|
*/
|
|
90981
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90991
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90982
90992
|
/**
|
|
90983
90993
|
*
|
|
90984
90994
|
* @type {boolean}
|
|
@@ -91104,10 +91114,10 @@ export interface PublisherDocumentsApiPatchEntityDocumentsRequest {
|
|
|
91104
91114
|
readonly filter?: string;
|
|
91105
91115
|
/**
|
|
91106
91116
|
* 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.
|
|
91107
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
91117
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
91108
91118
|
* @memberof PublisherDocumentsApiPatchEntityDocuments
|
|
91109
91119
|
*/
|
|
91110
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91120
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91111
91121
|
}
|
|
91112
91122
|
/**
|
|
91113
91123
|
* Request parameters for patchEntityPageTemplates operation in PublisherDocumentsApi.
|
|
@@ -91215,10 +91225,10 @@ export interface PublisherDocumentsApiUpdateEntityDocumentsRequest {
|
|
|
91215
91225
|
readonly filter?: string;
|
|
91216
91226
|
/**
|
|
91217
91227
|
* 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.
|
|
91218
|
-
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
91228
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
91219
91229
|
* @memberof PublisherDocumentsApiUpdateEntityDocuments
|
|
91220
91230
|
*/
|
|
91221
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91231
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91222
91232
|
}
|
|
91223
91233
|
/**
|
|
91224
91234
|
* Request parameters for updateEntityPageTemplates operation in PublisherDocumentsApi.
|
|
@@ -91455,7 +91465,7 @@ export declare function ReportControllerApiAxiosParamCreator_DeleteEntityReports
|
|
|
91455
91465
|
* @param {string} workspaceId
|
|
91456
91466
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
91457
91467
|
* @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\').
|
|
91458
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
91468
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
91459
91469
|
* @param {number} [page] Zero-based page index (0..N)
|
|
91460
91470
|
* @param {number} [size] The size of the page to be returned
|
|
91461
91471
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -91472,7 +91482,7 @@ export declare function ReportControllerApiAxiosParamCreator_GetAllEntitiesRepor
|
|
|
91472
91482
|
* @param {string} workspaceId
|
|
91473
91483
|
* @param {string} objectId
|
|
91474
91484
|
* @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\').
|
|
91475
|
-
* @param {Array<'userIdentifiers' | '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.
|
|
91485
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | '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.
|
|
91476
91486
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
91477
91487
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
91478
91488
|
* @param {*} [options] Override http request option.
|