Table of contents
Export
Download API definition:
GET https://qa-api.bentley.com/export/connections?imodelId[&$top][&$skip]

Retrieves export connections for the specified iModel.

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 parameters

Name
Required?
Description
imodelId
Yes

iModel Id

$top
No

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

$skip
No

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

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "connections": [{
        "iModelId": "a0471655-6b18-419e-ab01-ebf4fbff9dff",
        "iTwinId": "1db84556-49ba-41fd-8500-3657784c7752",
        "authenticationType": "User",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/5db42812-ebb8-4c58-98a4-2eaa99e0d8b6"
            },
            "iTwin": {
                "href": "https://api.bentley.com/itwins/4tb42812-ebb8-4c58-98a4-2eaa99e0d8b6"
            },
            "lastRun": {
                "href": "https://api.bentley.com/export/connections/fc226d0d-1647-48d7-8c11-f1f74f2d9808/runs/de626d0d-1647-48d7-8c11-f1f74f2d4523"
            }
        },
        "id": "VRZHoBhrnkGrAev0-_-d_xwvyrzjgaVGka5wU967Q7M",
        "displayName": "30"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/export/connections?$skip=50&$top=50"
        },
        "prev": {
            "href": "https://api.bentley.com/export/connections?$skip=0&$top=50"
        },
        "next": {
            "href": "https://api.bentley.com/export/connections?$skip=200&$top=50"
        }
    }
}

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 get specified connections.

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": "ConnectionNotFound",
        "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 out of limits.",
                "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

Name
Description
retry-after

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

Link

Name
Type
Description
href
String

Links

Name
Type
Description
self
next
prev

Authentication Type

One of 'User' or 'Service'

Name
Type
Description
User
String
Service
String

Connection Links

Name
Type
Description
iModel
iTwin
lastRun

Export Connection

Name
Type
Description
authenticationType
id
String
displayName
String
iModelId
String
iTwinId
String

Export Connections Response

Name
Type
Description
connections
_links

Error

Contains error information.

Name
Type
Description
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.

Name
Type
Description
error

Error information.