Create a ExportConnection that describes which iModel's data is to be exported.
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.
Associated entities
A connection is linked with an iModel. An iModel ID is required to be set when creating a ExportConnection.
Request headers
Indicates request body content type. Supported media type is application/json.
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
Export Connection (create)
Example
{ "displayName": "30", "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a", "authenticationType": "User" }
Response 201 Created
Connection successfully created.
{ "connection": { "id": "fc226d0d-1647-48d7-8c11-f1f74f2d9808", "displayName": "30", "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a", "iTwinId": "7dbd531d-6967-47b2-8945-a722a437ad7a", "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" } } } }
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 422 Unprocessable Entity
Invalid request to create connection. Request payload might be missing some of the required properties.
{ "error": { "code": "InvalidExportConnectionRequest", "message": "Cannot perform operation.", "details": [{ "code": "InvalidRequestBody", "message": "Error parsing JSON, malformed JSON." }, { "code": "MissingRequiredProperty", "message": "imodelId was not provided.", "target": "imodelId" }, { "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.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Link
Export Connection (create)
Authentication Type
One of 'User' or 'Service'
Connection Links
Export Connection Response
Export Connection
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.