Get Changesets Extended Data - iModels

iModels

Download API definition:

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

Retrieves a list of extended Changeset data entries for the iModel specified by the iModel id.

Extended data is an application specific data associated to the Changeset. This data is not interpreted by the service. Extended data must be a valid json object encoded as base64 string.

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_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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "extendedData": [{
            "changesetId": "78c09f3337370b26acabead1790d77b2a6ebc6ee",
            "changesetIndex": 1,
            "data": "ewogICJkYXRhIjogewogICAgImNoYW5nZWRGaWxlcyI6IFsKICAgICAgIkEuZGduIiwKICAgICAgIkIuZGduIgogICAgXSwKICAgICJ0YXNrSWQiOiAiZGIxNGY4MzUtOGQxYy00YjU2LTkyMzUtNzE1ZWJkMjMzODE0IgogIH0KfQ=="
        },
        {
            "changesetId": "a1ecbdc8c4f6173004f9f881914a57c5511a362b",
            "changesetIndex": 2,
            "data": "ewogICJkYXRhIjogewogICAgImNoYW5nZWRGaWxlcyI6IFsKICAgICAgIkEuZGduIiwKICAgICAgIkIuZGduIgogICAgXSwKICAgICJ0YXNrSWQiOiAiZGIxNGY4MzUtOGQxYy00YjU2LTkyMzUtNzE1ZWJkMjMzODE0IgogIH0KfQ=="
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets/extendeddata?$skip=100&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets/extendeddata?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets/extendeddata?$skip=200&$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

Specified iModel was not found.

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 Changesets Extended Data.",
        "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 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

Changeset Extended Data

Metadata of Changeset Extended Data.

changesetIndex

Int64

Index of the changeset.

changesetId

String

Id of the Changeset the extended data is associated to.

data

String

Application specific valid json object encoded as base64 string. Maximum supported size is 204800 bytes.

json

{
    "type": "object",
    "title": "Changeset Extended Data",
    "description": "Metadata of Changeset Extended Data.",
    "properties": {
        "changesetIndex": {
            "type": "integer",
            "format": "int64",
            "description": "Index of the changeset."
        },
        "changesetId": {
            "type": "string",
            "description": "Id of the Changeset the extended data is associated to."
        },
        "data": {
            "type": "string",
            "description": "Application specific valid json object encoded as base64 string. Maximum supported size is 204800 bytes."
        }
    },
    "additionalProperties": false
}

Changesets Extended Data Response

List of Changesets Extended Data entries.

extendedData

ChangesetExtendedData[]

Changesets Extended Data entries of the iModel.

_links

PagingLinks

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

json

{
    "type": "object",
    "title": "Changesets Extended Data Response",
    "description": "List of Changesets Extended Data entries.",
    "properties": {
        "extendedData": {
            "type": "array",
            "description": "Changesets Extended Data entries of the iModel.",
            "items": {
                "$ref": "#/components/schemas/ChangesetExtendedData"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the previous and next pages of results."
        }
    },
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

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

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.

json

{
    "type": "object",
    "title": "Paging Links",
    "description": "URLs for redoing the current request, getting to the previous or next page of results, if applicable.",
    "properties": {
        "self": {
            "description": "URL for redoing the current request.",
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "description": "URL for getting the previous page of results.",
            "$ref": "#/components/schemas/Link"
        },
        "next": {
            "description": "URL for getting the next page of results.",
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

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.

json

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

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

Was this page helpful?