Add a new Manifest Source File to a Manifest Connection
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.
Associated entities
SourceFile is added to a Connection. The reuqest path must contain a valid Connection ID
Request parameters
Connection Id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
ManifestFile (create)
Source file id.
Example
{ "sourceFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA" }
Response 201 Created
Manifest Connection sourceFile successfully added.
{ "sourceFile": { "id": "297c8ab9-53a3-4fe5-adf8-79b4c1a95cbb", "sourceFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA" } }
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 404 Not Found
This response indicates that the specified connection sourceFile was not found.
{ "error": { "code": "ManifestConnectionSourceFileNotFound", "message": "Requested ManifestConnection is not available." } }
Response 409 Conflict
The SourceFile is already mapped to the iModel.
{ "error": { "code": "FileMappingToTheIModelAlreadyExists", "message": "The SourceFile is already mapped to the iModel." } }
Response 422 Unprocessable Entity
Invalid request to add connection sourcefile. Request payload might be missing some of the required properties.
{ "error": { "code": "InvalidManifestConnectionSourceFileRequest", "message": "Cannot perform operation.", "details": [{ "code": "InvalidRequestBody", "message": "Error parsing JSON, malformed JSON." }, { "code": "MissingRequiredProperty", "message": "A property required to add or update a connection sourceFile is missing.", "target": "sourceFileId" }, { "code": "InvalidValue", "message": "Provided connectionId value is not valid.", "target": "connectionId" } ] } }
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.
ManifestFile
Source file entity id.
Source file id.
{ "type": "object", "properties": { "id": { "type": "string", "description": "Source file entity id." }, "sourceFileId": { "type": "string", "description": "Source file id." } }, "additionalProperties": false }
ManifestFile (create)
Source file id.
{ "title": "ManifestFile (create)", "type": "object", "properties": { "sourceFileId": { "type": "string", "description": "Source file id." } }, "required": [ "sourceFileId" ], "additionalProperties": false }
ManifestFile response
{ "title": "ManifestFile response", "type": "object", "properties": { "sourceFile": { "$ref": "#/components/schemas/ManifestFile", "description": "Manifest file entity." } }, "additionalProperties": false }
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.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
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.
{ "type": "object", "title": "Error Response", "description": "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.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?