Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
This repository contains packages that help consumption of iModels API. Please visit the iModels API documentation page on iTwin developer portal to learn more about the iModels service and its APIs. API clients contain methods that either act as a thin wrapper for sending a single request to the API or combine several requests to execute a more complex operation.
iModels API is a part of iTwin Platform. iTwin platform together with an open source iTwin.js library provides capabilities for creating, querying, modifying, and displaying Infrastructure Digital Twins.
This repository contains multiple packages:
-
@itwin/imodels-client-managementis an API client that exposes a subset of iModels API operations and is intended to use in iModel management applications. Such applications do not edit the iModel file itself, they allow user to perform administrative tasks - create Named Versions, view Changeset metadata and such. -
@itwin/imodels-client-authoringis an API client that extends@itwin/imodels-client-managementand exposes additional API operations to facilitate iModel editing workflows. This client should not be used directly as the operations it exposes can only be used meaningfully via iTwin.js library. -
@itwin/imodels-access-frontendpackage contains an implementation ofFrontendHubAccessinterface which enables the iTwin.js platform to use iModels API. -
@itwin/imodels-access-backendpackage contains an implementation ofBackendHubAccessinterface which enables the iTwin.js platform to use iModels API. -
@itwin/imodels-client-common-configpackage is used internally to share common configuration across the API clients. -
@itwin/imodels-clients-testspackage is used internally for@itwin/imodels-client-managementand@itwin/imodels-client-authoringpackage testing. -
@itwin/imodels-access-backend-testspackage is used internally for API client testing.
Please refer to the table below for guidance on which versions of @itwin/imodels-access-frontend and @itwin/imodels-access-backend packages are compatible with a specific iTwin.js version.
| iTwin.js version | @itwin/imodels-access-* version |
|---|---|
| >=3.0.0 <3.3.0 | >=1.0.1 <2.0.0 |
| >=3.3.0 <3.6.0 | >=2.0.0 <3.0.0 |
| >=3.6.0 <4.0.0 | >=3.0.0 <4.0.0 |
| >=4.0.0 | >=4.0.0, >=5.0.0 |