Table of contents
iTwins
Download API definition:
This operation is a Technical Preview and is available for testing purposes only. Do not use in production.
GET https://dev-api.bentley.com/itwins/exports

Retrieves a list of export jobs that were created by the calling user in the last 4 hours. They are returned ordered by createdDateTime in descending order. The most recent export job will be first in the list.

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 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
{
    "exports": [{
            "id": "b0e47485-346e-4058-9920-12f064ceb0b6",
            "request": {
                "queryScope": "MemberOfiTwin",
                "subClass": "Project",
                "select": "subClass,type,number,displayName,status",
                "filter": null,
                "includeInactive": true,
                "outputFormat": "JsonGZip"
            },
            "status": "InProgress",
            "outputUrl": null,
            "createdBy": "55126a9b-eecb-4ae8-92af-2b1cc8b1259a",
            "createdDateTime": "2024-10-14T16:31:43.791Z",
            "startedDateTime": null,
            "completedDateTime": null
        },
        {
            "id": "a81b9253-d0a3-4b09-962a-b5a51da34537",
            "request": {
                "queryScope": "OrganizationAdmin",
                "subClass": "Asset,Project",
                "select": "number,displayName,status",
                "filter": "status+eq+'Active'+and+contains(number,'abc')",
                "includeInactive": false,
                "outputFormat": "JsonGZip"
            },
            "status": "Completed",
            "outputUrl": "https://deveus.blob.windows.net/itwin-export/a81b9253-d0a3-4b09-962a-b5a51da34537.json.gz?sv=2018-03-28&sr=b&sig=abcdefg&se=2022-09-09T20%3A44%3A46Z&sp=r",
            "createdBy": "55126a9b-eecb-4ae8-92af-2b1cc8b1259a",
            "createdDateTime": "2024-10-14T15:46:49.663Z",
            "startedDateTime": "2024-10-14T15:46:49.663Z",
            "completedDateTime": "2024-10-14T15:46:49.663Z"
        }
    ]
}

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 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

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.

ExportStatus

The status of the export.

Name
Type
Description
Queued
String
InProgress
String
Completed
String
Failed
String

QueryScope

The scope of the query. This determines whether you want to query all iTwins that you are a member of or all iTwins in your organization. Only administrators can use the OrganizationAdmin option.

Name
Type
Description
MemberOfiTwin
String
OrganizationAdmin
String

ExportOutputFormat

The format of the export file.

Name
Type
Description
JsonGZip
String
JsonZipArchive
String
CsvGZip
String
Csv
String

iTwinExportRequest

Name
Type
Description
queryScope

MemberOfiTwin - (Default) The export will be limited to the iTwins that the user is a member of. Use the Access Control API to manage an iTwin's members.
OrganizationAdmin - The export will be limited to the iTwins that belong to the users organization. It can only be used by an organization admin. It is useful for admins that want to export all iTwins in their organization.

subClass
String

One or more iTwin subClasses. Use a comma delimited list to specify more than one. For example, to export Assets and Projects, specify 'Asset,Project'. If not specified, the export will include all subClasses.

select
String

A comma delimited list of iTwin properties that you want to include in the export. Keep the list of properties as small as possible to increase the speed of the export and limit the size of the export file. If not specified, then it will export the minimal representation which includes these columns: id,class,subClass,type,number,displayName

filter
String

An odata filter used to limit the iTwins that are exported. Use the subClass property to limit to specific subClasses. The filter is used to filter the results even further. All text values in the filter are case insensitive.
Examples:

  • status+in+['Active','Inactive']
  • status+eq+'Active'+and+contains('test',number)+and+CreatedDateTime+ge+2023-01-01T00:00:00Z
  • parentId+eq+'78202ffd-272b-4207-a7ad-7d2b1af5dafc'+and+(startswith('ABC',number)+or+startswith('ABC',displayName))
includeInactive
Boolean

By default, Inactive iTwins are not returned from any API. This flag allows you to indicate that you want the export to include inactive iTwins. If not specified, the export will include iTwins with any status but Inactive, including any new status added in the future. If you specify a status in the filter parameter, then an error will be returned if you also try to set the includeInactive flag.

outputFormat

JsonGZip - A single large json file compressed using gzip. (filename.json.gz)
JsonZipArchive - A zip archive containing multiple json files. Each file contains 20,000 itwins. (filename.zip)
CsvGZip - A single csv file compressed using gzip. (filename.csv.gz)
Csv - A single uncompressed csv file. (filename.csv)

iTwinExportDetails

Name
Type
Description
id
String

The Id of the export.

request

A copy of the export request.

status

The status of the export. Valid Values are Queued, InProgress, Completed, Failed

outputUrl
String, null

The url that is used to download the export. It will expire in 60 minutes. A new url is generated each time you query for the export details. The export is only available for 4 hours after the export completes. The outputUrl property will be null if the status is anything other than Completed. It will also be null if the export results in an empty file because the query returned no results.

createdBy
String, null

The Id of the user that created the export.

createdDateTime
Date-time

The date that the export was created.

startedDateTime
Date-time, null

The date that the export started. This can also help assess the freshness of the exported data.

completedDateTime
Date-time, null

The date that the export completed.

iTwinExportListResponse

Name
Type
Description
exports

Requested export list.

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.