Library

Components

Download API definition:

GET https://sampleHostName/library/components/{componentId}/variations[?projectId]

Retrieves variations for specified digital component from user's organization or project context.

Authentication

Requires Authorization header with valid Bearer token for scope library:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must be an Organization Administrator for the Organization or have Read permission assigned at the organization level or have Read permission assigned at the project level, in case request is scoped to a project.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.


Request parameters

Name
In
Required?
Description
componentId
template
Yes

Id of the component.

projectId
query
No

Id of the project.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope library:read

Accept
No

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

Response 200 OK

OK

json

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

Response 404 Not Found

This response indicates that the specified component variations not found.

json

Response 422 Unprocessable Entity

Invalid request to get component variations.

json

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

Response headers

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.