Get Inference Run Status - PnID to iTwin

REST API Overview

Reference

Changelog

Model versions

PnID to iTwin

Download API definition:

Get Inference Run Status

GET https://dev-api.bentley.com/synchronization/pnidtoitwin/inferences/{inferenceId}/run

Returns status of PnID Inference Run.

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 parameters

inferenceId

Yes

Id of the created PnID Inference.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response 200 OK

PnID Inference Run result returned successfully.

json

{
    "run": {
        "status": "inProgress",
        "duration": "PT10M",
        "progress": 0.1,
        "createdDateTime": "2022-01-20T14:45:47.073Z",
        "_links": {
            "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/results"
            },
            "inference": {
                "href": "https://api.bentley.com/synchronization/pnidtoitwin/inferences/bcbc71d4-c4d8-4cf7-b1fe-aaa194cd61c3"
            }
        }
    }
}

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 404 Not Found

Specified Inference Run was not found.

json

{
    "error": {
        "code": "PnIDInferenceNotFound",
        "message": "Requested PnID Inference is not available."
    }
}

Response 429 Too many requests

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

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

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

Definitions

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

PnID Inference Run Result

Container for PnID Inference Run.

run

PnIDInferenceRun

PnID Inference Run properties.

PnID Inference Run Status

Indicates state of the PnID Inference Run.

none

String

notStarted

String

queued

String

inProgress

String

failed

String

finished

String

canceled

String

PnID Inference Run

PnID Inference Run details.

status

PnIDInferenceRunStatus

duration

Duration

Computation duration of PnID Inference Run.

progress

Double

PnID Inference Run progress from 0 (no progress) to 1 (completed).

createdDateTime

Date-time

Date time of PnID Inference Run creation.

_links

PnIDInferenceRunLinks

Contains the hyperlinks to the related data of the PnID Inference Run.

PnID Inference Run Links

Contains the hyperlinks to related data of inference run.

inputs

Link

Information about all inference inputs.

results

Link

Information about all inference results.

inference

Link

Information about all inference.

Error

Contains error information.

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.

error

Error

Error information.