Get Extension Versions - iTwin.js Extensions

iTwin.js Extensions

Download API definition:

Get Extension Versions

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://dev-api.bentley.com/extensions/{extensionId}/versions[?$top][&$skip][&includeDeprecated]

Retrieves a list of extension versions that are associated with the extension provided through the extension ID.

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.

Request parameters

extensionId

Yes

Extension ID

$top

Requests the number of versions in the queried collection to be included in the result (default - 100)

$skip

Requests the number of versions in the queried collection that are to be skipped and not included in the result (default - 0)

includeDeprecated

Specify whether or not to include deprecated versions in the response (default - false)

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

Extension's versions successfully acquired.

json

{
    "_links": {
        "self": {
            "href": "https://api.bentley.com/extensions/67ef40a5-d47b-4ce9-83a0-803d558478a9/versions?$top=100&$skip=100"
        },
        "next": {
            "href": "https://api.bentley.com/extensions/67ef40a5-d47b-4ce9-83a0-803d558478a9/versions?$top=100&$skip=200"
        },
        "prev": {
            "href": "https://api.bentley.com/extensions/67ef40a5-d47b-4ce9-83a0-803d558478a9/versions?$top=100&$skip=0"
        }
    },
    "versions": [{
        "_links": {
            "iTwin": {
                "href": "https://api.bentley.com/iTwins/803548e2-3965-4344-9845-a65c26b3dd2a"
            },
            "self": {
                "href": "https://api.bentley.com/extensions/67ef40a5-d47b-4ce9-83a0-803d558478a9/versions/1.0.0"
            }
        },
        "number": "1.0.0",
        "creationTime": "2023-08-16T13:13:17.443Z"
    }]
}

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

Extension's versions could not be found.

json

{
    "error": {
        "code": "ExtensionNotFound",
        "message": "Requested Extension is not available.",
        "target": "iTwinId"
    }
}

Response 422 Unprocessable Entity

Invalid request to get Extension's versions.

json

{
    "error": {
        "code": "InvalidExtensionsRequest",
        "message": "Cannot retrieve extension.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided 'extensionId' is not valid.",
            "target": "extensionId"
        }]
    }
}

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

Get Extension's Versions Response

_links.self.href

String

_links.next.href

String

_links.prev.href

String

versions

Object[]

Versions associated with an extension.

json

{
    "title": "Get Extension's Versions Response",
    "type": "object",
    "properties": {
        "_links": {
            "type": "object",
            "properties": {
                "self": {
                    "type": "object",
                    "properties": {
                        "href": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false
                },
                "next": {
                    "type": "object",
                    "properties": {
                        "href": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false
                },
                "prev": {
                    "type": "object",
                    "properties": {
                        "href": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "versions": {
            "type": "array",
            "items": {
                "required": [
                    "_links",
                    "number",
                    "creationTime"
                ],
                "type": "object",
                "properties": {
                    "_links": {
                        "type": "object",
                        "properties": {
                            "iTwin": {
                                "type": "object",
                                "properties": {
                                    "href": {
                                        "type": "string"
                                    }
                                },
                                "additionalProperties": false
                            },
                            "self": {
                                "type": "object",
                                "properties": {
                                    "href": {
                                        "type": "string"
                                    }
                                },
                                "additionalProperties": false
                            }
                        }
                    },
                    "number": {
                        "type": "string",
                        "description": "The version number."
                    },
                    "creationTime": {
                        "type": "string"
                    }
                },
                "additionalProperties": false
            },
            "description": "Versions associated with an extension."
        }
    },
    "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?