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
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
OK
{ "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.
{ "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.
{ "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": "ConnectionNotFound", "message": "Requested iModelId is not available." } }
Response 422 Unprocessable Entity
Invalid request to get connections.
{ "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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Link
Links
Authentication Type
One of 'User' or 'Service'
Connection Links
Export Connection
Export Connections Response
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.
Was this page helpful?