Table of contents
PnID to iTwin
Download API definition:
POST https://api.bentley.com/synchronization/pnidtoitwin/inferences/{inferenceId}/inputs/

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 itwin-platform.

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

Request parameters

Name
In
Required?
Description
inferenceId
template
Yes

Id of the created PnID Inference.

Request headers

Name
Required?
Description
Content-Type
Yes

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

Content-Disposition
Yes

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

Authorization
Yes

OAuth access token with itwin-platform scope

Accept
No

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

Response 200 OK

Successfully uploaded Inference Input content.

json
{
    "input": {
        "id": "cG5pZC5wZGY-",
        "filename": "pnid.pdf",
        "size": 100,
        "_links": {
            "inputs": {
                "href": "https://api.bentley.com/synchronization/pnidtoitwin/inferences/bcbc71d4-c4d8-4cf7-b1fe-aaa194cd61c3/inputs"
            },
            "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.

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

Specified Inference was not found.

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

Response 409 Conflict

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

json
{
    "error": {
        "code": "PnIDInferenceInUse",
        "message": "PnID Inference is in use by PnID Inference Run."
    }
}

Response 415 Unsupported Media Type

Content type of file is not supported.

json
{
    "error": {
        "code": "UnsupportedMediaType",
        "message": "Media Type is not supported."
    }
}

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

Name
Description
retry-after

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

Link

Hyperlink container.

TableSchema
Name
Type
Description
href
String

Hyperlink to the specific entity.

File Content

Content of the input/result file.

TableSchema
Name
Type
Description
No data.

PnID Inference Input Links

Contains the hyperlinks to related data of PnID Inference Inputs.

TableSchema
Name
Type
Description
inputs

Information about all PnID Inference Inputs.

inference

Information about PnID Inference.

PnID Inference Upload Input

Represents input file for PnID Inference.

TableSchema
Name
Type
Description
id
String

File Id of PnID Inference Input

filename
String

Filename of PnID Inference Input.

size
Int64

File size of PnID Inference Input.

PnID Inference Input Result

Container for PnID Inference Input.

TableSchema
Name
Type
Description
input

PnID Inference Input properties.

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