Library

Components

Download API definition:


Upload Component

POST https://api.bentley.com/library/upload


Uploads a design file to create a digital component.

Notes

This endpoint is to create a component from design file. Supported file extensions are '.rfa', '.dgn' and '.cel'. This is a long running activity that runs in background after the endpoint is called and creates a component by extracting information from the design file, e.g., category, application, manufacturer and other metadata found in the design file. Response object has links to upload the design file or type catalog file, if specified. Client must upload type catalog file before uploading design file. Once files are uploaded, component creation activity can be tracked using job endpoint returned in the 'Location' header. Once job succeeds, component can be fetched using 'component' property provided under _links in job endpoint response.

Referenced Entities

A component can have referenced entities, e.g catalogs. 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 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 wiki page.

Rate limits

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