Starts PnID Inference Run after all inputs are uploaded.
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
Id of the created PnID Inference.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is required.
Response 201 Created
PnID Inference Run created successfully.
{ "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" } } } }
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.
{ "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.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 409 Conflict
PnID Inference Run is already created.
{ "error": { "code": "PnIDInferenceRunExists", "message": "PnID Inference Run with current PnID Inference already exists." } }
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)
{ "error": { "code": "InvalidPnIDtoiTwinRequest", "message": "Cannot create requested resource.", "details": [{ "code": "InvalidProperty", "message": "Required properties are not provided or incorrect.", "target": "inferenceId" }] } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Link
Hyperlink container.
Hyperlink to the specific entity.
Empty Content
PnID Inference Run Result
Container for PnID Inference Run.
PnID Inference Run Status
Indicates state of the PnID Inference Run.
PnID Inference Run
PnID Inference Run details.
Computation duration of PnID Inference Run.
PnID Inference Run progress from 0 (no progress) to 1 (completed).
Date time of PnID Inference Run creation.
PnID Inference Run Links
Contains the hyperlinks to related data of inference run.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.