Update iModel Changeset - iModels

REST API Overview

Reference

Changelog

iModels

Download API definition:

Update iModel Changeset

PATCH https://api.bentley.com/imodels/{id}/changesets/{changesetId}

Confirm that Changeset file has been uploaded to file storage and finalize Changeset push.

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.

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.

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

changesetId

Yes

Changeset id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Content-Type

Indicates request body content type. Supported media type is application/json.

Request body

Changeset (update)

briefcaseId

Integer

Yes

Id of the briefcase that was used to create the Changeset.

Changeset (update) state

ChangesetUpdate-state

Yes

Indicates the state of the Changeset. Should be set to 'fileUploaded'.

Example

json

{
    "state": "fileUploaded",
    "briefcaseId": 2
}

Response

Response 200 OK

json

{
    "changeset": {
        "id": "1f2e04b666edce395e37a795e2231e995cbf8349",
        "displayName": "256",
        "description": "Changeset 15",
        "index": 256,
        "parentId": "f7618612c572d7db8e3e6095d622d0d8aff22874",
        "state": "fileUploaded",
        "containingChanges": 0,
        "fileSize": 109,
        "briefcaseId": 2,
        "groupId": "1a038d01-5b2d-44d9-b4ca-e8d21805983c",
        "creatorId": "ea4dfb9f-7f66-4c6f-82c5-0efad1636a1f",
        "pushDateTime": "2020-10-21T06:35:30.7000000Z",
        "application": null,
        "synchronizationInfo": null,
        "_links": {
            "creator": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/ea4dfb9f-7f66-4c6f-82c5-0efad1636a1f"
            },
            "namedVersion": null,
            "currentOrPrecedingCheckpoint": null,
            "self": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets/1f2e04b666edce395e37a795e2231e995cbf8349"
            },
            "download": null
        }
    }
}

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

User is not authorized to update a Changeset.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

Specified iModel, Changeset, Briefcase or file was not found. FileNotFound will be returned if the server cannot find the uploaded Changeset file.

json

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

Response 409 Conflict

Changeset already exists, another user is currently pushing a Changeset or the iModel is not initialized.

json

{
    "error": {
        "code": "ConflictWithAnotherUser",
        "message": "Another user is pushing a Changeset."
    }
}

Response 415 Unsupported Media Type

This response indicates that the user has specified not supported media type in the request.

json

{
    "error": {
        "code": "UnsupportedMediaType",
        "message": "Media Type is not supported."
    }
}

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 update Changeset.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided 'state' value is not valid. Should be set to 'fileUploaded'.",
                "target": "state"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "state"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Failed to parse request body. Make sure it is a valid JSON."
            }
        ]
    }
}

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

Changeset (update) state

Indicates the state of the Changeset. Should be set to 'fileUploaded'.

waitingForFile

String

fileUploaded

String

Changeset (update)

Properties of Changeset to be updated.

briefcaseId

Integer

Id of the briefcase that was used to create the Changeset.

Changeset (update) state

ChangesetUpdate-state

Indicates the state of the Changeset. Should be set to 'fileUploaded'.

Changeset Response

Container for Changeset object.

changeset

Changeset

Changeset properties.

Changeset state

Indicates the state of the Changeset. 'waitingForFile' - indicates that Changeset metadata is created, but Changeset file is not uploaded yet or file upload is not confirmed yet. 'fileUploaded' - indicates that Changeset file is uploaded and confirmed.

waitingForFile

String

fileUploaded

String

Changeset

Changeset represents a file containing changes to the iModel. A single Changeset contains changes made on a single Briefcase file and pushed as a single file.

String

Id of the Changeset.

displayName

String

Display name of the Changeset. Corresponds to Index property.

description

String, null

Description of the Changeset.

index

Integer

Index of the Changeset (increasing, but not necessarily sequential).

parentId

String, null

Id of the parent Changeset.

creatorId

String

Id of the user who created the Changeset.

pushDateTime

Date-time

Date when the Changeset was pushed to iModelHub.

briefcaseId

Integer

Id of the briefcase that was used to push the Changeset.

groupId

String, null

Id of the Changeset Group that the Changeset belongs to.

fileSize

Integer

Size of the Changeset file in bytes.

containingChanges

Integer

Describes what type of changes Changeset contains. Tells what changes changeset contains. 0 - regular, 1 - schema, 2 - definition, 4 - spatial data, 8 - sheets and drawings, 16 - views and models, 32 - global properties. ContainingChanges is flag value, therefore all change types, except Schema, can be combined.

Changeset state

Changeset-state

application

Application

Information about the application that pushed the Changeset.

synchronizationInfo

SynchronizationInfo

Optional information about synchronization that is related to the Changeset.

_links

ChangesetLinks

Contains the hyperlinks to the related data of the Changeset.

Changeset Links

Hyperlinks to Changeset related data.

creator

Link

Information about the creator of the Changeset.

namedVersion

Link

Named Version which was created for Changeset. If this is null then Changeset does not have a Named Version created for it.

self

Link

Self hyperlink to get the details of the Changeset.

download

Link

Hyperlink to download Changeset file from Azure Blob storage. Set only if the user has at least imodels_read permission, otherwise it is always set to null.

currentOrPrecedingCheckpoint

Link

Hyperlink to get the latest successfully generated checkpoint where applied changeset index is lower or equal to this changeset index.

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

Application

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

String

Id of the application.

name

String

Application name.

SynchronizationInfo

Information about synchronization that is related to a Changeset. This information is set by applications that perform iModel synchronization.

taskId

String, null

Id of the synchronization task.

changedFiles

String[], null

List of source file names that contained changes which were synchronized to this Changeset.

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.