@gooddata/api-client-tiger 11.65.2-alpha.0 → 11.65.2-alpha.2
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 +49 -12
- package/esm/generated/metadata-json-api/api.d.ts +94 -62
- 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
|
@@ -11772,7 +11772,7 @@ export interface JsonApiPublisherDocumentOutDocument {
|
|
|
11772
11772
|
/**
|
|
11773
11773
|
* Included resources
|
|
11774
11774
|
*/
|
|
11775
|
-
'included'?: Array<
|
|
11775
|
+
'included'?: Array<JsonApiPublisherDocumentOutIncludes>;
|
|
11776
11776
|
'links'?: ObjectLinks;
|
|
11777
11777
|
'meta'?: JsonApiPublisherDocumentOutDocumentMeta;
|
|
11778
11778
|
}
|
|
@@ -11782,6 +11782,10 @@ export interface JsonApiPublisherDocumentOutDocumentMeta {
|
|
|
11782
11782
|
*/
|
|
11783
11783
|
'restricted'?: Array<RestrictedObject>;
|
|
11784
11784
|
}
|
|
11785
|
+
/**
|
|
11786
|
+
* @type JsonApiPublisherDocumentOutIncludes
|
|
11787
|
+
*/
|
|
11788
|
+
export type JsonApiPublisherDocumentOutIncludes = JsonApiDatasetOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiVisualizationObjectOutWithLinks;
|
|
11785
11789
|
/**
|
|
11786
11790
|
* A JSON:API document with a list of resources
|
|
11787
11791
|
*/
|
|
@@ -11790,7 +11794,7 @@ export interface JsonApiPublisherDocumentOutList {
|
|
|
11790
11794
|
/**
|
|
11791
11795
|
* Included resources
|
|
11792
11796
|
*/
|
|
11793
|
-
'included'?: Array<
|
|
11797
|
+
'included'?: Array<JsonApiPublisherDocumentOutIncludes>;
|
|
11794
11798
|
'links'?: ListLinks;
|
|
11795
11799
|
'meta'?: JsonApiPublisherDocumentOutListMeta;
|
|
11796
11800
|
}
|
|
@@ -11817,14 +11821,42 @@ export interface JsonApiPublisherDocumentOutMetaOrigin {
|
|
|
11817
11821
|
export type JsonApiPublisherDocumentOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
11818
11822
|
export interface JsonApiPublisherDocumentOutRelationships {
|
|
11819
11823
|
'createdBy'?: JsonApiPublisherDocumentOutRelationshipsCreatedBy;
|
|
11824
|
+
'datasets'?: JsonApiPublisherDocumentOutRelationshipsDatasets;
|
|
11825
|
+
'labels'?: JsonApiPublisherDocumentOutRelationshipsLabels;
|
|
11826
|
+
'metrics'?: JsonApiPublisherDocumentOutRelationshipsMetrics;
|
|
11820
11827
|
'modifiedBy'?: JsonApiPublisherDocumentOutRelationshipsModifiedBy;
|
|
11828
|
+
'visualizationObjects'?: JsonApiPublisherDocumentOutRelationshipsVisualizationObjects;
|
|
11821
11829
|
}
|
|
11822
11830
|
export interface JsonApiPublisherDocumentOutRelationshipsCreatedBy {
|
|
11823
11831
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
11824
11832
|
}
|
|
11833
|
+
export interface JsonApiPublisherDocumentOutRelationshipsDatasets {
|
|
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<JsonApiDatasetLinkage>;
|
|
11838
|
+
}
|
|
11839
|
+
export interface JsonApiPublisherDocumentOutRelationshipsLabels {
|
|
11840
|
+
/**
|
|
11841
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11842
|
+
*/
|
|
11843
|
+
'data': Array<JsonApiLabelLinkage>;
|
|
11844
|
+
}
|
|
11845
|
+
export interface JsonApiPublisherDocumentOutRelationshipsMetrics {
|
|
11846
|
+
/**
|
|
11847
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11848
|
+
*/
|
|
11849
|
+
'data': Array<JsonApiMetricLinkage>;
|
|
11850
|
+
}
|
|
11825
11851
|
export interface JsonApiPublisherDocumentOutRelationshipsModifiedBy {
|
|
11826
11852
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
11827
11853
|
}
|
|
11854
|
+
export interface JsonApiPublisherDocumentOutRelationshipsVisualizationObjects {
|
|
11855
|
+
/**
|
|
11856
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
11857
|
+
*/
|
|
11858
|
+
'data': Array<JsonApiVisualizationObjectLinkage>;
|
|
11859
|
+
}
|
|
11828
11860
|
export interface JsonApiPublisherDocumentOutWithLinks {
|
|
11829
11861
|
'attributes': JsonApiPublisherDocumentOutAttributes;
|
|
11830
11862
|
/**
|
|
@@ -38555,13 +38587,13 @@ export declare class DependencyGraphApi extends BaseAPI implements DependencyGra
|
|
|
38555
38587
|
* @summary Post Document
|
|
38556
38588
|
* @param {string} workspaceId
|
|
38557
38589
|
* @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.
|
|
38590
|
+
* @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
38591
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38560
38592
|
* @param {*} [options] Override http request option.
|
|
38561
38593
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38562
38594
|
* @throws {RequiredError}
|
|
38563
38595
|
*/
|
|
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>;
|
|
38596
|
+
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
38597
|
/**
|
|
38566
38598
|
*
|
|
38567
38599
|
* @summary Delete a Document
|
|
@@ -38588,7 +38620,7 @@ export declare function DocumentControllerApiAxiosParamCreator_DeleteEntityDocum
|
|
|
38588
38620
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38589
38621
|
* @throws {RequiredError}
|
|
38590
38622
|
*/
|
|
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>;
|
|
38623
|
+
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
38624
|
/**
|
|
38593
38625
|
*
|
|
38594
38626
|
* @summary Get a Document
|
|
@@ -38602,7 +38634,7 @@ export declare function DocumentControllerApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
38602
38634
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38603
38635
|
* @throws {RequiredError}
|
|
38604
38636
|
*/
|
|
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>;
|
|
38637
|
+
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
38638
|
/**
|
|
38607
38639
|
*
|
|
38608
38640
|
* @summary Patch a Document
|
|
@@ -38610,12 +38642,12 @@ export declare function DocumentControllerApiAxiosParamCreator_GetEntityDocument
|
|
|
38610
38642
|
* @param {string} objectId
|
|
38611
38643
|
* @param {JsonApiPublisherDocumentPatchDocument} jsonApiPublisherDocumentPatchDocument
|
|
38612
38644
|
* @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.
|
|
38645
|
+
* @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
38646
|
* @param {*} [options] Override http request option.
|
|
38615
38647
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38616
38648
|
* @throws {RequiredError}
|
|
38617
38649
|
*/
|
|
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>;
|
|
38650
|
+
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
38651
|
/**
|
|
38620
38652
|
*
|
|
38621
38653
|
* @summary Put a Document
|
|
@@ -38623,12 +38655,12 @@ export declare function DocumentControllerApiAxiosParamCreator_PatchEntityDocume
|
|
|
38623
38655
|
* @param {string} objectId
|
|
38624
38656
|
* @param {JsonApiPublisherDocumentInDocument} jsonApiPublisherDocumentInDocument
|
|
38625
38657
|
* @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.
|
|
38658
|
+
* @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
38659
|
* @param {*} [options] Override http request option.
|
|
38628
38660
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38629
38661
|
* @throws {RequiredError}
|
|
38630
38662
|
*/
|
|
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>;
|
|
38663
|
+
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
38664
|
/**
|
|
38633
38665
|
*
|
|
38634
38666
|
* @summary Post Document
|
|
@@ -38776,10 +38808,10 @@ export interface DocumentControllerApiCreateEntityDocumentsRequest {
|
|
|
38776
38808
|
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
38777
38809
|
/**
|
|
38778
38810
|
* 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'>}
|
|
38811
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38780
38812
|
* @memberof DocumentControllerApiCreateEntityDocuments
|
|
38781
38813
|
*/
|
|
38782
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38814
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38783
38815
|
/**
|
|
38784
38816
|
* Include Meta objects.
|
|
38785
38817
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -38832,10 +38864,10 @@ export interface DocumentControllerApiGetAllEntitiesDocumentsRequest {
|
|
|
38832
38864
|
readonly filter?: string;
|
|
38833
38865
|
/**
|
|
38834
38866
|
* 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'>}
|
|
38867
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38836
38868
|
* @memberof DocumentControllerApiGetAllEntitiesDocuments
|
|
38837
38869
|
*/
|
|
38838
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38870
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38839
38871
|
/**
|
|
38840
38872
|
* Zero-based page index (0..N)
|
|
38841
38873
|
* @type {number}
|
|
@@ -38893,10 +38925,10 @@ export interface DocumentControllerApiGetEntityDocumentsRequest {
|
|
|
38893
38925
|
readonly filter?: string;
|
|
38894
38926
|
/**
|
|
38895
38927
|
* 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'>}
|
|
38928
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38897
38929
|
* @memberof DocumentControllerApiGetEntityDocuments
|
|
38898
38930
|
*/
|
|
38899
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38931
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38900
38932
|
/**
|
|
38901
38933
|
*
|
|
38902
38934
|
* @type {boolean}
|
|
@@ -38942,10 +38974,10 @@ export interface DocumentControllerApiPatchEntityDocumentsRequest {
|
|
|
38942
38974
|
readonly filter?: string;
|
|
38943
38975
|
/**
|
|
38944
38976
|
* 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'>}
|
|
38977
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38946
38978
|
* @memberof DocumentControllerApiPatchEntityDocuments
|
|
38947
38979
|
*/
|
|
38948
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38980
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38949
38981
|
}
|
|
38950
38982
|
/**
|
|
38951
38983
|
* Request parameters for updateEntityDocuments operation in DocumentControllerApi.
|
|
@@ -38979,10 +39011,10 @@ export interface DocumentControllerApiUpdateEntityDocumentsRequest {
|
|
|
38979
39011
|
readonly filter?: string;
|
|
38980
39012
|
/**
|
|
38981
39013
|
* 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'>}
|
|
39014
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
38983
39015
|
* @memberof DocumentControllerApiUpdateEntityDocuments
|
|
38984
39016
|
*/
|
|
38985
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
39017
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
38986
39018
|
}
|
|
38987
39019
|
/**
|
|
38988
39020
|
* DocumentControllerApi - object-oriented interface
|
|
@@ -39074,7 +39106,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_DeleteEnt
|
|
|
39074
39106
|
* @param {string} workspaceId
|
|
39075
39107
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
39076
39108
|
* @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.
|
|
39109
|
+
* @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
39110
|
* @param {number} [page] Zero-based page index (0..N)
|
|
39079
39111
|
* @param {number} [size] The size of the page to be returned
|
|
39080
39112
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -39091,7 +39123,7 @@ export declare function DocumentTemplateControllerApiAxiosParamCreator_GetAllEnt
|
|
|
39091
39123
|
* @param {string} workspaceId
|
|
39092
39124
|
* @param {string} objectId
|
|
39093
39125
|
* @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.
|
|
39126
|
+
* @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
39127
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39096
39128
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39097
39129
|
* @param {*} [options] Override http request option.
|
|
@@ -39705,13 +39737,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityDocumentTemplat
|
|
|
39705
39737
|
* @summary Post Document
|
|
39706
39738
|
* @param {string} workspaceId
|
|
39707
39739
|
* @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.
|
|
39740
|
+
* @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
39741
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39710
39742
|
* @param {*} [options] Override http request option.
|
|
39711
39743
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39712
39744
|
* @throws {RequiredError}
|
|
39713
39745
|
*/
|
|
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>;
|
|
39746
|
+
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
39747
|
/**
|
|
39716
39748
|
*
|
|
39717
39749
|
* @summary Post Export Definitions
|
|
@@ -40835,7 +40867,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesDocumentTempl
|
|
|
40835
40867
|
* @param {Configuration} [configuration] Optional configuration.
|
|
40836
40868
|
* @throws {RequiredError}
|
|
40837
40869
|
*/
|
|
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>;
|
|
40870
|
+
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
40871
|
/**
|
|
40840
40872
|
* Space of the shared interest
|
|
40841
40873
|
* @summary Get Entitlements
|
|
@@ -41160,7 +41192,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesParameters(wo
|
|
|
41160
41192
|
* @param {string} workspaceId
|
|
41161
41193
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
41162
41194
|
* @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.
|
|
41195
|
+
* @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
41196
|
* @param {number} [page] Zero-based page index (0..N)
|
|
41165
41197
|
* @param {number} [size] The size of the page to be returned
|
|
41166
41198
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -41691,7 +41723,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityDocumentTemplates(
|
|
|
41691
41723
|
* @param {Configuration} [configuration] Optional configuration.
|
|
41692
41724
|
* @throws {RequiredError}
|
|
41693
41725
|
*/
|
|
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>;
|
|
41726
|
+
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
41727
|
/**
|
|
41696
41728
|
* Space of the shared interest
|
|
41697
41729
|
* @summary Get Entitlement entity
|
|
@@ -41991,7 +42023,7 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityReportTemplates(wo
|
|
|
41991
42023
|
* @param {string} workspaceId
|
|
41992
42024
|
* @param {string} objectId
|
|
41993
42025
|
* @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.
|
|
42026
|
+
* @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
42027
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
41996
42028
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
41997
42029
|
* @param {*} [options] Override http request option.
|
|
@@ -42380,12 +42412,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityDocumentTemplate
|
|
|
42380
42412
|
* @param {string} objectId
|
|
42381
42413
|
* @param {JsonApiPublisherDocumentPatchDocument} jsonApiPublisherDocumentPatchDocument
|
|
42382
42414
|
* @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.
|
|
42415
|
+
* @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
42416
|
* @param {*} [options] Override http request option.
|
|
42385
42417
|
* @param {Configuration} [configuration] Optional configuration.
|
|
42386
42418
|
* @throws {RequiredError}
|
|
42387
42419
|
*/
|
|
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>;
|
|
42420
|
+
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
42421
|
/**
|
|
42390
42422
|
*
|
|
42391
42423
|
* @summary Patch an Export Definition
|
|
@@ -43265,12 +43297,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityDocumentTemplat
|
|
|
43265
43297
|
* @param {string} objectId
|
|
43266
43298
|
* @param {JsonApiPublisherDocumentInDocument} jsonApiPublisherDocumentInDocument
|
|
43267
43299
|
* @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.
|
|
43300
|
+
* @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
43301
|
* @param {*} [options] Override http request option.
|
|
43270
43302
|
* @param {Configuration} [configuration] Optional configuration.
|
|
43271
43303
|
* @throws {RequiredError}
|
|
43272
43304
|
*/
|
|
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>;
|
|
43305
|
+
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
43306
|
/**
|
|
43275
43307
|
*
|
|
43276
43308
|
* @summary Put an Export Definition
|
|
@@ -50850,10 +50882,10 @@ export interface EntitiesApiCreateEntityDocumentsRequest {
|
|
|
50850
50882
|
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
50851
50883
|
/**
|
|
50852
50884
|
* 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'>}
|
|
50885
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50854
50886
|
* @memberof EntitiesApiCreateEntityDocuments
|
|
50855
50887
|
*/
|
|
50856
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50888
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50857
50889
|
/**
|
|
50858
50890
|
* Include Meta objects.
|
|
50859
50891
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -53422,10 +53454,10 @@ export interface EntitiesApiGetAllEntitiesDocumentsRequest {
|
|
|
53422
53454
|
readonly filter?: string;
|
|
53423
53455
|
/**
|
|
53424
53456
|
* 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'>}
|
|
53457
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
53426
53458
|
* @memberof EntitiesApiGetAllEntitiesDocuments
|
|
53427
53459
|
*/
|
|
53428
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53460
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53429
53461
|
/**
|
|
53430
53462
|
* Zero-based page index (0..N)
|
|
53431
53463
|
* @type {number}
|
|
@@ -56061,10 +56093,10 @@ export interface EntitiesApiGetEntityDocumentsRequest {
|
|
|
56061
56093
|
readonly filter?: string;
|
|
56062
56094
|
/**
|
|
56063
56095
|
* 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'>}
|
|
56096
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56065
56097
|
* @memberof EntitiesApiGetEntityDocuments
|
|
56066
56098
|
*/
|
|
56067
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56099
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56068
56100
|
/**
|
|
56069
56101
|
*
|
|
56070
56102
|
* @type {boolean}
|
|
@@ -57900,10 +57932,10 @@ export interface EntitiesApiPatchEntityDocumentsRequest {
|
|
|
57900
57932
|
readonly filter?: string;
|
|
57901
57933
|
/**
|
|
57902
57934
|
* 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'>}
|
|
57935
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
57904
57936
|
* @memberof EntitiesApiPatchEntityDocuments
|
|
57905
57937
|
*/
|
|
57906
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
57938
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
57907
57939
|
}
|
|
57908
57940
|
/**
|
|
57909
57941
|
* Request parameters for patchEntityExportDefinitions operation in EntitiesApi.
|
|
@@ -60217,10 +60249,10 @@ export interface EntitiesApiUpdateEntityDocumentsRequest {
|
|
|
60217
60249
|
readonly filter?: string;
|
|
60218
60250
|
/**
|
|
60219
60251
|
* 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'>}
|
|
60252
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
60221
60253
|
* @memberof EntitiesApiUpdateEntityDocuments
|
|
60222
60254
|
*/
|
|
60223
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
60255
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
60224
60256
|
}
|
|
60225
60257
|
/**
|
|
60226
60258
|
* Request parameters for updateEntityExportDefinitions operation in EntitiesApi.
|
|
@@ -89986,13 +90018,13 @@ export declare function PublisherDocumentsApiAxiosParamCreator_CreateEntityDocum
|
|
|
89986
90018
|
* @summary Post Document
|
|
89987
90019
|
* @param {string} workspaceId
|
|
89988
90020
|
* @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.
|
|
90021
|
+
* @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
90022
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
89991
90023
|
* @param {*} [options] Override http request option.
|
|
89992
90024
|
* @param {Configuration} [configuration] Optional configuration.
|
|
89993
90025
|
* @throws {RequiredError}
|
|
89994
90026
|
*/
|
|
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>;
|
|
90027
|
+
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
90028
|
/**
|
|
89997
90029
|
*
|
|
89998
90030
|
* @summary Post Page Template
|
|
@@ -90068,7 +90100,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetAllEntitiesDoc
|
|
|
90068
90100
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90069
90101
|
* @throws {RequiredError}
|
|
90070
90102
|
*/
|
|
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>;
|
|
90103
|
+
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
90104
|
/**
|
|
90073
90105
|
*
|
|
90074
90106
|
* @summary Get all Page Templates
|
|
@@ -90113,7 +90145,7 @@ export declare function PublisherDocumentsApiAxiosParamCreator_GetEntityDocument
|
|
|
90113
90145
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90114
90146
|
* @throws {RequiredError}
|
|
90115
90147
|
*/
|
|
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>;
|
|
90148
|
+
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
90149
|
/**
|
|
90118
90150
|
*
|
|
90119
90151
|
* @summary Get a Page Template
|
|
@@ -90148,12 +90180,12 @@ export declare function PublisherDocumentsApiAxiosParamCreator_PatchEntityDocume
|
|
|
90148
90180
|
* @param {string} objectId
|
|
90149
90181
|
* @param {JsonApiPublisherDocumentPatchDocument} jsonApiPublisherDocumentPatchDocument
|
|
90150
90182
|
* @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.
|
|
90183
|
+
* @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
90184
|
* @param {*} [options] Override http request option.
|
|
90153
90185
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90154
90186
|
* @throws {RequiredError}
|
|
90155
90187
|
*/
|
|
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>;
|
|
90188
|
+
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
90189
|
/**
|
|
90158
90190
|
*
|
|
90159
90191
|
* @summary Patch a Page Template
|
|
@@ -90187,12 +90219,12 @@ export declare function PublisherDocumentsApiAxiosParamCreator_UpdateEntityDocum
|
|
|
90187
90219
|
* @param {string} objectId
|
|
90188
90220
|
* @param {JsonApiPublisherDocumentInDocument} jsonApiPublisherDocumentInDocument
|
|
90189
90221
|
* @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.
|
|
90222
|
+
* @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
90223
|
* @param {*} [options] Override http request option.
|
|
90192
90224
|
* @param {Configuration} [configuration] Optional configuration.
|
|
90193
90225
|
* @throws {RequiredError}
|
|
90194
90226
|
*/
|
|
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>;
|
|
90227
|
+
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
90228
|
/**
|
|
90197
90229
|
*
|
|
90198
90230
|
* @summary Put a Page Template
|
|
@@ -90624,10 +90656,10 @@ export interface PublisherDocumentsApiCreateEntityDocumentsRequest {
|
|
|
90624
90656
|
readonly jsonApiPublisherDocumentPostOptionalIdDocument: JsonApiPublisherDocumentPostOptionalIdDocument;
|
|
90625
90657
|
/**
|
|
90626
90658
|
* 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'>}
|
|
90659
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90628
90660
|
* @memberof PublisherDocumentsApiCreateEntityDocuments
|
|
90629
90661
|
*/
|
|
90630
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90662
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90631
90663
|
/**
|
|
90632
90664
|
* Include Meta objects.
|
|
90633
90665
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -90810,10 +90842,10 @@ export interface PublisherDocumentsApiGetAllEntitiesDocumentsRequest {
|
|
|
90810
90842
|
readonly filter?: string;
|
|
90811
90843
|
/**
|
|
90812
90844
|
* 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'>}
|
|
90845
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90814
90846
|
* @memberof PublisherDocumentsApiGetAllEntitiesDocuments
|
|
90815
90847
|
*/
|
|
90816
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90848
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90817
90849
|
/**
|
|
90818
90850
|
* Zero-based page index (0..N)
|
|
90819
90851
|
* @type {number}
|
|
@@ -90975,10 +91007,10 @@ export interface PublisherDocumentsApiGetEntityDocumentsRequest {
|
|
|
90975
91007
|
readonly filter?: string;
|
|
90976
91008
|
/**
|
|
90977
91009
|
* 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'>}
|
|
91010
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
90979
91011
|
* @memberof PublisherDocumentsApiGetEntityDocuments
|
|
90980
91012
|
*/
|
|
90981
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91013
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
90982
91014
|
/**
|
|
90983
91015
|
*
|
|
90984
91016
|
* @type {boolean}
|
|
@@ -91104,10 +91136,10 @@ export interface PublisherDocumentsApiPatchEntityDocumentsRequest {
|
|
|
91104
91136
|
readonly filter?: string;
|
|
91105
91137
|
/**
|
|
91106
91138
|
* 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'>}
|
|
91139
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
91108
91140
|
* @memberof PublisherDocumentsApiPatchEntityDocuments
|
|
91109
91141
|
*/
|
|
91110
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91142
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91111
91143
|
}
|
|
91112
91144
|
/**
|
|
91113
91145
|
* Request parameters for patchEntityPageTemplates operation in PublisherDocumentsApi.
|
|
@@ -91215,10 +91247,10 @@ export interface PublisherDocumentsApiUpdateEntityDocumentsRequest {
|
|
|
91215
91247
|
readonly filter?: string;
|
|
91216
91248
|
/**
|
|
91217
91249
|
* 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'>}
|
|
91250
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
91219
91251
|
* @memberof PublisherDocumentsApiUpdateEntityDocuments
|
|
91220
91252
|
*/
|
|
91221
|
-
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91253
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'labels' | 'datasets' | 'metrics' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
91222
91254
|
}
|
|
91223
91255
|
/**
|
|
91224
91256
|
* Request parameters for updateEntityPageTemplates operation in PublisherDocumentsApi.
|
|
@@ -91455,7 +91487,7 @@ export declare function ReportControllerApiAxiosParamCreator_DeleteEntityReports
|
|
|
91455
91487
|
* @param {string} workspaceId
|
|
91456
91488
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
91457
91489
|
* @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.
|
|
91490
|
+
* @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
91491
|
* @param {number} [page] Zero-based page index (0..N)
|
|
91460
91492
|
* @param {number} [size] The size of the page to be returned
|
|
91461
91493
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -91472,7 +91504,7 @@ export declare function ReportControllerApiAxiosParamCreator_GetAllEntitiesRepor
|
|
|
91472
91504
|
* @param {string} workspaceId
|
|
91473
91505
|
* @param {string} objectId
|
|
91474
91506
|
* @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.
|
|
91507
|
+
* @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
91508
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
91477
91509
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
91478
91510
|
* @param {*} [options] Override http request option.
|