Get StorageConnections - Synchronization

Synchronization

Download API definition:

get https://dev-api.bentley.com/synchronization/imodels/storageconnections[?imodelId][&$top][&$skip]

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

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

Request

Request parameters

imodelId

iModel Id

$top

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

$skip

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

Yes

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

Response

Response 200 OK

json

{
    "connections": [{
        "id": "MWplZe9Uf0iR1IDMqyOMLqBN0_wHEVBGg_CzJmXdmE4",
        "displayName": "30"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/synchronization/imodels/storageconnections?iModelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=10&$top=10"
        },
        "prev": {
            "href": "https://api.bentley.com/synchronization/imodels/storageconnections?iModelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=0&$top=10"
        },
        "next": {
            "href": "https://api.bentley.com/synchronization/imodels/storageconnections?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 storage connections.

json

{
    "error": {
        "code": "InvalidConnectionsRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "code": "InvalidValue",
            "message": "Page size is over '50' 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 client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Links (paging)

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

Link

self

Link

json

{
    "type": "object",
    "title": "Links (paging)",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "$ref": "#/components/schemas/Link"
        },
        "self": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "URLs for redoing the current request, getting to the previous or next page of results.",
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Connection Links

iTwin

Link

iModel

Link

lastRun

Link

json

{
    "type": "object",
    "title": "Connection Links",
    "properties": {
        "iTwin": {
            "$ref": "#/components/schemas/Link"
        },
        "iModel": {
            "$ref": "#/components/schemas/Link"
        },
        "lastRun": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Storage Connection

String

Storage connection id.

_links

connection-links

iTwinId

String

iTwin id.

iModelId

String

iModel id.

displayName

String

A storage connection display name.

authenticationType

json

{
    "type": "object",
    "title": "Storage Connection",
    "properties": {
        "id": {
            "type": "string",
            "description": "Storage connection id."
        },
        "_links": {
            "$ref": "#/components/schemas/connection-links"
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin id."
        },
        "iModelId": {
            "type": "string",
            "description": "iModel id."
        },
        "displayName": {
            "type": "string",
            "description": "A storage connection display name."
        },
        "authenticationType": {
            "$ref": "#/components/schemas/authenticationType"
        }
    },
    "additionalProperties": false
}

Authentication Type

One of 'User' or 'Service'.

User

String

Service

String

json

{
    "enum": [
        "User",
        "Service"
    ],
    "type": "string",
    "title": "Authentication Type",
    "description": "One of 'User' or 'Service'."
}

Storage Connection (summary)

String

Storage connection id.

displayName

String

A storage connection display name.

json

{
    "type": "object",
    "title": "Storage Connection (summary)",
    "properties": {
        "id": {
            "type": "string",
            "description": "Storage connection id."
        },
        "displayName": {
            "type": "string",
            "description": "A storage connection display name."
        }
    },
    "additionalProperties": false
}

Storage Connections Response (prefer return=minimal)

_links

Links

connections

storage-connection-summary[]

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

json

{
    "type": "object",
    "title": "Storage Connections Response (prefer return=minimal)",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/Links"
        },
        "connections": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/storage-connection-summary"
            },
            "description": "A set of storage connection entities representing a minimal number of properties."
        }
    },
    "additionalProperties": false
}

Storage Connections Response (prefer return=representation)

_links

Links

connections

StorageConnection[]

A set of storage connection entities representing all storage connection properties

json

{
    "type": "object",
    "title": "Storage Connections Response (prefer return=representation)",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/Links"
        },
        "connections": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/StorageConnection"
            },
            "description": "A set of storage connection entities representing all storage connection properties"
        }
    },
    "additionalProperties": false
}

Was this page helpful?