Retrieves a list of Extensions. If an iTwinId was passed into the request, it will retrieve a list of extensions associated with that iTwin account. Else, it returns all public extensions.
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
Find all extensions that have the search string anywhere in the name.
Requests the number of extensions in the queried collection to be included in the result (default - 100)
Requests the number of extensions in the queried collection that are to be skipped and not included in the result (default - 0)
Id of the the iTwin for which to get extensions. If not provided, public extensions will be returned.
Specify whether or not returned extensions should be iTwin.js Studio Apps (default - false)
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
Extensions successfully acquired.
{ "extensions": [{ "id": "41d94bd4-46b8-48e9-a29a-7c7704a7e662", "name": "sensor-display", "description": "Extension which adds decorators to display sensors in the viewport.", "_links": { "iTwin": { "href": "https://api.bentley.com/iTwins/803548e2-3965-4344-9845-a65c26b3dd2a" }, "versions": { "href": "https://api.bentley.com/extensions/41d94bd4-46b8-48e9-a29a-7c7704a7e662/versions" } } }, { "id": "67ef40a5-d47b-4ce9-83a0-803d558478a9", "name": "highlight-element-info", "description": "Extension provides additional information for highlighted elements.", "_links": { "iTwin": { "href": "https://api.bentley.com/iTwins/803548e2-3965-4344-9845-a65c26b3dd2a" }, "versions": { "href": "https://api.bentley.com/extensions/67ef40a5-d47b-4ce9-83a0-803d558478a9/versions" } } } ], "_links": { "self": { "href": "https://api.bentley.com/extensions?iTwinId=803548e2-3965-4344-9845-a65c26b3dd2a&$top=100&$skip=100" }, "next": { "href": "https://api.bentley.com/extensions?iTwinId=803548e2-3965-4344-9845-a65c26b3dd2a&$top=100&$skip=200" }, "prev": { "href": "https://api.bentley.com/extensions?iTwinId=803548e2-3965-4344-9845-a65c26b3dd2a&$top=100&$skip=0" } } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
Extensions could not be found.
{ "error": { "code": "ExtensionsNotFound", "message": "Requested Extensions are not available.", "target": "iTwinId" } }
Response 422 Unprocessable Entity
Invalid request to get Extensions.
{ "error": { "code": "InvalidExtensionsRequest", "message": "Cannot retrieve extensions.", "details": [{ "code": "InvalidParameter", "message": "A valid iTwinId was not specified in the query. The value is missing or not a valid GUID.", "target": "iTwinId" }] } }
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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Get Extensions Response
Retrieved Extensions.
{ "title": "Get Extensions Response", "type": "object", "properties": { "extensions": { "type": "array", "items": { "required": [ "id", "name", "_links" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "_links": { "type": "object", "properties": { "iTwin": { "type": "object", "properties": { "href": { "type": "string" } }, "additionalProperties": false }, "versions": { "type": "object", "properties": { "href": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Retrieved Extensions." }, "_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 } }, "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "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.
{ "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?