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
Id of the created PnID Inference.
Request headers
Indicates inference input content type. Supported content types for this operation are: application/pdf, image/jpeg, image/png, image/bmp.
Indicates inference input content filename. Content-Disposition possible header format: attachment; filename="filename.pdf".
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is required.
Response 200 OK
Successfully uploaded Inference Input content.
{ "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.
{ "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 404 Not Found
Specified Inference was not found.
{ "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.
{ "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.
{ "error": { "code": "UnsupportedMediaType", "message": "Media Type is not supported." } }
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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Link
Hyperlink container.
Hyperlink to the specific entity.
File Content
Content of the input/result file.
PnID Inference Input Links
Contains the hyperlinks to related data of PnID Inference Inputs.
PnID Inference Upload Input
Represents input file for PnID Inference.
File Id of PnID Inference Input
Filename of PnID Inference Input.
File size of PnID Inference Input.
PnID Inference Input Result
Container for PnID Inference Input.
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.
Was this page helpful?