Table of contents
Library
Download API definition:
GET https://api.bentley.com/library/brands/{brandId}/components[?$top][&$skip][&$search]

Retrieves digital components from brand.

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

Name
In
Required?
Description
brandId
template
Yes

Id of the brand.

$top
query
No

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip
query
No

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$search
query
No

Find all components that have the search string anywhere in the hashTags or displayName.

Request headers

Name
Required?
Description
Prefer
No

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

Accept
Yes

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

Response 200 OK

OK

json
{
    "components": [{
            "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
            "displayName": "Door"
        },
        {
            "id": "3ea8dcff-5ebb-b236-ea2f-0bfbdf3c624b",
            "displayName": "Door"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/library/brands/88c18159-54ad-4c22-8083-050eaa632f80/components?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/library/brands/88c18159-54ad-4c22-8083-050eaa632f80/components?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/library/brands/88c18159-54ad-4c22-8083-050eaa632f80/components?$skip=100&$top=100"
        }
    }
}

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
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 422 Unprocessable Entity

Invalid request to get brand components.

json
{
    "error": {
        "code": "InvalidBrandComponentsRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidValue",
                "message": "Page size is over '1000' items limit.",
                "target": "$top"
            },
            {
                "code": "InvalidValue",
                "message": "Provided brandId value is not valid.",
                "target": "brandId"
            }
        ]
    }
}

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

Name
Description
retry-after

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

Brand Components (prefer return=representation)

TableSchema
Name
Type
Description
components
_links

Contains the hyperlinks to the previous and next pages of results.

Components (prefer return=minimal)

TableSchema
Name
Type
Description
components
_links

Contains the hyperlinks to the previous and next pages of results.

Component (summary)

TableSchema
Name
Type
Description
id
String

Id of the component.

displayName
String

Display name of the component.

Brand Component

TableSchema
Name
Type
Description
id
String

Id of the component.

displayName
String

Display name of the component.

description
String

Description of the component.

state
String

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.

createdDateTime
String

Created datetime of the component.

lastModifiedDateTime
String

Last modified datetime of the component.

supportedFileTypes
String[]

File types supported by the component.

hashtags
String[]

Hashtags of the component.

Link

TableSchema
Name
Type
Description
href
String

Links (paging)

TableSchema
Name
Type
Description
self
next
prev

Error

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 information.