Create StorageConnection Run - Synchronization

REST API Overview

Reference

Changelog

Synchronization

Download API definition:

Create StorageConnection Run

POST https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/run

Runs the specified StorageConnection.

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

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

Request

Request parameters

connectionId

Yes

Connection Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response

Response 202 Accepted

Accepted

Response 303 See Other

This response indicates that an active run is in progress and link is provided in location header.

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

This response indicates that user does not have required permissions to run specified connection.

json

{
    "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.

json

{
    "error": {
        "code": "StorageConnectionNotFound",
        "message": "Requested StorageConnection is not available."
    }
}

Response 409 Conflict

A run request is already being processed.

json

{
    "error": {
        "code": "ConflictWithAnotherIModelRequest",
        "message": "The iModel is already processing this request."
    }
}

Response 422 Unprocessable Entity

Invalid request to get run connection.

json

{
    "error": {
        "code": "InvalidStorageConnectionRunRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "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.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

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

Definitions

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

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.

error

Error

Error information.