Get Extension Version - iTwin.js Extensions

iTwin.js Extensions

Download API definition:

Get Extension Version

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/{versionNumber}

Gets the detailed metadata for a specific version of an extension, including file data.

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

Id of the extension.

versionNumber

Yes

A valid semantic version number string.

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 version successfully acquired.

json

{
    "_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"
        }
    },
    "version": {
        "extension": {
            "name": "highlight-element-info",
            "description": "Extension provides additional information for highlighted elements."
        },
        "number": "1.0.0",
        "files": [],
        "status": "WaitingForUpload",
        "deprecated": false,
        "lastUpdateTime": "2023-08-16T13:13:17.443Z",
        "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 could not be found.

json

{
    "error": {
        "code": "ExtensionsNotFound",
        "message": "Requested extension is not available.",
        "target": "extensionId"
    }
}

Response 422 Unprocessable Entity

Invalid request to get Extension version.

json

{
    "error": {
        "code": "InvalidExtensionsRequest",
        "message": "Cannot retrieve extension.",
        "details": [{
            "code": "InvalidParameter",
            "message": "A valid extensionId was not specified in the query.",
            "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

Checksum

sha256

String

json

{
    "required": [
        "sha256"
    ],
    "type": "object",
    "properties": {
        "sha256": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

FileResponse

downloadUrl

String

downloadUrlExpiresAt

Date

checksum

Checksum

json

{
    "required": [
        "downloadUrl",
        "downloadUrlExpiresAt",
        "checksum"
    ],
    "type": "object",
    "properties": {
        "downloadUrl": {
            "type": "string"
        },
        "downloadUrlExpiresAt": {
            "type": "string",
            "format": "Date"
        },
        "checksum": {
            "$ref": "#/components/schemas/Checksum"
        }
    },
    "additionalProperties": false
}

get-extension-version-response

_links.iTwin.href

String

_links.self.href

String

version.extension.name

String

version.extension.description

String

version.number

String

version.archiveFile

FileResponse

version.files

ExtractedFileResponse[]

version.status

String

version.statusMessage

String

version.deprecated

Boolean

version.lastUpdateTime

Date

version.creationTime

Date

json

{
    "type": "object",
    "properties": {
        "_links": {
            "required": [
                "self"
            ],
            "type": "object",
            "properties": {
                "iTwin": {
                    "type": "object",
                    "properties": {
                        "href": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false
                },
                "self": {
                    "type": "object",
                    "properties": {
                        "href": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "version": {
            "required": [
                "extension",
                "number",
                "creationTime",
                "status",
                "deprecated",
                "lastUpdateTime",
                "files"
            ],
            "type": "object",
            "properties": {
                "extension": {
                    "required": [
                        "name"
                    ],
                    "type": "object",
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "description": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false
                },
                "number": {
                    "type": "string"
                },
                "archiveFile": {
                    "$ref": "#/components/schemas/FileResponse"
                },
                "files": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/ExtractedFileResponse"
                    }
                },
                "status": {
                    "type": "string"
                },
                "statusMessage": {
                    "type": "string"
                },
                "deprecated": {
                    "type": "boolean"
                },
                "lastUpdateTime": {
                    "type": "string",
                    "format": "Date"
                },
                "creationTime": {
                    "type": "string",
                    "format": "Date"
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}

ExtractedFileResponse

downloadUrl

String

downloadUrlExpiresAt

Date

checksum

Checksum

relativePath

String

isMain

Boolean

json

{
    "required": [
        "downloadUrl",
        "downloadUrlExpiresAt",
        "checksum",
        "relativePath"
    ],
    "type": "object",
    "properties": {
        "downloadUrl": {
            "type": "string"
        },
        "downloadUrlExpiresAt": {
            "type": "string",
            "format": "Date"
        },
        "checksum": {
            "$ref": "#/components/schemas/Checksum"
        },
        "relativePath": {
            "type": "string"
        },
        "isMain": {
            "type": "boolean"
        }
    },
    "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?