Get Started
Documentation
Samples
Table of contents
Overview
Tutorials
Samples
Changelog
Library

Components

Download API definition:
Update Component Document
PUT https://api.bentley.com/library/components/{componentId}/documents/{documentId}

Updates a component 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: -Design -Thumbnail -Reference -GalleryImage -TypeCatalog

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 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
componentId
template
Yes

Id of the component.

documentId
template
Yes

Id of the document.

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

Document (create/update)

Name
Type
Required?
Description
displayName
String
Yes

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

extension
String
Yes

Extension of the file associated with this document, e.g., rfa, dgn, txt etc.

version
String
No

Version of the document.

previousVersionId
String
No

This is only used with document purpose 'Design'. Once a design document is being up-versioned, this should have value of previous active design document.

associatedDesignDocument
String
No

This is only used with purpose 'Thumbnail' or 'TypeCatalog' and refers to associated design document.

purpose
String
Yes

Indicates the purpose of document. Only one 'TypeCatalog' document can be added to a component with an existing design document. Display name of the type catalog and design document for a component must be same.

available
Boolean
No

This indicates if a file is associated to the document.

isActive
Boolean
No

This is by default true for all documents except where purpose is 'Design' or a 'Thumbnail' associated to the design document, in case there are multiple versions of the design document, only one can be active.

Example

json
Response
Response 200 OK
OK
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 document.
json
Response 404 Not Found
This response indicates that the specified document 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
Document (response)
Retrieved document response containing document.
TableSchema
Name
Type
Description
document
Document
Full representation of the document.
Document
TableSchema
Name
Type
Description
id
String
Id of the document.
displayName
String
Display name of the document.
extension
String
Extension of the associated file to the document.
version
String
Version of the document.
previousVersionId
String
This property is only used for design documents for up-version. Once a design document is up-versioned, this contains id of the previous design document.
purpose
String
Indicates the purpose of document.
size
Number
Size of the document.
available
Boolean
This indicates if associated file to this document is available.
isActive
Boolean
This is always true for all documents except design documents. In case there are multiple versions of a design document, only one can be active.
createdDateTime
String
Created datetime of the document.
lastModifiedDateTime
String
Last modified datetime of the document.
_links
document-links
Contains the hyperlinks to the related data of document.
Document (create/update)
TableSchema
Name
Type
Description
displayName
String
Display name of the document. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.
extension
String
Extension of the file associated with this document, e.g., rfa, dgn, txt etc.
version
String
Version of the document.
previousVersionId
String
This is only used with document purpose 'Design'. Once a design document is being up-versioned, this should have value of previous active design document.
associatedDesignDocument
String
This is only used with purpose 'Thumbnail' or 'TypeCatalog' and refers to associated design document.
purpose
String
Indicates the purpose of document. Only one 'TypeCatalog' document can be added to a component with an existing design document. Display name of the type catalog and design document for a component must be same.
available
Boolean
This indicates if a file is associated to the document.
isActive
Boolean
This is by default true for all documents except where purpose is 'Design' or a 'Thumbnail' associated to the design document, in case there are multiple versions of the design document, only one can be active.
Document Links
Hyperlinks to related data which complements this entity.
TableSchema
Name
Type
Description
associatedDesignDocument
Link
Link to associated design document.
fileUrl
Link
Link to download the file associated to this document.
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.