Get Started
Documentation
Samples
Table of contents
Overview
Tutorials
Samples
Changelog
Model versions
PnID to iTwin

PnID to iTwin

Download API definition:
Create Inference
POST https://api.bentley.com/synchronization/pnidtoitwin/inferences

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

Request

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope synchronization:modify

Accept
No

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

Request body

PnID Inference Payload

Name
Type
Required?
Description
modelVersion
String
Yes

ML Model version for PnID Inference.

iTwinId
Uuid
Yes

Id of the iTwin that created the PnID Inference.

Example

json
Response
Response 201 Created
Inference created successfully.
json
Response 401 Unauthorized
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.
json
Response 403 Forbidden
The user has insufficient permissions for the requested operation.
json
Response 422 Unprocessable Entity
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)
json
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
json
Response headers
Name
Description
retry-after
The number of requests exceeds the rate-limit for the client subscription.
Definitions
Link
Hyperlink container.
TableSchema
Name
Type
Description
href
String
Hyperlink to the specific entity.
PnID Inference
PnID Inference details.
TableSchema
Name
Type
Description
id
String
Unique PnID Inference identifier.
modelVersion
String
ML Model version for PnID Inference.
lastModifiedDateTime
Date-time
Date time of last PnID Inference modification.
createdDateTime
Date-time
Date time of PnID Inference creation.
_links
PnIDInferenceLinks
Contains the hyperlinks to related data of PnID Inference.
PnID Inference Payload
Properties of PnID Inference to be created.
TableSchema
Name
Type
Description
modelVersion
String
ML Model version for PnID Inference.
iTwinId
Uuid
Id of the iTwin that created the PnID Inference.
PnID Inference Result
Container for PnID Inference.
TableSchema
Name
Type
Description
inference
PnIDInference
PnID Inference properties.
PnIDInferenceLinks
TableSchema
Name
Type
Description
iTwin
Link
Information about iTwin.
run
Link
Information about all inference run.
inputs
Link
Information about all inference inputs.
results
Link
Information about all inference results.
Error
Contains error information.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
The target of the error.
Error Response
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.
TableSchema
Name
Type
Description
error
Error
Error information.