Get Started
Documentation
Samples

Library

Overview
Tutorials
Samples
Reference
Changelog

Components

Download API definition:
Update Component
PUT https://api.bentley.com/library/components/{id}

Updates existing component in user's organization context.

Notes

To update a component request body must contain all the properties desired for the component since this will replace existing component with current component definition. DisplayName and status are required properties.

Component status values are: -Draft -Published -Checked -Approved -Archived

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

Request parameters

Name
In
Required?
Description
id
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

Component (create/update)

Name
Type
Required?
Description
displayName
String
Yes

Display name of the component. Maximum length of the display name is 150, it must not include these special characters >, <, ^, $, ?, ||.

description
String
No

Description of the component. Maximum length of the description is 250.

state
String
Yes

Indicates the state of component.

catalogs
String[]
No

List of associated catalog Ids, must be string values of valid GUIDs of existing catalogs.

application
String
No

Associated application Id, must be a string value of valid GUID of existing application.

category
String
No

Associated category Id, must be a string value of valid GUID of existing category.

manufacturer
String
No

Associated manufacturer Id, must be a string value of valid GUID of existing manufacturer.

hashtags
String[]
No

Hashtags of the component. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.

Response

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 update component.
json
Response 404 Not Found
This response indicates that the specified component not found.
json
Response 422 Unprocessable Entity
Invalid request to upload component.
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.
Definitions
Component (response)
Retrieved component response containing component.
TableSchema
Name
Type
Description
component
Component
Full representation of the component.
Component
TableSchema
Name
Type
Description
id
String
Id of the component.
displayName
String
Display name of the component.
description
String
Description of the component.
state
String
Indicates the state of component.
createdDateTime
String
Created datetime of the component.
lastModifiedDateTime
String
Last modified datetime of the component.
supportedFileTypes
String[]
Supported file types of the component.
hashtags
String[]
Hashtags of the component.
_links
component-links
Contains the hyperlinks to the related data of component.
Component (create/update)
TableSchema
Name
Type
Description
displayName
String
Display name of the component. Maximum length of the display name is 150, it must not include these special characters >, <, ^, $, ?, ||.
description
String
Description of the component. Maximum length of the description is 250.
state
String
Indicates the state of component.
catalogs
String[]
List of associated catalog Ids, must be string values of valid GUIDs of existing catalogs.
application
String
Associated application Id, must be a string value of valid GUID of existing application.
category
String
Associated category Id, must be a string value of valid GUID of existing category.
manufacturer
String
Associated manufacturer Id, must be a string value of valid GUID of existing manufacturer.
hashtags
String[]
Hashtags of the component. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.
Component Links
Hyperlinks to related data which complements this entity.
TableSchema
Name
Type
Description
catalogs
Link[]
Links to associated catalogs.
application
Link
Link to associated application of the component.
category
Link
Link to associated category of the component.
manufacturer
Link
Link to associated manufacturer of the component.
Link
TableSchema
Name
Type
Description
href
String
Error Response
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.
TableSchema
Name
Type
Description
error
Error
Error information.
Error
Contains error information and an optional array of more specific errors.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
The target of the error.
details
ErrorDetails[]
Optional array of more specific errors.
Error Details
Contains error information.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
The target of the error.
Error Response
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.
TableSchema
Name
Type
Description
error
Error
Error information.