Download API definition:

POST https://sampleHostName/library/components

Creates component in user's organization context.


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.


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 page.


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 wiki page.

Rate limits

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