Get Brand - Library | iTwin Platform

Library

Download API definition:

Get Brand

GET https://api.bentley.com/library/brands/{brandId}

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

brandId

Yes

Id of the brand.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "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"
    }
}

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

{
    "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.

json

{
    "error": {
        "code": "BrandNotFound",
        "message": "Requested Brand is not available."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Brand (response)

Retrieved brand response containing brand.

brand

Brand

Full representation of the brand.

json

{
    "description": "Retrieved brand response containing brand.",
    "title": "Brand (response)",
    "type": "object",
    "properties": {
        "brand": {
            "description": "Full representation of the brand.",
            "$ref": "#/components/schemas/Brand"
        }
    },
    "additionalProperties": false
}

Brand

String

Id of the brand.

displayName

String

Display name of the brand.

description

String

Description of the brand.

isAvailable

Boolean

Indicates brand has published content and is available for use.

isOwned

Boolean

Indicates if brand belongs to user organization.

isPartnership

Boolean

Indicates if brand content is available by having a partnership with some other organization e.g., Bim Store Brand.

createdDateTime

String

Created datetime of the brand.

lastModifiedDateTime

String

Last modified datetime of the brand.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the brand."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the brand."
        },
        "description": {
            "type": "string",
            "description": "Description of the brand."
        },
        "isAvailable": {
            "type": "boolean",
            "description": "Indicates brand has published content and is available for use."
        },
        "isOwned": {
            "type": "boolean",
            "description": "Indicates if brand belongs to user organization."
        },
        "isPartnership": {
            "type": "boolean",
            "description": "Indicates if brand content is available by having a partnership with some other organization e.g., Bim Store Brand."
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the brand."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the brand."
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?