Create iModel Changeset - iModels

iModels

Download API definition:

post https://dev-api.bentley.com/imodels/{id}/changesets

Creates the metadata of a Changeset.

For more information on creating and retrieving Changesets using iTwin.js see working with Changesets.

Important: This operation should only be used by iTwin.js. For creating and uploading a valid Changeset please use iTwin.js libraries.

Pushing a Changeset consists of three steps:

Create Changeset metadata.
Upload Changeset file to cloud storage using upload property link from the response of Changeset metadata creation.

Request syntax:
    PUT upload HTTP/1.1

For Azure Blob storage the following request header is required: x-ms-blob-type: BlockBlob.

Complete the Changeset push by confirming that Changeset file was uploaded successfully. See Update iModel Changeset operation for the documentation.

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

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 (create)

String

Yes

Id of the changeset.

groupId

String, null

Id of the Changeset Group that the Changeset belongs to.

fileSize

Integer

Yes

Size of the Changeset file in bytes.

parentId

String, null

Id of the parent Changeset.

briefcaseId

Integer

Yes

Id of the briefcase that will be used to create the Changeset.

description

String, null

Description of the Changeset.

containingChanges

Integer, null

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.

synchronizationInfo

SynchronizationInfoCreate

Example

json

{
    "id": "1f2e04b666edce395e37a795e2231e995cbf8349",
    "description": "Changeset 15",
    "parentId": "f7618612c572d7db8e3e6095d622d0d8aff22874",
    "containingChanges": 0,
    "fileSize": 109,
    "briefcaseId": 2,
    "groupId": "1a038d01-5b2d-44d9-b4ca-e8d21805983c",
    "synchronizationInfo": {
        "changedFiles": ["File1.dgn"],
        "taskId": "5154ac23-d83f-4e82-b708-438fb6d51d4e"
    }
}

Response

Response 201 Created

Created

json

{
    "changeset": {
        "id": "1f2e04b666edce395e37a795e2231e995cbf8349",
        "displayName": "256",
        "description": "Changeset 15",
        "index": 0,
        "parentId": "f7618612c572d7db8e3e6095d622d0d8aff22874",
        "state": "waitingForFile",
        "containingChanges": 0,
        "fileSize": 109,
        "briefcaseId": 2,
        "groupId": "1a038d01-5b2d-44d9-b4ca-e8d21805983c",
        "synchronizationInfo": {
            "changedFiles": ["File1.dgn", "File2.dgn"],
            "taskId": "5154ac23-d83f-4e82-b708-438fb6d51d4e"
        },
        "creatorId": null,
        "pushDateTime": null,
        "application": null,
        "_links": {
            "creator": null,
            "namedVersion": null,
            "currentOrPrecedingCheckpoint": null,
            "self": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets/1f2e04b666edce395e37a795e2231e995cbf8349"
            },
            "upload": {
                "storageType": "azure",
                "href": "https://example.com/imodelhub-5e19bee0-3aea-4355-a9f0-c6df9989ee7d/1f2e04b666edce395e37a795e2231e995cbf8349.cs?sv=2019-07-07&sr=b&sig=**removed**&st=2021-07-30T09%3A02%3A10.1944006Z&se=2021-07-30T09%3A22%3A10.1944012Z&sp=rw"
            },
            "complete": {
                "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 403 Forbidden

User is not authorized to create a Changeset.

json

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

Response 404 Not Found

Specified iModel or Briefcase was not found.

json

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

Response 409 Conflict

iModel is not initialzied, a Changeset with the same id already exists, 'parentId' property value does not point to the latest changes or another user is currently in a process of pushing a changeset.

json

{
    "error": {
        "code": "NewerChangesExist",
        "message": "'parentId' does not match latest 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 create Changeset.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided 'fileSize' value is not valid. 'fileSize' must be a non-negative integer value.",
            "target": "fileSize"
        }, {
            "code": "MissingRequiredProperty",
            "message": "Required property is missing.",
            "target": "id"
        }, {
            "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 client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "nullable": true,
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Application

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

String

Id of the application.

name

String

Application name.

json

{
    "type": "object",
    "nullable": true,
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the application."
        },
        "name": {
            "type": "string",
            "description": "Application name."
        }
    },
    "description": "Information about the client application that is related to an entity.",
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "description": "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.",
    "additionalProperties": false
}

Changeset (create)

Properties of Changeset to be created.

String

Id of the changeset.

groupId

String, null

Id of the Changeset Group that the Changeset belongs to.

fileSize

Integer

Size of the Changeset file in bytes.

parentId

String, null

Id of the parent Changeset.

briefcaseId

Integer

Id of the briefcase that will be used to create the Changeset.

description

String, null

Description of the Changeset.

containingChanges

Integer, null

synchronizationInfo

SynchronizationInfoCreate

json

{
    "type": "object",
    "title": "Changeset (create)",
    "required": [
        "id",
        "briefcaseId",
        "fileSize"
    ],
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the changeset."
        },
        "groupId": {
            "type": "string",
            "nullable": true,
            "description": "Id of the [Changeset Group](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel-changeset-group/) that the Changeset belongs to."
        },
        "fileSize": {
            "type": "integer",
            "description": "Size of the Changeset file in bytes."
        },
        "parentId": {
            "type": "string",
            "nullable": true,
            "description": "Id of the parent Changeset."
        },
        "briefcaseId": {
            "type": "integer",
            "description": "Id of the briefcase that will be used to create the Changeset."
        },
        "description": {
            "type": "string",
            "nullable": true,
            "description": "Description of the Changeset."
        },
        "containingChanges": {
            "type": "integer",
            "nullable": true,
            "description": "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."
        },
        "synchronizationInfo": {
            "$ref": "#/components/schemas/SynchronizationInfoCreate"
        }
    },
    "description": "Properties of Changeset to be created.",
    "additionalProperties": false
}

CloudStorageLink storageType

Storage type. Possible values: azure - Azure Blob storage, google - Google Cloud storage.

azure

String

google

String

json

{
    "enum": [
        "azure",
        "google"
    ],
    "type": "string",
    "description": "Storage type. Possible values: `azure` - Azure Blob storage, `google` - Google Cloud storage.",
    "title": "CloudStorageLink storageType"
}

CloudStorageLink

Hyperlink container.

href

String

Hyperlink to cloud storage.

CloudStorageLink storageType

CloudStorageLink-storageType

Storage type. Possible values: azure - Azure Blob storage, google - Google Cloud storage.

json

{
    "type": "object",
    "nullable": true,
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to cloud storage."
        },
        "storageType": {
            "enum": [
                "azure",
                "google"
            ],
            "type": "string",
            "description": "Storage type. Possible values: `azure` - Azure Blob storage, `google` - Google Cloud storage.",
            "title": "CloudStorageLink storageType",
            "$ref": "#/components/schemas/CloudStorageLink-storageType"
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Created 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

json

{
    "enum": [
        "waitingForFile",
        "fileUploaded"
    ],
    "type": "string",
    "description": "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.",
    "title": "Created Changeset state"
}

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

index

Integer

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

Created Changeset state

CreatedChangeset-state

_links

CreatedChangesetLinks

groupId

String, null

Id of the Changeset Group that the Changeset belongs to.

fileSize

Integer

Size of the Changeset file in bytes.

parentId

String, null

Id of the parent Changeset.

creatorId

String, null

Id of the user who created the Changeset.

application

Application

briefcaseId

Integer

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

description

String, null

Description of the Changeset.

displayName

String

Display name of the Changeset. Corresponds to Index property.

pushDateTime

Date-time, null

Date when the Changeset was pushed to iModelHub.

containingChanges

Integer

Describes what type of 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.

synchronizationInfo

SynchronizationInfo

json

{
    "type": "object",
    "title": "Created Changeset",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the changeset."
        },
        "index": {
            "type": "integer",
            "description": "Index of the Changeset (increasing, but not necessarily sequential)."
        },
        "state": {
            "enum": [
                "waitingForFile",
                "fileUploaded"
            ],
            "type": "string",
            "description": "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.",
            "title": "Created Changeset state",
            "$ref": "#/components/schemas/CreatedChangeset-state"
        },
        "_links": {
            "$ref": "#/components/schemas/CreatedChangesetLinks"
        },
        "groupId": {
            "type": "string",
            "nullable": true,
            "description": "Id of the [Changeset Group](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel-changeset-group/) that the Changeset belongs to."
        },
        "fileSize": {
            "type": "integer",
            "description": "Size of the Changeset file in bytes."
        },
        "parentId": {
            "type": "string",
            "nullable": true,
            "description": "Id of the parent Changeset."
        },
        "creatorId": {
            "type": "string",
            "nullable": true,
            "description": "Id of the user who created the Changeset."
        },
        "application": {
            "$ref": "#/components/schemas/Application"
        },
        "briefcaseId": {
            "type": "integer",
            "description": "Id of the briefcase that was used to push the Changeset."
        },
        "description": {
            "type": "string",
            "nullable": true,
            "description": "Description of the Changeset."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the Changeset. Corresponds to Index property."
        },
        "pushDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Date when the Changeset was pushed to iModelHub."
        },
        "containingChanges": {
            "type": "integer",
            "description": "Describes what type of 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."
        },
        "synchronizationInfo": {
            "$ref": "#/components/schemas/SynchronizationInfo"
        }
    },
    "description": "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.",
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "nullable": true,
    "properties": {
        "taskId": {
            "type": "string",
            "nullable": true,
            "description": "Id of the synchronization task."
        },
        "changedFiles": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "nullable": true,
            "description": "List of source file names that contained changes which were synchronized to this Changeset."
        }
    },
    "description": "Information about synchronization that is related to a Changeset. This information is set by applications that perform iModel synchronization.",
    "additionalProperties": false
}

Created Changeset Links

Hyperlinks to Changeset related data.

self

upload

creator

complete

namedVersion

currentOrPrecedingCheckpoint

Link

json

{
    "type": "object",
    "title": "Created Changeset Links",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link"
        },
        "upload": {
            "$ref": "#/components/schemas/CloudStorageLink"
        },
        "creator": {
            "$ref": "#/components/schemas/Link"
        },
        "complete": {
            "$ref": "#/components/schemas/Link"
        },
        "namedVersion": {
            "$ref": "#/components/schemas/Link"
        },
        "currentOrPrecedingCheckpoint": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "Hyperlinks to Changeset related data.",
    "additionalProperties": false
}

Created Changeset Response

Container for Created Changeset object.

changeset

CreatedChangeset

json

{
    "type": "object",
    "title": "Created Changeset Response",
    "properties": {
        "changeset": {
            "$ref": "#/components/schemas/CreatedChangeset"
        }
    },
    "description": "Container for Created Changeset object.",
    "additionalProperties": false
}

SynchronizationInfo (create)

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

taskId

String

Id of the synchronization task.

changedFiles

String[], null

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

json

{
    "type": "object",
    "title": "SynchronizationInfo (create)",
    "nullable": true,
    "properties": {
        "taskId": {
            "type": "string",
            "description": "Id of the synchronization task."
        },
        "changedFiles": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "nullable": true,
            "description": "List of source file names that contained changes which were synchronized to this Changeset."
        }
    },
    "description": "Information about synchronization that is related to a Changeset. This information is set by applications that perform iModel synchronization.",
    "additionalProperties": false
}

Was this page helpful?