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.
User must have imodels_write 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_write 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.
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
HeaderNotFound
{"error":{"code":"HeaderNotFound","message":"Header Authorization was not found in the request. Access denied."}}
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
InvalidiModelsRequest
{"error":{"code":"InvalidiModelsRequest","message":"Cannot create Named Version.","details":[{"code":"InvalidValue","message":"Provided 'name' is not valid. The value exceeds allowed 255 characters.","target":"name"},{"code":"MissingRequiredProperty","message":"Required property is missing.","target":"name"},{"code":"InvalidRequestBody","message":"Failed to parse request body. Make sure it is a valid JSON."}]}}
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
String
Date when the Named Version was created.
state
String
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.
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.