Retrieves brand from library.
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
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.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "brand": { "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e", "displayName": "Power Distribution", "description": "Power Distribution Catalog", "isAvailable": true, "isOwned": true, "isPartnership": false, "createdDateTime": "2019-11-26T17:12:40.8516569Z", "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z" } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified brand not found.
{ "error": { "code": "BrandNotFound", "message": "Requested Brand is not available." } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Brand (response)
Retrieved brand response containing brand.
Brand
Id of the brand.
Display name of the brand.
Description of the brand.
Indicates brand has published content and is available for use.
Indicates if brand belongs to user organization.
Indicates if brand content is available by having a partnership with some other organization e.g., Bim Store Brand.
Created datetime of the brand.
Last modified datetime of the brand.
Error
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.