Digital Library to manage digital components

Digital component library and catalog management service.  It allows users to efficiently manage and distribute their digital component libraries, providing their designers with approved, proprietary components as well as approved manufacturer's content. 


library

---

Retrieves brand from library.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-brand

brandId

OAuth access token with scope `library:read`

Authorization

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

Accept

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.

application/json;InvalidAuthorizationScheme

This response indicates that the specified brand not found.

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

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

retry-after

Retrieved brand response containing brand.

brand-response

brand

Brand

Brand (response)

string

displayName

description

Indicates brand has published content and is available for use.

isAvailable

boolean

Indicates if brand belongs to user organization.

isOwned

Indicates if brand content is available by having a partnership with some other organization e.g., Bim Store Brand.

isPartnership

createdDateTime

lastModifiedDateTime

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

error

Error

Error Response

Contains error information and an optional array of more specific errors.

One of a server-defined set of error codes.

code

A human-readable representation of the error.

message

target

details

ErrorDetails

Error Details

ErrorResponse

---

Retrieves components analytics information as csv downloadable file from user's organization context.
Response contains 'Content-Disposition' header containing name of the file to be downloaded. Query parameters 'startDate' and 'endDate' specify the period for which analytics should be downloaded, these are required parameters and must be in this format yyyy-MM-dd'T'HH:mm:ss.fff'Z'.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `View Analytics` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

download-analytics

Start datetime of analytics to be returned, valid format is yyyy-MM-dd'T'HH:mm:ss.fff'Z'.

startDate

End datetime of analytics to be returned, valid format is yyyy-MM-dd'T'HH:mm:ss.fff'Z'.

endDate

This response indicates that user does not have required permissions to download analytics.

---

Creates an application in user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-application

OAuth access token with scope `library:modify`

This response indicates that user does not have required permissions to create category.

Application with the same name and version already exists within the organization.

application/json;InvalidCreateApplicationRequest

---

Deletes application from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-application

This response indicates that user does not have required permissions to delete specified application.

This response indicates that the specified application not found.

---

Retrieves Application from user's organization 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-application

---

Retrieves applications from user's organization context.

### Notes

The response returns only 50 entities.To retrieve all the entities, continuation token should be used in the subsequent requests, which is returned in the response under _links as part of next request url.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-applications

Response returns 50 results and a link to next page containing continuation token value. This value should be provided to the parameter to fetch next results. If there are no more results, response will not have a link to next url.

continuationToken

This response indicates that the specified applications not found.

---

Updates an application in user's organization context.

### Notes

To update an application, request body must contain all the properties desired for the application since this will replace existing application with current application definition. DisplayName and version are required properties.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-application

application/json;InvalidUpdateApplicationRequest

---

Retrieves documents for specified digital component from brand.

### Downloading Associated File

Associated file url can be found in fileUrl property returned in the response.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-brand-component-documents

componentId

Invalid request to get brand component documents.

---

Retrieves variations for specified digital component from brand.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-brand-component-variations

Invalid request to get brand component variations.

---

Retrieves webLinks for specified digital component from brand.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-brand-component-weblinks

Invalid request to get brand component weblinks.

---

Retrieves digital components from brand.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-brand-components

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

Find all components that have the search string anywhere in the  hashTags or displayName.

$search

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

Prefer

---

Retrieves brands.

### Response

By default, each entity in the returned list will have only the id and display name.

A full representation of each entity can be returned by specifying the *prefer* header that includes a value of *return=representation*.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-brands

---

Creates a catalog in user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-catalog

This response indicates that user does not have required permissions to create catalog.

Catalog with the same name already exists within the organization.

application/json;InvalidCreateCatalogRequest

---

Creates a catalog document in user's organization context.

### Notes

To create a catalog document, displayName extension and purpose are required properties.

Document purpose values are:
-Thumbnail 
-Reference

### Uploading Associated File

To complete the process, associated file should be uploaded to fileUrl (property in response) and a subsequent update document request should be made by setting 'available' property to true.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-catalog-document

catalogId

This response indicates that user does not have required permissions to create document.

Catalog Document with the same name, extension and version already exists

---

Creates a catalog webLink in user's organization context.

### Notes

To create a catalog webLink, displayName and uri are required properties.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-catalog-weblink

This response indicates that user does not have required permissions to create webLink.

WebLink with the same name already exists

---

Deletes catalog from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-catalog

This response indicates that user does not have required permissions to delete specified catalog.

This response indicates that the specified catalog not found.

---

Deletes provided document for specified catalog from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-catalog-document

documentId

This response indicates that user does not have required permissions to delete specified document.

This response indicates that the specified document not found.

---

Deletes provided webLink for specified catalog from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-catalog-weblink

webLinkId

This response indicates that user does not have required permissions to delete specified webLink.

This response indicates that the specified webLink not found.

---

Retrieves catalog from user's organization 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-catalog

---

Retrieves documents for specified digital catalog from user's organization context.

### Downloading Associated File

Associated file url can be found in fileUrl property returned in the response.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-catalog-document

This response indicates that the specified documents not found.

get-catalog-documents

This response indicates that the specified catalog documents not found.

---

Retrieves webLink for specified digital catalog from user's organization 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-catalog-weblink

---

Retrieves webLinks for specified digital catalog from user's organization 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-catalog-weblinks

This response indicates that the specified catalog WebLinks not found.

---

Retrieves digital catalogs from user's organization context.

### Response

By default, each entity in the returned list will have only the id and display name.

A full representation of each entity can be returned by specifying the *prefer* header that includes a value of *return=representation*.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-catalogs

Find all catalogs that have the search string anywhere in the  hashTags or displayName.

This response indicates that the specified components not found.

---

Updates a catalog in user's organization context.

### Notes

To update a catalog, request body must contain all the properties desired for the catalog since this will replace existing catalog with current catalog definition. DisplayName is required property.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-catalog

application/json;InvalidUpdateCatalogRequest

---

Updates a catalog document in user's organization context.

### Notes

To update a document, request body must contain all the properties desired for the document since this will replace existing document with current document definition. DisplayName extension and purpose are required properties.

Document purpose values are:
-Thumbnail 
-Reference

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-catalog-document

---

Updates a catalog webLink in user's organization context.

### Notes

To update a webLink, request body must contain all the properties desired for the webLink since this will replace existing webLink with current webLink definition. DisplayName and uri are required properties.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-catalog-weblink

This response indicates that user does not have required permissions to update webLink.

WebLink with the same name already exists.

---

Creates a category in user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-category

Category with the same name already exists within the organization.

application/json;InvalidCreateCategoryRequest

---

Deletes category from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-category

This response indicates that user does not have required permissions to delete specified category.

This response indicates that the specified category not found.

---

Retrieves categories from user's organization context.

### Notes

The response returns only 50 entities.To retrieve all the entities, continuation token should be used in the subsequent requests, which is returned in the response under _links as part of next request url.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-categories

This response indicates that the specified categories not found.

---

Retrieves category from user's organization 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](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Read` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-category

---

Updates a category in user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-category

application/json;InvalidUpdateCategoryRequest

---

Creates component in user's organization context.

### Notes

To create a component, displayName and status are required properties.

Component status values are:
-Draft
-Published 
-Checked
-Approved
-Archived
By default a component is created with Draft state, subsequently it can be updated to other states during component's validation cycle. Only published components can be used in project scope.

### Associated Entities
A component can have associated entities, e.g catalogs, application, category, manufacturer. These values should be valid Ids of existing entities.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Upload` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-component

This response indicates that user does not have required permissions to create component.

application/json;InvalidCreateComponentRequest

---

Creates a component document in user's organization context.

### Notes

To create a component document, displayName extension and purpose are required properties.

Document purpose values are:
-Design
-Thumbnail 
-Reference
-GalleryImage
-TypeCatalog

### Uploading Associated File
To complete the process, associated file should be uploaded to fileUrl (property in response) and a subsequent update document request should be made by setting 'available' property to true.

### Associated Documents
Document with purpose Thumbnail, GalleryImage and TypeCatalog can have associated design document, this should be a valid Id of existing design document. PreviousVersionId is only valid for Design documents and requires a valid Id of an existing design document, in case a design document needs up-version. In case there are multiple versions of the design document, only one design document and it's corresponding thumbnail can be active.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-component-document

Document with the same name, extension and version already exists.

---

Creates a component variation in user's organization context.

### Notes

To create a component variation, displayName is required property. If variation contains AdHocProperties, displayName and type are required properties of AdHocProperty.

AdHocProperty type values are:
-StringType
-IntegerType
-DoubleType
-FloatType
-BooleanType

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Upload` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-component-variation

This response indicates that user does not have required permissions to create variation.

---

Creates a component webLink in user's organization context.

### Notes

To create a component webLink, displayName and uri are required properties.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-component-weblink

---

Deletes digital component from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-component

This response indicates that user does not have required permissions to delete specified component.

This response indicates that the specified component not found.

---

Deletes provided document for specified digital component from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-component-document

---

Deletes provided variation for specified digital component from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-component-variation

variationId

This response indicates that user does not have required permissions to delete specified variation.

---

Deletes provided webLink for specified digital component from user's organization context.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `library:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization or have `Write` permission assigned at the organization level.

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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-component-weblink

---

Retrieves 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](https://developer.bentley.com/apis/overview/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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-component

projectId

---

Retrieves documents for specified digital component from user's organization or project context.

### Downloading Associated File

Associated file url can be found in fileUrl property returned in the response.

### 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](https://developer.bentley.com/apis/overview/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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-component-document

get-component-documents

This response indicates that the specified component documents not found.

Invalid request to get component documents.

---

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](https://developer.bentley.com/apis/overview/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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-component-variation

get-component-variations

This response indicates that the specified component variations not found.

Brands

Authentication

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Definitions

Brand (response)

Brand

Error Response

Error

Error Details

Error Response