Get Brands - Library | iTwin Platform

Library

Download API definition:

GET https://api.bentley.com/library/brands

Retrieves brands.

Response

By default, each entity in the returned list will have only the id and display name.

A full representation of each entity can be returned by specifying the prefer header that includes a value of return=representation.

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 headers

Prefer

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

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

{
    "brands": [{
            "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
            "displayName": "Power Distribution"
        },
        {
            "id": "3ea8dcff-5ebb-b236-ea2f-0bfbdf3c624b",
            "displayName": "Building Technology"
        }
    ]
}

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 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Brands (prefer return=representation)

brands

Brand[]

json

{
    "type": "object",
    "title": "Brands (prefer return=representation)",
    "properties": {
        "brands": {
            "type": "array",
            "items": {
                "description": "List of brands.",
                "$ref": "#/components/schemas/Brand"
            }
        }
    },
    "additionalProperties": false
}

Brands (prefer return=minimal)

brands

brand-summary[]

json

{
    "type": "object",
    "title": "Brands (prefer return=minimal)",
    "properties": {
        "brands": {
            "type": "array",
            "items": {
                "description": "List of brands.",
                "$ref": "#/components/schemas/brand-summary"
            }
        }
    },
    "additionalProperties": false
}

Brand (summary)

String

Id of the brand.

displayName

String

Display name of the brand.

json

{
    "type": "object",
    "title": "Brand (summary)",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the brand."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the 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?