@itwin/grouping-mapping-widget 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/lib/cjs/widget/GroupingMappingWidget.d.ts +4 -0
  2. package/lib/cjs/widget/GroupingMappingWidget.js +6 -23
  3. package/lib/cjs/widget/GroupingMappingWidget.js.map +1 -1
  4. package/lib/cjs/widget/components/CalculatedPropertyAction.d.ts +2 -2
  5. package/lib/cjs/widget/components/CalculatedPropertyAction.js +12 -7
  6. package/lib/cjs/widget/components/CalculatedPropertyAction.js.map +1 -1
  7. package/lib/cjs/widget/components/CalculatedPropertyTable.d.ts +5 -5
  8. package/lib/cjs/widget/components/CalculatedPropertyTable.js +15 -16
  9. package/lib/cjs/widget/components/CalculatedPropertyTable.js.map +1 -1
  10. package/lib/cjs/widget/components/ConfirmMappingsImport.d.ts +3 -3
  11. package/lib/cjs/widget/components/ConfirmMappingsImport.js +6 -3
  12. package/lib/cjs/widget/components/ConfirmMappingsImport.js.map +1 -1
  13. package/lib/cjs/widget/components/CustomCalculationAction.d.ts +2 -2
  14. package/lib/cjs/widget/components/CustomCalculationAction.js +14 -8
  15. package/lib/cjs/widget/components/CustomCalculationAction.js.map +1 -1
  16. package/lib/cjs/widget/components/CustomCalculationTable.d.ts +5 -5
  17. package/lib/cjs/widget/components/CustomCalculationTable.js +15 -16
  18. package/lib/cjs/widget/components/CustomCalculationTable.js.map +1 -1
  19. package/lib/cjs/widget/components/GroupAction.d.ts +2 -2
  20. package/lib/cjs/widget/components/GroupAction.js +8 -3
  21. package/lib/cjs/widget/components/GroupAction.js.map +1 -1
  22. package/lib/cjs/widget/components/GroupPropertyAction.js +9 -5
  23. package/lib/cjs/widget/components/GroupPropertyAction.js.map +1 -1
  24. package/lib/cjs/widget/components/GroupPropertyTable.d.ts +5 -5
  25. package/lib/cjs/widget/components/GroupPropertyTable.js +15 -16
  26. package/lib/cjs/widget/components/GroupPropertyTable.js.map +1 -1
  27. package/lib/cjs/widget/components/Grouping.d.ts +3 -3
  28. package/lib/cjs/widget/components/Grouping.js +22 -22
  29. package/lib/cjs/widget/components/Grouping.js.map +1 -1
  30. package/lib/cjs/widget/components/GroupingMapping.d.ts +12 -2
  31. package/lib/cjs/widget/components/GroupingMapping.js +18 -4
  32. package/lib/cjs/widget/components/GroupingMapping.js.map +1 -1
  33. package/lib/cjs/widget/components/Mapping.d.ts +2 -2
  34. package/lib/cjs/widget/components/Mapping.js +14 -14
  35. package/lib/cjs/widget/components/Mapping.js.map +1 -1
  36. package/lib/cjs/widget/components/MappingAction.d.ts +2 -2
  37. package/lib/cjs/widget/components/MappingAction.js +6 -3
  38. package/lib/cjs/widget/components/MappingAction.js.map +1 -1
  39. package/lib/cjs/widget/components/MappingImportWizardModal.js.map +1 -1
  40. package/lib/cjs/widget/components/PropertyMenu.d.ts +2 -2
  41. package/lib/cjs/widget/components/PropertyMenu.js.map +1 -1
  42. package/lib/cjs/widget/components/SelectIModel.js +4 -8
  43. package/lib/cjs/widget/components/SelectIModel.js.map +1 -1
  44. package/lib/cjs/widget/components/SelectMappings.d.ts +2 -2
  45. package/lib/cjs/widget/components/SelectMappings.js +10 -11
  46. package/lib/cjs/widget/components/SelectMappings.js.map +1 -1
  47. package/lib/cjs/widget/components/SelectProject.js +4 -8
  48. package/lib/cjs/widget/components/SelectProject.js.map +1 -1
  49. package/lib/esm/widget/GroupingMappingWidget.d.ts +4 -0
  50. package/lib/esm/widget/GroupingMappingWidget.js +6 -4
  51. package/lib/esm/widget/GroupingMappingWidget.js.map +1 -1
  52. package/lib/esm/widget/components/CalculatedPropertyAction.d.ts +2 -2
  53. package/lib/esm/widget/components/CalculatedPropertyAction.js +13 -8
  54. package/lib/esm/widget/components/CalculatedPropertyAction.js.map +1 -1
  55. package/lib/esm/widget/components/CalculatedPropertyTable.d.ts +5 -5
  56. package/lib/esm/widget/components/CalculatedPropertyTable.js +16 -17
  57. package/lib/esm/widget/components/CalculatedPropertyTable.js.map +1 -1
  58. package/lib/esm/widget/components/ConfirmMappingsImport.d.ts +3 -3
  59. package/lib/esm/widget/components/ConfirmMappingsImport.js +7 -4
  60. package/lib/esm/widget/components/ConfirmMappingsImport.js.map +1 -1
  61. package/lib/esm/widget/components/CustomCalculationAction.d.ts +2 -2
  62. package/lib/esm/widget/components/CustomCalculationAction.js +15 -9
  63. package/lib/esm/widget/components/CustomCalculationAction.js.map +1 -1
  64. package/lib/esm/widget/components/CustomCalculationTable.d.ts +5 -5
  65. package/lib/esm/widget/components/CustomCalculationTable.js +16 -17
  66. package/lib/esm/widget/components/CustomCalculationTable.js.map +1 -1
  67. package/lib/esm/widget/components/GroupAction.d.ts +2 -2
  68. package/lib/esm/widget/components/GroupAction.js +9 -4
  69. package/lib/esm/widget/components/GroupAction.js.map +1 -1
  70. package/lib/esm/widget/components/GroupPropertyAction.js +10 -6
  71. package/lib/esm/widget/components/GroupPropertyAction.js.map +1 -1
  72. package/lib/esm/widget/components/GroupPropertyTable.d.ts +5 -5
  73. package/lib/esm/widget/components/GroupPropertyTable.js +16 -17
  74. package/lib/esm/widget/components/GroupPropertyTable.js.map +1 -1
  75. package/lib/esm/widget/components/Grouping.d.ts +3 -3
  76. package/lib/esm/widget/components/Grouping.js +23 -23
  77. package/lib/esm/widget/components/Grouping.js.map +1 -1
  78. package/lib/esm/widget/components/GroupingMapping.d.ts +12 -2
  79. package/lib/esm/widget/components/GroupingMapping.js +17 -4
  80. package/lib/esm/widget/components/GroupingMapping.js.map +1 -1
  81. package/lib/esm/widget/components/Mapping.d.ts +2 -2
  82. package/lib/esm/widget/components/Mapping.js +15 -15
  83. package/lib/esm/widget/components/Mapping.js.map +1 -1
  84. package/lib/esm/widget/components/MappingAction.d.ts +2 -2
  85. package/lib/esm/widget/components/MappingAction.js +7 -4
  86. package/lib/esm/widget/components/MappingAction.js.map +1 -1
  87. package/lib/esm/widget/components/MappingImportWizardModal.js.map +1 -1
  88. package/lib/esm/widget/components/PropertyMenu.d.ts +2 -2
  89. package/lib/esm/widget/components/PropertyMenu.js.map +1 -1
  90. package/lib/esm/widget/components/SelectIModel.js +5 -6
  91. package/lib/esm/widget/components/SelectIModel.js.map +1 -1
  92. package/lib/esm/widget/components/SelectMappings.d.ts +2 -2
  93. package/lib/esm/widget/components/SelectMappings.js +11 -12
  94. package/lib/esm/widget/components/SelectMappings.js.map +1 -1
  95. package/lib/esm/widget/components/SelectProject.js +5 -6
  96. package/lib/esm/widget/components/SelectProject.js.map +1 -1
  97. package/package.json +2 -1
  98. package/lib/cjs/api/generated/api.d.ts +0 -3222
  99. package/lib/cjs/api/generated/api.js +0 -5291
  100. package/lib/cjs/api/generated/api.js.map +0 -1
  101. package/lib/cjs/api/generated/configuration.d.ts +0 -56
  102. package/lib/cjs/api/generated/configuration.js +0 -30
  103. package/lib/cjs/api/generated/configuration.js.map +0 -1
  104. package/lib/cjs/api/generated/index.d.ts +0 -14
  105. package/lib/cjs/api/generated/index.js +0 -31
  106. package/lib/cjs/api/generated/index.js.map +0 -1
  107. package/lib/cjs/api/reportingClient.d.ts +0 -34
  108. package/lib/cjs/api/reportingClient.js +0 -177
  109. package/lib/cjs/api/reportingClient.js.map +0 -1
  110. package/lib/cjs/widget/hooks/useFetchAccessToken.d.ts +0 -3
  111. package/lib/cjs/widget/hooks/useFetchAccessToken.js +0 -22
  112. package/lib/cjs/widget/hooks/useFetchAccessToken.js.map +0 -1
  113. package/lib/esm/api/generated/api.d.ts +0 -3222
  114. package/lib/esm/api/generated/api.js +0 -5248
  115. package/lib/esm/api/generated/api.js.map +0 -1
  116. package/lib/esm/api/generated/configuration.d.ts +0 -56
  117. package/lib/esm/api/generated/configuration.js +0 -26
  118. package/lib/esm/api/generated/configuration.js.map +0 -1
  119. package/lib/esm/api/generated/index.d.ts +0 -14
  120. package/lib/esm/api/generated/index.js +0 -19
  121. package/lib/esm/api/generated/index.js.map +0 -1
  122. package/lib/esm/api/reportingClient.d.ts +0 -34
  123. package/lib/esm/api/reportingClient.js +0 -173
  124. package/lib/esm/api/reportingClient.js.map +0 -1
  125. package/lib/esm/widget/hooks/useFetchAccessToken.d.ts +0 -3
  126. package/lib/esm/widget/hooks/useFetchAccessToken.js +0 -20
  127. package/lib/esm/widget/hooks/useFetchAccessToken.js.map +0 -1
@@ -1,3222 +0,0 @@
1
- /**
2
- * Reporting
3
- * Reporting is a resource for aggregating iTwin data to build custom dashboards and integrate iTwin data with your business applications. - Create digitial twin based reports which can be consumed through business intelligence applications such as Power BI. - Leverage the OData feed Data Access to generate reports by combining data from multiple data streams in the digital twin.
4
- *
5
- * OpenAPI spec version: v1
6
- *
7
- *
8
- * NOTE: This file is auto generated by the swagger code generator program.
9
- * https://github.com/swagger-api/swagger-codegen.git
10
- * Do not edit the file manually.
11
- */
12
- import { Configuration } from './configuration';
13
- export declare const BASE_PATH: string;
14
- /**
15
- *
16
- * @export
17
- */
18
- export declare const COLLECTION_FORMATS: {
19
- csv: string;
20
- ssv: string;
21
- tsv: string;
22
- pipes: string;
23
- };
24
- /**
25
- *
26
- * @export
27
- * @interface FetchAPI
28
- */
29
- export interface FetchAPI {
30
- (url: string, init?: any): Promise<Response>;
31
- }
32
- /**
33
- *
34
- * @export
35
- * @interface FetchArgs
36
- */
37
- export interface FetchArgs {
38
- url: string;
39
- options: any;
40
- }
41
- /**
42
- *
43
- * @export
44
- * @class BaseAPI
45
- */
46
- export declare class BaseAPI {
47
- protected basePath: string;
48
- protected fetch: FetchAPI;
49
- protected configuration: Configuration;
50
- constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
51
- }
52
- /**
53
- *
54
- * @export
55
- * @class RequiredError
56
- * @extends {Error}
57
- */
58
- export declare class RequiredError extends Error {
59
- field: string;
60
- name: 'RequiredError';
61
- constructor(field: string, msg?: string);
62
- }
63
- /**
64
- * List of CalculatedProperties.
65
- * @export
66
- * @interface CalculatedPropertyCollectionReportingAPI
67
- */
68
- export interface CalculatedPropertyCollectionReportingAPI {
69
- /**
70
- * List of CalculatedProperties.
71
- * @type {Array<CalculatedPropertyReportingAPI>}
72
- * @memberof CalculatedPropertyCollectionReportingAPI
73
- */
74
- properties?: Array<CalculatedPropertyReportingAPI>;
75
- /**
76
- *
77
- * @type {PagedResponseLinksReportingAPI}
78
- * @memberof CalculatedPropertyCollectionReportingAPI
79
- */
80
- _links?: PagedResponseLinksReportingAPI;
81
- }
82
- /**
83
- * Properties of the CalculatedProperty to be created.
84
- * @export
85
- * @interface CalculatedPropertyCreateReportingAPI
86
- */
87
- export interface CalculatedPropertyCreateReportingAPI {
88
- /**
89
- * Name of the CalculatedProperty.
90
- * @type {string}
91
- * @memberof CalculatedPropertyCreateReportingAPI
92
- */
93
- propertyName: string;
94
- /**
95
- * The type of the CalculatedProperty. One of 'Area', 'Length', 'Volume', 'BoundingBoxLongestEdgeLength', 'BoundingBoxIntermediateEdgeLength', 'BoundingBoxShortestEdgeLength', 'BoundingBoxDiagonalLength', 'BoundingBoxLongestFaceDiagonalLength', 'BoundingBoxIntermediateFaceDiagonalLength', 'BoundingBoxShortestFaceDiagonalLength'.
96
- * @type {string}
97
- * @memberof CalculatedPropertyCreateReportingAPI
98
- */
99
- type: string;
100
- }
101
- /**
102
- *
103
- * @export
104
- * @interface CalculatedPropertyLinksReportingAPI
105
- */
106
- export interface CalculatedPropertyLinksReportingAPI {
107
- /**
108
- *
109
- * @type {LinkReportingAPI}
110
- * @memberof CalculatedPropertyLinksReportingAPI
111
- */
112
- imodel?: LinkReportingAPI;
113
- /**
114
- *
115
- * @type {LinkReportingAPI}
116
- * @memberof CalculatedPropertyLinksReportingAPI
117
- */
118
- mapping?: LinkReportingAPI;
119
- /**
120
- *
121
- * @type {LinkReportingAPI}
122
- * @memberof CalculatedPropertyLinksReportingAPI
123
- */
124
- group?: LinkReportingAPI;
125
- }
126
- /**
127
- * Defines a CalculatedProperty or 'column' for a Group. It is calculated for each element returned by the Group's query.
128
- * @export
129
- * @interface CalculatedPropertyReportingAPI
130
- */
131
- export interface CalculatedPropertyReportingAPI {
132
- /**
133
- * The CalculatedProperty Id.
134
- * @type {string}
135
- * @memberof CalculatedPropertyReportingAPI
136
- */
137
- id?: string;
138
- /**
139
- * Name of the Property (OData v4 SimpleIdentifier).
140
- * @type {string}
141
- * @memberof CalculatedPropertyReportingAPI
142
- */
143
- propertyName?: string;
144
- /**
145
- * The type of the CalculatedProperty. One of 'Area', 'Length', 'Volume', 'BoundingBoxLongestEdgeLength', 'BoundingBoxIntermediateEdgeLength', 'BoundingBoxShortestEdgeLength', 'BoundingBoxDiagonalLength', 'BoundingBoxLongestFaceDiagonalLength', 'BoundingBoxIntermediateFaceDiagonalLength', 'BoundingBoxShortestFaceDiagonalLength'.
146
- * @type {string}
147
- * @memberof CalculatedPropertyReportingAPI
148
- */
149
- type?: string;
150
- /**
151
- * The quantity type of the CalculatedProperty. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'.
152
- * @type {string}
153
- * @memberof CalculatedPropertyReportingAPI
154
- */
155
- quantityType?: string;
156
- /**
157
- *
158
- * @type {CalculatedPropertyLinksReportingAPI}
159
- * @memberof CalculatedPropertyReportingAPI
160
- */
161
- _links?: CalculatedPropertyLinksReportingAPI;
162
- }
163
- /**
164
- * Container for a CalculatedProperty object.
165
- * @export
166
- * @interface CalculatedPropertySingleReportingAPI
167
- */
168
- export interface CalculatedPropertySingleReportingAPI {
169
- /**
170
- *
171
- * @type {CalculatedPropertyReportingAPI}
172
- * @memberof CalculatedPropertySingleReportingAPI
173
- */
174
- property?: CalculatedPropertyReportingAPI;
175
- }
176
- /**
177
- * Properties of the CalculatedProperty to be updated.
178
- * @export
179
- * @interface CalculatedPropertyUpdateReportingAPI
180
- */
181
- export interface CalculatedPropertyUpdateReportingAPI {
182
- /**
183
- * Name of the CalculatedProperty.
184
- * @type {string}
185
- * @memberof CalculatedPropertyUpdateReportingAPI
186
- */
187
- propertyName?: string;
188
- /**
189
- * The type of the CalculatedProperty. One of 'Area', 'Length', 'Volume', 'BoundingBoxLongestEdgeLength', 'BoundingBoxIntermediateEdgeLength', 'BoundingBoxShortestEdgeLength', 'BoundingBoxDiagonalLength', 'BoundingBoxLongestFaceDiagonalLength', 'BoundingBoxIntermediateFaceDiagonalLength', 'BoundingBoxShortestFaceDiagonalLength'.
190
- * @type {string}
191
- * @memberof CalculatedPropertyUpdateReportingAPI
192
- */
193
- type?: string;
194
- }
195
- /**
196
- * List of CustomCalculations.
197
- * @export
198
- * @interface CustomCalculationCollectionReportingAPI
199
- */
200
- export interface CustomCalculationCollectionReportingAPI {
201
- /**
202
- * List of CustomCalculations.
203
- * @type {Array<CustomCalculationReportingAPI>}
204
- * @memberof CustomCalculationCollectionReportingAPI
205
- */
206
- customCalculations?: Array<CustomCalculationReportingAPI>;
207
- /**
208
- *
209
- * @type {PagedResponseLinksReportingAPI}
210
- * @memberof CustomCalculationCollectionReportingAPI
211
- */
212
- _links?: PagedResponseLinksReportingAPI;
213
- }
214
- /**
215
- * Properties of the CustomCalculation to be created.
216
- * @export
217
- * @interface CustomCalculationCreateReportingAPI
218
- */
219
- export interface CustomCalculationCreateReportingAPI {
220
- /**
221
- * Name of the Property (OData v4 SimpleIdentifier).
222
- * @type {string}
223
- * @memberof CustomCalculationCreateReportingAPI
224
- */
225
- propertyName: string;
226
- /**
227
- * A mathematical formula which will be evaluated for each element returned by the Group's query.
228
- * @type {string}
229
- * @memberof CustomCalculationCreateReportingAPI
230
- */
231
- formula: string;
232
- /**
233
- * The quantity type of the CustomCalculation. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'. Default is 'Undefined'.
234
- * @type {string}
235
- * @memberof CustomCalculationCreateReportingAPI
236
- */
237
- quantityType?: string;
238
- }
239
- /**
240
- * Defines a CustomCalculation or 'column' for a Group. It is calculated using the given formula for each element returned by the Group's query.
241
- * @export
242
- * @interface CustomCalculationReportingAPI
243
- */
244
- export interface CustomCalculationReportingAPI {
245
- /**
246
- * The CustomCalculation Id.
247
- * @type {string}
248
- * @memberof CustomCalculationReportingAPI
249
- */
250
- id?: string;
251
- /**
252
- * Name of the Property (OData v4 SimpleIdentifier).
253
- * @type {string}
254
- * @memberof CustomCalculationReportingAPI
255
- */
256
- propertyName?: string;
257
- /**
258
- * A mathematical formula which will be evaluated for each element returned by the Group's query.
259
- * @type {string}
260
- * @memberof CustomCalculationReportingAPI
261
- */
262
- formula?: string;
263
- /**
264
- * The quantity type of the CustomCalculation. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'.
265
- * @type {string}
266
- * @memberof CustomCalculationReportingAPI
267
- */
268
- quantityType?: string;
269
- /**
270
- *
271
- * @type {CalculatedPropertyLinksReportingAPI}
272
- * @memberof CustomCalculationReportingAPI
273
- */
274
- _links?: CalculatedPropertyLinksReportingAPI;
275
- }
276
- /**
277
- * Container for a CustomCalculation object.
278
- * @export
279
- * @interface CustomCalculationSingleReportingAPI
280
- */
281
- export interface CustomCalculationSingleReportingAPI {
282
- /**
283
- *
284
- * @type {CustomCalculationReportingAPI}
285
- * @memberof CustomCalculationSingleReportingAPI
286
- */
287
- customCalculation?: CustomCalculationReportingAPI;
288
- }
289
- /**
290
- * Properties of the CustomCalculation to be updated.
291
- * @export
292
- * @interface CustomCalculationUpdateReportingAPI
293
- */
294
- export interface CustomCalculationUpdateReportingAPI {
295
- /**
296
- * Name of the Property (OData v4 SimpleIdentifier).
297
- * @type {string}
298
- * @memberof CustomCalculationUpdateReportingAPI
299
- */
300
- propertyName?: string;
301
- /**
302
- * A mathematical formula which will be evaluated for each element returned by the Group's query.
303
- * @type {string}
304
- * @memberof CustomCalculationUpdateReportingAPI
305
- */
306
- formula?: string;
307
- /**
308
- * The quantity type of the CustomCalculation. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'.
309
- * @type {string}
310
- * @memberof CustomCalculationUpdateReportingAPI
311
- */
312
- quantityType?: string;
313
- }
314
- /**
315
- * Defines a target ECProperty for a Group. This is used to determine what properties will be read from the query response of a Group.
316
- * @export
317
- * @interface ECPropertyReportingAPI
318
- */
319
- export interface ECPropertyReportingAPI {
320
- /**
321
- * The target ECSchema.
322
- * @type {string}
323
- * @memberof ECPropertyReportingAPI
324
- */
325
- ecSchemaName?: string;
326
- /**
327
- * The target ECClass.
328
- * @type {string}
329
- * @memberof ECPropertyReportingAPI
330
- */
331
- ecClassName?: string;
332
- /**
333
- * The target ECProperty.
334
- * @type {string}
335
- * @memberof ECPropertyReportingAPI
336
- */
337
- ecPropertyName?: string;
338
- /**
339
- * The type of the target ECProperty.
340
- * @type {string}
341
- * @memberof ECPropertyReportingAPI
342
- */
343
- ecPropertyType?: string;
344
- }
345
- /**
346
- * Contains error information.
347
- * @export
348
- * @interface ErrorDetailsReportingAPI
349
- */
350
- export interface ErrorDetailsReportingAPI {
351
- /**
352
- * One of a server-defined set of error codes.
353
- * @type {string}
354
- * @memberof ErrorDetailsReportingAPI
355
- */
356
- code: string;
357
- /**
358
- * A human-readable representation of the error.
359
- * @type {string}
360
- * @memberof ErrorDetailsReportingAPI
361
- */
362
- message: string;
363
- }
364
- /**
365
- * Contains error information and an optional array of more specific errors.
366
- * @export
367
- * @interface ErrorReportingAPI
368
- */
369
- export interface ErrorReportingAPI {
370
- /**
371
- * One of a server-defined set of error codes.
372
- * @type {string}
373
- * @memberof ErrorReportingAPI
374
- */
375
- code: string;
376
- /**
377
- * A human-readable representation of the error.
378
- * @type {string}
379
- * @memberof ErrorReportingAPI
380
- */
381
- message: string;
382
- /**
383
- * Optional array of more specific errors.
384
- * @type {Array<ErrorDetailsReportingAPI>}
385
- * @memberof ErrorReportingAPI
386
- */
387
- details?: Array<ErrorDetailsReportingAPI>;
388
- }
389
- /**
390
- * Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
391
- * @export
392
- * @interface ErrorResponseReportingAPI
393
- */
394
- export interface ErrorResponseReportingAPI {
395
- /**
396
- *
397
- * @type {Error}
398
- * @memberof ErrorResponseReportingAPI
399
- */
400
- error: Error;
401
- }
402
- /**
403
- * Metadata associated with a data extraction run.
404
- * @export
405
- * @interface ExtractionRunReportingAPI
406
- */
407
- export interface ExtractionRunReportingAPI {
408
- /**
409
- *
410
- * @type {ExtractionRunRunReportingAPI}
411
- * @memberof ExtractionRunReportingAPI
412
- */
413
- run?: ExtractionRunRunReportingAPI;
414
- }
415
- /**
416
- * Extraction Run properties.
417
- * @export
418
- * @interface ExtractionRunRunReportingAPI
419
- */
420
- export interface ExtractionRunRunReportingAPI {
421
- /**
422
- * Unique Identifier for the Extraction Run. Use this to check run status.
423
- * @type {string}
424
- * @memberof ExtractionRunRunReportingAPI
425
- */
426
- id?: string;
427
- }
428
- /**
429
- * Status of the specified Extraction Run.
430
- * @export
431
- * @interface ExtractionStatusReportingAPI
432
- */
433
- export interface ExtractionStatusReportingAPI {
434
- /**
435
- *
436
- * @type {ExtractionStatusStatusReportingAPI}
437
- * @memberof ExtractionStatusReportingAPI
438
- */
439
- status?: ExtractionStatusStatusReportingAPI;
440
- }
441
- /**
442
- * Extraction Status properties.
443
- * @export
444
- * @interface ExtractionStatusStatusReportingAPI
445
- */
446
- export interface ExtractionStatusStatusReportingAPI {
447
- /**
448
- * Current state of the Extraction Run - 'Running', 'Succeeded', or 'Failed'.
449
- * @type {string}
450
- * @memberof ExtractionStatusStatusReportingAPI
451
- */
452
- state?: string;
453
- /**
454
- * Additional justification for the current state of the Extraction Run.
455
- * @type {string}
456
- * @memberof ExtractionStatusStatusReportingAPI
457
- */
458
- reason?: string;
459
- }
460
- /**
461
- * List of Groups.
462
- * @export
463
- * @interface GroupCollectionReportingAPI
464
- */
465
- export interface GroupCollectionReportingAPI {
466
- /**
467
- * List of Groups.
468
- * @type {Array<GroupReportingAPI>}
469
- * @memberof GroupCollectionReportingAPI
470
- */
471
- groups?: Array<GroupReportingAPI>;
472
- /**
473
- *
474
- * @type {PagedResponseLinksReportingAPI}
475
- * @memberof GroupCollectionReportingAPI
476
- */
477
- _links?: PagedResponseLinksReportingAPI;
478
- }
479
- /**
480
- * Properties of the Group to be created.
481
- * @export
482
- * @interface GroupCreateReportingAPI
483
- */
484
- export interface GroupCreateReportingAPI {
485
- /**
486
- * Name of the Group (OData v4 SimpleIdentifier).
487
- * @type {string}
488
- * @memberof GroupCreateReportingAPI
489
- */
490
- groupName?: string;
491
- /**
492
- * Description of the Group.
493
- * @type {string}
494
- * @memberof GroupCreateReportingAPI
495
- */
496
- description?: string;
497
- /**
498
- * Query string that will be executed against the target iModel to build this Group.
499
- * @type {string}
500
- * @memberof GroupCreateReportingAPI
501
- */
502
- query?: string;
503
- }
504
- /**
505
- * List of GroupProperties.
506
- * @export
507
- * @interface GroupPropertyCollectionReportingAPI
508
- */
509
- export interface GroupPropertyCollectionReportingAPI {
510
- /**
511
- * List of GroupProperties.
512
- * @type {Array<GroupPropertyReportingAPI>}
513
- * @memberof GroupPropertyCollectionReportingAPI
514
- */
515
- properties?: Array<GroupPropertyReportingAPI>;
516
- /**
517
- *
518
- * @type {PagedResponseLinksReportingAPI}
519
- * @memberof GroupPropertyCollectionReportingAPI
520
- */
521
- _links?: PagedResponseLinksReportingAPI;
522
- }
523
- /**
524
- * Properties of the GroupProperty to be created.
525
- * @export
526
- * @interface GroupPropertyCreateReportingAPI
527
- */
528
- export interface GroupPropertyCreateReportingAPI {
529
- /**
530
- * Name of the Property (OData v4 SimpleIdentifier).
531
- * @type {string}
532
- * @memberof GroupPropertyCreateReportingAPI
533
- */
534
- propertyName?: string;
535
- /**
536
- * The data type of the GroupProperty. One of 'Boolean', 'Number', 'String', or 'Undefined'.
537
- * @type {string}
538
- * @memberof GroupPropertyCreateReportingAPI
539
- */
540
- dataType?: string;
541
- /**
542
- * The quantity type of the GroupProperty. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'.
543
- * @type {string}
544
- * @memberof GroupPropertyCreateReportingAPI
545
- */
546
- quantityType?: string;
547
- /**
548
- * List of ECProperties that map to this GroupProperty.
549
- * @type {Array<ECPropertyReportingAPI>}
550
- * @memberof GroupPropertyCreateReportingAPI
551
- */
552
- ecProperties?: Array<ECPropertyReportingAPI>;
553
- }
554
- /**
555
- * Defines a one-to-many property mapping to a set of ECProperties for a Group - to be used when a Group query will return data from multiple ECClasses.
556
- * @export
557
- * @interface GroupPropertyReportingAPI
558
- */
559
- export interface GroupPropertyReportingAPI {
560
- /**
561
- * The GroupProperty Id.
562
- * @type {string}
563
- * @memberof GroupPropertyReportingAPI
564
- */
565
- id?: string;
566
- /**
567
- * Name of the Property (OData v4 SimpleIdentifier).
568
- * @type {string}
569
- * @memberof GroupPropertyReportingAPI
570
- */
571
- propertyName?: string;
572
- /**
573
- * The data type of the GroupProperty. One of 'Boolean', 'Number', 'String', or 'Undefined'.
574
- * @type {string}
575
- * @memberof GroupPropertyReportingAPI
576
- */
577
- dataType?: string;
578
- /**
579
- * The quantity type of the GroupProperty. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'.
580
- * @type {string}
581
- * @memberof GroupPropertyReportingAPI
582
- */
583
- quantityType?: string;
584
- /**
585
- * List of ECProperties that map to this GroupProperty.
586
- * @type {Array<ECPropertyReportingAPI>}
587
- * @memberof GroupPropertyReportingAPI
588
- */
589
- ecProperties?: Array<ECPropertyReportingAPI>;
590
- }
591
- /**
592
- * Container for a GroupProperty object.
593
- * @export
594
- * @interface GroupPropertySingleReportingAPI
595
- */
596
- export interface GroupPropertySingleReportingAPI {
597
- /**
598
- *
599
- * @type {GroupPropertyReportingAPI}
600
- * @memberof GroupPropertySingleReportingAPI
601
- */
602
- property?: GroupPropertyReportingAPI;
603
- }
604
- /**
605
- * Properties of the GroupProperty to be updated.
606
- * @export
607
- * @interface GroupPropertyUpdateReportingAPI
608
- */
609
- export interface GroupPropertyUpdateReportingAPI {
610
- /**
611
- * Name of the Property (OData v4 SimpleIdentifier).
612
- * @type {string}
613
- * @memberof GroupPropertyUpdateReportingAPI
614
- */
615
- propertyName?: string;
616
- /**
617
- * The data type of the GroupProperty. One of 'Boolean', 'Number', 'String', or 'Undefined'.
618
- * @type {string}
619
- * @memberof GroupPropertyUpdateReportingAPI
620
- */
621
- dataType?: string;
622
- /**
623
- * The quantity type of the GroupProperty. One of 'Area', 'Distance', 'Force', 'Mass', 'Monetary', 'Time', 'Volume, or 'Undefined'.
624
- * @type {string}
625
- * @memberof GroupPropertyUpdateReportingAPI
626
- */
627
- quantityType?: string;
628
- /**
629
- * List of ECProperties that map to this GroupProperty.
630
- * @type {Array<ECPropertyReportingAPI>}
631
- * @memberof GroupPropertyUpdateReportingAPI
632
- */
633
- ecProperties?: Array<ECPropertyReportingAPI>;
634
- }
635
- /**
636
- * Defines a single Group (collection of iModel elements) in an iModel Mapping.
637
- * @export
638
- * @interface GroupReportingAPI
639
- */
640
- export interface GroupReportingAPI {
641
- /**
642
- * The Group Id.
643
- * @type {string}
644
- * @memberof GroupReportingAPI
645
- */
646
- id?: string;
647
- /**
648
- * Name of the Group (OData v4 SimpleIdentifier).
649
- * @type {string}
650
- * @memberof GroupReportingAPI
651
- */
652
- groupName?: string;
653
- /**
654
- * Description of the Group.
655
- * @type {string}
656
- * @memberof GroupReportingAPI
657
- */
658
- description?: string;
659
- /**
660
- * Query string that will be executed against the target iModel to build this Group.
661
- * @type {string}
662
- * @memberof GroupReportingAPI
663
- */
664
- query?: string;
665
- }
666
- /**
667
- * Container for a Group object.
668
- * @export
669
- * @interface GroupSingleReportingAPI
670
- */
671
- export interface GroupSingleReportingAPI {
672
- /**
673
- *
674
- * @type {GroupReportingAPI}
675
- * @memberof GroupSingleReportingAPI
676
- */
677
- group?: GroupReportingAPI;
678
- }
679
- /**
680
- * Properties of the Group to be updated.
681
- * @export
682
- * @interface GroupUpdateReportingAPI
683
- */
684
- export interface GroupUpdateReportingAPI {
685
- /**
686
- * Name of the Group (OData v4 SimpleIdentifier).
687
- * @type {string}
688
- * @memberof GroupUpdateReportingAPI
689
- */
690
- groupName?: string;
691
- /**
692
- * Description of the Group.
693
- * @type {string}
694
- * @memberof GroupUpdateReportingAPI
695
- */
696
- description?: string;
697
- /**
698
- * Query string that will be executed against the target iModel to build this Group.
699
- * @type {string}
700
- * @memberof GroupUpdateReportingAPI
701
- */
702
- query?: string;
703
- }
704
- /**
705
- * Hyperlink container.
706
- * @export
707
- * @interface LinkReportingAPI
708
- */
709
- export interface LinkReportingAPI {
710
- /**
711
- * Hyperlink to the specific entity.
712
- * @type {string}
713
- * @memberof LinkReportingAPI
714
- */
715
- href?: string;
716
- }
717
- /**
718
- * List of Mappings.
719
- * @export
720
- * @interface MappingCollectionReportingAPI
721
- */
722
- export interface MappingCollectionReportingAPI {
723
- /**
724
- * List of Mappings.
725
- * @type {Array<MappingReportingAPI>}
726
- * @memberof MappingCollectionReportingAPI
727
- */
728
- mappings?: Array<MappingReportingAPI>;
729
- /**
730
- *
731
- * @type {PagedResponseLinksReportingAPI}
732
- * @memberof MappingCollectionReportingAPI
733
- */
734
- _links?: PagedResponseLinksReportingAPI;
735
- }
736
- /**
737
- * Properties for the copied Mapping.
738
- * @export
739
- * @interface MappingCopyReportingAPI
740
- */
741
- export interface MappingCopyReportingAPI {
742
- /**
743
- * The target iModel Id.
744
- * @type {string}
745
- * @memberof MappingCopyReportingAPI
746
- */
747
- targetIModelId: string;
748
- /**
749
- * Name of the target Mapping (OData v4 SimpleIdentifier).
750
- * @type {string}
751
- * @memberof MappingCopyReportingAPI
752
- */
753
- mappingName?: string;
754
- }
755
- /**
756
- * Properties of the Mapping to be created.
757
- * @export
758
- * @interface MappingCreateReportingAPI
759
- */
760
- export interface MappingCreateReportingAPI {
761
- /**
762
- * Name of the Mapping (OData v4 SimpleIdentifier).
763
- * @type {string}
764
- * @memberof MappingCreateReportingAPI
765
- */
766
- mappingName?: string;
767
- /**
768
- * Description of the Mapping.
769
- * @type {string}
770
- * @memberof MappingCreateReportingAPI
771
- */
772
- description?: string;
773
- }
774
- /**
775
- * Contains contextual hyperlinks to related data.
776
- * @export
777
- * @interface MappingLinksReportingAPI
778
- */
779
- export interface MappingLinksReportingAPI {
780
- /**
781
- *
782
- * @type {LinkReportingAPI}
783
- * @memberof MappingLinksReportingAPI
784
- */
785
- imodel?: LinkReportingAPI;
786
- }
787
- /**
788
- * Defines a Mapping for an iModel. Each mapping represents a collection of 'Groups', sets of iModel elements, and their properties of interest.
789
- * @export
790
- * @interface MappingReportingAPI
791
- */
792
- export interface MappingReportingAPI {
793
- /**
794
- * The Mapping Id.
795
- * @type {string}
796
- * @memberof MappingReportingAPI
797
- */
798
- id?: string;
799
- /**
800
- * Name of the Mapping (OData v4 SimpleIdentifier).
801
- * @type {string}
802
- * @memberof MappingReportingAPI
803
- */
804
- mappingName?: string;
805
- /**
806
- * Description of the Mapping.
807
- * @type {string}
808
- * @memberof MappingReportingAPI
809
- */
810
- description?: string;
811
- /**
812
- * Date when the Mapping was created.
813
- * @type {string}
814
- * @memberof MappingReportingAPI
815
- */
816
- createdOn?: string;
817
- /**
818
- * Email of the user who created the Mapping.
819
- * @type {string}
820
- * @memberof MappingReportingAPI
821
- */
822
- createdBy?: string;
823
- /**
824
- * Date when the Mapping was last modified.
825
- * @type {string}
826
- * @memberof MappingReportingAPI
827
- */
828
- modifiedOn?: string;
829
- /**
830
- * Email of the user who last modified the Mapping.
831
- * @type {string}
832
- * @memberof MappingReportingAPI
833
- */
834
- modifiedBy?: string;
835
- /**
836
- *
837
- * @type {MappingLinksReportingAPI}
838
- * @memberof MappingReportingAPI
839
- */
840
- _links?: MappingLinksReportingAPI;
841
- }
842
- /**
843
- * Container for a Mapping object.
844
- * @export
845
- * @interface MappingSingleReportingAPI
846
- */
847
- export interface MappingSingleReportingAPI {
848
- /**
849
- *
850
- * @type {MappingReportingAPI}
851
- * @memberof MappingSingleReportingAPI
852
- */
853
- mapping?: MappingReportingAPI;
854
- }
855
- /**
856
- * Properties of the Mapping to be updated.
857
- * @export
858
- * @interface MappingUpdateReportingAPI
859
- */
860
- export interface MappingUpdateReportingAPI {
861
- /**
862
- * Name of the Mapping (OData v4 SimpleIdentifier).
863
- * @type {string}
864
- * @memberof MappingUpdateReportingAPI
865
- */
866
- mappingName?: string;
867
- /**
868
- * Description of the Mapping.
869
- * @type {string}
870
- * @memberof MappingUpdateReportingAPI
871
- */
872
- description?: string;
873
- }
874
- /**
875
- *
876
- * @export
877
- * @interface ODataItemReportingAPI
878
- */
879
- export interface ODataItemReportingAPI {
880
- /**
881
- *
882
- * @type {string}
883
- * @memberof ODataItemReportingAPI
884
- */
885
- name?: string;
886
- /**
887
- *
888
- * @type {string}
889
- * @memberof ODataItemReportingAPI
890
- */
891
- url?: string;
892
- }
893
- /**
894
- * OData response.
895
- * @export
896
- * @interface ODataResponseReportingAPI
897
- */
898
- export interface ODataResponseReportingAPI {
899
- /**
900
- *
901
- * @type {ODataResponseStatusReportingAPI}
902
- * @memberof ODataResponseReportingAPI
903
- */
904
- status?: ODataResponseStatusReportingAPI;
905
- }
906
- /**
907
- * OData response.
908
- * @export
909
- * @interface ODataResponseStatusReportingAPI
910
- */
911
- export interface ODataResponseStatusReportingAPI {
912
- /**
913
- * OData Schema
914
- * @type {string}
915
- * @memberof ODataResponseStatusReportingAPI
916
- */
917
- odata_context?: string;
918
- /**
919
- *
920
- * @type {Array<ODataItemReportingAPI>}
921
- * @memberof ODataResponseStatusReportingAPI
922
- */
923
- value?: Array<ODataItemReportingAPI>;
924
- }
925
- /**
926
- * URLs for redoing the current request and/or getting the next page of results if applicable.
927
- * @export
928
- * @interface PagedResponseLinksReportingAPI
929
- */
930
- export interface PagedResponseLinksReportingAPI {
931
- /**
932
- *
933
- * @type {LinkReportingAPI}
934
- * @memberof PagedResponseLinksReportingAPI
935
- */
936
- next?: LinkReportingAPI;
937
- /**
938
- *
939
- * @type {LinkReportingAPI}
940
- * @memberof PagedResponseLinksReportingAPI
941
- */
942
- self?: LinkReportingAPI;
943
- }
944
- /**
945
- * List of Reports.
946
- * @export
947
- * @interface ReportCollectionReportingAPI
948
- */
949
- export interface ReportCollectionReportingAPI {
950
- /**
951
- * List of Reports.
952
- * @type {Array<ReportReportingAPI>}
953
- * @memberof ReportCollectionReportingAPI
954
- */
955
- reports?: Array<ReportReportingAPI>;
956
- /**
957
- *
958
- * @type {PagedResponseLinksReportingAPI}
959
- * @memberof ReportCollectionReportingAPI
960
- */
961
- _links?: PagedResponseLinksReportingAPI;
962
- }
963
- /**
964
- * Properties of the Report to be created.
965
- * @export
966
- * @interface ReportCreateReportingAPI
967
- */
968
- export interface ReportCreateReportingAPI {
969
- /**
970
- * Name of the Report.
971
- * @type {string}
972
- * @memberof ReportCreateReportingAPI
973
- */
974
- displayName?: string;
975
- /**
976
- * Description of the Report.
977
- * @type {string}
978
- * @memberof ReportCreateReportingAPI
979
- */
980
- description?: string;
981
- /**
982
- * The Project Id this Report will be drawing data from.
983
- * @type {string}
984
- * @memberof ReportCreateReportingAPI
985
- */
986
- projectId?: string;
987
- }
988
- /**
989
- * Contains contextual hyperlinks to related data.
990
- * @export
991
- * @interface ReportLinksReportingAPI
992
- */
993
- export interface ReportLinksReportingAPI {
994
- /**
995
- *
996
- * @type {LinkReportingAPI}
997
- * @memberof ReportLinksReportingAPI
998
- */
999
- project?: LinkReportingAPI;
1000
- }
1001
- /**
1002
- * List of Report Mappings.
1003
- * @export
1004
- * @interface ReportMappingCollectionReportingAPI
1005
- */
1006
- export interface ReportMappingCollectionReportingAPI {
1007
- /**
1008
- * List of Report Mappings.
1009
- * @type {Array<ReportMappingReportingAPI>}
1010
- * @memberof ReportMappingCollectionReportingAPI
1011
- */
1012
- mappings?: Array<ReportMappingReportingAPI>;
1013
- /**
1014
- *
1015
- * @type {PagedResponseLinksReportingAPI}
1016
- * @memberof ReportMappingCollectionReportingAPI
1017
- */
1018
- _links?: PagedResponseLinksReportingAPI;
1019
- }
1020
- /**
1021
- * Properties of the Report Mapping to be created.
1022
- * @export
1023
- * @interface ReportMappingCreateReportingAPI
1024
- */
1025
- export interface ReportMappingCreateReportingAPI {
1026
- /**
1027
- * The Mapping Id that should be linked to this Report.
1028
- * @type {string}
1029
- * @memberof ReportMappingCreateReportingAPI
1030
- */
1031
- mappingId?: string;
1032
- /**
1033
- * The iModel Id.
1034
- * @type {string}
1035
- * @memberof ReportMappingCreateReportingAPI
1036
- */
1037
- imodelId?: string;
1038
- }
1039
- /**
1040
- * Contains contextual hyperlinks to related data.
1041
- * @export
1042
- * @interface ReportMappingLinksReportingAPI
1043
- */
1044
- export interface ReportMappingLinksReportingAPI {
1045
- /**
1046
- *
1047
- * @type {LinkReportingAPI}
1048
- * @memberof ReportMappingLinksReportingAPI
1049
- */
1050
- report?: LinkReportingAPI;
1051
- /**
1052
- *
1053
- * @type {LinkReportingAPI}
1054
- * @memberof ReportMappingLinksReportingAPI
1055
- */
1056
- mapping?: LinkReportingAPI;
1057
- /**
1058
- *
1059
- * @type {LinkReportingAPI}
1060
- * @memberof ReportMappingLinksReportingAPI
1061
- */
1062
- imodel?: LinkReportingAPI;
1063
- }
1064
- /**
1065
- * Defines a relationship between Report and Mapping. A Mapping can be associated with more than one Report.
1066
- * @export
1067
- * @interface ReportMappingReportingAPI
1068
- */
1069
- export interface ReportMappingReportingAPI {
1070
- /**
1071
- * The Report Id.
1072
- * @type {string}
1073
- * @memberof ReportMappingReportingAPI
1074
- */
1075
- reportId?: string;
1076
- /**
1077
- * The Mapping Id.
1078
- * @type {string}
1079
- * @memberof ReportMappingReportingAPI
1080
- */
1081
- mappingId?: string;
1082
- /**
1083
- * The iModel Id.
1084
- * @type {string}
1085
- * @memberof ReportMappingReportingAPI
1086
- */
1087
- imodelId?: string;
1088
- /**
1089
- *
1090
- * @type {ReportMappingLinksReportingAPI}
1091
- * @memberof ReportMappingReportingAPI
1092
- */
1093
- _links?: ReportMappingLinksReportingAPI;
1094
- }
1095
- /**
1096
- * Container for a Report Mapping object.
1097
- * @export
1098
- * @interface ReportMappingSingleReportingAPI
1099
- */
1100
- export interface ReportMappingSingleReportingAPI {
1101
- /**
1102
- *
1103
- * @type {ReportMappingReportingAPI}
1104
- * @memberof ReportMappingSingleReportingAPI
1105
- */
1106
- mapping?: ReportMappingReportingAPI;
1107
- }
1108
- /**
1109
- * Defines a unit of data that can be exposed as an OData feed. The contents of a Report are defined in Report Mappings.
1110
- * @export
1111
- * @interface ReportReportingAPI
1112
- */
1113
- export interface ReportReportingAPI {
1114
- /**
1115
- * The Report Id.
1116
- * @type {string}
1117
- * @memberof ReportReportingAPI
1118
- */
1119
- id?: string;
1120
- /**
1121
- * Name of the Report.
1122
- * @type {string}
1123
- * @memberof ReportReportingAPI
1124
- */
1125
- displayName?: string;
1126
- /**
1127
- * Description of the Report.
1128
- * @type {string}
1129
- * @memberof ReportReportingAPI
1130
- */
1131
- description?: string;
1132
- /**
1133
- * Flag indicating whether or not a Report has been marked for deletion.
1134
- * @type {boolean}
1135
- * @memberof ReportReportingAPI
1136
- */
1137
- deleted?: boolean;
1138
- /**
1139
- *
1140
- * @type {ReportLinksReportingAPI}
1141
- * @memberof ReportReportingAPI
1142
- */
1143
- _links?: ReportLinksReportingAPI;
1144
- }
1145
- /**
1146
- * Container for a Report object.
1147
- * @export
1148
- * @interface ReportSingleReportingAPI
1149
- */
1150
- export interface ReportSingleReportingAPI {
1151
- /**
1152
- *
1153
- * @type {ReportReportingAPI}
1154
- * @memberof ReportSingleReportingAPI
1155
- */
1156
- report?: ReportReportingAPI;
1157
- }
1158
- /**
1159
- * Properties of the Report to be updated.
1160
- * @export
1161
- * @interface ReportUpdateReportingAPI
1162
- */
1163
- export interface ReportUpdateReportingAPI {
1164
- /**
1165
- * Name of the Report.
1166
- * @type {string}
1167
- * @memberof ReportUpdateReportingAPI
1168
- */
1169
- displayName?: string;
1170
- /**
1171
- * Description of the Report.
1172
- * @type {string}
1173
- * @memberof ReportUpdateReportingAPI
1174
- */
1175
- description?: string;
1176
- /**
1177
- * Flag indicating whether or not a Report has been marked for deletion.
1178
- * @type {boolean}
1179
- * @memberof ReportUpdateReportingAPI
1180
- */
1181
- deleted?: boolean;
1182
- }
1183
- /**
1184
- * DataAccessApi - fetch parameter creator
1185
- * @export
1186
- */
1187
- export declare const DataAccessApiFetchParamCreator: (configuration?: Configuration | undefined) => {
1188
- /**
1189
- * --- Lists all OData Entities for a Report. This endpoint can be used as an OData feed in applications like Excel or Power BI. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1190
- * @summary OData
1191
- * @param {string} reportId The Report Id.
1192
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1193
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1194
- * @param {*} [options] Override http request option.
1195
- * @throws {RequiredError}
1196
- */
1197
- odata(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1198
- /**
1199
- * --- Lists the raw table data for a Report Entity. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1200
- * @summary OData Entity
1201
- * @param {string} reportId The Report Id.
1202
- * @param {string} region NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1203
- * @param {string} manifestId NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1204
- * @param {string} entityType NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1205
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1206
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1207
- * @param {*} [options] Override http request option.
1208
- * @throws {RequiredError}
1209
- */
1210
- odataEntity(reportId: string, region: string, manifestId: string, entityType: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1211
- /**
1212
- * --- Lists schemas for all Entities tied to a Report. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1213
- * @summary OData Metadata
1214
- * @param {string} reportId The Report Id.
1215
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1216
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1217
- * @param {*} [options] Override http request option.
1218
- * @throws {RequiredError}
1219
- */
1220
- odataMetadata(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1221
- };
1222
- /**
1223
- * DataAccessApi - functional programming interface
1224
- * @export
1225
- */
1226
- export declare const DataAccessApiFp: (configuration?: Configuration | undefined) => {
1227
- /**
1228
- * --- Lists all OData Entities for a Report. This endpoint can be used as an OData feed in applications like Excel or Power BI. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1229
- * @summary OData
1230
- * @param {string} reportId The Report Id.
1231
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1232
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1233
- * @param {*} [options] Override http request option.
1234
- * @throws {RequiredError}
1235
- */
1236
- odata(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ODataResponseReportingAPI>;
1237
- /**
1238
- * --- Lists the raw table data for a Report Entity. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1239
- * @summary OData Entity
1240
- * @param {string} reportId The Report Id.
1241
- * @param {string} region NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1242
- * @param {string} manifestId NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1243
- * @param {string} entityType NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1244
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1245
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1246
- * @param {*} [options] Override http request option.
1247
- * @throws {RequiredError}
1248
- */
1249
- odataEntity(reportId: string, region: string, manifestId: string, entityType: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1250
- /**
1251
- * --- Lists schemas for all Entities tied to a Report. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1252
- * @summary OData Metadata
1253
- * @param {string} reportId The Report Id.
1254
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1255
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1256
- * @param {*} [options] Override http request option.
1257
- * @throws {RequiredError}
1258
- */
1259
- odataMetadata(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1260
- };
1261
- /**
1262
- * DataAccessApi - factory interface
1263
- * @export
1264
- */
1265
- export declare const DataAccessApiFactory: (configuration?: Configuration | undefined, fetch?: FetchAPI | undefined, basePath?: string | undefined) => {
1266
- /**
1267
- * --- Lists all OData Entities for a Report. This endpoint can be used as an OData feed in applications like Excel or Power BI. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1268
- * @summary OData
1269
- * @param {string} reportId The Report Id.
1270
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1271
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1272
- * @param {*} [options] Override http request option.
1273
- * @throws {RequiredError}
1274
- */
1275
- odata(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<ODataResponseReportingAPI>;
1276
- /**
1277
- * --- Lists the raw table data for a Report Entity. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1278
- * @summary OData Entity
1279
- * @param {string} reportId The Report Id.
1280
- * @param {string} region NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1281
- * @param {string} manifestId NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1282
- * @param {string} entityType NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1283
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1284
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1285
- * @param {*} [options] Override http request option.
1286
- * @throws {RequiredError}
1287
- */
1288
- odataEntity(reportId: string, region: string, manifestId: string, entityType: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
1289
- /**
1290
- * --- Lists schemas for all Entities tied to a Report. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1291
- * @summary OData Metadata
1292
- * @param {string} reportId The Report Id.
1293
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1294
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1295
- * @param {*} [options] Override http request option.
1296
- * @throws {RequiredError}
1297
- */
1298
- odataMetadata(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
1299
- };
1300
- /**
1301
- * DataAccessApi - object-oriented interface
1302
- * @export
1303
- * @class DataAccessApi
1304
- * @extends {BaseAPI}
1305
- */
1306
- export declare class DataAccessApi extends BaseAPI {
1307
- /**
1308
- * --- Lists all OData Entities for a Report. This endpoint can be used as an OData feed in applications like Excel or Power BI. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1309
- * @summary OData
1310
- * @param {string} reportId The Report Id.
1311
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1312
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1313
- * @param {*} [options] Override http request option.
1314
- * @throws {RequiredError}
1315
- * @memberof DataAccessApi
1316
- */
1317
- odata(reportId: string, Authorization: string, Accept?: string, options?: any): Promise<ODataResponseReportingAPI>;
1318
- /**
1319
- * --- Lists the raw table data for a Report Entity. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1320
- * @summary OData Entity
1321
- * @param {string} reportId The Report Id.
1322
- * @param {string} region NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1323
- * @param {string} manifestId NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1324
- * @param {string} entityType NOTE: These parameters are not meant to be set manually. Instead use the URLs generated by the OData endpoint directly.
1325
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1326
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1327
- * @param {*} [options] Override http request option.
1328
- * @throws {RequiredError}
1329
- * @memberof DataAccessApi
1330
- */
1331
- odataEntity(reportId: string, region: string, manifestId: string, entityType: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
1332
- /**
1333
- * --- Lists schemas for all Entities tied to a Report. ### Notes This is an OData v4 compliant endpoint. This endpoint should only be accessed using OData compliant libraries and tools such as Power BI. Use of these endpoints directly is not prohibited, however we recommend understanding the [OData protocols and conventions](https://www.odata.org/documentation/) first. ### Authentication Requires `Authorization` header with one of schemes: - Valid [API Key](/apis/insights/api-keys) used as the password in Basic auth. - Valid Bearer token for scope `insights:read`. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1334
- * @summary OData Metadata
1335
- * @param {string} reportId The Report Id.
1336
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1337
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1338
- * @param {*} [options] Override http request option.
1339
- * @throws {RequiredError}
1340
- * @memberof DataAccessApi
1341
- */
1342
- odataMetadata(reportId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
1343
- }
1344
- /**
1345
- * ExtractionApi - fetch parameter creator
1346
- * @export
1347
- */
1348
- export declare const ExtractionApiFetchParamCreator: (configuration?: Configuration | undefined) => {
1349
- /**
1350
- * --- Gets the Status of an Extraction Run. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1351
- * @summary Get Extraction Status
1352
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
1353
- * @param {string} jobId Unique Identifier of the Extraction Run.
1354
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1355
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1356
- * @param {*} [options] Override http request option.
1357
- * @throws {RequiredError}
1358
- */
1359
- getExtractionStatus(imodelId: string, jobId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1360
- /**
1361
- * --- Manually run Extraction of data from an iModel. Latest Named Version is used for Extraction. For the iModel data source, data must be Extracted first before it can be used in your Reports. ### Notes iModel data Extraction is executed automatically after new Named Version is created. Do not call this API on scheduled basis or after making changes to an iModel. Only call this API after creating or changing an iModel Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1362
- * @summary Run Extraction
1363
- * @param {string} imodelId The iModel Id.
1364
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1365
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1366
- * @param {*} [options] Override http request option.
1367
- * @throws {RequiredError}
1368
- */
1369
- runExtraction(imodelId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1370
- };
1371
- /**
1372
- * ExtractionApi - functional programming interface
1373
- * @export
1374
- */
1375
- export declare const ExtractionApiFp: (configuration?: Configuration | undefined) => {
1376
- /**
1377
- * --- Gets the Status of an Extraction Run. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1378
- * @summary Get Extraction Status
1379
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
1380
- * @param {string} jobId Unique Identifier of the Extraction Run.
1381
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1382
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1383
- * @param {*} [options] Override http request option.
1384
- * @throws {RequiredError}
1385
- */
1386
- getExtractionStatus(imodelId: string, jobId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ExtractionStatusReportingAPI>;
1387
- /**
1388
- * --- Manually run Extraction of data from an iModel. Latest Named Version is used for Extraction. For the iModel data source, data must be Extracted first before it can be used in your Reports. ### Notes iModel data Extraction is executed automatically after new Named Version is created. Do not call this API on scheduled basis or after making changes to an iModel. Only call this API after creating or changing an iModel Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1389
- * @summary Run Extraction
1390
- * @param {string} imodelId The iModel Id.
1391
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1392
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1393
- * @param {*} [options] Override http request option.
1394
- * @throws {RequiredError}
1395
- */
1396
- runExtraction(imodelId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ExtractionRunReportingAPI>;
1397
- };
1398
- /**
1399
- * ExtractionApi - factory interface
1400
- * @export
1401
- */
1402
- export declare const ExtractionApiFactory: (configuration?: Configuration | undefined, fetch?: FetchAPI | undefined, basePath?: string | undefined) => {
1403
- /**
1404
- * --- Gets the Status of an Extraction Run. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1405
- * @summary Get Extraction Status
1406
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
1407
- * @param {string} jobId Unique Identifier of the Extraction Run.
1408
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1409
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1410
- * @param {*} [options] Override http request option.
1411
- * @throws {RequiredError}
1412
- */
1413
- getExtractionStatus(imodelId: string, jobId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<ExtractionStatusReportingAPI>;
1414
- /**
1415
- * --- Manually run Extraction of data from an iModel. Latest Named Version is used for Extraction. For the iModel data source, data must be Extracted first before it can be used in your Reports. ### Notes iModel data Extraction is executed automatically after new Named Version is created. Do not call this API on scheduled basis or after making changes to an iModel. Only call this API after creating or changing an iModel Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1416
- * @summary Run Extraction
1417
- * @param {string} imodelId The iModel Id.
1418
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1419
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1420
- * @param {*} [options] Override http request option.
1421
- * @throws {RequiredError}
1422
- */
1423
- runExtraction(imodelId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<ExtractionRunReportingAPI>;
1424
- };
1425
- /**
1426
- * ExtractionApi - object-oriented interface
1427
- * @export
1428
- * @class ExtractionApi
1429
- * @extends {BaseAPI}
1430
- */
1431
- export declare class ExtractionApi extends BaseAPI {
1432
- /**
1433
- * --- Gets the Status of an Extraction Run. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1434
- * @summary Get Extraction Status
1435
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
1436
- * @param {string} jobId Unique Identifier of the Extraction Run.
1437
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1438
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1439
- * @param {*} [options] Override http request option.
1440
- * @throws {RequiredError}
1441
- * @memberof ExtractionApi
1442
- */
1443
- getExtractionStatus(imodelId: string, jobId: string, Authorization: string, Accept?: string, options?: any): Promise<ExtractionStatusReportingAPI>;
1444
- /**
1445
- * --- Manually run Extraction of data from an iModel. Latest Named Version is used for Extraction. For the iModel data source, data must be Extracted first before it can be used in your Reports. ### Notes iModel data Extraction is executed automatically after new Named Version is created. Do not call this API on scheduled basis or after making changes to an iModel. Only call this API after creating or changing an iModel Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1446
- * @summary Run Extraction
1447
- * @param {string} imodelId The iModel Id.
1448
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1449
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1450
- * @param {*} [options] Override http request option.
1451
- * @throws {RequiredError}
1452
- * @memberof ExtractionApi
1453
- */
1454
- runExtraction(imodelId: string, Authorization: string, Accept?: string, options?: any): Promise<ExtractionRunReportingAPI>;
1455
- }
1456
- /**
1457
- * MappingsApi - fetch parameter creator
1458
- * @export
1459
- */
1460
- export declare const MappingsApiFetchParamCreator: (configuration?: Configuration | undefined) => {
1461
- /**
1462
- * --- Copies a Mapping and all its Groups, GroupProperties, CalculatedProperties, and CustomCalculations to a target iModel. The `mappingName` request body property is optional. If the `mappingName` is not provided the new Mapping will have the same name as the source Mapping but with the `_Copy` appendix. If the `mappingName` is provided the new Mapping will have the provided name. The `mappingName` property becomes mandatory if the source Mapping has 124 or more characters in its name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1463
- * @summary Copy Mapping
1464
- * @param {string} imodelId Id of the source Mapping&#x27;s iModel.
1465
- * @param {string} mappingId Id of the source Mapping.
1466
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1467
- * @param {MappingCopyReportingAPI} [body]
1468
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1469
- * @param {*} [options] Override http request option.
1470
- * @throws {RequiredError}
1471
- */
1472
- copyMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingCopyReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1473
- /**
1474
- * --- Creates a CalculatedProperty for a Group. Each CalculatedProperty defines a property or 'column' which is calculated for each element that is returned by the Group's query. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1475
- * @summary Create CalculatedProperty
1476
- * @param {string} imodelId The iModel Id.
1477
- * @param {string} mappingId The Mapping Id.
1478
- * @param {string} groupId Id of the Group for which to create a new CalculatedProperty.
1479
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1480
- * @param {CalculatedPropertyCreateReportingAPI} [body]
1481
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1482
- * @param {*} [options] Override http request option.
1483
- * @throws {RequiredError}
1484
- */
1485
- createCalculatedproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CalculatedPropertyCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1486
- /**
1487
- * --- Creates a CustomCalculation for a Group. Each CustomCalculation defines a column in the output data which is filled with values calculated using the given formula for each element that is returned by the Group's query. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1488
- * @summary Create CustomCalculation
1489
- * @param {string} imodelId The iModel Id.
1490
- * @param {string} mappingId The Mapping Id.
1491
- * @param {string} groupId Id of the Group for which to create a new CustomCalculation.
1492
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1493
- * @param {CustomCalculationCreateReportingAPI} [body]
1494
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1495
- * @param {*} [options] Override http request option.
1496
- * @throws {RequiredError}
1497
- */
1498
- createCustomcalculation(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CustomCalculationCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1499
- /**
1500
- * --- Creates a Group for an iModel data source Mapping. A Group is a collection of design elements from an iModel represented by an [ECSQL](https://www.itwinjs.org/learning/ecsql/) query and defines one table in the output data of a report. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1501
- * @summary Create Group
1502
- * @param {string} imodelId The iModel Id.
1503
- * @param {string} mappingId Id of the Mapping for which to create a new Group.
1504
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1505
- * @param {GroupCreateReportingAPI} [body]
1506
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1507
- * @param {*} [options] Override http request option.
1508
- * @throws {RequiredError}
1509
- */
1510
- createGroup(imodelId: string, mappingId: string, Authorization: string, body?: GroupCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1511
- /**
1512
- * --- Creates a GroupProperty for a Group. Each GroupProperty defines a column of mapped data. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1513
- * @summary Create GroupProperty
1514
- * @param {string} imodelId The iModel Id.
1515
- * @param {string} mappingId The Mapping Id.
1516
- * @param {string} groupId Id of the Group for which to create a new GroupProperty.
1517
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1518
- * @param {GroupPropertyCreateReportingAPI} [body]
1519
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1520
- * @param {*} [options] Override http request option.
1521
- * @throws {RequiredError}
1522
- */
1523
- createGroupproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupPropertyCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1524
- /**
1525
- * --- Creates a Mapping for an iModel. Each Mapping represents a collection of tables (Groups) of data that can be consumed in a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1526
- * @summary Create Mapping
1527
- * @param {string} imodelId Id of the iModel for which to create a new Mapping.
1528
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1529
- * @param {MappingCreateReportingAPI} [body]
1530
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1531
- * @param {*} [options] Override http request option.
1532
- * @throws {RequiredError}
1533
- */
1534
- createMapping(imodelId: string, Authorization: string, body?: MappingCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1535
- /**
1536
- * --- Deletes a CalculatedProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1537
- * @summary Delete CalculatedProperty
1538
- * @param {string} imodelId The iModel Id.
1539
- * @param {string} mappingId The Mapping Id.
1540
- * @param {string} groupId The Group Id.
1541
- * @param {string} propertyId Id of the CalculatedProperty to be deleted.
1542
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1543
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1544
- * @param {*} [options] Override http request option.
1545
- * @throws {RequiredError}
1546
- */
1547
- deleteCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1548
- /**
1549
- * --- Deletes a CustomCalculation from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1550
- * @summary Delete CustomCalculation
1551
- * @param {string} imodelId The iModel Id.
1552
- * @param {string} mappingId The Mapping Id.
1553
- * @param {string} groupId The Group Id.
1554
- * @param {string} customCalculationId Id of the CustomCalculation to be deleted.
1555
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1556
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1557
- * @param {*} [options] Override http request option.
1558
- * @throws {RequiredError}
1559
- */
1560
- deleteCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1561
- /**
1562
- * --- Deletes a Group for a Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1563
- * @summary Delete Group
1564
- * @param {string} imodelId The iModel Id.
1565
- * @param {string} mappingId The Mapping Id.
1566
- * @param {string} groupId Id of the Group to be deleted.
1567
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1568
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1569
- * @param {*} [options] Override http request option.
1570
- * @throws {RequiredError}
1571
- */
1572
- deleteGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1573
- /**
1574
- * --- Deletes a GroupProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1575
- * @summary Delete GroupProperty
1576
- * @param {string} imodelId The iModel Id.
1577
- * @param {string} mappingId The Mapping Id.
1578
- * @param {string} groupId The Group Id.
1579
- * @param {string} propertyId Id of the GroupProperty to be deleted.
1580
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1581
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1582
- * @param {*} [options] Override http request option.
1583
- * @throws {RequiredError}
1584
- */
1585
- deleteGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1586
- /**
1587
- * --- Deletes a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1588
- * @summary Delete Mapping
1589
- * @param {string} imodelId The iModel Id.
1590
- * @param {string} mappingId Id of the Mapping to be deleted.
1591
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1592
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1593
- * @param {*} [options] Override http request option.
1594
- * @throws {RequiredError}
1595
- */
1596
- deleteMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1597
- /**
1598
- * --- Gets all CalculatedProperties for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1599
- * @summary Get CalculatedProperties
1600
- * @param {string} imodelId The iModel Id.
1601
- * @param {string} mappingId The Mapping Id.
1602
- * @param {string} groupId The Group Id.
1603
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1604
- * @param {number} [top] Optional max items to be sent in response.
1605
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1606
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1607
- * @param {*} [options] Override http request option.
1608
- * @throws {RequiredError}
1609
- */
1610
- getCalculatedproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1611
- /**
1612
- * --- Gets a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1613
- * @summary Get CalculatedProperty
1614
- * @param {string} imodelId The iModel Id.
1615
- * @param {string} mappingId The Mapping Id.
1616
- * @param {string} groupId The Group Id.
1617
- * @param {string} propertyId The CalculatedProperty Id.
1618
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1619
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1620
- * @param {*} [options] Override http request option.
1621
- * @throws {RequiredError}
1622
- */
1623
- getCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1624
- /**
1625
- * --- Gets a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1626
- * @summary Get CustomCalculation
1627
- * @param {string} imodelId The iModel Id.
1628
- * @param {string} mappingId The Mapping Id.
1629
- * @param {string} groupId The Group Id.
1630
- * @param {string} customCalculationId The CalculatedProperty Id.
1631
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1632
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1633
- * @param {*} [options] Override http request option.
1634
- * @throws {RequiredError}
1635
- */
1636
- getCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1637
- /**
1638
- * --- Gets all CustomCalculations for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1639
- * @summary Get CustomCalculations
1640
- * @param {string} imodelId The iModel Id.
1641
- * @param {string} mappingId The Mapping Id.
1642
- * @param {string} groupId The Group Id.
1643
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1644
- * @param {number} [top] Optional max items to be sent in response.
1645
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1646
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1647
- * @param {*} [options] Override http request option.
1648
- * @throws {RequiredError}
1649
- */
1650
- getCustomcalculations(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1651
- /**
1652
- * --- Gets a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1653
- * @summary Get Group
1654
- * @param {string} imodelId The iModel Id.
1655
- * @param {string} mappingId The Mapping Id.
1656
- * @param {string} groupId The Group Id.
1657
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1658
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1659
- * @param {*} [options] Override http request option.
1660
- * @throws {RequiredError}
1661
- */
1662
- getGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1663
- /**
1664
- * --- Gets all GroupProperties for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1665
- * @summary Get GroupProperties
1666
- * @param {string} imodelId The iModel Id.
1667
- * @param {string} mappingId The Mapping Id.
1668
- * @param {string} groupId The Group Id.
1669
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1670
- * @param {number} [top] Optional max items to be sent in response.
1671
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1672
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1673
- * @param {*} [options] Override http request option.
1674
- * @throws {RequiredError}
1675
- */
1676
- getGroupproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1677
- /**
1678
- * --- Gets a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1679
- * @summary Get GroupProperty
1680
- * @param {string} imodelId The iModel Id.
1681
- * @param {string} mappingId The Mapping Id.
1682
- * @param {string} groupId The Group Id.
1683
- * @param {string} propertyId The GroupProperty Id.
1684
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1685
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1686
- * @param {*} [options] Override http request option.
1687
- * @throws {RequiredError}
1688
- */
1689
- getGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1690
- /**
1691
- * --- Gets all Groups for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1692
- * @summary Get Groups
1693
- * @param {string} imodelId The iModel Id.
1694
- * @param {string} mappingId The Mapping Id.
1695
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1696
- * @param {number} [top] Optional max items to be sent in response.
1697
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1698
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1699
- * @param {*} [options] Override http request option.
1700
- * @throws {RequiredError}
1701
- */
1702
- getGroups(imodelId: string, mappingId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1703
- /**
1704
- * --- Gets a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1705
- * @summary Get Mapping
1706
- * @param {string} imodelId The iModel Id.
1707
- * @param {string} mappingId The Mapping Id.
1708
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1709
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1710
- * @param {*} [options] Override http request option.
1711
- * @throws {RequiredError}
1712
- */
1713
- getMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
1714
- /**
1715
- * --- Gets all Mappings for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1716
- * @summary Get Mappings
1717
- * @param {string} imodelId The iModel Id.
1718
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1719
- * @param {number} [top] Optional max items to be sent in response.
1720
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1721
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1722
- * @param {*} [options] Override http request option.
1723
- * @throws {RequiredError}
1724
- */
1725
- getMappings(imodelId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1726
- /**
1727
- * --- Updates a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1728
- * @summary Update CalculatedProperty
1729
- * @param {string} imodelId The iModel Id.
1730
- * @param {string} mappingId The Mapping Id.
1731
- * @param {string} groupId The Group Id.
1732
- * @param {string} propertyId Id of the CalculatedProperty to be updated.
1733
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1734
- * @param {CalculatedPropertyUpdateReportingAPI} [body]
1735
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1736
- * @param {*} [options] Override http request option.
1737
- * @throws {RequiredError}
1738
- */
1739
- updateCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: CalculatedPropertyUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1740
- /**
1741
- * --- Updates a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1742
- * @summary Update CustomCalculation
1743
- * @param {string} imodelId The iModel Id.
1744
- * @param {string} mappingId The Mapping Id.
1745
- * @param {string} groupId The Group Id.
1746
- * @param {string} customCalculationId Id of the CustomCalculation to be updated.
1747
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1748
- * @param {CustomCalculationUpdateReportingAPI} [body]
1749
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1750
- * @param {*} [options] Override http request option.
1751
- * @throws {RequiredError}
1752
- */
1753
- updateCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, body?: CustomCalculationUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1754
- /**
1755
- * --- Updates a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1756
- * @summary Update Group
1757
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
1758
- * @param {string} mappingId Globally Unique Identifier of the target Mapping.
1759
- * @param {string} groupId Id of the Group to be updated.
1760
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1761
- * @param {GroupUpdateReportingAPI} [body]
1762
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1763
- * @param {*} [options] Override http request option.
1764
- * @throws {RequiredError}
1765
- */
1766
- updateGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1767
- /**
1768
- * --- Updates a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1769
- * @summary Update GroupProperty
1770
- * @param {string} imodelId The iModel Id.
1771
- * @param {string} mappingId The Mapping Id.
1772
- * @param {string} groupId The Group Id.
1773
- * @param {string} propertyId Id of the GroupProperty to be updated.
1774
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1775
- * @param {GroupPropertyUpdateReportingAPI} [body]
1776
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1777
- * @param {*} [options] Override http request option.
1778
- * @throws {RequiredError}
1779
- */
1780
- updateGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: GroupPropertyUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1781
- /**
1782
- * --- Updates a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1783
- * @summary Update Mapping
1784
- * @param {string} imodelId The iModel Id.
1785
- * @param {string} mappingId Id of the Mapping to be updated.
1786
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1787
- * @param {MappingUpdateReportingAPI} [body]
1788
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1789
- * @param {*} [options] Override http request option.
1790
- * @throws {RequiredError}
1791
- */
1792
- updateMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
1793
- };
1794
- /**
1795
- * MappingsApi - functional programming interface
1796
- * @export
1797
- */
1798
- export declare const MappingsApiFp: (configuration?: Configuration | undefined) => {
1799
- /**
1800
- * --- Copies a Mapping and all its Groups, GroupProperties, CalculatedProperties, and CustomCalculations to a target iModel. The `mappingName` request body property is optional. If the `mappingName` is not provided the new Mapping will have the same name as the source Mapping but with the `_Copy` appendix. If the `mappingName` is provided the new Mapping will have the provided name. The `mappingName` property becomes mandatory if the source Mapping has 124 or more characters in its name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1801
- * @summary Copy Mapping
1802
- * @param {string} imodelId Id of the source Mapping&#x27;s iModel.
1803
- * @param {string} mappingId Id of the source Mapping.
1804
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1805
- * @param {MappingCopyReportingAPI} [body]
1806
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1807
- * @param {*} [options] Override http request option.
1808
- * @throws {RequiredError}
1809
- */
1810
- copyMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingCopyReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<MappingSingleReportingAPI>;
1811
- /**
1812
- * --- Creates a CalculatedProperty for a Group. Each CalculatedProperty defines a property or 'column' which is calculated for each element that is returned by the Group's query. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1813
- * @summary Create CalculatedProperty
1814
- * @param {string} imodelId The iModel Id.
1815
- * @param {string} mappingId The Mapping Id.
1816
- * @param {string} groupId Id of the Group for which to create a new CalculatedProperty.
1817
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1818
- * @param {CalculatedPropertyCreateReportingAPI} [body]
1819
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1820
- * @param {*} [options] Override http request option.
1821
- * @throws {RequiredError}
1822
- */
1823
- createCalculatedproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CalculatedPropertyCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CalculatedPropertySingleReportingAPI>;
1824
- /**
1825
- * --- Creates a CustomCalculation for a Group. Each CustomCalculation defines a column in the output data which is filled with values calculated using the given formula for each element that is returned by the Group's query. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1826
- * @summary Create CustomCalculation
1827
- * @param {string} imodelId The iModel Id.
1828
- * @param {string} mappingId The Mapping Id.
1829
- * @param {string} groupId Id of the Group for which to create a new CustomCalculation.
1830
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1831
- * @param {CustomCalculationCreateReportingAPI} [body]
1832
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1833
- * @param {*} [options] Override http request option.
1834
- * @throws {RequiredError}
1835
- */
1836
- createCustomcalculation(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CustomCalculationCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CustomCalculationSingleReportingAPI>;
1837
- /**
1838
- * --- Creates a Group for an iModel data source Mapping. A Group is a collection of design elements from an iModel represented by an [ECSQL](https://www.itwinjs.org/learning/ecsql/) query and defines one table in the output data of a report. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1839
- * @summary Create Group
1840
- * @param {string} imodelId The iModel Id.
1841
- * @param {string} mappingId Id of the Mapping for which to create a new Group.
1842
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1843
- * @param {GroupCreateReportingAPI} [body]
1844
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1845
- * @param {*} [options] Override http request option.
1846
- * @throws {RequiredError}
1847
- */
1848
- createGroup(imodelId: string, mappingId: string, Authorization: string, body?: GroupCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupSingleReportingAPI>;
1849
- /**
1850
- * --- Creates a GroupProperty for a Group. Each GroupProperty defines a column of mapped data. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1851
- * @summary Create GroupProperty
1852
- * @param {string} imodelId The iModel Id.
1853
- * @param {string} mappingId The Mapping Id.
1854
- * @param {string} groupId Id of the Group for which to create a new GroupProperty.
1855
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1856
- * @param {GroupPropertyCreateReportingAPI} [body]
1857
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1858
- * @param {*} [options] Override http request option.
1859
- * @throws {RequiredError}
1860
- */
1861
- createGroupproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupPropertyCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupPropertySingleReportingAPI>;
1862
- /**
1863
- * --- Creates a Mapping for an iModel. Each Mapping represents a collection of tables (Groups) of data that can be consumed in a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1864
- * @summary Create Mapping
1865
- * @param {string} imodelId Id of the iModel for which to create a new Mapping.
1866
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1867
- * @param {MappingCreateReportingAPI} [body]
1868
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1869
- * @param {*} [options] Override http request option.
1870
- * @throws {RequiredError}
1871
- */
1872
- createMapping(imodelId: string, Authorization: string, body?: MappingCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<MappingSingleReportingAPI>;
1873
- /**
1874
- * --- Deletes a CalculatedProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1875
- * @summary Delete CalculatedProperty
1876
- * @param {string} imodelId The iModel Id.
1877
- * @param {string} mappingId The Mapping Id.
1878
- * @param {string} groupId The Group Id.
1879
- * @param {string} propertyId Id of the CalculatedProperty to be deleted.
1880
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1881
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1882
- * @param {*} [options] Override http request option.
1883
- * @throws {RequiredError}
1884
- */
1885
- deleteCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1886
- /**
1887
- * --- Deletes a CustomCalculation from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1888
- * @summary Delete CustomCalculation
1889
- * @param {string} imodelId The iModel Id.
1890
- * @param {string} mappingId The Mapping Id.
1891
- * @param {string} groupId The Group Id.
1892
- * @param {string} customCalculationId Id of the CustomCalculation to be deleted.
1893
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1894
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1895
- * @param {*} [options] Override http request option.
1896
- * @throws {RequiredError}
1897
- */
1898
- deleteCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1899
- /**
1900
- * --- Deletes a Group for a Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1901
- * @summary Delete Group
1902
- * @param {string} imodelId The iModel Id.
1903
- * @param {string} mappingId The Mapping Id.
1904
- * @param {string} groupId Id of the Group to be deleted.
1905
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1906
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1907
- * @param {*} [options] Override http request option.
1908
- * @throws {RequiredError}
1909
- */
1910
- deleteGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1911
- /**
1912
- * --- Deletes a GroupProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1913
- * @summary Delete GroupProperty
1914
- * @param {string} imodelId The iModel Id.
1915
- * @param {string} mappingId The Mapping Id.
1916
- * @param {string} groupId The Group Id.
1917
- * @param {string} propertyId Id of the GroupProperty to be deleted.
1918
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1919
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1920
- * @param {*} [options] Override http request option.
1921
- * @throws {RequiredError}
1922
- */
1923
- deleteGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1924
- /**
1925
- * --- Deletes a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1926
- * @summary Delete Mapping
1927
- * @param {string} imodelId The iModel Id.
1928
- * @param {string} mappingId Id of the Mapping to be deleted.
1929
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
1930
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1931
- * @param {*} [options] Override http request option.
1932
- * @throws {RequiredError}
1933
- */
1934
- deleteMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
1935
- /**
1936
- * --- Gets all CalculatedProperties for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1937
- * @summary Get CalculatedProperties
1938
- * @param {string} imodelId The iModel Id.
1939
- * @param {string} mappingId The Mapping Id.
1940
- * @param {string} groupId The Group Id.
1941
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1942
- * @param {number} [top] Optional max items to be sent in response.
1943
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1944
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1945
- * @param {*} [options] Override http request option.
1946
- * @throws {RequiredError}
1947
- */
1948
- getCalculatedproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CalculatedPropertyCollectionReportingAPI>;
1949
- /**
1950
- * --- Gets a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1951
- * @summary Get CalculatedProperty
1952
- * @param {string} imodelId The iModel Id.
1953
- * @param {string} mappingId The Mapping Id.
1954
- * @param {string} groupId The Group Id.
1955
- * @param {string} propertyId The CalculatedProperty Id.
1956
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1957
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1958
- * @param {*} [options] Override http request option.
1959
- * @throws {RequiredError}
1960
- */
1961
- getCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CalculatedPropertySingleReportingAPI>;
1962
- /**
1963
- * --- Gets a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1964
- * @summary Get CustomCalculation
1965
- * @param {string} imodelId The iModel Id.
1966
- * @param {string} mappingId The Mapping Id.
1967
- * @param {string} groupId The Group Id.
1968
- * @param {string} customCalculationId The CalculatedProperty Id.
1969
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1970
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1971
- * @param {*} [options] Override http request option.
1972
- * @throws {RequiredError}
1973
- */
1974
- getCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CustomCalculationSingleReportingAPI>;
1975
- /**
1976
- * --- Gets all CustomCalculations for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1977
- * @summary Get CustomCalculations
1978
- * @param {string} imodelId The iModel Id.
1979
- * @param {string} mappingId The Mapping Id.
1980
- * @param {string} groupId The Group Id.
1981
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1982
- * @param {number} [top] Optional max items to be sent in response.
1983
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
1984
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1985
- * @param {*} [options] Override http request option.
1986
- * @throws {RequiredError}
1987
- */
1988
- getCustomcalculations(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CustomCalculationCollectionReportingAPI>;
1989
- /**
1990
- * --- Gets a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
1991
- * @summary Get Group
1992
- * @param {string} imodelId The iModel Id.
1993
- * @param {string} mappingId The Mapping Id.
1994
- * @param {string} groupId The Group Id.
1995
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
1996
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
1997
- * @param {*} [options] Override http request option.
1998
- * @throws {RequiredError}
1999
- */
2000
- getGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupSingleReportingAPI>;
2001
- /**
2002
- * --- Gets all GroupProperties for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2003
- * @summary Get GroupProperties
2004
- * @param {string} imodelId The iModel Id.
2005
- * @param {string} mappingId The Mapping Id.
2006
- * @param {string} groupId The Group Id.
2007
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2008
- * @param {number} [top] Optional max items to be sent in response.
2009
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2010
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2011
- * @param {*} [options] Override http request option.
2012
- * @throws {RequiredError}
2013
- */
2014
- getGroupproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupPropertyCollectionReportingAPI>;
2015
- /**
2016
- * --- Gets a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2017
- * @summary Get GroupProperty
2018
- * @param {string} imodelId The iModel Id.
2019
- * @param {string} mappingId The Mapping Id.
2020
- * @param {string} groupId The Group Id.
2021
- * @param {string} propertyId The GroupProperty Id.
2022
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2023
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2024
- * @param {*} [options] Override http request option.
2025
- * @throws {RequiredError}
2026
- */
2027
- getGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupPropertySingleReportingAPI>;
2028
- /**
2029
- * --- Gets all Groups for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2030
- * @summary Get Groups
2031
- * @param {string} imodelId The iModel Id.
2032
- * @param {string} mappingId The Mapping Id.
2033
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2034
- * @param {number} [top] Optional max items to be sent in response.
2035
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2036
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2037
- * @param {*} [options] Override http request option.
2038
- * @throws {RequiredError}
2039
- */
2040
- getGroups(imodelId: string, mappingId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupCollectionReportingAPI>;
2041
- /**
2042
- * --- Gets a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2043
- * @summary Get Mapping
2044
- * @param {string} imodelId The iModel Id.
2045
- * @param {string} mappingId The Mapping Id.
2046
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2047
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2048
- * @param {*} [options] Override http request option.
2049
- * @throws {RequiredError}
2050
- */
2051
- getMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<MappingSingleReportingAPI>;
2052
- /**
2053
- * --- Gets all Mappings for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2054
- * @summary Get Mappings
2055
- * @param {string} imodelId The iModel Id.
2056
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2057
- * @param {number} [top] Optional max items to be sent in response.
2058
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2059
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2060
- * @param {*} [options] Override http request option.
2061
- * @throws {RequiredError}
2062
- */
2063
- getMappings(imodelId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<MappingCollectionReportingAPI>;
2064
- /**
2065
- * --- Updates a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2066
- * @summary Update CalculatedProperty
2067
- * @param {string} imodelId The iModel Id.
2068
- * @param {string} mappingId The Mapping Id.
2069
- * @param {string} groupId The Group Id.
2070
- * @param {string} propertyId Id of the CalculatedProperty to be updated.
2071
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2072
- * @param {CalculatedPropertyUpdateReportingAPI} [body]
2073
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2074
- * @param {*} [options] Override http request option.
2075
- * @throws {RequiredError}
2076
- */
2077
- updateCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: CalculatedPropertyUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CalculatedPropertySingleReportingAPI>;
2078
- /**
2079
- * --- Updates a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2080
- * @summary Update CustomCalculation
2081
- * @param {string} imodelId The iModel Id.
2082
- * @param {string} mappingId The Mapping Id.
2083
- * @param {string} groupId The Group Id.
2084
- * @param {string} customCalculationId Id of the CustomCalculation to be updated.
2085
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2086
- * @param {CustomCalculationUpdateReportingAPI} [body]
2087
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2088
- * @param {*} [options] Override http request option.
2089
- * @throws {RequiredError}
2090
- */
2091
- updateCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, body?: CustomCalculationUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<CustomCalculationSingleReportingAPI>;
2092
- /**
2093
- * --- Updates a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2094
- * @summary Update Group
2095
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
2096
- * @param {string} mappingId Globally Unique Identifier of the target Mapping.
2097
- * @param {string} groupId Id of the Group to be updated.
2098
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2099
- * @param {GroupUpdateReportingAPI} [body]
2100
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2101
- * @param {*} [options] Override http request option.
2102
- * @throws {RequiredError}
2103
- */
2104
- updateGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupSingleReportingAPI>;
2105
- /**
2106
- * --- Updates a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2107
- * @summary Update GroupProperty
2108
- * @param {string} imodelId The iModel Id.
2109
- * @param {string} mappingId The Mapping Id.
2110
- * @param {string} groupId The Group Id.
2111
- * @param {string} propertyId Id of the GroupProperty to be updated.
2112
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2113
- * @param {GroupPropertyUpdateReportingAPI} [body]
2114
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2115
- * @param {*} [options] Override http request option.
2116
- * @throws {RequiredError}
2117
- */
2118
- updateGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: GroupPropertyUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<GroupPropertySingleReportingAPI>;
2119
- /**
2120
- * --- Updates a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2121
- * @summary Update Mapping
2122
- * @param {string} imodelId The iModel Id.
2123
- * @param {string} mappingId Id of the Mapping to be updated.
2124
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2125
- * @param {MappingUpdateReportingAPI} [body]
2126
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2127
- * @param {*} [options] Override http request option.
2128
- * @throws {RequiredError}
2129
- */
2130
- updateMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<MappingSingleReportingAPI>;
2131
- };
2132
- /**
2133
- * MappingsApi - factory interface
2134
- * @export
2135
- */
2136
- export declare const MappingsApiFactory: (configuration?: Configuration | undefined, fetch?: FetchAPI | undefined, basePath?: string | undefined) => {
2137
- /**
2138
- * --- Copies a Mapping and all its Groups, GroupProperties, CalculatedProperties, and CustomCalculations to a target iModel. The `mappingName` request body property is optional. If the `mappingName` is not provided the new Mapping will have the same name as the source Mapping but with the `_Copy` appendix. If the `mappingName` is provided the new Mapping will have the provided name. The `mappingName` property becomes mandatory if the source Mapping has 124 or more characters in its name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2139
- * @summary Copy Mapping
2140
- * @param {string} imodelId Id of the source Mapping&#x27;s iModel.
2141
- * @param {string} mappingId Id of the source Mapping.
2142
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2143
- * @param {MappingCopyReportingAPI} [body]
2144
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2145
- * @param {*} [options] Override http request option.
2146
- * @throws {RequiredError}
2147
- */
2148
- copyMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingCopyReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<MappingSingleReportingAPI>;
2149
- /**
2150
- * --- Creates a CalculatedProperty for a Group. Each CalculatedProperty defines a property or 'column' which is calculated for each element that is returned by the Group's query. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2151
- * @summary Create CalculatedProperty
2152
- * @param {string} imodelId The iModel Id.
2153
- * @param {string} mappingId The Mapping Id.
2154
- * @param {string} groupId Id of the Group for which to create a new CalculatedProperty.
2155
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2156
- * @param {CalculatedPropertyCreateReportingAPI} [body]
2157
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2158
- * @param {*} [options] Override http request option.
2159
- * @throws {RequiredError}
2160
- */
2161
- createCalculatedproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CalculatedPropertyCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<CalculatedPropertySingleReportingAPI>;
2162
- /**
2163
- * --- Creates a CustomCalculation for a Group. Each CustomCalculation defines a column in the output data which is filled with values calculated using the given formula for each element that is returned by the Group's query. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2164
- * @summary Create CustomCalculation
2165
- * @param {string} imodelId The iModel Id.
2166
- * @param {string} mappingId The Mapping Id.
2167
- * @param {string} groupId Id of the Group for which to create a new CustomCalculation.
2168
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2169
- * @param {CustomCalculationCreateReportingAPI} [body]
2170
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2171
- * @param {*} [options] Override http request option.
2172
- * @throws {RequiredError}
2173
- */
2174
- createCustomcalculation(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CustomCalculationCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<CustomCalculationSingleReportingAPI>;
2175
- /**
2176
- * --- Creates a Group for an iModel data source Mapping. A Group is a collection of design elements from an iModel represented by an [ECSQL](https://www.itwinjs.org/learning/ecsql/) query and defines one table in the output data of a report. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2177
- * @summary Create Group
2178
- * @param {string} imodelId The iModel Id.
2179
- * @param {string} mappingId Id of the Mapping for which to create a new Group.
2180
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2181
- * @param {GroupCreateReportingAPI} [body]
2182
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2183
- * @param {*} [options] Override http request option.
2184
- * @throws {RequiredError}
2185
- */
2186
- createGroup(imodelId: string, mappingId: string, Authorization: string, body?: GroupCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<GroupSingleReportingAPI>;
2187
- /**
2188
- * --- Creates a GroupProperty for a Group. Each GroupProperty defines a column of mapped data. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2189
- * @summary Create GroupProperty
2190
- * @param {string} imodelId The iModel Id.
2191
- * @param {string} mappingId The Mapping Id.
2192
- * @param {string} groupId Id of the Group for which to create a new GroupProperty.
2193
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2194
- * @param {GroupPropertyCreateReportingAPI} [body]
2195
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2196
- * @param {*} [options] Override http request option.
2197
- * @throws {RequiredError}
2198
- */
2199
- createGroupproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupPropertyCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<GroupPropertySingleReportingAPI>;
2200
- /**
2201
- * --- Creates a Mapping for an iModel. Each Mapping represents a collection of tables (Groups) of data that can be consumed in a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2202
- * @summary Create Mapping
2203
- * @param {string} imodelId Id of the iModel for which to create a new Mapping.
2204
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2205
- * @param {MappingCreateReportingAPI} [body]
2206
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2207
- * @param {*} [options] Override http request option.
2208
- * @throws {RequiredError}
2209
- */
2210
- createMapping(imodelId: string, Authorization: string, body?: MappingCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<MappingSingleReportingAPI>;
2211
- /**
2212
- * --- Deletes a CalculatedProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2213
- * @summary Delete CalculatedProperty
2214
- * @param {string} imodelId The iModel Id.
2215
- * @param {string} mappingId The Mapping Id.
2216
- * @param {string} groupId The Group Id.
2217
- * @param {string} propertyId Id of the CalculatedProperty to be deleted.
2218
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2219
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2220
- * @param {*} [options] Override http request option.
2221
- * @throws {RequiredError}
2222
- */
2223
- deleteCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
2224
- /**
2225
- * --- Deletes a CustomCalculation from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2226
- * @summary Delete CustomCalculation
2227
- * @param {string} imodelId The iModel Id.
2228
- * @param {string} mappingId The Mapping Id.
2229
- * @param {string} groupId The Group Id.
2230
- * @param {string} customCalculationId Id of the CustomCalculation to be deleted.
2231
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2232
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2233
- * @param {*} [options] Override http request option.
2234
- * @throws {RequiredError}
2235
- */
2236
- deleteCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
2237
- /**
2238
- * --- Deletes a Group for a Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2239
- * @summary Delete Group
2240
- * @param {string} imodelId The iModel Id.
2241
- * @param {string} mappingId The Mapping Id.
2242
- * @param {string} groupId Id of the Group to be deleted.
2243
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2244
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2245
- * @param {*} [options] Override http request option.
2246
- * @throws {RequiredError}
2247
- */
2248
- deleteGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
2249
- /**
2250
- * --- Deletes a GroupProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2251
- * @summary Delete GroupProperty
2252
- * @param {string} imodelId The iModel Id.
2253
- * @param {string} mappingId The Mapping Id.
2254
- * @param {string} groupId The Group Id.
2255
- * @param {string} propertyId Id of the GroupProperty to be deleted.
2256
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2257
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2258
- * @param {*} [options] Override http request option.
2259
- * @throws {RequiredError}
2260
- */
2261
- deleteGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
2262
- /**
2263
- * --- Deletes a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2264
- * @summary Delete Mapping
2265
- * @param {string} imodelId The iModel Id.
2266
- * @param {string} mappingId Id of the Mapping to be deleted.
2267
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2268
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2269
- * @param {*} [options] Override http request option.
2270
- * @throws {RequiredError}
2271
- */
2272
- deleteMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
2273
- /**
2274
- * --- Gets all CalculatedProperties for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2275
- * @summary Get CalculatedProperties
2276
- * @param {string} imodelId The iModel Id.
2277
- * @param {string} mappingId The Mapping Id.
2278
- * @param {string} groupId The Group Id.
2279
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2280
- * @param {number} [top] Optional max items to be sent in response.
2281
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2282
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2283
- * @param {*} [options] Override http request option.
2284
- * @throws {RequiredError}
2285
- */
2286
- getCalculatedproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): Promise<CalculatedPropertyCollectionReportingAPI>;
2287
- /**
2288
- * --- Gets a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2289
- * @summary Get CalculatedProperty
2290
- * @param {string} imodelId The iModel Id.
2291
- * @param {string} mappingId The Mapping Id.
2292
- * @param {string} groupId The Group Id.
2293
- * @param {string} propertyId The CalculatedProperty Id.
2294
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2295
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2296
- * @param {*} [options] Override http request option.
2297
- * @throws {RequiredError}
2298
- */
2299
- getCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<CalculatedPropertySingleReportingAPI>;
2300
- /**
2301
- * --- Gets a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2302
- * @summary Get CustomCalculation
2303
- * @param {string} imodelId The iModel Id.
2304
- * @param {string} mappingId The Mapping Id.
2305
- * @param {string} groupId The Group Id.
2306
- * @param {string} customCalculationId The CalculatedProperty Id.
2307
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2308
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2309
- * @param {*} [options] Override http request option.
2310
- * @throws {RequiredError}
2311
- */
2312
- getCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<CustomCalculationSingleReportingAPI>;
2313
- /**
2314
- * --- Gets all CustomCalculations for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2315
- * @summary Get CustomCalculations
2316
- * @param {string} imodelId The iModel Id.
2317
- * @param {string} mappingId The Mapping Id.
2318
- * @param {string} groupId The Group Id.
2319
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2320
- * @param {number} [top] Optional max items to be sent in response.
2321
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2322
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2323
- * @param {*} [options] Override http request option.
2324
- * @throws {RequiredError}
2325
- */
2326
- getCustomcalculations(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): Promise<CustomCalculationCollectionReportingAPI>;
2327
- /**
2328
- * --- Gets a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2329
- * @summary Get Group
2330
- * @param {string} imodelId The iModel Id.
2331
- * @param {string} mappingId The Mapping Id.
2332
- * @param {string} groupId The Group Id.
2333
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2334
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2335
- * @param {*} [options] Override http request option.
2336
- * @throws {RequiredError}
2337
- */
2338
- getGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<GroupSingleReportingAPI>;
2339
- /**
2340
- * --- Gets all GroupProperties for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2341
- * @summary Get GroupProperties
2342
- * @param {string} imodelId The iModel Id.
2343
- * @param {string} mappingId The Mapping Id.
2344
- * @param {string} groupId The Group Id.
2345
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2346
- * @param {number} [top] Optional max items to be sent in response.
2347
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2348
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2349
- * @param {*} [options] Override http request option.
2350
- * @throws {RequiredError}
2351
- */
2352
- getGroupproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): Promise<GroupPropertyCollectionReportingAPI>;
2353
- /**
2354
- * --- Gets a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2355
- * @summary Get GroupProperty
2356
- * @param {string} imodelId The iModel Id.
2357
- * @param {string} mappingId The Mapping Id.
2358
- * @param {string} groupId The Group Id.
2359
- * @param {string} propertyId The GroupProperty Id.
2360
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2361
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2362
- * @param {*} [options] Override http request option.
2363
- * @throws {RequiredError}
2364
- */
2365
- getGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<GroupPropertySingleReportingAPI>;
2366
- /**
2367
- * --- Gets all Groups for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2368
- * @summary Get Groups
2369
- * @param {string} imodelId The iModel Id.
2370
- * @param {string} mappingId The Mapping Id.
2371
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2372
- * @param {number} [top] Optional max items to be sent in response.
2373
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2374
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2375
- * @param {*} [options] Override http request option.
2376
- * @throws {RequiredError}
2377
- */
2378
- getGroups(imodelId: string, mappingId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): Promise<GroupCollectionReportingAPI>;
2379
- /**
2380
- * --- Gets a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2381
- * @summary Get Mapping
2382
- * @param {string} imodelId The iModel Id.
2383
- * @param {string} mappingId The Mapping Id.
2384
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2385
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2386
- * @param {*} [options] Override http request option.
2387
- * @throws {RequiredError}
2388
- */
2389
- getMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<MappingSingleReportingAPI>;
2390
- /**
2391
- * --- Gets all Mappings for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2392
- * @summary Get Mappings
2393
- * @param {string} imodelId The iModel Id.
2394
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2395
- * @param {number} [top] Optional max items to be sent in response.
2396
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2397
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2398
- * @param {*} [options] Override http request option.
2399
- * @throws {RequiredError}
2400
- */
2401
- getMappings(imodelId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): Promise<MappingCollectionReportingAPI>;
2402
- /**
2403
- * --- Updates a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2404
- * @summary Update CalculatedProperty
2405
- * @param {string} imodelId The iModel Id.
2406
- * @param {string} mappingId The Mapping Id.
2407
- * @param {string} groupId The Group Id.
2408
- * @param {string} propertyId Id of the CalculatedProperty to be updated.
2409
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2410
- * @param {CalculatedPropertyUpdateReportingAPI} [body]
2411
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2412
- * @param {*} [options] Override http request option.
2413
- * @throws {RequiredError}
2414
- */
2415
- updateCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: CalculatedPropertyUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<CalculatedPropertySingleReportingAPI>;
2416
- /**
2417
- * --- Updates a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2418
- * @summary Update CustomCalculation
2419
- * @param {string} imodelId The iModel Id.
2420
- * @param {string} mappingId The Mapping Id.
2421
- * @param {string} groupId The Group Id.
2422
- * @param {string} customCalculationId Id of the CustomCalculation to be updated.
2423
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2424
- * @param {CustomCalculationUpdateReportingAPI} [body]
2425
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2426
- * @param {*} [options] Override http request option.
2427
- * @throws {RequiredError}
2428
- */
2429
- updateCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, body?: CustomCalculationUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<CustomCalculationSingleReportingAPI>;
2430
- /**
2431
- * --- Updates a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2432
- * @summary Update Group
2433
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
2434
- * @param {string} mappingId Globally Unique Identifier of the target Mapping.
2435
- * @param {string} groupId Id of the Group to be updated.
2436
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2437
- * @param {GroupUpdateReportingAPI} [body]
2438
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2439
- * @param {*} [options] Override http request option.
2440
- * @throws {RequiredError}
2441
- */
2442
- updateGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<GroupSingleReportingAPI>;
2443
- /**
2444
- * --- Updates a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2445
- * @summary Update GroupProperty
2446
- * @param {string} imodelId The iModel Id.
2447
- * @param {string} mappingId The Mapping Id.
2448
- * @param {string} groupId The Group Id.
2449
- * @param {string} propertyId Id of the GroupProperty to be updated.
2450
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2451
- * @param {GroupPropertyUpdateReportingAPI} [body]
2452
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2453
- * @param {*} [options] Override http request option.
2454
- * @throws {RequiredError}
2455
- */
2456
- updateGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: GroupPropertyUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<GroupPropertySingleReportingAPI>;
2457
- /**
2458
- * --- Updates a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2459
- * @summary Update Mapping
2460
- * @param {string} imodelId The iModel Id.
2461
- * @param {string} mappingId Id of the Mapping to be updated.
2462
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2463
- * @param {MappingUpdateReportingAPI} [body]
2464
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2465
- * @param {*} [options] Override http request option.
2466
- * @throws {RequiredError}
2467
- */
2468
- updateMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<MappingSingleReportingAPI>;
2469
- };
2470
- /**
2471
- * MappingsApi - object-oriented interface
2472
- * @export
2473
- * @class MappingsApi
2474
- * @extends {BaseAPI}
2475
- */
2476
- export declare class MappingsApi extends BaseAPI {
2477
- /**
2478
- * --- Copies a Mapping and all its Groups, GroupProperties, CalculatedProperties, and CustomCalculations to a target iModel. The `mappingName` request body property is optional. If the `mappingName` is not provided the new Mapping will have the same name as the source Mapping but with the `_Copy` appendix. If the `mappingName` is provided the new Mapping will have the provided name. The `mappingName` property becomes mandatory if the source Mapping has 124 or more characters in its name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2479
- * @summary Copy Mapping
2480
- * @param {string} imodelId Id of the source Mapping&#x27;s iModel.
2481
- * @param {string} mappingId Id of the source Mapping.
2482
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2483
- * @param {MappingCopyReportingAPI} [body]
2484
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2485
- * @param {*} [options] Override http request option.
2486
- * @throws {RequiredError}
2487
- * @memberof MappingsApi
2488
- */
2489
- copyMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingCopyReportingAPI, Accept?: string, options?: any): Promise<MappingSingleReportingAPI>;
2490
- /**
2491
- * --- Creates a CalculatedProperty for a Group. Each CalculatedProperty defines a property or 'column' which is calculated for each element that is returned by the Group's query. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2492
- * @summary Create CalculatedProperty
2493
- * @param {string} imodelId The iModel Id.
2494
- * @param {string} mappingId The Mapping Id.
2495
- * @param {string} groupId Id of the Group for which to create a new CalculatedProperty.
2496
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2497
- * @param {CalculatedPropertyCreateReportingAPI} [body]
2498
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2499
- * @param {*} [options] Override http request option.
2500
- * @throws {RequiredError}
2501
- * @memberof MappingsApi
2502
- */
2503
- createCalculatedproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CalculatedPropertyCreateReportingAPI, Accept?: string, options?: any): Promise<CalculatedPropertySingleReportingAPI>;
2504
- /**
2505
- * --- Creates a CustomCalculation for a Group. Each CustomCalculation defines a column in the output data which is filled with values calculated using the given formula for each element that is returned by the Group's query. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2506
- * @summary Create CustomCalculation
2507
- * @param {string} imodelId The iModel Id.
2508
- * @param {string} mappingId The Mapping Id.
2509
- * @param {string} groupId Id of the Group for which to create a new CustomCalculation.
2510
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2511
- * @param {CustomCalculationCreateReportingAPI} [body]
2512
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2513
- * @param {*} [options] Override http request option.
2514
- * @throws {RequiredError}
2515
- * @memberof MappingsApi
2516
- */
2517
- createCustomcalculation(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: CustomCalculationCreateReportingAPI, Accept?: string, options?: any): Promise<CustomCalculationSingleReportingAPI>;
2518
- /**
2519
- * --- Creates a Group for an iModel data source Mapping. A Group is a collection of design elements from an iModel represented by an [ECSQL](https://www.itwinjs.org/learning/ecsql/) query and defines one table in the output data of a report. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2520
- * @summary Create Group
2521
- * @param {string} imodelId The iModel Id.
2522
- * @param {string} mappingId Id of the Mapping for which to create a new Group.
2523
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2524
- * @param {GroupCreateReportingAPI} [body]
2525
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2526
- * @param {*} [options] Override http request option.
2527
- * @throws {RequiredError}
2528
- * @memberof MappingsApi
2529
- */
2530
- createGroup(imodelId: string, mappingId: string, Authorization: string, body?: GroupCreateReportingAPI, Accept?: string, options?: any): Promise<GroupSingleReportingAPI>;
2531
- /**
2532
- * --- Creates a GroupProperty for a Group. Each GroupProperty defines a column of mapped data. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2533
- * @summary Create GroupProperty
2534
- * @param {string} imodelId The iModel Id.
2535
- * @param {string} mappingId The Mapping Id.
2536
- * @param {string} groupId Id of the Group for which to create a new GroupProperty.
2537
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2538
- * @param {GroupPropertyCreateReportingAPI} [body]
2539
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2540
- * @param {*} [options] Override http request option.
2541
- * @throws {RequiredError}
2542
- * @memberof MappingsApi
2543
- */
2544
- createGroupproperty(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupPropertyCreateReportingAPI, Accept?: string, options?: any): Promise<GroupPropertySingleReportingAPI>;
2545
- /**
2546
- * --- Creates a Mapping for an iModel. Each Mapping represents a collection of tables (Groups) of data that can be consumed in a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2547
- * @summary Create Mapping
2548
- * @param {string} imodelId Id of the iModel for which to create a new Mapping.
2549
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2550
- * @param {MappingCreateReportingAPI} [body]
2551
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2552
- * @param {*} [options] Override http request option.
2553
- * @throws {RequiredError}
2554
- * @memberof MappingsApi
2555
- */
2556
- createMapping(imodelId: string, Authorization: string, body?: MappingCreateReportingAPI, Accept?: string, options?: any): Promise<MappingSingleReportingAPI>;
2557
- /**
2558
- * --- Deletes a CalculatedProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2559
- * @summary Delete CalculatedProperty
2560
- * @param {string} imodelId The iModel Id.
2561
- * @param {string} mappingId The Mapping Id.
2562
- * @param {string} groupId The Group Id.
2563
- * @param {string} propertyId Id of the CalculatedProperty to be deleted.
2564
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2565
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2566
- * @param {*} [options] Override http request option.
2567
- * @throws {RequiredError}
2568
- * @memberof MappingsApi
2569
- */
2570
- deleteCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
2571
- /**
2572
- * --- Deletes a CustomCalculation from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2573
- * @summary Delete CustomCalculation
2574
- * @param {string} imodelId The iModel Id.
2575
- * @param {string} mappingId The Mapping Id.
2576
- * @param {string} groupId The Group Id.
2577
- * @param {string} customCalculationId Id of the CustomCalculation to be deleted.
2578
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2579
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2580
- * @param {*} [options] Override http request option.
2581
- * @throws {RequiredError}
2582
- * @memberof MappingsApi
2583
- */
2584
- deleteCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
2585
- /**
2586
- * --- Deletes a Group for a Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2587
- * @summary Delete Group
2588
- * @param {string} imodelId The iModel Id.
2589
- * @param {string} mappingId The Mapping Id.
2590
- * @param {string} groupId Id of the Group to be deleted.
2591
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2592
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2593
- * @param {*} [options] Override http request option.
2594
- * @throws {RequiredError}
2595
- * @memberof MappingsApi
2596
- */
2597
- deleteGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
2598
- /**
2599
- * --- Deletes a GroupProperty from a Group. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2600
- * @summary Delete GroupProperty
2601
- * @param {string} imodelId The iModel Id.
2602
- * @param {string} mappingId The Mapping Id.
2603
- * @param {string} groupId The Group Id.
2604
- * @param {string} propertyId Id of the GroupProperty to be deleted.
2605
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2606
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2607
- * @param {*} [options] Override http request option.
2608
- * @throws {RequiredError}
2609
- * @memberof MappingsApi
2610
- */
2611
- deleteGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
2612
- /**
2613
- * --- Deletes a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2614
- * @summary Delete Mapping
2615
- * @param {string} imodelId The iModel Id.
2616
- * @param {string} mappingId Id of the Mapping to be deleted.
2617
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2618
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2619
- * @param {*} [options] Override http request option.
2620
- * @throws {RequiredError}
2621
- * @memberof MappingsApi
2622
- */
2623
- deleteMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
2624
- /**
2625
- * --- Gets all CalculatedProperties for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2626
- * @summary Get CalculatedProperties
2627
- * @param {string} imodelId The iModel Id.
2628
- * @param {string} mappingId The Mapping Id.
2629
- * @param {string} groupId The Group Id.
2630
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2631
- * @param {number} [top] Optional max items to be sent in response.
2632
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2633
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2634
- * @param {*} [options] Override http request option.
2635
- * @throws {RequiredError}
2636
- * @memberof MappingsApi
2637
- */
2638
- getCalculatedproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number, continuationToken?: string, Accept?: string, options?: any): Promise<CalculatedPropertyCollectionReportingAPI>;
2639
- /**
2640
- * --- Gets a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2641
- * @summary Get CalculatedProperty
2642
- * @param {string} imodelId The iModel Id.
2643
- * @param {string} mappingId The Mapping Id.
2644
- * @param {string} groupId The Group Id.
2645
- * @param {string} propertyId The CalculatedProperty Id.
2646
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2647
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2648
- * @param {*} [options] Override http request option.
2649
- * @throws {RequiredError}
2650
- * @memberof MappingsApi
2651
- */
2652
- getCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string, options?: any): Promise<CalculatedPropertySingleReportingAPI>;
2653
- /**
2654
- * --- Gets a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2655
- * @summary Get CustomCalculation
2656
- * @param {string} imodelId The iModel Id.
2657
- * @param {string} mappingId The Mapping Id.
2658
- * @param {string} groupId The Group Id.
2659
- * @param {string} customCalculationId The CalculatedProperty Id.
2660
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2661
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2662
- * @param {*} [options] Override http request option.
2663
- * @throws {RequiredError}
2664
- * @memberof MappingsApi
2665
- */
2666
- getCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, Accept?: string, options?: any): Promise<CustomCalculationSingleReportingAPI>;
2667
- /**
2668
- * --- Gets all CustomCalculations for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2669
- * @summary Get CustomCalculations
2670
- * @param {string} imodelId The iModel Id.
2671
- * @param {string} mappingId The Mapping Id.
2672
- * @param {string} groupId The Group Id.
2673
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2674
- * @param {number} [top] Optional max items to be sent in response.
2675
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2676
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2677
- * @param {*} [options] Override http request option.
2678
- * @throws {RequiredError}
2679
- * @memberof MappingsApi
2680
- */
2681
- getCustomcalculations(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number, continuationToken?: string, Accept?: string, options?: any): Promise<CustomCalculationCollectionReportingAPI>;
2682
- /**
2683
- * --- Gets a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2684
- * @summary Get Group
2685
- * @param {string} imodelId The iModel Id.
2686
- * @param {string} mappingId The Mapping Id.
2687
- * @param {string} groupId The Group Id.
2688
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2689
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2690
- * @param {*} [options] Override http request option.
2691
- * @throws {RequiredError}
2692
- * @memberof MappingsApi
2693
- */
2694
- getGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, Accept?: string, options?: any): Promise<GroupSingleReportingAPI>;
2695
- /**
2696
- * --- Gets all GroupProperties for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2697
- * @summary Get GroupProperties
2698
- * @param {string} imodelId The iModel Id.
2699
- * @param {string} mappingId The Mapping Id.
2700
- * @param {string} groupId The Group Id.
2701
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2702
- * @param {number} [top] Optional max items to be sent in response.
2703
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2704
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2705
- * @param {*} [options] Override http request option.
2706
- * @throws {RequiredError}
2707
- * @memberof MappingsApi
2708
- */
2709
- getGroupproperties(imodelId: string, mappingId: string, groupId: string, Authorization: string, top?: number, continuationToken?: string, Accept?: string, options?: any): Promise<GroupPropertyCollectionReportingAPI>;
2710
- /**
2711
- * --- Gets a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2712
- * @summary Get GroupProperty
2713
- * @param {string} imodelId The iModel Id.
2714
- * @param {string} mappingId The Mapping Id.
2715
- * @param {string} groupId The Group Id.
2716
- * @param {string} propertyId The GroupProperty Id.
2717
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2718
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2719
- * @param {*} [options] Override http request option.
2720
- * @throws {RequiredError}
2721
- * @memberof MappingsApi
2722
- */
2723
- getGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, Accept?: string, options?: any): Promise<GroupPropertySingleReportingAPI>;
2724
- /**
2725
- * --- Gets all Groups for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2726
- * @summary Get Groups
2727
- * @param {string} imodelId The iModel Id.
2728
- * @param {string} mappingId The Mapping Id.
2729
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2730
- * @param {number} [top] Optional max items to be sent in response.
2731
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2732
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2733
- * @param {*} [options] Override http request option.
2734
- * @throws {RequiredError}
2735
- * @memberof MappingsApi
2736
- */
2737
- getGroups(imodelId: string, mappingId: string, Authorization: string, top?: number, continuationToken?: string, Accept?: string, options?: any): Promise<GroupCollectionReportingAPI>;
2738
- /**
2739
- * --- Gets a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2740
- * @summary Get Mapping
2741
- * @param {string} imodelId The iModel Id.
2742
- * @param {string} mappingId The Mapping Id.
2743
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2744
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2745
- * @param {*} [options] Override http request option.
2746
- * @throws {RequiredError}
2747
- * @memberof MappingsApi
2748
- */
2749
- getMapping(imodelId: string, mappingId: string, Authorization: string, Accept?: string, options?: any): Promise<MappingSingleReportingAPI>;
2750
- /**
2751
- * --- Gets all Mappings for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2752
- * @summary Get Mappings
2753
- * @param {string} imodelId The iModel Id.
2754
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2755
- * @param {number} [top] Optional max items to be sent in response.
2756
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2757
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2758
- * @param {*} [options] Override http request option.
2759
- * @throws {RequiredError}
2760
- * @memberof MappingsApi
2761
- */
2762
- getMappings(imodelId: string, Authorization: string, top?: number, continuationToken?: string, Accept?: string, options?: any): Promise<MappingCollectionReportingAPI>;
2763
- /**
2764
- * --- Updates a CalculatedProperty for a Group. ### Calculation Types Calculation types that start with `BoundingBox` use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element. List of all available calculation types: - `Length` - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length. - `Area` - calculation of a geometric element's surface area. - `Volume` - calculation of a geometric element's volume. - `BoundingBoxLongestEdgeLength` - calculation that gives the longest edge length of an element aligned bounding box. - `BoundingBoxIntermediateEdgeLength` - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box. - `BoundingBoxShortestEdgeLength` - calculation that gives the shortest edge length of an element aligned bounding box. - `BoundingBoxDiagonalLength` - calculation that gives the distance between 2 opposite corners of the element aligned bounding box. - `BoundingBoxLongestFaceDiagonalLength` - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box. - `BoundingBoxIntermediateFaceDiagonalLength` - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest. - `BoundingBoxShortestFaceDiagonalLength` - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2765
- * @summary Update CalculatedProperty
2766
- * @param {string} imodelId The iModel Id.
2767
- * @param {string} mappingId The Mapping Id.
2768
- * @param {string} groupId The Group Id.
2769
- * @param {string} propertyId Id of the CalculatedProperty to be updated.
2770
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2771
- * @param {CalculatedPropertyUpdateReportingAPI} [body]
2772
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2773
- * @param {*} [options] Override http request option.
2774
- * @throws {RequiredError}
2775
- * @memberof MappingsApi
2776
- */
2777
- updateCalculatedproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: CalculatedPropertyUpdateReportingAPI, Accept?: string, options?: any): Promise<CalculatedPropertySingleReportingAPI>;
2778
- /**
2779
- * --- Updates a CustomCalculation for a Group. ### CustomCalculations CustomCalculation is a kind of Group property which has a mathematical formula. CustomCalculation defines a column in the output data which gets filled with a result of the formula evaluation. The formula is evaluated during each extraction for each row of the Group's query result. The formula supports using other columns (GroupProperty, CalculatedProperty or CustomCalculation entities) as variables. Recursive formulas are not supported, i.e., formula containing a variable `X` is not supported inside a CustomCalculation with a `propertyName` equal to `X`. Supported operators: - Unary `-` (negation) has a precedence of 5 and right associativity - `**` (exponentiation) has a precedence of 4 and right associativity - `*` (multiplication) has a precedence of 3 and left associativity - `/` (division) has a precedence of 3 and left associativity - `%` (remainder) has a precedence of 3 and left associativity - `+` (addition) has a precedence of 2 and left associativity - Binary `-` (subtraction) has a precedence of 2 and left associativity Parenthesis `(` and `)` can be used to change the precedence of operations. Variables, constants, and functions have a precedence of 1 and left associativity. Supported constants: - `E` - Euler's constant and the base of natural logarithms (approx. 2.718) - `LN2` - natural logarithm of 2 (approx. 0.693) - `LN10` - natural logarithm of 10 (approx. 2.303) - `LOG2E` - base-2 logarithm of `E` (approx. 1.443) - `PI` - ratio of a circle's circumference to its diameter (approx. 3.14159) - `SQRT1_2` - square root of ½ (approx. 0.707) - `SQRT2` - square root of 2 (approx. 1.414) Supported numeric constant formats: - Decimal, e.g., `123` or `1.123` - Binary (base 2), e.g., `0b1010` - Octal (base 8), e.g., `0o1234567` - Hexadecimal (base 16), e.g., `0x123af` - Scientific notation, e.g., `1.123e+3` Supported functions: - `abs(x)` - returns the absolute value of `x` - `acos(x)` - returns the arccosine of `x` - `acosh(x)` - returns the hyperbolic arccosine of `x` - `asin(x)` - returns the arcsine of `x` - `asinh(x)` - returns the hyperbolic arcsine of `x` - `atan(x)` - returns the arctangent of `x` - `atanh(x)` - returns the hyperbolic arctangent of `x` - `atan2(y, x)` - returns the arctangent of the quotient of `y` divided by `x` - `cbrt(x)` - returns the cube root of `x` - `ceil(x)` - returns the smallest integer greater than or equal to `x` - `clz32(x)` - returns the number of leading zero bits of the 32-bit integer `x` - `cos(x)` - returns the cosine of `x` - `cosh(x)` - returns the hyperbolic cosine of `x` - `exp(x)` - returns `E ** x` or `pow(E, x)`, where `x` is the argument, and `E` is Euler's constant (2.718…, the base of the natural logarithm) - `expm1(x)` - returns subtracting 1 from `exp(x)` - `floor(x)` - returns the largest integer less than or equal to `x` - `fround(x)` - returns the nearest single precision float representation of `x` - `hypot(x, y[, z[, …]])` - returns the square root of the sum of squares of its arguments - `imul(x, y)` - returns the result of the 32-bit integer multiplication of `x` and `y` - `log(x)` - returns the natural logarithm of `x` - `log1p(x)` - returns the natural logarithm of `1 + x` - `log10(x)` - returns the base-10 logarithm of `x` - `log2(x)` - returns the base-2 logarithm of `x` - `max(x, y[, z[, …]])` - returns the largest of 2 or more numbers - `min(x, y[, z[, …]])` - returns the smallest of 2 or more numbers - `pow(x, y)` - returns base `x` to the exponent power `y` (i.e., `x**y`) - `random()` - returns a pseudo-random number between 0 and 1. The value only changes between different output tables. All rows within a single output table get the same value - `round(x)` - returns the value of the number `x` rounded to the nearest integer - `sign(x)` - returns the sign of the `x`, indicating whether `x` is positive (`1`), negative (`-1`), or zero (`0`) - `sin(x)` - returns the sine of `x` - `sinh(x)` - returns the hyperbolic sine of `x` - `sqrt(x)` - returns the positive square root of `x` - `tan(x)` - returns the tangent of `x` - `tanh(x)` - returns the hyperbolic tangent of `x` - `trunc(x)` - returns the integer portion of `x`, removing any fractional digits Examples of supported formulas: - `min(A * B, B * C, A * C)` - if `A`, `B`, and `C` are 3 different lengths of box edges, then this formula will result in the smallest side surface area of that box - `min * max` - formula does not have parenthesis after function names, so the `min` and `max` operands are treated as variables (other columns), not as functions. If the Group has columns `min` and `max`, and their values are `2` and `5`, then the result of this formula is `10` for that row - `2 ** 3` - 2 raised to the power of 3. Result will be 8. This can also be written as `pow(2, 3)` - `min(cos(X), sin(X))` - function nesting is supported - `A * (B + C)` - `A` multiplied by the sum of `B` and `C` - `A * B + C` - same as `(A * B) + C` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2780
- * @summary Update CustomCalculation
2781
- * @param {string} imodelId The iModel Id.
2782
- * @param {string} mappingId The Mapping Id.
2783
- * @param {string} groupId The Group Id.
2784
- * @param {string} customCalculationId Id of the CustomCalculation to be updated.
2785
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2786
- * @param {CustomCalculationUpdateReportingAPI} [body]
2787
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2788
- * @param {*} [options] Override http request option.
2789
- * @throws {RequiredError}
2790
- * @memberof MappingsApi
2791
- */
2792
- updateCustomcalculation(imodelId: string, mappingId: string, groupId: string, customCalculationId: string, Authorization: string, body?: CustomCalculationUpdateReportingAPI, Accept?: string, options?: any): Promise<CustomCalculationSingleReportingAPI>;
2793
- /**
2794
- * --- Updates a Group for a Mapping. ### Group Query The `query` parameter of a Group supports ECSql and ECClassIds. If a valid ECSql query is given and the selected class is `bis.Element`, or if it is a descendant of the class `bis.Element`, the only required column is `ECInstanceId`. - `SELECT * FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT * FROM Building.Beam` is a valid query - `SELECT ECInstanceId FROM bis.Element` is a valid query - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECInstanceId FROM Building.Beam` is valid - `SELECT ECClassId FROM bis.Element` is _not_ a valid query because ECInstanceId column is missing - Assuming that class `Building.Beam` is a descendant of the class `bis.Element`, the query `SELECT ECClassId FROM Building.Beam` is _not_ valid because ECInstanceId column is missing - Assuming that `Building.BeamAspect` is an aspect, the query `SELECT A.ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.Id = E.ECInstanceId` is _not_ valid because the selected `ECInstanceId` is of the aspect, not the element In all other cases when providing an ECSql query it is required to select `ECInstanceId`, `ECClassId`, and all other columns that you are planning to use for mapping. If only `ECInstanceId` and `ECClassId` are selected and other columns are used for mapping, those columns will be filled with `null` values. If either `ECInstanceId` or `ECClassId` column is not selected, the query will not produce any output. If the `query` parameter does not contain a valid ECSql query, then it must be equal to `bis.Element`, `bis.ElementAspect`, or any of their descendants. The ECClassId format `{schemaName}:{schemaItemName}` where `schemaName` does not contain a 3-part version number is supported. The ECClassId format `{schemaName}.{schemaItemName}` is supported. The ECClassId format `{schemaAlias}:{schemaItemName}` where `schemaAlias` is the alias of a `schemaName` is supported. The ECClassId format `{schemaFullName}:{schemaItemName}` where `schemaFullName` contains a 3-part version number is _not_ supported. When the given ECClassId is equal to `bis.Element` or is one of its descendants, then all elements with the ECClassId will be selected. When the given ECClassId is equal to `bis.ElementAspect` or is one of its descendants, then all elements that have such aspect will be selected. When the given ECClassId is none of the above, the query will not produce any output. - If a class `Building.Beam` does not have any subclasses and the `query` parameter is set to `Building.Beam`, then all elements with ECClassIds of `Building.Beam` will be selected - If there is a class `Building.StructuralMember` which has 2 subclasses `Building.Beam` and `Building.Column`, and the `query` parameter is set to `Building.StructuralMember`, then all elements with ECClassIds of `Building.StructuralMember`, `Building.Beam`, and `Building.Column` will be selected - If a class `Building.BeamAspect` inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.BeamAspect`, then all elements that have a `Building.BeamAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId - If there is class `Building.StructuralMemberAspect` which has 2 subclasses `Building.BeamAspect` and `Building.ColumnAspect`, the `Building.StructuralMemberAspect` class inherits from a class `bis.ElementAspect` (is unique or multi aspect) and the `query` parameter is set to `Building.StructuralMemberAspect`, then all elements that have `Building.StructuralMemberAspect`, `Building.BeamAspect`, or `Building.ColumnAspect` attached to them will be selected. This query will _not_ select the aspects themselves, but the elements that they are attached to. The selected elements may have any ECClassId If different queries are needed for a single output table, then create multiple Groups with those different queries but with the same name for each Group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all GroupProperties of Groups with the same name. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2795
- * @summary Update Group
2796
- * @param {string} imodelId Globally Unique Identifier of the target iModel.
2797
- * @param {string} mappingId Globally Unique Identifier of the target Mapping.
2798
- * @param {string} groupId Id of the Group to be updated.
2799
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2800
- * @param {GroupUpdateReportingAPI} [body]
2801
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2802
- * @param {*} [options] Override http request option.
2803
- * @throws {RequiredError}
2804
- * @memberof MappingsApi
2805
- */
2806
- updateGroup(imodelId: string, mappingId: string, groupId: string, Authorization: string, body?: GroupUpdateReportingAPI, Accept?: string, options?: any): Promise<GroupSingleReportingAPI>;
2807
- /**
2808
- * --- Updates a GroupProperty for a Group. ### Mapping ECProperties GroupProperties define mappings from ECProperties on an iModel to columns. They allow mapping the queried, element, element aspect, or related element properties. Content of the columns depend on the `ecProperties` field. The `ecProperties` field is a prioritized array which contains `ECProperty` entities. The closer the `ECProperty` is to the array's start, the higher the priority. The priority of `ECProperty` can be changed by reordering the `ecProperties` array. Reading of the `ecProperties` array stops when a valid value is found. For example, if the `ecProperties` array contains 2 entries and the first entry results in a null or undefined value, it will take the second entry. The value can be undefined if the given ECProperty does not exist. The result column will be filled with a null value if no valid value was found. Evaluating `ecProperties` is prioritized by: 1. Queried properties 2. Element properties 3. Element aspect properties Having queried properties as the highest priority allows for constant or complex values to be added to a mapping. `ECProperty` lookup is defined by 3 values - `ECSchemaName`, `ECClassName`, and `ECPropertyName`. `ECSchemaName` and `ECClassName` are used together to create a ECClassId which is the ECClassId of the current row when selecting a property. Class inheritance is _not_ checked. If the ECClassId of a selected row does not match the `ECSchemaName` and `ECClassName` pair, the value for this `ECProperty` is considered undefined. If the formed ECClassId is of an element aspect, the current selected row is an element and there is only 1 instance of that element aspect related to the element, the property lookup is done on the element aspect. `ECSchemaName` and `ECClassName` are case-insensitive. `ECSchemaName` and `ECClassName` can be set to a wildcard value `*`. - If the value of `ECSchemaName` is `*` and the value of `ECClassName` is `Beam`, then it will match any `Beam` class from any schema (e.g. `Building.Beam`, `Structural.Beam`, etc.) - If the value of `ECSchemaName` is `Building` and the value of `ECClassName` is `*`, then it will match any class from the schema `Building` (e.g. `Building.Beam`, `Building.CurtainWall`, etc.) - If values of `ECSchemaName` and `ECClassName` are `*`, then it will match any ECClassId (e.g. `Building.Beam`, `Structural.Column`, etc.) - If either value of `ECSchemaName` or `ECClassName` are `*`, then no element aspect lookup is done Set `ECPropertyName` to a property name that you want to select. The value of `ECPropertyName` can also be a path defining how to find a property. The path segments must be separated by a period (`.`). The path can contain the names of: - A navigation property - A struct property - A string property that happens to contain a string representation of a json object - A property inside the selected json Names of properties are not case sensitive. If json object does not have duplicate property names which only differ in letter casing, then those json properties are not case sensitive. We recommend treating json properties as case sensitive. - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category` or `category`, then the whole value `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` will be selected - If `Category` property is a navigation property with a value of `{\"id\":\"0x2000000000b\",\"relClassName\":\"BisCore.GeometricElement3dIsInCategory\"}` and the `ECPropertyName` is set to `Category.id`, then only the `id` value `0x2000000000b` will be selected - If `Category` property is a navigation property and it points to a row that has a property `CodeValue` that we want to select, the `ECPropertyName` should be set to `Category.CodeValue` - If `Model` property is a navigation property and it points to a row that has a property `JsonProperties` with a value `{\"formatter\":{\"mastUnit\":{\"label\":\"m\"}}}` and we want to select the master unit label, the `ECPropertyName` should be set to `Model.JsonProperties.formatter.mastUnit.label`. The result will be `m` ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2809
- * @summary Update GroupProperty
2810
- * @param {string} imodelId The iModel Id.
2811
- * @param {string} mappingId The Mapping Id.
2812
- * @param {string} groupId The Group Id.
2813
- * @param {string} propertyId Id of the GroupProperty to be updated.
2814
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2815
- * @param {GroupPropertyUpdateReportingAPI} [body]
2816
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2817
- * @param {*} [options] Override http request option.
2818
- * @throws {RequiredError}
2819
- * @memberof MappingsApi
2820
- */
2821
- updateGroupproperty(imodelId: string, mappingId: string, groupId: string, propertyId: string, Authorization: string, body?: GroupPropertyUpdateReportingAPI, Accept?: string, options?: any): Promise<GroupPropertySingleReportingAPI>;
2822
- /**
2823
- * --- Updates a Mapping for an iModel. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_write` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2824
- * @summary Update Mapping
2825
- * @param {string} imodelId The iModel Id.
2826
- * @param {string} mappingId Id of the Mapping to be updated.
2827
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2828
- * @param {MappingUpdateReportingAPI} [body]
2829
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2830
- * @param {*} [options] Override http request option.
2831
- * @throws {RequiredError}
2832
- * @memberof MappingsApi
2833
- */
2834
- updateMapping(imodelId: string, mappingId: string, Authorization: string, body?: MappingUpdateReportingAPI, Accept?: string, options?: any): Promise<MappingSingleReportingAPI>;
2835
- }
2836
- /**
2837
- * ReportsApi - fetch parameter creator
2838
- * @export
2839
- */
2840
- export declare const ReportsApiFetchParamCreator: (configuration?: Configuration | undefined) => {
2841
- /**
2842
- * --- Creates a Report within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2843
- * @summary Create Report
2844
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2845
- * @param {ReportCreateReportingAPI} [body]
2846
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2847
- * @param {*} [options] Override http request option.
2848
- * @throws {RequiredError}
2849
- */
2850
- createReport(Authorization: string, body?: ReportCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
2851
- /**
2852
- * --- Creates a Report Mapping. Each one links a Mapping to a Report and each Report can have more than one Report Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read`, `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2853
- * @summary Create Report Mapping
2854
- * @param {string} reportId The Report Id.
2855
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2856
- * @param {ReportMappingCreateReportingAPI} [body]
2857
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2858
- * @param {*} [options] Override http request option.
2859
- * @throws {RequiredError}
2860
- */
2861
- createReportMapping(reportId: string, Authorization: string, body?: ReportMappingCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
2862
- /**
2863
- * --- Marks a Report for deletetion. Reports are permanently deleted one month after being marked for deletion. A Report marked for deletion can be restored if it hasn't been permanently deleted yet. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2864
- * @summary Delete Report
2865
- * @param {string} reportId Id of the Report to be deleted.
2866
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2867
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2868
- * @param {*} [options] Override http request option.
2869
- * @throws {RequiredError}
2870
- */
2871
- deleteReport(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
2872
- /**
2873
- * --- Deletes a Report Mapping from a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2874
- * @summary Delete Report Mapping
2875
- * @param {string} reportId The Report Id.
2876
- * @param {string} mappingId Id of the Report Mapping to be deleted.
2877
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2878
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2879
- * @param {*} [options] Override http request option.
2880
- * @throws {RequiredError}
2881
- */
2882
- deleteReportMapping(reportId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
2883
- /**
2884
- * --- Gets all Reports within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2885
- * @summary Get Project Reports
2886
- * @param {string} projectId The Project Id.
2887
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2888
- * @param {number} [top] Optional max items to be sent in response.
2889
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2890
- * @param {boolean} [deleted] Optionally filter Reports by those marked for deletion. NOTE: Reports marked for deletion will be permanently deleted after 1 month unless deletion is reverted.
2891
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2892
- * @param {*} [options] Override http request option.
2893
- * @throws {RequiredError}
2894
- */
2895
- getProjectReports(projectId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, deleted?: boolean | undefined, Accept?: string | undefined, options?: any): FetchArgs;
2896
- /**
2897
- * --- Gets a single Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2898
- * @summary Get Report
2899
- * @param {string} reportId The Report Id.
2900
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2901
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2902
- * @param {*} [options] Override http request option.
2903
- * @throws {RequiredError}
2904
- */
2905
- getReport(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): FetchArgs;
2906
- /**
2907
- * --- Gets all Report Mappings for a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2908
- * @summary Get Report Mappings
2909
- * @param {string} reportId The Report Id.
2910
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2911
- * @param {number} [top] Optional max items to be sent in response.
2912
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2913
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2914
- * @param {*} [options] Override http request option.
2915
- * @throws {RequiredError}
2916
- */
2917
- getReportMappings(reportId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): FetchArgs;
2918
- /**
2919
- * --- Updates a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2920
- * @summary Update Report
2921
- * @param {string} reportId Id of the Report to be updated.
2922
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2923
- * @param {ReportUpdateReportingAPI} [body]
2924
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2925
- * @param {*} [options] Override http request option.
2926
- * @throws {RequiredError}
2927
- */
2928
- updateReport(reportId: string, Authorization: string, body?: ReportUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): FetchArgs;
2929
- };
2930
- /**
2931
- * ReportsApi - functional programming interface
2932
- * @export
2933
- */
2934
- export declare const ReportsApiFp: (configuration?: Configuration | undefined) => {
2935
- /**
2936
- * --- Creates a Report within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2937
- * @summary Create Report
2938
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2939
- * @param {ReportCreateReportingAPI} [body]
2940
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2941
- * @param {*} [options] Override http request option.
2942
- * @throws {RequiredError}
2943
- */
2944
- createReport(Authorization: string, body?: ReportCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ReportSingleReportingAPI>;
2945
- /**
2946
- * --- Creates a Report Mapping. Each one links a Mapping to a Report and each Report can have more than one Report Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read`, `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2947
- * @summary Create Report Mapping
2948
- * @param {string} reportId The Report Id.
2949
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2950
- * @param {ReportMappingCreateReportingAPI} [body]
2951
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2952
- * @param {*} [options] Override http request option.
2953
- * @throws {RequiredError}
2954
- */
2955
- createReportMapping(reportId: string, Authorization: string, body?: ReportMappingCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ReportMappingSingleReportingAPI>;
2956
- /**
2957
- * --- Marks a Report for deletetion. Reports are permanently deleted one month after being marked for deletion. A Report marked for deletion can be restored if it hasn't been permanently deleted yet. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2958
- * @summary Delete Report
2959
- * @param {string} reportId Id of the Report to be deleted.
2960
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2961
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2962
- * @param {*} [options] Override http request option.
2963
- * @throws {RequiredError}
2964
- */
2965
- deleteReport(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
2966
- /**
2967
- * --- Deletes a Report Mapping from a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2968
- * @summary Delete Report Mapping
2969
- * @param {string} reportId The Report Id.
2970
- * @param {string} mappingId Id of the Report Mapping to be deleted.
2971
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
2972
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2973
- * @param {*} [options] Override http request option.
2974
- * @throws {RequiredError}
2975
- */
2976
- deleteReportMapping(reportId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<Response>;
2977
- /**
2978
- * --- Gets all Reports within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2979
- * @summary Get Project Reports
2980
- * @param {string} projectId The Project Id.
2981
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2982
- * @param {number} [top] Optional max items to be sent in response.
2983
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
2984
- * @param {boolean} [deleted] Optionally filter Reports by those marked for deletion. NOTE: Reports marked for deletion will be permanently deleted after 1 month unless deletion is reverted.
2985
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2986
- * @param {*} [options] Override http request option.
2987
- * @throws {RequiredError}
2988
- */
2989
- getProjectReports(projectId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, deleted?: boolean | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ReportCollectionReportingAPI>;
2990
- /**
2991
- * --- Gets a single Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
2992
- * @summary Get Report
2993
- * @param {string} reportId The Report Id.
2994
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
2995
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
2996
- * @param {*} [options] Override http request option.
2997
- * @throws {RequiredError}
2998
- */
2999
- getReport(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ReportSingleReportingAPI>;
3000
- /**
3001
- * --- Gets all Report Mappings for a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3002
- * @summary Get Report Mappings
3003
- * @param {string} reportId The Report Id.
3004
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3005
- * @param {number} [top] Optional max items to be sent in response.
3006
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
3007
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3008
- * @param {*} [options] Override http request option.
3009
- * @throws {RequiredError}
3010
- */
3011
- getReportMappings(reportId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ReportMappingCollectionReportingAPI>;
3012
- /**
3013
- * --- Updates a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3014
- * @summary Update Report
3015
- * @param {string} reportId Id of the Report to be updated.
3016
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3017
- * @param {ReportUpdateReportingAPI} [body]
3018
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3019
- * @param {*} [options] Override http request option.
3020
- * @throws {RequiredError}
3021
- */
3022
- updateReport(reportId: string, Authorization: string, body?: ReportUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): (fetch?: FetchAPI | undefined, basePath?: string | undefined) => Promise<ReportSingleReportingAPI>;
3023
- };
3024
- /**
3025
- * ReportsApi - factory interface
3026
- * @export
3027
- */
3028
- export declare const ReportsApiFactory: (configuration?: Configuration | undefined, fetch?: FetchAPI | undefined, basePath?: string | undefined) => {
3029
- /**
3030
- * --- Creates a Report within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3031
- * @summary Create Report
3032
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3033
- * @param {ReportCreateReportingAPI} [body]
3034
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3035
- * @param {*} [options] Override http request option.
3036
- * @throws {RequiredError}
3037
- */
3038
- createReport(Authorization: string, body?: ReportCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<ReportSingleReportingAPI>;
3039
- /**
3040
- * --- Creates a Report Mapping. Each one links a Mapping to a Report and each Report can have more than one Report Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read`, `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3041
- * @summary Create Report Mapping
3042
- * @param {string} reportId The Report Id.
3043
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3044
- * @param {ReportMappingCreateReportingAPI} [body]
3045
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3046
- * @param {*} [options] Override http request option.
3047
- * @throws {RequiredError}
3048
- */
3049
- createReportMapping(reportId: string, Authorization: string, body?: ReportMappingCreateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<ReportMappingSingleReportingAPI>;
3050
- /**
3051
- * --- Marks a Report for deletetion. Reports are permanently deleted one month after being marked for deletion. A Report marked for deletion can be restored if it hasn't been permanently deleted yet. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3052
- * @summary Delete Report
3053
- * @param {string} reportId Id of the Report to be deleted.
3054
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3055
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3056
- * @param {*} [options] Override http request option.
3057
- * @throws {RequiredError}
3058
- */
3059
- deleteReport(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
3060
- /**
3061
- * --- Deletes a Report Mapping from a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3062
- * @summary Delete Report Mapping
3063
- * @param {string} reportId The Report Id.
3064
- * @param {string} mappingId Id of the Report Mapping to be deleted.
3065
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3066
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3067
- * @param {*} [options] Override http request option.
3068
- * @throws {RequiredError}
3069
- */
3070
- deleteReportMapping(reportId: string, mappingId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<Response>;
3071
- /**
3072
- * --- Gets all Reports within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3073
- * @summary Get Project Reports
3074
- * @param {string} projectId The Project Id.
3075
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3076
- * @param {number} [top] Optional max items to be sent in response.
3077
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
3078
- * @param {boolean} [deleted] Optionally filter Reports by those marked for deletion. NOTE: Reports marked for deletion will be permanently deleted after 1 month unless deletion is reverted.
3079
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3080
- * @param {*} [options] Override http request option.
3081
- * @throws {RequiredError}
3082
- */
3083
- getProjectReports(projectId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, deleted?: boolean | undefined, Accept?: string | undefined, options?: any): Promise<ReportCollectionReportingAPI>;
3084
- /**
3085
- * --- Gets a single Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3086
- * @summary Get Report
3087
- * @param {string} reportId The Report Id.
3088
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3089
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3090
- * @param {*} [options] Override http request option.
3091
- * @throws {RequiredError}
3092
- */
3093
- getReport(reportId: string, Authorization: string, Accept?: string | undefined, options?: any): Promise<ReportSingleReportingAPI>;
3094
- /**
3095
- * --- Gets all Report Mappings for a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3096
- * @summary Get Report Mappings
3097
- * @param {string} reportId The Report Id.
3098
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3099
- * @param {number} [top] Optional max items to be sent in response.
3100
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
3101
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3102
- * @param {*} [options] Override http request option.
3103
- * @throws {RequiredError}
3104
- */
3105
- getReportMappings(reportId: string, Authorization: string, top?: number | undefined, continuationToken?: string | undefined, Accept?: string | undefined, options?: any): Promise<ReportMappingCollectionReportingAPI>;
3106
- /**
3107
- * --- Updates a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3108
- * @summary Update Report
3109
- * @param {string} reportId Id of the Report to be updated.
3110
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3111
- * @param {ReportUpdateReportingAPI} [body]
3112
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3113
- * @param {*} [options] Override http request option.
3114
- * @throws {RequiredError}
3115
- */
3116
- updateReport(reportId: string, Authorization: string, body?: ReportUpdateReportingAPI | undefined, Accept?: string | undefined, options?: any): Promise<ReportSingleReportingAPI>;
3117
- };
3118
- /**
3119
- * ReportsApi - object-oriented interface
3120
- * @export
3121
- * @class ReportsApi
3122
- * @extends {BaseAPI}
3123
- */
3124
- export declare class ReportsApi extends BaseAPI {
3125
- /**
3126
- * --- Creates a Report within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3127
- * @summary Create Report
3128
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3129
- * @param {ReportCreateReportingAPI} [body]
3130
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3131
- * @param {*} [options] Override http request option.
3132
- * @throws {RequiredError}
3133
- * @memberof ReportsApi
3134
- */
3135
- createReport(Authorization: string, body?: ReportCreateReportingAPI, Accept?: string, options?: any): Promise<ReportSingleReportingAPI>;
3136
- /**
3137
- * --- Creates a Report Mapping. Each one links a Mapping to a Report and each Report can have more than one Report Mapping. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `imodels_read`, `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3138
- * @summary Create Report Mapping
3139
- * @param {string} reportId The Report Id.
3140
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3141
- * @param {ReportMappingCreateReportingAPI} [body]
3142
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3143
- * @param {*} [options] Override http request option.
3144
- * @throws {RequiredError}
3145
- * @memberof ReportsApi
3146
- */
3147
- createReportMapping(reportId: string, Authorization: string, body?: ReportMappingCreateReportingAPI, Accept?: string, options?: any): Promise<ReportMappingSingleReportingAPI>;
3148
- /**
3149
- * --- Marks a Report for deletetion. Reports are permanently deleted one month after being marked for deletion. A Report marked for deletion can be restored if it hasn't been permanently deleted yet. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3150
- * @summary Delete Report
3151
- * @param {string} reportId Id of the Report to be deleted.
3152
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3153
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3154
- * @param {*} [options] Override http request option.
3155
- * @throws {RequiredError}
3156
- * @memberof ReportsApi
3157
- */
3158
- deleteReport(reportId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
3159
- /**
3160
- * --- Deletes a Report Mapping from a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3161
- * @summary Delete Report Mapping
3162
- * @param {string} reportId The Report Id.
3163
- * @param {string} mappingId Id of the Report Mapping to be deleted.
3164
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3165
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3166
- * @param {*} [options] Override http request option.
3167
- * @throws {RequiredError}
3168
- * @memberof ReportsApi
3169
- */
3170
- deleteReportMapping(reportId: string, mappingId: string, Authorization: string, Accept?: string, options?: any): Promise<Response>;
3171
- /**
3172
- * --- Gets all Reports within the context of a Project. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3173
- * @summary Get Project Reports
3174
- * @param {string} projectId The Project Id.
3175
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3176
- * @param {number} [top] Optional max items to be sent in response.
3177
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
3178
- * @param {boolean} [deleted] Optionally filter Reports by those marked for deletion. NOTE: Reports marked for deletion will be permanently deleted after 1 month unless deletion is reverted.
3179
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3180
- * @param {*} [options] Override http request option.
3181
- * @throws {RequiredError}
3182
- * @memberof ReportsApi
3183
- */
3184
- getProjectReports(projectId: string, Authorization: string, top?: number, continuationToken?: string, deleted?: boolean, Accept?: string, options?: any): Promise<ReportCollectionReportingAPI>;
3185
- /**
3186
- * --- Gets a single Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3187
- * @summary Get Report
3188
- * @param {string} reportId The Report Id.
3189
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3190
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3191
- * @param {*} [options] Override http request option.
3192
- * @throws {RequiredError}
3193
- * @memberof ReportsApi
3194
- */
3195
- getReport(reportId: string, Authorization: string, Accept?: string, options?: any): Promise<ReportSingleReportingAPI>;
3196
- /**
3197
- * --- Gets all Report Mappings for a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:read`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_view` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3198
- * @summary Get Report Mappings
3199
- * @param {string} reportId The Report Id.
3200
- * @param {string} Authorization OAuth access token with scope &#x60;insights:read&#x60;
3201
- * @param {number} [top] Optional max items to be sent in response.
3202
- * @param {string} [continuationToken] Optional token to retrieve next page in paginated response.
3203
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3204
- * @param {*} [options] Override http request option.
3205
- * @throws {RequiredError}
3206
- * @memberof ReportsApi
3207
- */
3208
- getReportMappings(reportId: string, Authorization: string, top?: number, continuationToken?: string, Accept?: string, options?: any): Promise<ReportMappingCollectionReportingAPI>;
3209
- /**
3210
- * --- Updates a Report. ### Authentication Requires `Authorization` header with valid Bearer token for scope `insights:modify`. For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. ### Authorization User must have `insights_modify` permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled. Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. ### Rate limits All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. ---
3211
- * @summary Update Report
3212
- * @param {string} reportId Id of the Report to be updated.
3213
- * @param {string} Authorization OAuth access token with scope &#x60;insights:modify&#x60;
3214
- * @param {ReportUpdateReportingAPI} [body]
3215
- * @param {string} [Accept] Setting to &#x60;application/vnd.bentley.itwin-platform.v1+json&#x60; is recommended.
3216
- * @param {*} [options] Override http request option.
3217
- * @throws {RequiredError}
3218
- * @memberof ReportsApi
3219
- */
3220
- updateReport(reportId: string, Authorization: string, body?: ReportUpdateReportingAPI, Accept?: string, options?: any): Promise<ReportSingleReportingAPI>;
3221
- }
3222
- //# sourceMappingURL=api.d.ts.map