Get Connections - Synchronization

REST API Overview

Reference

Changelog

Synchronization

Download API definition:

Get Connections

GET https://api.bentley.com/synchronization/imodels/connections?imodelId[&$top][&$skip]

Retrieves connections for the specified iModel.

Notes

The Prefer header can be used to specify how much result metadata is desired by the client. The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports "return=representation" and "return=minimal" preferences.

The "return=representation" preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. The "return=minimal" preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer header is not specified.

Authentication

Requires Authorization header with valid Bearer token for scope synchronization:read or itwin-platform.

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

Request

Request parameters

imodelId

query

Yes

iModel Id

$top

query

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

query

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

Request headers

Authorization

Yes

OAuth access token with synchronization:read or itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "connections": [{
        "id": "MWplZe9Uf0iR1IDMqyOMLuL24kbZK4VNvgn4ev3etXI",
        "displayName": "30"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/synchronization/imodels/connections?imodelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=10&$top=10"
        },
        "prev": {
            "href": "https://api.bentley.com/synchronization/imodels/connections?imodelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=0&$top=10"
        },
        "next": {
            "href": "https://api.bentley.com/synchronization/imodels/connections?imodelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=20&$top=10"
        }
    }
}

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

This response indicates that the specified iModel was not found.

json

{
    "error": {
        "code": "IModelNotFound",
        "message": "Requested iModelId is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get connections.

json

{
    "error": {
        "code": "InvalidConnectionsRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidValue",
                "message": "Page size is over '1000' items limit.",
                "target": "$top"
            },
            {
                "code": "InvalidValue",
                "message": "Provided imodelId value is not valid.",
                "target": "imodelId"
            }
        ]
    }
}

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

Connections (prefer return=minimal)

TableSchema

connections

connection-summary[]

A set of connection entities representing a minimal number of properties.

_links

Links

Links to current, previous, and next connection.

Connections (prefer return=representation)

TableSchema

connections

Connection[]

A set of connection entities representing all connection properties.

_links

Links

Links to current, previous, and next connection.

Connection

TableSchema

String

Connection id.

displayName

String

A connection display name.

iModelId

String

iModel id.

_links

connection-links

A set of links to iModel, iTwin, and the latest connection run.

Connection (summary)

TableSchema

String

Connection id.

displayName

String

A connection display name.

Connection Links

TableSchema

iModel

Link

Link to iModel.

iTwin

Link

Link to iTwin.

lastRun

Link

Link to latest run for a connection.

Link

TableSchema

href

String

Hyperlink to the specific entity.

Links (paging)

URLs for redoing the current request, getting to the previous or next page of results.

TableSchema

self

Link

URL for redoing the current request.

Link

URL for getting the next page of results.

Link

URL for getting the previous page of results.

Error

Contains error information.

TableSchema

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

error

Error

Error information.