Table of contents
iModels
Download API definition:
GET https://qa-api.bentley.com/imodels/{id}/namedversions/{namedVersionId}

Retrieves the details of a Named Version.

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.

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 parameters

Name
Required?
Description
id
Yes

iModel id

namedVersionId
Yes

Named Version id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "namedVersion": {
        "id": "3020441b-e179-4334-a59a-4fb8deb93df1",
        "displayName": "Wind farm design",
        "changesetId": "1f2e04b666edce395e37a795e2231e995cbf8349",
        "changesetIndex": 14,
        "name": "Wind farm design",
        "description": "Finalized wind farm design in Sun City",
        "createdDateTime": "2020-10-21T06:42:57.6700000Z",
        "state": "visible",
        "application": {
            "id": "itwin-designer-unique-id",
            "name": "iTwin Designer"
        },
        "_links": {
            "creator": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/ea4dfb9f-7f66-4c6f-82c5-0efad1636a1f"
            },
            "changeset": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets/1f2e04b666edce395e37a795e2231e995cbf8349"
            }
        }
    }
}

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 or Named Version was not found.

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

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.

Named Version Response

Container for Named Version object.

Name
Type
Description
namedVersion

Named Version properties.

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.

Name
Type
Description
hidden
String
visible
String

Named Version

Full representation of the Named Version.

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

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.

application

Information about the application that acquired the Briefcase.

_links

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

Named Version Links

Hyperlinks to Named Version related data.

Name
Type
Description
creator

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.

Name
Type
Description
href
String

Hyperlink to the specific entity.

Application

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

Name
Type
Description
id
String

Id of the application.

name
String

Application name.

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.

Was this page helpful?