@gooddata/api-client-tiger 11.56.0-alpha.0 → 11.56.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/actions.d.ts.map +1 -1
- package/esm/actionsUtilities.d.ts.map +1 -1
- package/esm/api-client-tiger.d.ts +1745 -2144
- package/esm/authActions.d.ts.map +1 -1
- package/esm/automation.d.ts.map +1 -1
- package/esm/client.d.ts.map +1 -1
- package/esm/constants.d.ts.map +1 -1
- package/esm/entitiesObjects.d.ts.map +1 -1
- package/esm/execution.d.ts +1 -1
- package/esm/execution.d.ts.map +1 -1
- package/esm/executionResult.d.ts +1 -1
- package/esm/executionResult.d.ts.map +1 -1
- package/esm/explain.d.ts.map +1 -1
- package/esm/export.d.ts.map +1 -1
- package/esm/gd-tiger-model/typeGuards.d.ts.map +1 -1
- package/esm/genAI.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/base.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/common.d.ts +6 -6
- package/esm/generated/afm-rest-api/common.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +1491 -2185
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +290 -1375
- package/esm/generated/ai-json-api/base.d.ts.map +1 -1
- package/esm/generated/ai-json-api/common.d.ts +6 -6
- package/esm/generated/ai-json-api/common.d.ts.map +1 -1
- package/esm/generated/auth-json-api/base.d.ts.map +1 -1
- package/esm/generated/auth-json-api/common.d.ts +6 -6
- package/esm/generated/auth-json-api/common.d.ts.map +1 -1
- package/esm/generated/auth-json-api/template.d.ts +4 -4
- package/esm/generated/auth-json-api/template.d.ts.map +1 -1
- package/esm/generated/automation-json-api/base.d.ts.map +1 -1
- package/esm/generated/automation-json-api/common.d.ts +6 -6
- package/esm/generated/automation-json-api/common.d.ts.map +1 -1
- package/esm/generated/export-json-api/base.d.ts.map +1 -1
- package/esm/generated/export-json-api/common.d.ts +6 -6
- package/esm/generated/export-json-api/common.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +560 -49
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +414 -90
- package/esm/generated/metadata-json-api/base.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/common.d.ts +6 -6
- package/esm/generated/metadata-json-api/common.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/common.d.ts +6 -6
- package/esm/generated/result-json-api/common.d.ts.map +1 -1
- package/esm/generated/scan-json-api/base.d.ts.map +1 -1
- package/esm/generated/scan-json-api/common.d.ts +6 -6
- package/esm/generated/scan-json-api/common.d.ts.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/labelElements.d.ts.map +1 -1
- package/esm/layout.d.ts.map +1 -1
- package/esm/locationStyle.d.ts.map +1 -1
- package/esm/metadataUtilities.d.ts.map +1 -1
- package/esm/organizationUtilities.d.ts +1 -1
- package/esm/organizationUtilities.d.ts.map +1 -1
- package/esm/profile.d.ts +10 -10
- package/esm/profile.d.ts.map +1 -1
- package/esm/result.d.ts.map +1 -1
- package/esm/scanModel.d.ts.map +1 -1
- package/esm/smartFunctions.d.ts +1 -1
- package/esm/smartFunctions.d.ts.map +1 -1
- package/esm/userManagement.d.ts.map +1 -1
- package/esm/validDescendants.d.ts.map +1 -1
- package/esm/validObjects.d.ts.map +1 -1
- package/package.json +5 -5
|
@@ -1349,7 +1349,7 @@ export interface DeclarativeAgent {
|
|
|
1349
1349
|
*/
|
|
1350
1350
|
'userGroups'?: Array<DeclarativeUserGroupIdentifier>;
|
|
1351
1351
|
}
|
|
1352
|
-
export type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
1352
|
+
export type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor';
|
|
1353
1353
|
export type DeclarativeAgentSkillsModeEnum = 'all' | 'custom';
|
|
1354
1354
|
/**
|
|
1355
1355
|
* AI agent configurations.
|
|
@@ -3864,6 +3864,16 @@ export interface IntroSlideTemplate {
|
|
|
3864
3864
|
'header'?: RunningSection | null;
|
|
3865
3865
|
'titleField'?: string | null;
|
|
3866
3866
|
}
|
|
3867
|
+
export interface Invitation {
|
|
3868
|
+
'email': string;
|
|
3869
|
+
'firstName'?: string;
|
|
3870
|
+
/**
|
|
3871
|
+
* Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends)
|
|
3872
|
+
*/
|
|
3873
|
+
'forceSend'?: boolean;
|
|
3874
|
+
'lastName'?: string;
|
|
3875
|
+
'userId': string;
|
|
3876
|
+
}
|
|
3867
3877
|
/**
|
|
3868
3878
|
* Target delta for IP allowlist policy actions.
|
|
3869
3879
|
*/
|
|
@@ -3901,7 +3911,7 @@ export interface JsonApiAgentInAttributes {
|
|
|
3901
3911
|
'personality'?: string | null;
|
|
3902
3912
|
'skillsMode'?: JsonApiAgentInAttributesSkillsModeEnum;
|
|
3903
3913
|
}
|
|
3904
|
-
export type JsonApiAgentInAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
3914
|
+
export type JsonApiAgentInAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor';
|
|
3905
3915
|
export type JsonApiAgentInAttributesSkillsModeEnum = 'all' | 'custom';
|
|
3906
3916
|
/**
|
|
3907
3917
|
* Rule that an agent follows when answering.
|
|
@@ -3970,7 +3980,7 @@ export interface JsonApiAgentOutAttributes {
|
|
|
3970
3980
|
'personality'?: string | null;
|
|
3971
3981
|
'skillsMode'?: JsonApiAgentOutAttributesSkillsModeEnum;
|
|
3972
3982
|
}
|
|
3973
|
-
export type JsonApiAgentOutAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
3983
|
+
export type JsonApiAgentOutAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor';
|
|
3974
3984
|
export type JsonApiAgentOutAttributesSkillsModeEnum = 'all' | 'custom';
|
|
3975
3985
|
/**
|
|
3976
3986
|
* Rule that an agent follows when answering.
|
|
@@ -4083,7 +4093,7 @@ export interface JsonApiAgentPatchAttributes {
|
|
|
4083
4093
|
'personality'?: string | null;
|
|
4084
4094
|
'skillsMode'?: JsonApiAgentPatchAttributesSkillsModeEnum;
|
|
4085
4095
|
}
|
|
4086
|
-
export type JsonApiAgentPatchAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
4096
|
+
export type JsonApiAgentPatchAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor';
|
|
4087
4097
|
export type JsonApiAgentPatchAttributesSkillsModeEnum = 'all' | 'custom';
|
|
4088
4098
|
/**
|
|
4089
4099
|
* Rule that an agent follows when answering.
|
|
@@ -11095,6 +11105,7 @@ export interface JsonApiReportOut {
|
|
|
11095
11105
|
*/
|
|
11096
11106
|
'id': string;
|
|
11097
11107
|
'meta'?: JsonApiReportOutMeta;
|
|
11108
|
+
'relationships'?: JsonApiReportOutRelationships;
|
|
11098
11109
|
/**
|
|
11099
11110
|
* Object type
|
|
11100
11111
|
*/
|
|
@@ -11107,7 +11118,15 @@ export interface JsonApiReportOutAttributes {
|
|
|
11107
11118
|
* Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11108
11119
|
*/
|
|
11109
11120
|
'content': object;
|
|
11121
|
+
/**
|
|
11122
|
+
* Time of the entity creation.
|
|
11123
|
+
*/
|
|
11124
|
+
'createdAt'?: string | null;
|
|
11110
11125
|
'description'?: string;
|
|
11126
|
+
/**
|
|
11127
|
+
* Time of the last entity modification.
|
|
11128
|
+
*/
|
|
11129
|
+
'modifiedAt'?: string | null;
|
|
11111
11130
|
/**
|
|
11112
11131
|
* Last day of the reported period, inclusive.
|
|
11113
11132
|
*/
|
|
@@ -11125,6 +11144,10 @@ export interface JsonApiReportOutAttributes {
|
|
|
11125
11144
|
}
|
|
11126
11145
|
export interface JsonApiReportOutDocument {
|
|
11127
11146
|
'data': JsonApiReportOut;
|
|
11147
|
+
/**
|
|
11148
|
+
* Included resources
|
|
11149
|
+
*/
|
|
11150
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
11128
11151
|
'links'?: ObjectLinks;
|
|
11129
11152
|
}
|
|
11130
11153
|
/**
|
|
@@ -11132,6 +11155,10 @@ export interface JsonApiReportOutDocument {
|
|
|
11132
11155
|
*/
|
|
11133
11156
|
export interface JsonApiReportOutList {
|
|
11134
11157
|
'data': Array<JsonApiReportOutWithLinks>;
|
|
11158
|
+
/**
|
|
11159
|
+
* Included resources
|
|
11160
|
+
*/
|
|
11161
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
11135
11162
|
'links'?: ListLinks;
|
|
11136
11163
|
'meta'?: JsonApiReportOutListMeta;
|
|
11137
11164
|
}
|
|
@@ -11152,6 +11179,16 @@ export interface JsonApiReportOutMetaOrigin {
|
|
|
11152
11179
|
'originType': JsonApiReportOutMetaOriginOriginTypeEnum;
|
|
11153
11180
|
}
|
|
11154
11181
|
export type JsonApiReportOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
11182
|
+
export interface JsonApiReportOutRelationships {
|
|
11183
|
+
'createdBy'?: JsonApiReportOutRelationshipsCreatedBy;
|
|
11184
|
+
'modifiedBy'?: JsonApiReportOutRelationshipsModifiedBy;
|
|
11185
|
+
}
|
|
11186
|
+
export interface JsonApiReportOutRelationshipsCreatedBy {
|
|
11187
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
11188
|
+
}
|
|
11189
|
+
export interface JsonApiReportOutRelationshipsModifiedBy {
|
|
11190
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
11191
|
+
}
|
|
11155
11192
|
export interface JsonApiReportOutWithLinks {
|
|
11156
11193
|
'attributes': JsonApiReportOutAttributes;
|
|
11157
11194
|
/**
|
|
@@ -11159,6 +11196,7 @@ export interface JsonApiReportOutWithLinks {
|
|
|
11159
11196
|
*/
|
|
11160
11197
|
'id': string;
|
|
11161
11198
|
'meta'?: JsonApiReportOutMeta;
|
|
11199
|
+
'relationships'?: JsonApiReportOutRelationships;
|
|
11162
11200
|
/**
|
|
11163
11201
|
* Object type
|
|
11164
11202
|
*/
|
|
@@ -11204,6 +11242,7 @@ export interface JsonApiReportPageLayoutOut {
|
|
|
11204
11242
|
*/
|
|
11205
11243
|
'id': string;
|
|
11206
11244
|
'meta'?: JsonApiReportPageLayoutOutMeta;
|
|
11245
|
+
'relationships'?: JsonApiReportPageLayoutOutRelationships;
|
|
11207
11246
|
/**
|
|
11208
11247
|
* Object type
|
|
11209
11248
|
*/
|
|
@@ -11216,12 +11255,24 @@ export interface JsonApiReportPageLayoutOutAttributes {
|
|
|
11216
11255
|
* Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11217
11256
|
*/
|
|
11218
11257
|
'content': object;
|
|
11258
|
+
/**
|
|
11259
|
+
* Time of the entity creation.
|
|
11260
|
+
*/
|
|
11261
|
+
'createdAt'?: string | null;
|
|
11219
11262
|
'description'?: string;
|
|
11263
|
+
/**
|
|
11264
|
+
* Time of the last entity modification.
|
|
11265
|
+
*/
|
|
11266
|
+
'modifiedAt'?: string | null;
|
|
11220
11267
|
'tags'?: Array<string>;
|
|
11221
11268
|
'title': string;
|
|
11222
11269
|
}
|
|
11223
11270
|
export interface JsonApiReportPageLayoutOutDocument {
|
|
11224
11271
|
'data': JsonApiReportPageLayoutOut;
|
|
11272
|
+
/**
|
|
11273
|
+
* Included resources
|
|
11274
|
+
*/
|
|
11275
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
11225
11276
|
'links'?: ObjectLinks;
|
|
11226
11277
|
}
|
|
11227
11278
|
/**
|
|
@@ -11229,6 +11280,10 @@ export interface JsonApiReportPageLayoutOutDocument {
|
|
|
11229
11280
|
*/
|
|
11230
11281
|
export interface JsonApiReportPageLayoutOutList {
|
|
11231
11282
|
'data': Array<JsonApiReportPageLayoutOutWithLinks>;
|
|
11283
|
+
/**
|
|
11284
|
+
* Included resources
|
|
11285
|
+
*/
|
|
11286
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
11232
11287
|
'links'?: ListLinks;
|
|
11233
11288
|
'meta'?: JsonApiReportPageLayoutOutListMeta;
|
|
11234
11289
|
}
|
|
@@ -11249,6 +11304,16 @@ export interface JsonApiReportPageLayoutOutMetaOrigin {
|
|
|
11249
11304
|
'originType': JsonApiReportPageLayoutOutMetaOriginOriginTypeEnum;
|
|
11250
11305
|
}
|
|
11251
11306
|
export type JsonApiReportPageLayoutOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
11307
|
+
export interface JsonApiReportPageLayoutOutRelationships {
|
|
11308
|
+
'createdBy'?: JsonApiReportPageLayoutOutRelationshipsCreatedBy;
|
|
11309
|
+
'modifiedBy'?: JsonApiReportPageLayoutOutRelationshipsModifiedBy;
|
|
11310
|
+
}
|
|
11311
|
+
export interface JsonApiReportPageLayoutOutRelationshipsCreatedBy {
|
|
11312
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
11313
|
+
}
|
|
11314
|
+
export interface JsonApiReportPageLayoutOutRelationshipsModifiedBy {
|
|
11315
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
11316
|
+
}
|
|
11252
11317
|
export interface JsonApiReportPageLayoutOutWithLinks {
|
|
11253
11318
|
'attributes': JsonApiReportPageLayoutOutAttributes;
|
|
11254
11319
|
/**
|
|
@@ -11256,6 +11321,7 @@ export interface JsonApiReportPageLayoutOutWithLinks {
|
|
|
11256
11321
|
*/
|
|
11257
11322
|
'id': string;
|
|
11258
11323
|
'meta'?: JsonApiReportPageLayoutOutMeta;
|
|
11324
|
+
'relationships'?: JsonApiReportPageLayoutOutRelationships;
|
|
11259
11325
|
/**
|
|
11260
11326
|
* Object type
|
|
11261
11327
|
*/
|
|
@@ -11437,6 +11503,7 @@ export interface JsonApiReportTemplateOut {
|
|
|
11437
11503
|
*/
|
|
11438
11504
|
'id': string;
|
|
11439
11505
|
'meta'?: JsonApiReportTemplateOutMeta;
|
|
11506
|
+
'relationships'?: JsonApiReportTemplateOutRelationships;
|
|
11440
11507
|
/**
|
|
11441
11508
|
* Object type
|
|
11442
11509
|
*/
|
|
@@ -11449,12 +11516,24 @@ export interface JsonApiReportTemplateOutAttributes {
|
|
|
11449
11516
|
* Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.
|
|
11450
11517
|
*/
|
|
11451
11518
|
'content': object;
|
|
11519
|
+
/**
|
|
11520
|
+
* Time of the entity creation.
|
|
11521
|
+
*/
|
|
11522
|
+
'createdAt'?: string | null;
|
|
11452
11523
|
'description'?: string;
|
|
11524
|
+
/**
|
|
11525
|
+
* Time of the last entity modification.
|
|
11526
|
+
*/
|
|
11527
|
+
'modifiedAt'?: string | null;
|
|
11453
11528
|
'tags'?: Array<string>;
|
|
11454
11529
|
'title': string;
|
|
11455
11530
|
}
|
|
11456
11531
|
export interface JsonApiReportTemplateOutDocument {
|
|
11457
11532
|
'data': JsonApiReportTemplateOut;
|
|
11533
|
+
/**
|
|
11534
|
+
* Included resources
|
|
11535
|
+
*/
|
|
11536
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
11458
11537
|
'links'?: ObjectLinks;
|
|
11459
11538
|
}
|
|
11460
11539
|
/**
|
|
@@ -11462,6 +11541,10 @@ export interface JsonApiReportTemplateOutDocument {
|
|
|
11462
11541
|
*/
|
|
11463
11542
|
export interface JsonApiReportTemplateOutList {
|
|
11464
11543
|
'data': Array<JsonApiReportTemplateOutWithLinks>;
|
|
11544
|
+
/**
|
|
11545
|
+
* Included resources
|
|
11546
|
+
*/
|
|
11547
|
+
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
11465
11548
|
'links'?: ListLinks;
|
|
11466
11549
|
'meta'?: JsonApiReportTemplateOutListMeta;
|
|
11467
11550
|
}
|
|
@@ -11482,6 +11565,16 @@ export interface JsonApiReportTemplateOutMetaOrigin {
|
|
|
11482
11565
|
'originType': JsonApiReportTemplateOutMetaOriginOriginTypeEnum;
|
|
11483
11566
|
}
|
|
11484
11567
|
export type JsonApiReportTemplateOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
11568
|
+
export interface JsonApiReportTemplateOutRelationships {
|
|
11569
|
+
'createdBy'?: JsonApiReportTemplateOutRelationshipsCreatedBy;
|
|
11570
|
+
'modifiedBy'?: JsonApiReportTemplateOutRelationshipsModifiedBy;
|
|
11571
|
+
}
|
|
11572
|
+
export interface JsonApiReportTemplateOutRelationshipsCreatedBy {
|
|
11573
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
11574
|
+
}
|
|
11575
|
+
export interface JsonApiReportTemplateOutRelationshipsModifiedBy {
|
|
11576
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
11577
|
+
}
|
|
11485
11578
|
export interface JsonApiReportTemplateOutWithLinks {
|
|
11486
11579
|
'attributes': JsonApiReportTemplateOutAttributes;
|
|
11487
11580
|
/**
|
|
@@ -11489,6 +11582,7 @@ export interface JsonApiReportTemplateOutWithLinks {
|
|
|
11489
11582
|
*/
|
|
11490
11583
|
'id': string;
|
|
11491
11584
|
'meta'?: JsonApiReportTemplateOutMeta;
|
|
11585
|
+
'relationships'?: JsonApiReportTemplateOutRelationships;
|
|
11492
11586
|
/**
|
|
11493
11587
|
* Object type
|
|
11494
11588
|
*/
|
|
@@ -16288,6 +16382,15 @@ export declare function ActionsApiAxiosParamCreator_PauseOrganizationAutomations
|
|
|
16288
16382
|
* @throws {RequiredError}
|
|
16289
16383
|
*/
|
|
16290
16384
|
export declare function ActionsApiAxiosParamCreator_PauseWorkspaceAutomations(workspaceId: string, workspaceAutomationManagementBulkRequest: WorkspaceAutomationManagementBulkRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
16385
|
+
/**
|
|
16386
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
16387
|
+
* @summary Invite User
|
|
16388
|
+
* @param {Invitation} invitation
|
|
16389
|
+
* @param {*} [options] Override http request option.
|
|
16390
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
16391
|
+
* @throws {RequiredError}
|
|
16392
|
+
*/
|
|
16393
|
+
export declare function ActionsApiAxiosParamCreator_ProcessInvitation(invitation: Invitation, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
16291
16394
|
/**
|
|
16292
16395
|
* Notification sets up all reports to be computed again with new data.
|
|
16293
16396
|
* @summary Register an upload notification
|
|
@@ -16884,6 +16987,17 @@ export declare function ActionsApi_PauseOrganizationAutomations(axios: AxiosInst
|
|
|
16884
16987
|
* @throws {RequiredError}
|
|
16885
16988
|
*/
|
|
16886
16989
|
export declare function ActionsApi_PauseWorkspaceAutomations(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiPauseWorkspaceAutomationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
16990
|
+
/**
|
|
16991
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
16992
|
+
* @summary Invite User
|
|
16993
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
16994
|
+
* @param {string} basePath Base path.
|
|
16995
|
+
* @param {ActionsApiProcessInvitationRequest} requestParameters Request parameters.
|
|
16996
|
+
* @param {*} [options] Override http request option.
|
|
16997
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
16998
|
+
* @throws {RequiredError}
|
|
16999
|
+
*/
|
|
17000
|
+
export declare function ActionsApi_ProcessInvitation(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiProcessInvitationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
16887
17001
|
/**
|
|
16888
17002
|
* Notification sets up all reports to be computed again with new data.
|
|
16889
17003
|
* @summary Register an upload notification
|
|
@@ -17451,6 +17565,15 @@ export interface ActionsApiInterface {
|
|
|
17451
17565
|
* @memberof ActionsApiInterface
|
|
17452
17566
|
*/
|
|
17453
17567
|
pauseWorkspaceAutomations(requestParameters: ActionsApiPauseWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
17568
|
+
/**
|
|
17569
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
17570
|
+
* @summary Invite User
|
|
17571
|
+
* @param {ActionsApiProcessInvitationRequest} requestParameters Request parameters.
|
|
17572
|
+
* @param {*} [options] Override http request option.
|
|
17573
|
+
* @throws {RequiredError}
|
|
17574
|
+
* @memberof ActionsApiInterface
|
|
17575
|
+
*/
|
|
17576
|
+
processInvitation(requestParameters: ActionsApiProcessInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
17454
17577
|
/**
|
|
17455
17578
|
* Notification sets up all reports to be computed again with new data.
|
|
17456
17579
|
* @summary Register an upload notification
|
|
@@ -18301,6 +18424,19 @@ export interface ActionsApiPauseWorkspaceAutomationsRequest {
|
|
|
18301
18424
|
*/
|
|
18302
18425
|
readonly workspaceAutomationManagementBulkRequest: WorkspaceAutomationManagementBulkRequest;
|
|
18303
18426
|
}
|
|
18427
|
+
/**
|
|
18428
|
+
* Request parameters for processInvitation operation in ActionsApi.
|
|
18429
|
+
* @export
|
|
18430
|
+
* @interface ActionsApiProcessInvitationRequest
|
|
18431
|
+
*/
|
|
18432
|
+
export interface ActionsApiProcessInvitationRequest {
|
|
18433
|
+
/**
|
|
18434
|
+
*
|
|
18435
|
+
* @type {Invitation}
|
|
18436
|
+
* @memberof ActionsApiProcessInvitation
|
|
18437
|
+
*/
|
|
18438
|
+
readonly invitation: Invitation;
|
|
18439
|
+
}
|
|
18304
18440
|
/**
|
|
18305
18441
|
* Request parameters for registerUploadNotification operation in ActionsApi.
|
|
18306
18442
|
* @export
|
|
@@ -18933,6 +19069,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
18933
19069
|
* @memberof ActionsApi
|
|
18934
19070
|
*/
|
|
18935
19071
|
pauseWorkspaceAutomations(requestParameters: ActionsApiPauseWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
19072
|
+
/**
|
|
19073
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
19074
|
+
* @summary Invite User
|
|
19075
|
+
* @param {ActionsApiProcessInvitationRequest} requestParameters Request parameters.
|
|
19076
|
+
* @param {*} [options] Override http request option.
|
|
19077
|
+
* @throws {RequiredError}
|
|
19078
|
+
* @memberof ActionsApi
|
|
19079
|
+
*/
|
|
19080
|
+
processInvitation(requestParameters: ActionsApiProcessInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
18936
19081
|
/**
|
|
18937
19082
|
* Notification sets up all reports to be computed again with new data.
|
|
18938
19083
|
* @summary Register an upload notification
|
|
@@ -36487,34 +36632,37 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityParameters(work
|
|
|
36487
36632
|
* @summary Post Report Page Layout
|
|
36488
36633
|
* @param {string} workspaceId
|
|
36489
36634
|
* @param {JsonApiReportPageLayoutPostOptionalIdDocument} jsonApiReportPageLayoutPostOptionalIdDocument
|
|
36635
|
+
* @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.
|
|
36490
36636
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
36491
36637
|
* @param {*} [options] Override http request option.
|
|
36492
36638
|
* @param {Configuration} [configuration] Optional configuration.
|
|
36493
36639
|
* @throws {RequiredError}
|
|
36494
36640
|
*/
|
|
36495
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityReportPageLayouts(workspaceId: string, jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36641
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityReportPageLayouts(workspaceId: string, jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36496
36642
|
/**
|
|
36497
36643
|
*
|
|
36498
36644
|
* @summary Post Report Template
|
|
36499
36645
|
* @param {string} workspaceId
|
|
36500
36646
|
* @param {JsonApiReportTemplatePostOptionalIdDocument} jsonApiReportTemplatePostOptionalIdDocument
|
|
36647
|
+
* @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.
|
|
36501
36648
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
36502
36649
|
* @param {*} [options] Override http request option.
|
|
36503
36650
|
* @param {Configuration} [configuration] Optional configuration.
|
|
36504
36651
|
* @throws {RequiredError}
|
|
36505
36652
|
*/
|
|
36506
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityReportTemplates(workspaceId: string, jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36653
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityReportTemplates(workspaceId: string, jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36507
36654
|
/**
|
|
36508
36655
|
*
|
|
36509
36656
|
* @summary Post Report
|
|
36510
36657
|
* @param {string} workspaceId
|
|
36511
36658
|
* @param {JsonApiReportPostOptionalIdDocument} jsonApiReportPostOptionalIdDocument
|
|
36659
|
+
* @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.
|
|
36512
36660
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
36513
36661
|
* @param {*} [options] Override http request option.
|
|
36514
36662
|
* @param {Configuration} [configuration] Optional configuration.
|
|
36515
36663
|
* @throws {RequiredError}
|
|
36516
36664
|
*/
|
|
36517
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityReports(workspaceId: string, jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36665
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityReports(workspaceId: string, jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
36518
36666
|
/**
|
|
36519
36667
|
*
|
|
36520
36668
|
* @summary Post Theming
|
|
@@ -37677,6 +37825,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesParameters(wo
|
|
|
37677
37825
|
* @param {string} workspaceId
|
|
37678
37826
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
37679
37827
|
* @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\').
|
|
37828
|
+
* @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.
|
|
37680
37829
|
* @param {number} [page] Zero-based page index (0..N)
|
|
37681
37830
|
* @param {number} [size] The size of the page to be returned
|
|
37682
37831
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -37686,13 +37835,14 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesParameters(wo
|
|
|
37686
37835
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37687
37836
|
* @throws {RequiredError}
|
|
37688
37837
|
*/
|
|
37689
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReportPageLayouts(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37838
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReportPageLayouts(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>;
|
|
37690
37839
|
/**
|
|
37691
37840
|
*
|
|
37692
37841
|
* @summary Get all Report Templates
|
|
37693
37842
|
* @param {string} workspaceId
|
|
37694
37843
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
37695
37844
|
* @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\').
|
|
37845
|
+
* @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.
|
|
37696
37846
|
* @param {number} [page] Zero-based page index (0..N)
|
|
37697
37847
|
* @param {number} [size] The size of the page to be returned
|
|
37698
37848
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -37702,13 +37852,14 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReportPageLay
|
|
|
37702
37852
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37703
37853
|
* @throws {RequiredError}
|
|
37704
37854
|
*/
|
|
37705
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReportTemplates(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37855
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReportTemplates(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>;
|
|
37706
37856
|
/**
|
|
37707
37857
|
*
|
|
37708
37858
|
* @summary Get all Reports
|
|
37709
37859
|
* @param {string} workspaceId
|
|
37710
37860
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
37711
37861
|
* @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\').
|
|
37862
|
+
* @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.
|
|
37712
37863
|
* @param {number} [page] Zero-based page index (0..N)
|
|
37713
37864
|
* @param {number} [size] The size of the page to be returned
|
|
37714
37865
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -37718,7 +37869,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReportTemplat
|
|
|
37718
37869
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37719
37870
|
* @throws {RequiredError}
|
|
37720
37871
|
*/
|
|
37721
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReports(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
37872
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesReports(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>;
|
|
37722
37873
|
/**
|
|
37723
37874
|
*
|
|
37724
37875
|
* @summary Get all Theming entities
|
|
@@ -38435,39 +38586,42 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityParameters(workspa
|
|
|
38435
38586
|
* @param {string} workspaceId
|
|
38436
38587
|
* @param {string} objectId
|
|
38437
38588
|
* @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\').
|
|
38589
|
+
* @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.
|
|
38438
38590
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38439
38591
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38440
38592
|
* @param {*} [options] Override http request option.
|
|
38441
38593
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38442
38594
|
* @throws {RequiredError}
|
|
38443
38595
|
*/
|
|
38444
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityReportPageLayouts(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38596
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityReportPageLayouts(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>;
|
|
38445
38597
|
/**
|
|
38446
38598
|
*
|
|
38447
38599
|
* @summary Get a Report Template
|
|
38448
38600
|
* @param {string} workspaceId
|
|
38449
38601
|
* @param {string} objectId
|
|
38450
38602
|
* @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\').
|
|
38603
|
+
* @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.
|
|
38451
38604
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38452
38605
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38453
38606
|
* @param {*} [options] Override http request option.
|
|
38454
38607
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38455
38608
|
* @throws {RequiredError}
|
|
38456
38609
|
*/
|
|
38457
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityReportTemplates(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38610
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityReportTemplates(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>;
|
|
38458
38611
|
/**
|
|
38459
38612
|
*
|
|
38460
38613
|
* @summary Get a Report
|
|
38461
38614
|
* @param {string} workspaceId
|
|
38462
38615
|
* @param {string} objectId
|
|
38463
38616
|
* @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\').
|
|
38617
|
+
* @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.
|
|
38464
38618
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38465
38619
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38466
38620
|
* @param {*} [options] Override http request option.
|
|
38467
38621
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38468
38622
|
* @throws {RequiredError}
|
|
38469
38623
|
*/
|
|
38470
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityReports(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
38624
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityReports(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>;
|
|
38471
38625
|
/**
|
|
38472
38626
|
*
|
|
38473
38627
|
* @summary Get Theming
|
|
@@ -39043,11 +39197,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityParameters(works
|
|
|
39043
39197
|
* @param {string} objectId
|
|
39044
39198
|
* @param {JsonApiReportPageLayoutPatchDocument} jsonApiReportPageLayoutPatchDocument
|
|
39045
39199
|
* @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\').
|
|
39200
|
+
* @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.
|
|
39046
39201
|
* @param {*} [options] Override http request option.
|
|
39047
39202
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39048
39203
|
* @throws {RequiredError}
|
|
39049
39204
|
*/
|
|
39050
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutPatchDocument: JsonApiReportPageLayoutPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39205
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutPatchDocument: JsonApiReportPageLayoutPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39051
39206
|
/**
|
|
39052
39207
|
*
|
|
39053
39208
|
* @summary Patch a Report Template
|
|
@@ -39055,11 +39210,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityReportPageLayout
|
|
|
39055
39210
|
* @param {string} objectId
|
|
39056
39211
|
* @param {JsonApiReportTemplatePatchDocument} jsonApiReportTemplatePatchDocument
|
|
39057
39212
|
* @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\').
|
|
39213
|
+
* @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.
|
|
39058
39214
|
* @param {*} [options] Override http request option.
|
|
39059
39215
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39060
39216
|
* @throws {RequiredError}
|
|
39061
39217
|
*/
|
|
39062
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplatePatchDocument: JsonApiReportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39218
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplatePatchDocument: JsonApiReportTemplatePatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39063
39219
|
/**
|
|
39064
39220
|
*
|
|
39065
39221
|
* @summary Patch a Report
|
|
@@ -39067,11 +39223,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityReportTemplates(
|
|
|
39067
39223
|
* @param {string} objectId
|
|
39068
39224
|
* @param {JsonApiReportPatchDocument} jsonApiReportPatchDocument
|
|
39069
39225
|
* @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\').
|
|
39226
|
+
* @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.
|
|
39070
39227
|
* @param {*} [options] Override http request option.
|
|
39071
39228
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39072
39229
|
* @throws {RequiredError}
|
|
39073
39230
|
*/
|
|
39074
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityReports(workspaceId: string, objectId: string, jsonApiReportPatchDocument: JsonApiReportPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39231
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityReports(workspaceId: string, objectId: string, jsonApiReportPatchDocument: JsonApiReportPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39075
39232
|
/**
|
|
39076
39233
|
*
|
|
39077
39234
|
* @summary Patch Theming
|
|
@@ -39872,11 +40029,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityParameters(work
|
|
|
39872
40029
|
* @param {string} objectId
|
|
39873
40030
|
* @param {JsonApiReportPageLayoutInDocument} jsonApiReportPageLayoutInDocument
|
|
39874
40031
|
* @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\').
|
|
40032
|
+
* @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.
|
|
39875
40033
|
* @param {*} [options] Override http request option.
|
|
39876
40034
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39877
40035
|
* @throws {RequiredError}
|
|
39878
40036
|
*/
|
|
39879
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutInDocument: JsonApiReportPageLayoutInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40037
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutInDocument: JsonApiReportPageLayoutInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39880
40038
|
/**
|
|
39881
40039
|
*
|
|
39882
40040
|
* @summary Put a Report Template
|
|
@@ -39884,11 +40042,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityReportPageLayou
|
|
|
39884
40042
|
* @param {string} objectId
|
|
39885
40043
|
* @param {JsonApiReportTemplateInDocument} jsonApiReportTemplateInDocument
|
|
39886
40044
|
* @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\').
|
|
40045
|
+
* @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.
|
|
39887
40046
|
* @param {*} [options] Override http request option.
|
|
39888
40047
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39889
40048
|
* @throws {RequiredError}
|
|
39890
40049
|
*/
|
|
39891
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplateInDocument: JsonApiReportTemplateInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40050
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplateInDocument: JsonApiReportTemplateInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39892
40051
|
/**
|
|
39893
40052
|
*
|
|
39894
40053
|
* @summary Put a Report
|
|
@@ -39896,11 +40055,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityReportTemplates
|
|
|
39896
40055
|
* @param {string} objectId
|
|
39897
40056
|
* @param {JsonApiReportInDocument} jsonApiReportInDocument
|
|
39898
40057
|
* @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\').
|
|
40058
|
+
* @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.
|
|
39899
40059
|
* @param {*} [options] Override http request option.
|
|
39900
40060
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39901
40061
|
* @throws {RequiredError}
|
|
39902
40062
|
*/
|
|
39903
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityReports(workspaceId: string, objectId: string, jsonApiReportInDocument: JsonApiReportInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
40063
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityReports(workspaceId: string, objectId: string, jsonApiReportInDocument: JsonApiReportInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
39904
40064
|
/**
|
|
39905
40065
|
*
|
|
39906
40066
|
* @summary Put Theming
|
|
@@ -47169,6 +47329,12 @@ export interface EntitiesApiCreateEntityReportPageLayoutsRequest {
|
|
|
47169
47329
|
* @memberof EntitiesApiCreateEntityReportPageLayouts
|
|
47170
47330
|
*/
|
|
47171
47331
|
readonly jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument;
|
|
47332
|
+
/**
|
|
47333
|
+
* 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.
|
|
47334
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
47335
|
+
* @memberof EntitiesApiCreateEntityReportPageLayouts
|
|
47336
|
+
*/
|
|
47337
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
47172
47338
|
/**
|
|
47173
47339
|
* Include Meta objects.
|
|
47174
47340
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -47194,6 +47360,12 @@ export interface EntitiesApiCreateEntityReportTemplatesRequest {
|
|
|
47194
47360
|
* @memberof EntitiesApiCreateEntityReportTemplates
|
|
47195
47361
|
*/
|
|
47196
47362
|
readonly jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument;
|
|
47363
|
+
/**
|
|
47364
|
+
* 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.
|
|
47365
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
47366
|
+
* @memberof EntitiesApiCreateEntityReportTemplates
|
|
47367
|
+
*/
|
|
47368
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
47197
47369
|
/**
|
|
47198
47370
|
* Include Meta objects.
|
|
47199
47371
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -47219,6 +47391,12 @@ export interface EntitiesApiCreateEntityReportsRequest {
|
|
|
47219
47391
|
* @memberof EntitiesApiCreateEntityReports
|
|
47220
47392
|
*/
|
|
47221
47393
|
readonly jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument;
|
|
47394
|
+
/**
|
|
47395
|
+
* 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.
|
|
47396
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
47397
|
+
* @memberof EntitiesApiCreateEntityReports
|
|
47398
|
+
*/
|
|
47399
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
47222
47400
|
/**
|
|
47223
47401
|
* Include Meta objects.
|
|
47224
47402
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -50202,6 +50380,12 @@ export interface EntitiesApiGetAllEntitiesReportPageLayoutsRequest {
|
|
|
50202
50380
|
* @memberof EntitiesApiGetAllEntitiesReportPageLayouts
|
|
50203
50381
|
*/
|
|
50204
50382
|
readonly filter?: string;
|
|
50383
|
+
/**
|
|
50384
|
+
* 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.
|
|
50385
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50386
|
+
* @memberof EntitiesApiGetAllEntitiesReportPageLayouts
|
|
50387
|
+
*/
|
|
50388
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50205
50389
|
/**
|
|
50206
50390
|
* Zero-based page index (0..N)
|
|
50207
50391
|
* @type {number}
|
|
@@ -50257,6 +50441,12 @@ export interface EntitiesApiGetAllEntitiesReportTemplatesRequest {
|
|
|
50257
50441
|
* @memberof EntitiesApiGetAllEntitiesReportTemplates
|
|
50258
50442
|
*/
|
|
50259
50443
|
readonly filter?: string;
|
|
50444
|
+
/**
|
|
50445
|
+
* 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.
|
|
50446
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50447
|
+
* @memberof EntitiesApiGetAllEntitiesReportTemplates
|
|
50448
|
+
*/
|
|
50449
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50260
50450
|
/**
|
|
50261
50451
|
* Zero-based page index (0..N)
|
|
50262
50452
|
* @type {number}
|
|
@@ -50312,6 +50502,12 @@ export interface EntitiesApiGetAllEntitiesReportsRequest {
|
|
|
50312
50502
|
* @memberof EntitiesApiGetAllEntitiesReports
|
|
50313
50503
|
*/
|
|
50314
50504
|
readonly filter?: string;
|
|
50505
|
+
/**
|
|
50506
|
+
* 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.
|
|
50507
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
50508
|
+
* @memberof EntitiesApiGetAllEntitiesReports
|
|
50509
|
+
*/
|
|
50510
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
50315
50511
|
/**
|
|
50316
50512
|
* Zero-based page index (0..N)
|
|
50317
50513
|
* @type {number}
|
|
@@ -52317,6 +52513,12 @@ export interface EntitiesApiGetEntityReportPageLayoutsRequest {
|
|
|
52317
52513
|
* @memberof EntitiesApiGetEntityReportPageLayouts
|
|
52318
52514
|
*/
|
|
52319
52515
|
readonly filter?: string;
|
|
52516
|
+
/**
|
|
52517
|
+
* 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.
|
|
52518
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
52519
|
+
* @memberof EntitiesApiGetEntityReportPageLayouts
|
|
52520
|
+
*/
|
|
52521
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
52320
52522
|
/**
|
|
52321
52523
|
*
|
|
52322
52524
|
* @type {boolean}
|
|
@@ -52354,6 +52556,12 @@ export interface EntitiesApiGetEntityReportTemplatesRequest {
|
|
|
52354
52556
|
* @memberof EntitiesApiGetEntityReportTemplates
|
|
52355
52557
|
*/
|
|
52356
52558
|
readonly filter?: string;
|
|
52559
|
+
/**
|
|
52560
|
+
* 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.
|
|
52561
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
52562
|
+
* @memberof EntitiesApiGetEntityReportTemplates
|
|
52563
|
+
*/
|
|
52564
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
52357
52565
|
/**
|
|
52358
52566
|
*
|
|
52359
52567
|
* @type {boolean}
|
|
@@ -52391,6 +52599,12 @@ export interface EntitiesApiGetEntityReportsRequest {
|
|
|
52391
52599
|
* @memberof EntitiesApiGetEntityReports
|
|
52392
52600
|
*/
|
|
52393
52601
|
readonly filter?: string;
|
|
52602
|
+
/**
|
|
52603
|
+
* 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.
|
|
52604
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
52605
|
+
* @memberof EntitiesApiGetEntityReports
|
|
52606
|
+
*/
|
|
52607
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
52394
52608
|
/**
|
|
52395
52609
|
*
|
|
52396
52610
|
* @type {boolean}
|
|
@@ -53915,6 +54129,12 @@ export interface EntitiesApiPatchEntityReportPageLayoutsRequest {
|
|
|
53915
54129
|
* @memberof EntitiesApiPatchEntityReportPageLayouts
|
|
53916
54130
|
*/
|
|
53917
54131
|
readonly filter?: string;
|
|
54132
|
+
/**
|
|
54133
|
+
* 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.
|
|
54134
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
54135
|
+
* @memberof EntitiesApiPatchEntityReportPageLayouts
|
|
54136
|
+
*/
|
|
54137
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53918
54138
|
}
|
|
53919
54139
|
/**
|
|
53920
54140
|
* Request parameters for patchEntityReportTemplates operation in EntitiesApi.
|
|
@@ -53946,6 +54166,12 @@ export interface EntitiesApiPatchEntityReportTemplatesRequest {
|
|
|
53946
54166
|
* @memberof EntitiesApiPatchEntityReportTemplates
|
|
53947
54167
|
*/
|
|
53948
54168
|
readonly filter?: string;
|
|
54169
|
+
/**
|
|
54170
|
+
* 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.
|
|
54171
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
54172
|
+
* @memberof EntitiesApiPatchEntityReportTemplates
|
|
54173
|
+
*/
|
|
54174
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53949
54175
|
}
|
|
53950
54176
|
/**
|
|
53951
54177
|
* Request parameters for patchEntityReports operation in EntitiesApi.
|
|
@@ -53977,6 +54203,12 @@ export interface EntitiesApiPatchEntityReportsRequest {
|
|
|
53977
54203
|
* @memberof EntitiesApiPatchEntityReports
|
|
53978
54204
|
*/
|
|
53979
54205
|
readonly filter?: string;
|
|
54206
|
+
/**
|
|
54207
|
+
* 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.
|
|
54208
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
54209
|
+
* @memberof EntitiesApiPatchEntityReports
|
|
54210
|
+
*/
|
|
54211
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
53980
54212
|
}
|
|
53981
54213
|
/**
|
|
53982
54214
|
* Request parameters for patchEntityThemes operation in EntitiesApi.
|
|
@@ -56060,6 +56292,12 @@ export interface EntitiesApiUpdateEntityReportPageLayoutsRequest {
|
|
|
56060
56292
|
* @memberof EntitiesApiUpdateEntityReportPageLayouts
|
|
56061
56293
|
*/
|
|
56062
56294
|
readonly filter?: string;
|
|
56295
|
+
/**
|
|
56296
|
+
* 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.
|
|
56297
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56298
|
+
* @memberof EntitiesApiUpdateEntityReportPageLayouts
|
|
56299
|
+
*/
|
|
56300
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56063
56301
|
}
|
|
56064
56302
|
/**
|
|
56065
56303
|
* Request parameters for updateEntityReportTemplates operation in EntitiesApi.
|
|
@@ -56091,6 +56329,12 @@ export interface EntitiesApiUpdateEntityReportTemplatesRequest {
|
|
|
56091
56329
|
* @memberof EntitiesApiUpdateEntityReportTemplates
|
|
56092
56330
|
*/
|
|
56093
56331
|
readonly filter?: string;
|
|
56332
|
+
/**
|
|
56333
|
+
* 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.
|
|
56334
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56335
|
+
* @memberof EntitiesApiUpdateEntityReportTemplates
|
|
56336
|
+
*/
|
|
56337
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56094
56338
|
}
|
|
56095
56339
|
/**
|
|
56096
56340
|
* Request parameters for updateEntityReports operation in EntitiesApi.
|
|
@@ -56122,6 +56366,12 @@ export interface EntitiesApiUpdateEntityReportsRequest {
|
|
|
56122
56366
|
* @memberof EntitiesApiUpdateEntityReports
|
|
56123
56367
|
*/
|
|
56124
56368
|
readonly filter?: string;
|
|
56369
|
+
/**
|
|
56370
|
+
* 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.
|
|
56371
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
56372
|
+
* @memberof EntitiesApiUpdateEntityReports
|
|
56373
|
+
*/
|
|
56374
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
56125
56375
|
}
|
|
56126
56376
|
/**
|
|
56127
56377
|
* Request parameters for updateEntityThemes operation in EntitiesApi.
|
|
@@ -83994,12 +84244,13 @@ export declare class PluginsApi extends BaseAPI implements PluginsApiInterface {
|
|
|
83994
84244
|
* @summary Post Report
|
|
83995
84245
|
* @param {string} workspaceId
|
|
83996
84246
|
* @param {JsonApiReportPostOptionalIdDocument} jsonApiReportPostOptionalIdDocument
|
|
84247
|
+
* @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.
|
|
83997
84248
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
83998
84249
|
* @param {*} [options] Override http request option.
|
|
83999
84250
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84000
84251
|
* @throws {RequiredError}
|
|
84001
84252
|
*/
|
|
84002
|
-
export declare function ReportControllerApiAxiosParamCreator_CreateEntityReports(workspaceId: string, jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84253
|
+
export declare function ReportControllerApiAxiosParamCreator_CreateEntityReports(workspaceId: string, jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84003
84254
|
/**
|
|
84004
84255
|
*
|
|
84005
84256
|
* @summary Delete a Report
|
|
@@ -84016,6 +84267,7 @@ export declare function ReportControllerApiAxiosParamCreator_DeleteEntityReports
|
|
|
84016
84267
|
* @param {string} workspaceId
|
|
84017
84268
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
84018
84269
|
* @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\').
|
|
84270
|
+
* @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.
|
|
84019
84271
|
* @param {number} [page] Zero-based page index (0..N)
|
|
84020
84272
|
* @param {number} [size] The size of the page to be returned
|
|
84021
84273
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -84025,20 +84277,21 @@ export declare function ReportControllerApiAxiosParamCreator_DeleteEntityReports
|
|
|
84025
84277
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84026
84278
|
* @throws {RequiredError}
|
|
84027
84279
|
*/
|
|
84028
|
-
export declare function ReportControllerApiAxiosParamCreator_GetAllEntitiesReports(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84280
|
+
export declare function ReportControllerApiAxiosParamCreator_GetAllEntitiesReports(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>;
|
|
84029
84281
|
/**
|
|
84030
84282
|
*
|
|
84031
84283
|
* @summary Get a Report
|
|
84032
84284
|
* @param {string} workspaceId
|
|
84033
84285
|
* @param {string} objectId
|
|
84034
84286
|
* @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\').
|
|
84287
|
+
* @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.
|
|
84035
84288
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
84036
84289
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
84037
84290
|
* @param {*} [options] Override http request option.
|
|
84038
84291
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84039
84292
|
* @throws {RequiredError}
|
|
84040
84293
|
*/
|
|
84041
|
-
export declare function ReportControllerApiAxiosParamCreator_GetEntityReports(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84294
|
+
export declare function ReportControllerApiAxiosParamCreator_GetEntityReports(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>;
|
|
84042
84295
|
/**
|
|
84043
84296
|
*
|
|
84044
84297
|
* @summary Patch a Report
|
|
@@ -84046,11 +84299,12 @@ export declare function ReportControllerApiAxiosParamCreator_GetEntityReports(wo
|
|
|
84046
84299
|
* @param {string} objectId
|
|
84047
84300
|
* @param {JsonApiReportPatchDocument} jsonApiReportPatchDocument
|
|
84048
84301
|
* @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\').
|
|
84302
|
+
* @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.
|
|
84049
84303
|
* @param {*} [options] Override http request option.
|
|
84050
84304
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84051
84305
|
* @throws {RequiredError}
|
|
84052
84306
|
*/
|
|
84053
|
-
export declare function ReportControllerApiAxiosParamCreator_PatchEntityReports(workspaceId: string, objectId: string, jsonApiReportPatchDocument: JsonApiReportPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84307
|
+
export declare function ReportControllerApiAxiosParamCreator_PatchEntityReports(workspaceId: string, objectId: string, jsonApiReportPatchDocument: JsonApiReportPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84054
84308
|
/**
|
|
84055
84309
|
*
|
|
84056
84310
|
* @summary Put a Report
|
|
@@ -84058,11 +84312,12 @@ export declare function ReportControllerApiAxiosParamCreator_PatchEntityReports(
|
|
|
84058
84312
|
* @param {string} objectId
|
|
84059
84313
|
* @param {JsonApiReportInDocument} jsonApiReportInDocument
|
|
84060
84314
|
* @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\').
|
|
84315
|
+
* @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.
|
|
84061
84316
|
* @param {*} [options] Override http request option.
|
|
84062
84317
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84063
84318
|
* @throws {RequiredError}
|
|
84064
84319
|
*/
|
|
84065
|
-
export declare function ReportControllerApiAxiosParamCreator_UpdateEntityReports(workspaceId: string, objectId: string, jsonApiReportInDocument: JsonApiReportInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84320
|
+
export declare function ReportControllerApiAxiosParamCreator_UpdateEntityReports(workspaceId: string, objectId: string, jsonApiReportInDocument: JsonApiReportInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84066
84321
|
/**
|
|
84067
84322
|
*
|
|
84068
84323
|
* @summary Post Report
|
|
@@ -84208,6 +84463,12 @@ export interface ReportControllerApiCreateEntityReportsRequest {
|
|
|
84208
84463
|
* @memberof ReportControllerApiCreateEntityReports
|
|
84209
84464
|
*/
|
|
84210
84465
|
readonly jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument;
|
|
84466
|
+
/**
|
|
84467
|
+
* 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.
|
|
84468
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84469
|
+
* @memberof ReportControllerApiCreateEntityReports
|
|
84470
|
+
*/
|
|
84471
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84211
84472
|
/**
|
|
84212
84473
|
* Include Meta objects.
|
|
84213
84474
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -84258,6 +84519,12 @@ export interface ReportControllerApiGetAllEntitiesReportsRequest {
|
|
|
84258
84519
|
* @memberof ReportControllerApiGetAllEntitiesReports
|
|
84259
84520
|
*/
|
|
84260
84521
|
readonly filter?: string;
|
|
84522
|
+
/**
|
|
84523
|
+
* 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.
|
|
84524
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84525
|
+
* @memberof ReportControllerApiGetAllEntitiesReports
|
|
84526
|
+
*/
|
|
84527
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84261
84528
|
/**
|
|
84262
84529
|
* Zero-based page index (0..N)
|
|
84263
84530
|
* @type {number}
|
|
@@ -84313,6 +84580,12 @@ export interface ReportControllerApiGetEntityReportsRequest {
|
|
|
84313
84580
|
* @memberof ReportControllerApiGetEntityReports
|
|
84314
84581
|
*/
|
|
84315
84582
|
readonly filter?: string;
|
|
84583
|
+
/**
|
|
84584
|
+
* 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.
|
|
84585
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84586
|
+
* @memberof ReportControllerApiGetEntityReports
|
|
84587
|
+
*/
|
|
84588
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84316
84589
|
/**
|
|
84317
84590
|
*
|
|
84318
84591
|
* @type {boolean}
|
|
@@ -84356,6 +84629,12 @@ export interface ReportControllerApiPatchEntityReportsRequest {
|
|
|
84356
84629
|
* @memberof ReportControllerApiPatchEntityReports
|
|
84357
84630
|
*/
|
|
84358
84631
|
readonly filter?: string;
|
|
84632
|
+
/**
|
|
84633
|
+
* 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.
|
|
84634
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84635
|
+
* @memberof ReportControllerApiPatchEntityReports
|
|
84636
|
+
*/
|
|
84637
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84359
84638
|
}
|
|
84360
84639
|
/**
|
|
84361
84640
|
* Request parameters for updateEntityReports operation in ReportControllerApi.
|
|
@@ -84387,6 +84666,12 @@ export interface ReportControllerApiUpdateEntityReportsRequest {
|
|
|
84387
84666
|
* @memberof ReportControllerApiUpdateEntityReports
|
|
84388
84667
|
*/
|
|
84389
84668
|
readonly filter?: string;
|
|
84669
|
+
/**
|
|
84670
|
+
* 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.
|
|
84671
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84672
|
+
* @memberof ReportControllerApiUpdateEntityReports
|
|
84673
|
+
*/
|
|
84674
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84390
84675
|
}
|
|
84391
84676
|
/**
|
|
84392
84677
|
* ReportControllerApi - object-oriented interface
|
|
@@ -84455,12 +84740,13 @@ export declare class ReportControllerApi extends BaseAPI implements ReportContro
|
|
|
84455
84740
|
* @summary Post Report Page Layout
|
|
84456
84741
|
* @param {string} workspaceId
|
|
84457
84742
|
* @param {JsonApiReportPageLayoutPostOptionalIdDocument} jsonApiReportPageLayoutPostOptionalIdDocument
|
|
84743
|
+
* @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.
|
|
84458
84744
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
84459
84745
|
* @param {*} [options] Override http request option.
|
|
84460
84746
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84461
84747
|
* @throws {RequiredError}
|
|
84462
84748
|
*/
|
|
84463
|
-
export declare function ReportPageLayoutControllerApiAxiosParamCreator_CreateEntityReportPageLayouts(workspaceId: string, jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84749
|
+
export declare function ReportPageLayoutControllerApiAxiosParamCreator_CreateEntityReportPageLayouts(workspaceId: string, jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84464
84750
|
/**
|
|
84465
84751
|
*
|
|
84466
84752
|
* @summary Delete a Report Page Layout
|
|
@@ -84477,6 +84763,7 @@ export declare function ReportPageLayoutControllerApiAxiosParamCreator_DeleteEnt
|
|
|
84477
84763
|
* @param {string} workspaceId
|
|
84478
84764
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
84479
84765
|
* @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\').
|
|
84766
|
+
* @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.
|
|
84480
84767
|
* @param {number} [page] Zero-based page index (0..N)
|
|
84481
84768
|
* @param {number} [size] The size of the page to be returned
|
|
84482
84769
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -84486,20 +84773,21 @@ export declare function ReportPageLayoutControllerApiAxiosParamCreator_DeleteEnt
|
|
|
84486
84773
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84487
84774
|
* @throws {RequiredError}
|
|
84488
84775
|
*/
|
|
84489
|
-
export declare function ReportPageLayoutControllerApiAxiosParamCreator_GetAllEntitiesReportPageLayouts(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84776
|
+
export declare function ReportPageLayoutControllerApiAxiosParamCreator_GetAllEntitiesReportPageLayouts(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>;
|
|
84490
84777
|
/**
|
|
84491
84778
|
*
|
|
84492
84779
|
* @summary Get a Report Page Layout
|
|
84493
84780
|
* @param {string} workspaceId
|
|
84494
84781
|
* @param {string} objectId
|
|
84495
84782
|
* @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\').
|
|
84783
|
+
* @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.
|
|
84496
84784
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
84497
84785
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
84498
84786
|
* @param {*} [options] Override http request option.
|
|
84499
84787
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84500
84788
|
* @throws {RequiredError}
|
|
84501
84789
|
*/
|
|
84502
|
-
export declare function ReportPageLayoutControllerApiAxiosParamCreator_GetEntityReportPageLayouts(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84790
|
+
export declare function ReportPageLayoutControllerApiAxiosParamCreator_GetEntityReportPageLayouts(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>;
|
|
84503
84791
|
/**
|
|
84504
84792
|
*
|
|
84505
84793
|
* @summary Patch a Report Page Layout
|
|
@@ -84507,11 +84795,12 @@ export declare function ReportPageLayoutControllerApiAxiosParamCreator_GetEntity
|
|
|
84507
84795
|
* @param {string} objectId
|
|
84508
84796
|
* @param {JsonApiReportPageLayoutPatchDocument} jsonApiReportPageLayoutPatchDocument
|
|
84509
84797
|
* @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\').
|
|
84798
|
+
* @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.
|
|
84510
84799
|
* @param {*} [options] Override http request option.
|
|
84511
84800
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84512
84801
|
* @throws {RequiredError}
|
|
84513
84802
|
*/
|
|
84514
|
-
export declare function ReportPageLayoutControllerApiAxiosParamCreator_PatchEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutPatchDocument: JsonApiReportPageLayoutPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84803
|
+
export declare function ReportPageLayoutControllerApiAxiosParamCreator_PatchEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutPatchDocument: JsonApiReportPageLayoutPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84515
84804
|
/**
|
|
84516
84805
|
*
|
|
84517
84806
|
* @summary Put a Report Page Layout
|
|
@@ -84519,11 +84808,12 @@ export declare function ReportPageLayoutControllerApiAxiosParamCreator_PatchEnti
|
|
|
84519
84808
|
* @param {string} objectId
|
|
84520
84809
|
* @param {JsonApiReportPageLayoutInDocument} jsonApiReportPageLayoutInDocument
|
|
84521
84810
|
* @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\').
|
|
84811
|
+
* @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.
|
|
84522
84812
|
* @param {*} [options] Override http request option.
|
|
84523
84813
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84524
84814
|
* @throws {RequiredError}
|
|
84525
84815
|
*/
|
|
84526
|
-
export declare function ReportPageLayoutControllerApiAxiosParamCreator_UpdateEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutInDocument: JsonApiReportPageLayoutInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84816
|
+
export declare function ReportPageLayoutControllerApiAxiosParamCreator_UpdateEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutInDocument: JsonApiReportPageLayoutInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84527
84817
|
/**
|
|
84528
84818
|
*
|
|
84529
84819
|
* @summary Post Report Page Layout
|
|
@@ -84669,6 +84959,12 @@ export interface ReportPageLayoutControllerApiCreateEntityReportPageLayoutsReque
|
|
|
84669
84959
|
* @memberof ReportPageLayoutControllerApiCreateEntityReportPageLayouts
|
|
84670
84960
|
*/
|
|
84671
84961
|
readonly jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument;
|
|
84962
|
+
/**
|
|
84963
|
+
* 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.
|
|
84964
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
84965
|
+
* @memberof ReportPageLayoutControllerApiCreateEntityReportPageLayouts
|
|
84966
|
+
*/
|
|
84967
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84672
84968
|
/**
|
|
84673
84969
|
* Include Meta objects.
|
|
84674
84970
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -84719,6 +85015,12 @@ export interface ReportPageLayoutControllerApiGetAllEntitiesReportPageLayoutsReq
|
|
|
84719
85015
|
* @memberof ReportPageLayoutControllerApiGetAllEntitiesReportPageLayouts
|
|
84720
85016
|
*/
|
|
84721
85017
|
readonly filter?: string;
|
|
85018
|
+
/**
|
|
85019
|
+
* 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.
|
|
85020
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85021
|
+
* @memberof ReportPageLayoutControllerApiGetAllEntitiesReportPageLayouts
|
|
85022
|
+
*/
|
|
85023
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84722
85024
|
/**
|
|
84723
85025
|
* Zero-based page index (0..N)
|
|
84724
85026
|
* @type {number}
|
|
@@ -84774,6 +85076,12 @@ export interface ReportPageLayoutControllerApiGetEntityReportPageLayoutsRequest
|
|
|
84774
85076
|
* @memberof ReportPageLayoutControllerApiGetEntityReportPageLayouts
|
|
84775
85077
|
*/
|
|
84776
85078
|
readonly filter?: string;
|
|
85079
|
+
/**
|
|
85080
|
+
* 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.
|
|
85081
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85082
|
+
* @memberof ReportPageLayoutControllerApiGetEntityReportPageLayouts
|
|
85083
|
+
*/
|
|
85084
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84777
85085
|
/**
|
|
84778
85086
|
*
|
|
84779
85087
|
* @type {boolean}
|
|
@@ -84817,6 +85125,12 @@ export interface ReportPageLayoutControllerApiPatchEntityReportPageLayoutsReques
|
|
|
84817
85125
|
* @memberof ReportPageLayoutControllerApiPatchEntityReportPageLayouts
|
|
84818
85126
|
*/
|
|
84819
85127
|
readonly filter?: string;
|
|
85128
|
+
/**
|
|
85129
|
+
* 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.
|
|
85130
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85131
|
+
* @memberof ReportPageLayoutControllerApiPatchEntityReportPageLayouts
|
|
85132
|
+
*/
|
|
85133
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84820
85134
|
}
|
|
84821
85135
|
/**
|
|
84822
85136
|
* Request parameters for updateEntityReportPageLayouts operation in ReportPageLayoutControllerApi.
|
|
@@ -84848,6 +85162,12 @@ export interface ReportPageLayoutControllerApiUpdateEntityReportPageLayoutsReque
|
|
|
84848
85162
|
* @memberof ReportPageLayoutControllerApiUpdateEntityReportPageLayouts
|
|
84849
85163
|
*/
|
|
84850
85164
|
readonly filter?: string;
|
|
85165
|
+
/**
|
|
85166
|
+
* 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.
|
|
85167
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85168
|
+
* @memberof ReportPageLayoutControllerApiUpdateEntityReportPageLayouts
|
|
85169
|
+
*/
|
|
85170
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
84851
85171
|
}
|
|
84852
85172
|
/**
|
|
84853
85173
|
* ReportPageLayoutControllerApi - object-oriented interface
|
|
@@ -84916,12 +85236,13 @@ export declare class ReportPageLayoutControllerApi extends BaseAPI implements Re
|
|
|
84916
85236
|
* @summary Post Report Template
|
|
84917
85237
|
* @param {string} workspaceId
|
|
84918
85238
|
* @param {JsonApiReportTemplatePostOptionalIdDocument} jsonApiReportTemplatePostOptionalIdDocument
|
|
85239
|
+
* @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.
|
|
84919
85240
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
84920
85241
|
* @param {*} [options] Override http request option.
|
|
84921
85242
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84922
85243
|
* @throws {RequiredError}
|
|
84923
85244
|
*/
|
|
84924
|
-
export declare function ReportTemplateControllerApiAxiosParamCreator_CreateEntityReportTemplates(workspaceId: string, jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85245
|
+
export declare function ReportTemplateControllerApiAxiosParamCreator_CreateEntityReportTemplates(workspaceId: string, jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84925
85246
|
/**
|
|
84926
85247
|
*
|
|
84927
85248
|
* @summary Delete a Report Template
|
|
@@ -84938,6 +85259,7 @@ export declare function ReportTemplateControllerApiAxiosParamCreator_DeleteEntit
|
|
|
84938
85259
|
* @param {string} workspaceId
|
|
84939
85260
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
84940
85261
|
* @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\').
|
|
85262
|
+
* @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.
|
|
84941
85263
|
* @param {number} [page] Zero-based page index (0..N)
|
|
84942
85264
|
* @param {number} [size] The size of the page to be returned
|
|
84943
85265
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -84947,20 +85269,21 @@ export declare function ReportTemplateControllerApiAxiosParamCreator_DeleteEntit
|
|
|
84947
85269
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84948
85270
|
* @throws {RequiredError}
|
|
84949
85271
|
*/
|
|
84950
|
-
export declare function ReportTemplateControllerApiAxiosParamCreator_GetAllEntitiesReportTemplates(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85272
|
+
export declare function ReportTemplateControllerApiAxiosParamCreator_GetAllEntitiesReportTemplates(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>;
|
|
84951
85273
|
/**
|
|
84952
85274
|
*
|
|
84953
85275
|
* @summary Get a Report Template
|
|
84954
85276
|
* @param {string} workspaceId
|
|
84955
85277
|
* @param {string} objectId
|
|
84956
85278
|
* @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\').
|
|
85279
|
+
* @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.
|
|
84957
85280
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
84958
85281
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
84959
85282
|
* @param {*} [options] Override http request option.
|
|
84960
85283
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84961
85284
|
* @throws {RequiredError}
|
|
84962
85285
|
*/
|
|
84963
|
-
export declare function ReportTemplateControllerApiAxiosParamCreator_GetEntityReportTemplates(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85286
|
+
export declare function ReportTemplateControllerApiAxiosParamCreator_GetEntityReportTemplates(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>;
|
|
84964
85287
|
/**
|
|
84965
85288
|
*
|
|
84966
85289
|
* @summary Patch a Report Template
|
|
@@ -84968,11 +85291,12 @@ export declare function ReportTemplateControllerApiAxiosParamCreator_GetEntityRe
|
|
|
84968
85291
|
* @param {string} objectId
|
|
84969
85292
|
* @param {JsonApiReportTemplatePatchDocument} jsonApiReportTemplatePatchDocument
|
|
84970
85293
|
* @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\').
|
|
85294
|
+
* @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.
|
|
84971
85295
|
* @param {*} [options] Override http request option.
|
|
84972
85296
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84973
85297
|
* @throws {RequiredError}
|
|
84974
85298
|
*/
|
|
84975
|
-
export declare function ReportTemplateControllerApiAxiosParamCreator_PatchEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplatePatchDocument: JsonApiReportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85299
|
+
export declare function ReportTemplateControllerApiAxiosParamCreator_PatchEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplatePatchDocument: JsonApiReportTemplatePatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84976
85300
|
/**
|
|
84977
85301
|
*
|
|
84978
85302
|
* @summary Put a Report Template
|
|
@@ -84980,11 +85304,12 @@ export declare function ReportTemplateControllerApiAxiosParamCreator_PatchEntity
|
|
|
84980
85304
|
* @param {string} objectId
|
|
84981
85305
|
* @param {JsonApiReportTemplateInDocument} jsonApiReportTemplateInDocument
|
|
84982
85306
|
* @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\').
|
|
85307
|
+
* @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.
|
|
84983
85308
|
* @param {*} [options] Override http request option.
|
|
84984
85309
|
* @param {Configuration} [configuration] Optional configuration.
|
|
84985
85310
|
* @throws {RequiredError}
|
|
84986
85311
|
*/
|
|
84987
|
-
export declare function ReportTemplateControllerApiAxiosParamCreator_UpdateEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplateInDocument: JsonApiReportTemplateInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85312
|
+
export declare function ReportTemplateControllerApiAxiosParamCreator_UpdateEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplateInDocument: JsonApiReportTemplateInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
84988
85313
|
/**
|
|
84989
85314
|
*
|
|
84990
85315
|
* @summary Post Report Template
|
|
@@ -85130,6 +85455,12 @@ export interface ReportTemplateControllerApiCreateEntityReportTemplatesRequest {
|
|
|
85130
85455
|
* @memberof ReportTemplateControllerApiCreateEntityReportTemplates
|
|
85131
85456
|
*/
|
|
85132
85457
|
readonly jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument;
|
|
85458
|
+
/**
|
|
85459
|
+
* 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.
|
|
85460
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85461
|
+
* @memberof ReportTemplateControllerApiCreateEntityReportTemplates
|
|
85462
|
+
*/
|
|
85463
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
85133
85464
|
/**
|
|
85134
85465
|
* Include Meta objects.
|
|
85135
85466
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -85180,6 +85511,12 @@ export interface ReportTemplateControllerApiGetAllEntitiesReportTemplatesRequest
|
|
|
85180
85511
|
* @memberof ReportTemplateControllerApiGetAllEntitiesReportTemplates
|
|
85181
85512
|
*/
|
|
85182
85513
|
readonly filter?: string;
|
|
85514
|
+
/**
|
|
85515
|
+
* 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.
|
|
85516
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85517
|
+
* @memberof ReportTemplateControllerApiGetAllEntitiesReportTemplates
|
|
85518
|
+
*/
|
|
85519
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
85183
85520
|
/**
|
|
85184
85521
|
* Zero-based page index (0..N)
|
|
85185
85522
|
* @type {number}
|
|
@@ -85235,6 +85572,12 @@ export interface ReportTemplateControllerApiGetEntityReportTemplatesRequest {
|
|
|
85235
85572
|
* @memberof ReportTemplateControllerApiGetEntityReportTemplates
|
|
85236
85573
|
*/
|
|
85237
85574
|
readonly filter?: string;
|
|
85575
|
+
/**
|
|
85576
|
+
* 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.
|
|
85577
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85578
|
+
* @memberof ReportTemplateControllerApiGetEntityReportTemplates
|
|
85579
|
+
*/
|
|
85580
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
85238
85581
|
/**
|
|
85239
85582
|
*
|
|
85240
85583
|
* @type {boolean}
|
|
@@ -85278,6 +85621,12 @@ export interface ReportTemplateControllerApiPatchEntityReportTemplatesRequest {
|
|
|
85278
85621
|
* @memberof ReportTemplateControllerApiPatchEntityReportTemplates
|
|
85279
85622
|
*/
|
|
85280
85623
|
readonly filter?: string;
|
|
85624
|
+
/**
|
|
85625
|
+
* 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.
|
|
85626
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85627
|
+
* @memberof ReportTemplateControllerApiPatchEntityReportTemplates
|
|
85628
|
+
*/
|
|
85629
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
85281
85630
|
}
|
|
85282
85631
|
/**
|
|
85283
85632
|
* Request parameters for updateEntityReportTemplates operation in ReportTemplateControllerApi.
|
|
@@ -85309,6 +85658,12 @@ export interface ReportTemplateControllerApiUpdateEntityReportTemplatesRequest {
|
|
|
85309
85658
|
* @memberof ReportTemplateControllerApiUpdateEntityReportTemplates
|
|
85310
85659
|
*/
|
|
85311
85660
|
readonly filter?: string;
|
|
85661
|
+
/**
|
|
85662
|
+
* 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.
|
|
85663
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
85664
|
+
* @memberof ReportTemplateControllerApiUpdateEntityReportTemplates
|
|
85665
|
+
*/
|
|
85666
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
85312
85667
|
}
|
|
85313
85668
|
/**
|
|
85314
85669
|
* ReportTemplateControllerApi - object-oriented interface
|
|
@@ -85501,34 +85856,37 @@ export declare class ReportingSettingsApi extends BaseAPI implements ReportingSe
|
|
|
85501
85856
|
* @summary Post Report Page Layout
|
|
85502
85857
|
* @param {string} workspaceId
|
|
85503
85858
|
* @param {JsonApiReportPageLayoutPostOptionalIdDocument} jsonApiReportPageLayoutPostOptionalIdDocument
|
|
85859
|
+
* @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.
|
|
85504
85860
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85505
85861
|
* @param {*} [options] Override http request option.
|
|
85506
85862
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85507
85863
|
* @throws {RequiredError}
|
|
85508
85864
|
*/
|
|
85509
|
-
export declare function ReportsApiAxiosParamCreator_CreateEntityReportPageLayouts(workspaceId: string, jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85865
|
+
export declare function ReportsApiAxiosParamCreator_CreateEntityReportPageLayouts(workspaceId: string, jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85510
85866
|
/**
|
|
85511
85867
|
*
|
|
85512
85868
|
* @summary Post Report Template
|
|
85513
85869
|
* @param {string} workspaceId
|
|
85514
85870
|
* @param {JsonApiReportTemplatePostOptionalIdDocument} jsonApiReportTemplatePostOptionalIdDocument
|
|
85871
|
+
* @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.
|
|
85515
85872
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85516
85873
|
* @param {*} [options] Override http request option.
|
|
85517
85874
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85518
85875
|
* @throws {RequiredError}
|
|
85519
85876
|
*/
|
|
85520
|
-
export declare function ReportsApiAxiosParamCreator_CreateEntityReportTemplates(workspaceId: string, jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85877
|
+
export declare function ReportsApiAxiosParamCreator_CreateEntityReportTemplates(workspaceId: string, jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85521
85878
|
/**
|
|
85522
85879
|
*
|
|
85523
85880
|
* @summary Post Report
|
|
85524
85881
|
* @param {string} workspaceId
|
|
85525
85882
|
* @param {JsonApiReportPostOptionalIdDocument} jsonApiReportPostOptionalIdDocument
|
|
85883
|
+
* @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.
|
|
85526
85884
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85527
85885
|
* @param {*} [options] Override http request option.
|
|
85528
85886
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85529
85887
|
* @throws {RequiredError}
|
|
85530
85888
|
*/
|
|
85531
|
-
export declare function ReportsApiAxiosParamCreator_CreateEntityReports(workspaceId: string, jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85889
|
+
export declare function ReportsApiAxiosParamCreator_CreateEntityReports(workspaceId: string, jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85532
85890
|
/**
|
|
85533
85891
|
*
|
|
85534
85892
|
* @summary Delete a Report Page Layout
|
|
@@ -85565,6 +85923,7 @@ export declare function ReportsApiAxiosParamCreator_DeleteEntityReports(workspac
|
|
|
85565
85923
|
* @param {string} workspaceId
|
|
85566
85924
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
85567
85925
|
* @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\').
|
|
85926
|
+
* @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.
|
|
85568
85927
|
* @param {number} [page] Zero-based page index (0..N)
|
|
85569
85928
|
* @param {number} [size] The size of the page to be returned
|
|
85570
85929
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -85574,13 +85933,14 @@ export declare function ReportsApiAxiosParamCreator_DeleteEntityReports(workspac
|
|
|
85574
85933
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85575
85934
|
* @throws {RequiredError}
|
|
85576
85935
|
*/
|
|
85577
|
-
export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReportPageLayouts(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85936
|
+
export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReportPageLayouts(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>;
|
|
85578
85937
|
/**
|
|
85579
85938
|
*
|
|
85580
85939
|
* @summary Get all Report Templates
|
|
85581
85940
|
* @param {string} workspaceId
|
|
85582
85941
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
85583
85942
|
* @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\').
|
|
85943
|
+
* @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.
|
|
85584
85944
|
* @param {number} [page] Zero-based page index (0..N)
|
|
85585
85945
|
* @param {number} [size] The size of the page to be returned
|
|
85586
85946
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -85590,13 +85950,14 @@ export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReportPageLayo
|
|
|
85590
85950
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85591
85951
|
* @throws {RequiredError}
|
|
85592
85952
|
*/
|
|
85593
|
-
export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReportTemplates(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85953
|
+
export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReportTemplates(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>;
|
|
85594
85954
|
/**
|
|
85595
85955
|
*
|
|
85596
85956
|
* @summary Get all Reports
|
|
85597
85957
|
* @param {string} workspaceId
|
|
85598
85958
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
85599
85959
|
* @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\').
|
|
85960
|
+
* @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.
|
|
85600
85961
|
* @param {number} [page] Zero-based page index (0..N)
|
|
85601
85962
|
* @param {number} [size] The size of the page to be returned
|
|
85602
85963
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -85606,46 +85967,49 @@ export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReportTemplate
|
|
|
85606
85967
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85607
85968
|
* @throws {RequiredError}
|
|
85608
85969
|
*/
|
|
85609
|
-
export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReports(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85970
|
+
export declare function ReportsApiAxiosParamCreator_GetAllEntitiesReports(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>;
|
|
85610
85971
|
/**
|
|
85611
85972
|
*
|
|
85612
85973
|
* @summary Get a Report Page Layout
|
|
85613
85974
|
* @param {string} workspaceId
|
|
85614
85975
|
* @param {string} objectId
|
|
85615
85976
|
* @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\').
|
|
85977
|
+
* @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.
|
|
85616
85978
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
85617
85979
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85618
85980
|
* @param {*} [options] Override http request option.
|
|
85619
85981
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85620
85982
|
* @throws {RequiredError}
|
|
85621
85983
|
*/
|
|
85622
|
-
export declare function ReportsApiAxiosParamCreator_GetEntityReportPageLayouts(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85984
|
+
export declare function ReportsApiAxiosParamCreator_GetEntityReportPageLayouts(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>;
|
|
85623
85985
|
/**
|
|
85624
85986
|
*
|
|
85625
85987
|
* @summary Get a Report Template
|
|
85626
85988
|
* @param {string} workspaceId
|
|
85627
85989
|
* @param {string} objectId
|
|
85628
85990
|
* @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\').
|
|
85991
|
+
* @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.
|
|
85629
85992
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
85630
85993
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85631
85994
|
* @param {*} [options] Override http request option.
|
|
85632
85995
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85633
85996
|
* @throws {RequiredError}
|
|
85634
85997
|
*/
|
|
85635
|
-
export declare function ReportsApiAxiosParamCreator_GetEntityReportTemplates(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85998
|
+
export declare function ReportsApiAxiosParamCreator_GetEntityReportTemplates(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>;
|
|
85636
85999
|
/**
|
|
85637
86000
|
*
|
|
85638
86001
|
* @summary Get a Report
|
|
85639
86002
|
* @param {string} workspaceId
|
|
85640
86003
|
* @param {string} objectId
|
|
85641
86004
|
* @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\').
|
|
86005
|
+
* @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.
|
|
85642
86006
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
85643
86007
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
85644
86008
|
* @param {*} [options] Override http request option.
|
|
85645
86009
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85646
86010
|
* @throws {RequiredError}
|
|
85647
86011
|
*/
|
|
85648
|
-
export declare function ReportsApiAxiosParamCreator_GetEntityReports(workspaceId: string, objectId: string, filter?: string, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86012
|
+
export declare function ReportsApiAxiosParamCreator_GetEntityReports(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>;
|
|
85649
86013
|
/**
|
|
85650
86014
|
*
|
|
85651
86015
|
* @summary Patch a Report Page Layout
|
|
@@ -85653,11 +86017,12 @@ export declare function ReportsApiAxiosParamCreator_GetEntityReports(workspaceId
|
|
|
85653
86017
|
* @param {string} objectId
|
|
85654
86018
|
* @param {JsonApiReportPageLayoutPatchDocument} jsonApiReportPageLayoutPatchDocument
|
|
85655
86019
|
* @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\').
|
|
86020
|
+
* @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.
|
|
85656
86021
|
* @param {*} [options] Override http request option.
|
|
85657
86022
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85658
86023
|
* @throws {RequiredError}
|
|
85659
86024
|
*/
|
|
85660
|
-
export declare function ReportsApiAxiosParamCreator_PatchEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutPatchDocument: JsonApiReportPageLayoutPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86025
|
+
export declare function ReportsApiAxiosParamCreator_PatchEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutPatchDocument: JsonApiReportPageLayoutPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85661
86026
|
/**
|
|
85662
86027
|
*
|
|
85663
86028
|
* @summary Patch a Report Template
|
|
@@ -85665,11 +86030,12 @@ export declare function ReportsApiAxiosParamCreator_PatchEntityReportPageLayouts
|
|
|
85665
86030
|
* @param {string} objectId
|
|
85666
86031
|
* @param {JsonApiReportTemplatePatchDocument} jsonApiReportTemplatePatchDocument
|
|
85667
86032
|
* @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\').
|
|
86033
|
+
* @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.
|
|
85668
86034
|
* @param {*} [options] Override http request option.
|
|
85669
86035
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85670
86036
|
* @throws {RequiredError}
|
|
85671
86037
|
*/
|
|
85672
|
-
export declare function ReportsApiAxiosParamCreator_PatchEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplatePatchDocument: JsonApiReportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86038
|
+
export declare function ReportsApiAxiosParamCreator_PatchEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplatePatchDocument: JsonApiReportTemplatePatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85673
86039
|
/**
|
|
85674
86040
|
*
|
|
85675
86041
|
* @summary Patch a Report
|
|
@@ -85677,11 +86043,12 @@ export declare function ReportsApiAxiosParamCreator_PatchEntityReportTemplates(w
|
|
|
85677
86043
|
* @param {string} objectId
|
|
85678
86044
|
* @param {JsonApiReportPatchDocument} jsonApiReportPatchDocument
|
|
85679
86045
|
* @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\').
|
|
86046
|
+
* @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.
|
|
85680
86047
|
* @param {*} [options] Override http request option.
|
|
85681
86048
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85682
86049
|
* @throws {RequiredError}
|
|
85683
86050
|
*/
|
|
85684
|
-
export declare function ReportsApiAxiosParamCreator_PatchEntityReports(workspaceId: string, objectId: string, jsonApiReportPatchDocument: JsonApiReportPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86051
|
+
export declare function ReportsApiAxiosParamCreator_PatchEntityReports(workspaceId: string, objectId: string, jsonApiReportPatchDocument: JsonApiReportPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85685
86052
|
/**
|
|
85686
86053
|
*
|
|
85687
86054
|
* @summary Put a Report Page Layout
|
|
@@ -85689,11 +86056,12 @@ export declare function ReportsApiAxiosParamCreator_PatchEntityReports(workspace
|
|
|
85689
86056
|
* @param {string} objectId
|
|
85690
86057
|
* @param {JsonApiReportPageLayoutInDocument} jsonApiReportPageLayoutInDocument
|
|
85691
86058
|
* @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\').
|
|
86059
|
+
* @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.
|
|
85692
86060
|
* @param {*} [options] Override http request option.
|
|
85693
86061
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85694
86062
|
* @throws {RequiredError}
|
|
85695
86063
|
*/
|
|
85696
|
-
export declare function ReportsApiAxiosParamCreator_UpdateEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutInDocument: JsonApiReportPageLayoutInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86064
|
+
export declare function ReportsApiAxiosParamCreator_UpdateEntityReportPageLayouts(workspaceId: string, objectId: string, jsonApiReportPageLayoutInDocument: JsonApiReportPageLayoutInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85697
86065
|
/**
|
|
85698
86066
|
*
|
|
85699
86067
|
* @summary Put a Report Template
|
|
@@ -85701,11 +86069,12 @@ export declare function ReportsApiAxiosParamCreator_UpdateEntityReportPageLayout
|
|
|
85701
86069
|
* @param {string} objectId
|
|
85702
86070
|
* @param {JsonApiReportTemplateInDocument} jsonApiReportTemplateInDocument
|
|
85703
86071
|
* @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\').
|
|
86072
|
+
* @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.
|
|
85704
86073
|
* @param {*} [options] Override http request option.
|
|
85705
86074
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85706
86075
|
* @throws {RequiredError}
|
|
85707
86076
|
*/
|
|
85708
|
-
export declare function ReportsApiAxiosParamCreator_UpdateEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplateInDocument: JsonApiReportTemplateInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86077
|
+
export declare function ReportsApiAxiosParamCreator_UpdateEntityReportTemplates(workspaceId: string, objectId: string, jsonApiReportTemplateInDocument: JsonApiReportTemplateInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85709
86078
|
/**
|
|
85710
86079
|
*
|
|
85711
86080
|
* @summary Put a Report
|
|
@@ -85713,11 +86082,12 @@ export declare function ReportsApiAxiosParamCreator_UpdateEntityReportTemplates(
|
|
|
85713
86082
|
* @param {string} objectId
|
|
85714
86083
|
* @param {JsonApiReportInDocument} jsonApiReportInDocument
|
|
85715
86084
|
* @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\').
|
|
86085
|
+
* @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.
|
|
85716
86086
|
* @param {*} [options] Override http request option.
|
|
85717
86087
|
* @param {Configuration} [configuration] Optional configuration.
|
|
85718
86088
|
* @throws {RequiredError}
|
|
85719
86089
|
*/
|
|
85720
|
-
export declare function ReportsApiAxiosParamCreator_UpdateEntityReports(workspaceId: string, objectId: string, jsonApiReportInDocument: JsonApiReportInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
86090
|
+
export declare function ReportsApiAxiosParamCreator_UpdateEntityReports(workspaceId: string, objectId: string, jsonApiReportInDocument: JsonApiReportInDocument, filter?: string, include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
85721
86091
|
/**
|
|
85722
86092
|
*
|
|
85723
86093
|
* @summary Post Report Page Layout
|
|
@@ -86103,6 +86473,12 @@ export interface ReportsApiCreateEntityReportPageLayoutsRequest {
|
|
|
86103
86473
|
* @memberof ReportsApiCreateEntityReportPageLayouts
|
|
86104
86474
|
*/
|
|
86105
86475
|
readonly jsonApiReportPageLayoutPostOptionalIdDocument: JsonApiReportPageLayoutPostOptionalIdDocument;
|
|
86476
|
+
/**
|
|
86477
|
+
* 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.
|
|
86478
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86479
|
+
* @memberof ReportsApiCreateEntityReportPageLayouts
|
|
86480
|
+
*/
|
|
86481
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86106
86482
|
/**
|
|
86107
86483
|
* Include Meta objects.
|
|
86108
86484
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -86128,6 +86504,12 @@ export interface ReportsApiCreateEntityReportTemplatesRequest {
|
|
|
86128
86504
|
* @memberof ReportsApiCreateEntityReportTemplates
|
|
86129
86505
|
*/
|
|
86130
86506
|
readonly jsonApiReportTemplatePostOptionalIdDocument: JsonApiReportTemplatePostOptionalIdDocument;
|
|
86507
|
+
/**
|
|
86508
|
+
* 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.
|
|
86509
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86510
|
+
* @memberof ReportsApiCreateEntityReportTemplates
|
|
86511
|
+
*/
|
|
86512
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86131
86513
|
/**
|
|
86132
86514
|
* Include Meta objects.
|
|
86133
86515
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -86153,6 +86535,12 @@ export interface ReportsApiCreateEntityReportsRequest {
|
|
|
86153
86535
|
* @memberof ReportsApiCreateEntityReports
|
|
86154
86536
|
*/
|
|
86155
86537
|
readonly jsonApiReportPostOptionalIdDocument: JsonApiReportPostOptionalIdDocument;
|
|
86538
|
+
/**
|
|
86539
|
+
* 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.
|
|
86540
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86541
|
+
* @memberof ReportsApiCreateEntityReports
|
|
86542
|
+
*/
|
|
86543
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86156
86544
|
/**
|
|
86157
86545
|
* Include Meta objects.
|
|
86158
86546
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -86241,6 +86629,12 @@ export interface ReportsApiGetAllEntitiesReportPageLayoutsRequest {
|
|
|
86241
86629
|
* @memberof ReportsApiGetAllEntitiesReportPageLayouts
|
|
86242
86630
|
*/
|
|
86243
86631
|
readonly filter?: string;
|
|
86632
|
+
/**
|
|
86633
|
+
* 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.
|
|
86634
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86635
|
+
* @memberof ReportsApiGetAllEntitiesReportPageLayouts
|
|
86636
|
+
*/
|
|
86637
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86244
86638
|
/**
|
|
86245
86639
|
* Zero-based page index (0..N)
|
|
86246
86640
|
* @type {number}
|
|
@@ -86296,6 +86690,12 @@ export interface ReportsApiGetAllEntitiesReportTemplatesRequest {
|
|
|
86296
86690
|
* @memberof ReportsApiGetAllEntitiesReportTemplates
|
|
86297
86691
|
*/
|
|
86298
86692
|
readonly filter?: string;
|
|
86693
|
+
/**
|
|
86694
|
+
* 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.
|
|
86695
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86696
|
+
* @memberof ReportsApiGetAllEntitiesReportTemplates
|
|
86697
|
+
*/
|
|
86698
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86299
86699
|
/**
|
|
86300
86700
|
* Zero-based page index (0..N)
|
|
86301
86701
|
* @type {number}
|
|
@@ -86351,6 +86751,12 @@ export interface ReportsApiGetAllEntitiesReportsRequest {
|
|
|
86351
86751
|
* @memberof ReportsApiGetAllEntitiesReports
|
|
86352
86752
|
*/
|
|
86353
86753
|
readonly filter?: string;
|
|
86754
|
+
/**
|
|
86755
|
+
* 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.
|
|
86756
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86757
|
+
* @memberof ReportsApiGetAllEntitiesReports
|
|
86758
|
+
*/
|
|
86759
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86354
86760
|
/**
|
|
86355
86761
|
* Zero-based page index (0..N)
|
|
86356
86762
|
* @type {number}
|
|
@@ -86406,6 +86812,12 @@ export interface ReportsApiGetEntityReportPageLayoutsRequest {
|
|
|
86406
86812
|
* @memberof ReportsApiGetEntityReportPageLayouts
|
|
86407
86813
|
*/
|
|
86408
86814
|
readonly filter?: string;
|
|
86815
|
+
/**
|
|
86816
|
+
* 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.
|
|
86817
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86818
|
+
* @memberof ReportsApiGetEntityReportPageLayouts
|
|
86819
|
+
*/
|
|
86820
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86409
86821
|
/**
|
|
86410
86822
|
*
|
|
86411
86823
|
* @type {boolean}
|
|
@@ -86443,6 +86855,12 @@ export interface ReportsApiGetEntityReportTemplatesRequest {
|
|
|
86443
86855
|
* @memberof ReportsApiGetEntityReportTemplates
|
|
86444
86856
|
*/
|
|
86445
86857
|
readonly filter?: string;
|
|
86858
|
+
/**
|
|
86859
|
+
* 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.
|
|
86860
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86861
|
+
* @memberof ReportsApiGetEntityReportTemplates
|
|
86862
|
+
*/
|
|
86863
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86446
86864
|
/**
|
|
86447
86865
|
*
|
|
86448
86866
|
* @type {boolean}
|
|
@@ -86480,6 +86898,12 @@ export interface ReportsApiGetEntityReportsRequest {
|
|
|
86480
86898
|
* @memberof ReportsApiGetEntityReports
|
|
86481
86899
|
*/
|
|
86482
86900
|
readonly filter?: string;
|
|
86901
|
+
/**
|
|
86902
|
+
* 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.
|
|
86903
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86904
|
+
* @memberof ReportsApiGetEntityReports
|
|
86905
|
+
*/
|
|
86906
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86483
86907
|
/**
|
|
86484
86908
|
*
|
|
86485
86909
|
* @type {boolean}
|
|
@@ -86523,6 +86947,12 @@ export interface ReportsApiPatchEntityReportPageLayoutsRequest {
|
|
|
86523
86947
|
* @memberof ReportsApiPatchEntityReportPageLayouts
|
|
86524
86948
|
*/
|
|
86525
86949
|
readonly filter?: string;
|
|
86950
|
+
/**
|
|
86951
|
+
* 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.
|
|
86952
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86953
|
+
* @memberof ReportsApiPatchEntityReportPageLayouts
|
|
86954
|
+
*/
|
|
86955
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86526
86956
|
}
|
|
86527
86957
|
/**
|
|
86528
86958
|
* Request parameters for patchEntityReportTemplates operation in ReportsApi.
|
|
@@ -86554,6 +86984,12 @@ export interface ReportsApiPatchEntityReportTemplatesRequest {
|
|
|
86554
86984
|
* @memberof ReportsApiPatchEntityReportTemplates
|
|
86555
86985
|
*/
|
|
86556
86986
|
readonly filter?: string;
|
|
86987
|
+
/**
|
|
86988
|
+
* 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.
|
|
86989
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
86990
|
+
* @memberof ReportsApiPatchEntityReportTemplates
|
|
86991
|
+
*/
|
|
86992
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86557
86993
|
}
|
|
86558
86994
|
/**
|
|
86559
86995
|
* Request parameters for patchEntityReports operation in ReportsApi.
|
|
@@ -86585,6 +87021,12 @@ export interface ReportsApiPatchEntityReportsRequest {
|
|
|
86585
87021
|
* @memberof ReportsApiPatchEntityReports
|
|
86586
87022
|
*/
|
|
86587
87023
|
readonly filter?: string;
|
|
87024
|
+
/**
|
|
87025
|
+
* 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.
|
|
87026
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
87027
|
+
* @memberof ReportsApiPatchEntityReports
|
|
87028
|
+
*/
|
|
87029
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86588
87030
|
}
|
|
86589
87031
|
/**
|
|
86590
87032
|
* Request parameters for updateEntityReportPageLayouts operation in ReportsApi.
|
|
@@ -86616,6 +87058,12 @@ export interface ReportsApiUpdateEntityReportPageLayoutsRequest {
|
|
|
86616
87058
|
* @memberof ReportsApiUpdateEntityReportPageLayouts
|
|
86617
87059
|
*/
|
|
86618
87060
|
readonly filter?: string;
|
|
87061
|
+
/**
|
|
87062
|
+
* 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.
|
|
87063
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
87064
|
+
* @memberof ReportsApiUpdateEntityReportPageLayouts
|
|
87065
|
+
*/
|
|
87066
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86619
87067
|
}
|
|
86620
87068
|
/**
|
|
86621
87069
|
* Request parameters for updateEntityReportTemplates operation in ReportsApi.
|
|
@@ -86647,6 +87095,12 @@ export interface ReportsApiUpdateEntityReportTemplatesRequest {
|
|
|
86647
87095
|
* @memberof ReportsApiUpdateEntityReportTemplates
|
|
86648
87096
|
*/
|
|
86649
87097
|
readonly filter?: string;
|
|
87098
|
+
/**
|
|
87099
|
+
* 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.
|
|
87100
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
87101
|
+
* @memberof ReportsApiUpdateEntityReportTemplates
|
|
87102
|
+
*/
|
|
87103
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86650
87104
|
}
|
|
86651
87105
|
/**
|
|
86652
87106
|
* Request parameters for updateEntityReports operation in ReportsApi.
|
|
@@ -86678,6 +87132,12 @@ export interface ReportsApiUpdateEntityReportsRequest {
|
|
|
86678
87132
|
* @memberof ReportsApiUpdateEntityReports
|
|
86679
87133
|
*/
|
|
86680
87134
|
readonly filter?: string;
|
|
87135
|
+
/**
|
|
87136
|
+
* 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.
|
|
87137
|
+
* @type {Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>}
|
|
87138
|
+
* @memberof ReportsApiUpdateEntityReports
|
|
87139
|
+
*/
|
|
87140
|
+
readonly include?: Array<'userIdentifiers' | 'createdBy' | 'modifiedBy' | 'ALL'>;
|
|
86681
87141
|
}
|
|
86682
87142
|
/**
|
|
86683
87143
|
* ReportsApi - object-oriented interface
|
|
@@ -87698,6 +88158,15 @@ export declare class UsageApi extends BaseAPI implements UsageApiInterface {
|
|
|
87698
88158
|
* @throws {RequiredError}
|
|
87699
88159
|
*/
|
|
87700
88160
|
export declare function UserAuthorizationApiAxiosParamCreator_GetProfile(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
88161
|
+
/**
|
|
88162
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
88163
|
+
* @summary Invite User
|
|
88164
|
+
* @param {Invitation} invitation
|
|
88165
|
+
* @param {*} [options] Override http request option.
|
|
88166
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
88167
|
+
* @throws {RequiredError}
|
|
88168
|
+
*/
|
|
88169
|
+
export declare function UserAuthorizationApiAxiosParamCreator_ProcessInvitation(invitation: Invitation, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
87701
88170
|
/**
|
|
87702
88171
|
* Returns a Profile including Organization and Current User Information.
|
|
87703
88172
|
* @summary Get Profile
|
|
@@ -87708,6 +88177,17 @@ export declare function UserAuthorizationApiAxiosParamCreator_GetProfile(options
|
|
|
87708
88177
|
* @throws {RequiredError}
|
|
87709
88178
|
*/
|
|
87710
88179
|
export declare function UserAuthorizationApi_GetProfile(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<Profile>;
|
|
88180
|
+
/**
|
|
88181
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
88182
|
+
* @summary Invite User
|
|
88183
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
88184
|
+
* @param {string} basePath Base path.
|
|
88185
|
+
* @param {UserAuthorizationApiProcessInvitationRequest} requestParameters Request parameters.
|
|
88186
|
+
* @param {*} [options] Override http request option.
|
|
88187
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
88188
|
+
* @throws {RequiredError}
|
|
88189
|
+
*/
|
|
88190
|
+
export declare function UserAuthorizationApi_ProcessInvitation(axios: AxiosInstance, basePath: string, requestParameters: UserAuthorizationApiProcessInvitationRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
87711
88191
|
/**
|
|
87712
88192
|
* UserAuthorizationApi - interface
|
|
87713
88193
|
* @export
|
|
@@ -87722,6 +88202,28 @@ export interface UserAuthorizationApiInterface {
|
|
|
87722
88202
|
* @memberof UserAuthorizationApiInterface
|
|
87723
88203
|
*/
|
|
87724
88204
|
getProfile(options?: AxiosRequestConfig): AxiosPromise<Profile>;
|
|
88205
|
+
/**
|
|
88206
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
88207
|
+
* @summary Invite User
|
|
88208
|
+
* @param {UserAuthorizationApiProcessInvitationRequest} requestParameters Request parameters.
|
|
88209
|
+
* @param {*} [options] Override http request option.
|
|
88210
|
+
* @throws {RequiredError}
|
|
88211
|
+
* @memberof UserAuthorizationApiInterface
|
|
88212
|
+
*/
|
|
88213
|
+
processInvitation(requestParameters: UserAuthorizationApiProcessInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
88214
|
+
}
|
|
88215
|
+
/**
|
|
88216
|
+
* Request parameters for processInvitation operation in UserAuthorizationApi.
|
|
88217
|
+
* @export
|
|
88218
|
+
* @interface UserAuthorizationApiProcessInvitationRequest
|
|
88219
|
+
*/
|
|
88220
|
+
export interface UserAuthorizationApiProcessInvitationRequest {
|
|
88221
|
+
/**
|
|
88222
|
+
*
|
|
88223
|
+
* @type {Invitation}
|
|
88224
|
+
* @memberof UserAuthorizationApiProcessInvitation
|
|
88225
|
+
*/
|
|
88226
|
+
readonly invitation: Invitation;
|
|
87725
88227
|
}
|
|
87726
88228
|
/**
|
|
87727
88229
|
* UserAuthorizationApi - object-oriented interface
|
|
@@ -87738,6 +88240,15 @@ export declare class UserAuthorizationApi extends BaseAPI implements UserAuthori
|
|
|
87738
88240
|
* @memberof UserAuthorizationApi
|
|
87739
88241
|
*/
|
|
87740
88242
|
getProfile(options?: AxiosRequestConfig): AxiosPromise<Profile>;
|
|
88243
|
+
/**
|
|
88244
|
+
* Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.
|
|
88245
|
+
* @summary Invite User
|
|
88246
|
+
* @param {UserAuthorizationApiProcessInvitationRequest} requestParameters Request parameters.
|
|
88247
|
+
* @param {*} [options] Override http request option.
|
|
88248
|
+
* @throws {RequiredError}
|
|
88249
|
+
* @memberof UserAuthorizationApi
|
|
88250
|
+
*/
|
|
88251
|
+
processInvitation(requestParameters: UserAuthorizationApiProcessInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
87741
88252
|
}
|
|
87742
88253
|
/**
|
|
87743
88254
|
* User - represents entity interacting with platform
|