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

Brands

Download API definition:
Get Brand Component Documents
GET https://api.bentley.com/library/brands/{brandId}/components/{componentId}/documents

Retrieves documents for specified digital component from brand.

Downloading Associated File

Associated file url can be found in fileUrl property returned in the response.

Authentication

Requires Authorization header with valid Bearer token for scope library:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization 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
brandId
template
Yes

Id of the brand.

componentId
template
Yes

Id of the component.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope library:read

Accept
No

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

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 422 Unprocessable Entity
Invalid request to get brand component documents.
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
Documents
TableSchema
Name
Type
Description
documents
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 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.