Recognize symbols and tags from a raster PnID.

pnid-to-itwin-v2

Synchronization

Recognize symbols and tags from a raster P&ID.

pnid-to-itwin

---
Creates new PnID Inference for a specific model version. This endpoint registers a new inference pipeline in Azure Machine Learning service with already trained PnID (Piping & Instrumentation Diagrams) ML model. To create new PnID Inference please provide iTwin ID and model version. All available model versions are listed in the [Model versions](/apis/pnid-to-itwin-v2/model-versions/) section.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-inference

OAuth access token with scope `synchronization:modify`

Authorization

Setting to `application/vnd.bentley.itwin-platform.v2+json` is required.

Accept

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

The user has insufficient permissions for the requested operation.

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Starts PnID Inference Run after all inputs are uploaded.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-inference-run

inferenceId

---

Deletes PnID Inference.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-inference

PnID Inference Input cannot be created due to other resource being used.

---

Deletes PnID Inference Input.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-inference-input

Filename of the file uploaded to PnID Inference.

filename

Specified Inference cannot be deleted due to data conflict.

---

Cancels execution of PnID Inference Run.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-inference-run

---

Gets PnID Inference by specified id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference

OAuth access token with scope `synchronization:read`

---

Returns content of PnID Inference Input.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-input-content

Content of the inference input file returned successfully.

---

Returns all PnID Inference Inputs.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-inputs

List of PnID Inference Inputs returned successfully.

---

Returns content of PnID Inference Run Result.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-run-result-content

Filename of the PnID Inference result file.

Content of the inference result file returned successfully.

Specified Inference Run Result was not found.

---

Returns all PnID Inference Results.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-run-results

List of PnID Inference Run results returned successfully.

---

Returns status of PnID Inference Run.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-run

PnID Inference Run result returned successfully.

---

Returns all PnID Inferences in iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-itwin-inferences

Id of the iTwin that created the PnID Inference.

iTwinId

List of PnID Inference returned successfully.

---

Uploads a file or replace the existing file if one already exists with the same name as PnID Inference Input.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


upload-inference-input-content

Indicates inference input content type. Supported content types for this operation are: `application/pdf`, `image/jpeg`, `image/png`, `image/bmp`.

Content-Type

Indicates inference input content filename. Content-Disposition possible header format: `attachment; filename="filename.pdf"`.

Content-Disposition

Successfully uploaded Inference Input content.

PnID Inference Input content cannot be updated due to other resource being used.

Manage Access Controls for your iTwin member using iTwin roles and permissions.

access-control

itwins

Interact with your projects.

View, update, create, and delete projects.


projects

users

iModelHub is the control center for iModels. It is responsible for coordinating concurrent access to iModels as well as changes made to them in a form of [Changesets](https://www.itwinjs.org/learning/glossary/#changeset).

Overview of [iModelHub](https://www.itwinjs.org/learning/imodelhub/) and [iModels](https://www.itwinjs.org/learning/imodels/).

These APIs lets you retrieve metadata about the iModels pushed to iModelHub. To view, create or update your iModels use [iTwin.js](https://www.itwinjs.org/) client libraries.


imodels-v2

Digital Library to manage digital components

Digital component library and catalog management service.  It allows users to efficiently manage and distribute their digital component libraries, providing their designers with approved, proprietary components as well as approved manufacturer's content. 


library

Interact with your reality data.

View, update, create, and delete reality data.


reality-data


The Saved Views API provides a central place to store view information so it can be retrieved or shared across applications.

#### Technical Preview breaking changes:
<b>projectId</b> is recently changed to <b>iTwinId</b>.

savedviews

The Sensor Data Service (SDS) provides a unified method for retrieving time series sensor data (and related metadata) within iTwin and other platforms. The SDS simplifies the process of connecting sensor data from sources including IoT Devices, IaaS IoT Hubs, Enterprise Systems, and other generic repositories. Availability of this data enables developers, vendors, and users to develop OT workflows to create new use cases for digital twins in their products.


sensor-data

Storage API allowing quick files managing

storage

The Webhooks API allows you to subscribe to events happening in iTwin Platform.

### Supported event sources

- iModels events


webhooks

itwin-unreal

Interact with your jobs and projects for ContextCapture

Create, update, delete jobs and projects.

contextcapture

Access iTwin data integrations with Carbon Calculation solutions for Embodied Carbon, Life Cycle Assessments, and more.

carbon-calculation

Access Design Element Classification machine learning model.  
Create and manage classification runs.

designelementclassification

Access iModels data using OData v4 interface

imodels-odata

Interact with your data analysis jobs.

Create, update, delete jobs.

realitydataanalysis

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.

insights-v2

# Changed Elements

The Changed Elements API provides consumers with the elements that have changed in an iModel between two changesets. This API has four operations:

1. Enable Change Tracking
2. Get Change Tracking
3. Get Comparison
4. Get Changesets

Before obtaining a comparison, it is necessary to enable change tracking of an iModel. This means that the API will be listening to the following events:
1. New Named Version Created
2. Changeset Group Completed

When any of those events trigger, the API will process the new changes and store a summary of all the elements that have changed.

After tracking is enabled and the iModel is processed, the comparison endpoint may be used to query for a summary of changed elements between any two given `ChangeSets`.

changed-elements

Forms Service

View, create, and edit details of forms that have been filled out in a project, as well as their comments, attached files, and change history.  Full CRUD functionality is available for form data, with form definitions being available in a read-only context.

Note that throughout this API the terms "form" (by itself) and "form data" both refer to the same thing: data collected from users (generally entered into controls of a UI, or programmatically generated). By contrast, a "form definition" is a piece of metadata connected to form data instances. It determines the "type" of form that is filled out, and in applications that support custom form layouts, it determines how the controls are placed in the user interface.

Form definitions should be added, imported, and customized by project administrators through the Bentley Form Manager web application; they cannot be modified using this API. The app can be found at https://connect-formmanager.bentley.com/ManageForms.aspx?projectId=(yourProjectId) where `yourProjectId` is replaced by the ID of the project being customized.

forms

Issue Service

View, create, and edit details of issues that have been raised in a CONNECT project or context, as well as their comments, attached files, and change history.  Retrieval of form definitions (which define how to display an issue in an interactive UI) is also supported, though customization of them is not (and should be done by a project administrator through the CONNECT Issues web application, if needed).

issues-v1

Export API is a cloud-based API meant to export the data from the iModels to other standard formats such as IFC or LandXML. It allows users export data from iModels which are hosted in Bentley's iModelHub to an IFC or LandXML file.

export

mesh-export

iModel Connections API is a cloud-based synchronization API meant to synchronize the data in Input Files and iModels. It allows users to establish links from their design files to iModels, hosted in Bentley's iModelHub. Users can synchronize updates to their design files.

synchronization

iModel transformations service

Perform transformations on iModels.


transformations

The Clash Detection API allows you to manage clash detection suppression rules, tests, runs, and results. You can run tests and monitor the progress.

clash-detection

The Property Validation API allows you to manage property value validation rules, tests, runs, and results. You can run tests and monitor the progress.

validation

visualization

Walk-through on how to run the PnID ML Model and get your Results.

PnID to iTwin

Tutorials