Library

Components

Download API definition:

POST https://sampleHostName/library/components/{componentId}/variations

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


Request parameters

Name
In
Required?
Description
componentId
template
Yes

Id of the component.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope library:modify

Accept
No

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

Request body

variation-create-update

Name
Type
Required?
Description
No data.

Response 201 Created

Created

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 403 Forbidden

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

json

Response 422 Unprocessable Entity

Invalid request to create WebLink.

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.