Runs the specified ManifestConnection.
Notes
When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others.
Authentication
Requires Authorization header with valid Bearer token for scope synchronization:modify or itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
Connection Id
Request headers
OAuth access token with synchronization:modify or itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
An optional field containing BLOB storage url to the JSON file where DocumentAttributeSchema is defined.
Example
{ "documentAttributeSchemaUrl": "https://blob.net/documentAttributeSchema.json", "sourceFiles": [{ "id": "f5b36238", "name": "Master.dgn", "action": "bridge", "url": "https://blob.net/Master.dgn", "connectorType": "MSTN", "documentAttribute": { "className": "ProjectwiseDynamic:PWDocumentLink", "properties": { "Revision": "R01", "Suitability": "S01", "CodeValue": "89c7f032-6dfb-4a0b-8511-983e2d18728a" } }, "children": [{ "id": "a7c36238", "parentId": "f5b36238", "name": "Reference.dgn", "url": "https://blob.net/Reference.dgn", "connectorType": "CIVIL", "documentAttribute": { "className": "ProjectwiseDynamic:PWDocumentLink", "properties": { "Revision": "R01", "Suitability": "S01", "CodeValue": "89c7f032-6dfb-4a0b-8511-983e2d18728a" } } }] }] }
Response 303 See Other
This response indicates that an active run is in progress and link is provided in location header.
The resource location
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
This response indicates that user does not have required permissions to run specified connection.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 404 Not Found
This response indicates that the specified connection was not found.
{ "error": { "code": "ManifestConnectionNotFound", "message": "Requested ManifestConnection is not available." } }
Response 409 Conflict
A run request is already being processed.
{ "error": { "code": "ConflictWithAnotherIModelRequest", "message": "This request is already being processed for this iModel." } }
Response 422 Unprocessable Entity
Invalid request to create a connection run.
{ "error": { "code": "InvalidManifestConnectionRunRequest", "message": "Cannot perform operation.", "details": [{ "code": "InvalidRequestBody", "message": "Error parsing JSON, malformed JSON." }, { "code": "InvalidValue", "message": "Provided connectionId value is not valid.", "target": "connectionId" } ] } }
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." } }
The number of requests exceeds the rate-limit for the client subscription.
Manifest for Run Create
An optional field containing BLOB storage url to the JSON file where DocumentAttributeSchema is defined.
Manifest's Source File
A unique identifier for soureFile entity assigned and recognized by Synchronization API.
A manifest source file name.
Location of manifest source file relative to the current (working) directory.
Pre-authenticated url for file.
Type of connector used for synchronization. Refer supported connector format for details.
Additional metadata associated with manfiest source file
Manifest Source File's Child File
A unique identifier for child soureFile entity.
A unique identifier associated with parent manifest source file.
The name of Manifest source file's child file.
Location of the child file relative to the current (working) directory.
Pre-authenticated url for the child file.
Type of connector used for synchronization. Refer supported connector format for details.
Additional metadata associated with child soureFile
DocumentAttribute
An ECClass in the DocumentAttributeSchema to be used for the document.
Contains properties from the specified ClassName to be set for the document.
Action type
Action for synchronization type values: [bridge, unmap].
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.