Reporting

Extraction

Download API definition:

POST https://sampleHostName/insights/reporting/datasources/imodels/{imodelId}/extraction/run

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 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 wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Extraction row limiting

Mappings created or modified by using the "Try it out" function can only extract a maximum of 100 rows for each group. Mapping modification is considered any POST/DELETE/PATCH/PUT request to any endpoint with the tag "Mappings" or if the URL contains {mappingId}.