Brands
Retrieves digital components from brand.
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 parameters
Id of the brand.
The $top system query option requests the number of items in the queried collection to be included in the result.
The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
Find all components that have the search string anywhere in the hashTags or displayName.
Request headers
Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.
OAuth access token with scope library:read
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
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.
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
The number of requests exceeds the rate-limit for the client subscription.
Brand Components (prefer return=representation)
Components (prefer return=minimal)
Component (summary)
Id of the component.
Display name of the component.
Brand Component
Id of the component.
Display name of the component.
Description of the component.
Indicates the state of component. By default a component is created with Draft state, subsequently it can be updated to other states during component's validation cycle.
Created datetime of the component.
Last modified datetime of the component.
File types supported by the component.
Hashtags of the component.
Link
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.
Error
Contains error information and an optional array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Details
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.