Get iModel Named Versions - iModels

REST API Overview

Reference

iModels

Download API definition:

GET https://api.bentley.com/imodels/{id}/namedversions[?$top][&$skip][&$orderBy][&$search][&name]

Retrieves a list of Named Versions for the iModel specified by the iModel id.

Every Changeset on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions.

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.

Authorization

User must have imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

Yes

iModel id

$top

The $top query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: $top=1. When $top parameter is not provided default is set to 100. $top value cannot exceed 1000.

$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. E.g. to return items from the collection starting at the third place provide the following query: $skip=2.

$orderBy

The $orderBy query option allows clients to request ascending using 'asc' or descending using 'desc' order of the returned collection by one or more item properties. Currently supported properties for Named Versions are 'changesetIndex' and 'createdDateTime'. When neither 'asc' or 'desc' keyword is specified the collection is sorted in ascending order. To sort the collection in descending order provide 'desc' keyword e.g.: $orderBy=changesetIndex desc,createdDateTime desc

$search

The $search query option allows users to filter Named Versions whose name or description property contains the search string. E.g. to return Named Versions whose name or description contains 'Milestone 1', provide the following query: $search=Milestone%201. This parameter cannot be used at the same time as the name parameter. Valid values for this parameter are non-empty strings that are not longer than 255 characters.

name

The name query option allows users to filter Named Versions by their name property. E.g. to return Named Versions that have a name equal to 'Milestone 1' provide the following query: name=Milestone%201. Valid values for this parameter follow the same requirements as for Named Version creation - strings should be not empty, consist not only of whitespace and not exceed 255 characters. This query option uses case insensitive matching.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Prefer

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

Response

Response 200 OK

json

{
    "namedVersions": [{
            "id": "1083a893-0f60-4918-8fb0-c3feebf84d6a",
            "displayName": "Solar farm design",
            "changesetId": "9913e22a00eb1086c6be0ed3d09e692738fdfe9d",
            "changesetIndex": 11
        },
        {
            "id": "3020441b-e179-4334-a59a-4fb8deb93df1",
            "displayName": "Wind farm design",
            "changesetId": "1f2e04b666edce395e37a795e2231e995cbf8349",
            "changesetIndex": 14
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/namedversions?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/namedversions?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/namedversions?$skip=100&$top=100"
        }
    }
}

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

Requested iModel is not available.

json

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot get Named Versions.",
        "details": [{
            "code": "InvalidValue",
            "message": "'-1' is not a valid '$skip' value. '$skip' must be a non-negative integer.",
            "target": "$skip"
        }]
    }
}

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

retry-after

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

Definitions

Named Version (summary)

Summarized representation of the Named Version.

String

Id of the Named Version.

displayName

String

Display name of the Named Version. Corresponds to Name property.

changesetId

String, null

Id of the Changeset that the Named Version is created for.

changesetIndex

Int64

Index of the Changeset that the Named Version is created for.

Named Versions (prefer return=minimal)

List of Named Versions in minimal representation.

namedVersions

NamedVersionSummary[]

List of Named Versions of the iModel.

_links

PagingLinks

Contains the hyperlinks to the previous and next pages of results.

Named Versions (prefer return=representation)

List of Named Versions in full representation.

namedVersions

NamedVersion[]

List of Named Versions of the iModel.

_links

PagingLinks

Contains the hyperlinks to the previous and next pages of results.

Named Version state

Indicates the state of the named version. 'hidden' - indicates that Named Version should be hidden in the user interface. 'visible' - indicates that Named Version should be visible in the user interface.

hidden

String

visible

String

Named Version

Full representation of the Named Version.

String

Id of the Named Version.

displayName

String

Display name of the Named Version. Corresponds to Name property.

changesetId

String, null

Id of the Changeset that the Named Version is created for.

changesetIndex

Int64

Index of the Changeset that the Named Version is created for.

name

String

Named Version name.

description

String, null

Description of the Named Version.

createdDateTime

Date-time

Date when the Named Version was created.

Named Version state

NamedVersion-state

application

Application

Information about the application that acquired the Briefcase.

_links

NamedVersionLinks

Contains the hyperlinks to the related data of the Named Version.

Named Version Links

Hyperlinks to Named Version related data.

creator

Link

Information about the creator of the Named Version.

changeset

Link, null

Changeset for which the Named Version was created. If this is null then Named Version was created for a baseline iModel.

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

Paging Links

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

self

Link

URL for redoing the current request.

Link

URL for getting the previous page of results.

Link

URL for getting the next page of results.

Application

Information about the client application that is related to an entity.

String

Id of the application.

name

String

Application name.

Error

Contains error information.

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.

error

Error

Error information.