Table of contents
PnID to iTwin
Download API definition:
POST https://qa-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 itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

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
{
    "modelVersion": "1.3",
    "iTwinId": "ea9cb5ab-22c5-4cef-807a-df47f07b01f3"
}

Response 201 Created

Inference created successfully.

json
{
    "inference": {
        "id": "bcbc71d4-c4d8-4cf7-b1fe-aaa194cd61c3",
        "modelVersion": "1.3",
        "lastModifiedDateTime": "2022-01-20T14:45:47.073Z",
        "createdDateTime": "2022-01-20T14:45:47.073Z",
        "_links": {
            "iTwin": {
                "href": "https://api.bentley.com/itwins/ea9cb5ab-22c5-4cef-807a-df47f07b01f3"
            },
            "run": {
                "href": "https://api.bentley.com/synchronization/pnidtoitwin/inferences/bcbc71d4-c4d8-4cf7-b1fe-aaa194cd61c3/run"
            },
            "inputs": {
                "href": "https://api.bentley.com/synchronization/pnidtoitwin/inferences/bcbc71d4-c4d8-4cf7-b1fe-aaa194cd61c3/inputs"
            },
            "results": {
                "href": "https://api.bentley.com/synchronization/pnidtoitwin/inferences/bcbc71d4-c4d8-4cf7-b1fe-aaa194cd61c3/run/results"
            }
        }
    }
}

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
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

The user has insufficient permissions for the requested operation.

json
{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

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
{
    "error": {
        "code": "InvalidPnIDtoiTwinRequest",
        "message": "Cannot create requested resource.",
        "details": [{
            "code": "MissingRequiredProperty",
            "message": "Required property is missing.",
            "target": "modelVersion"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json
{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

Link

Hyperlink container.

Name
Type
Description
href
String

Hyperlink to the specific entity.

PnID Inference

PnID Inference details.

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

Contains the hyperlinks to related data of PnID Inference.

PnID Inference Payload

Properties of PnID Inference to be created.

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.

Name
Type
Description
inference

PnID Inference properties.

PnIDInferenceLinks

Name
Type
Description
iTwin

Information about iTwin.

run

Information about all inference run.

inputs

Information about all inference inputs.

results

Information about all inference results.

Error

Contains error information.

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, null

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.

Name
Type
Description
error

Error information.