Get Brand Components - Library

Library

Download API definition:

Get Brand Components

get https://dev-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

brandId

Yes

Id of the brand.

$top

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

$skip

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

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

Request headers

Prefer

Indicates a level of details in the response.

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

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

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 requested operation or resource could not be found.

json

{
    "error": {
        "code": "ResourceNotFound",
        "message": "The requested resource was not found. Verify the API URL and the Accept header.",
        "details": [{
            "code": "OperationNotFound",
            "message": "Unable to match incoming request to an operation."
        }]
    }
}

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

Link

href

String

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

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

Links (paging)

Link

self

Link

json

{
    "type": "object",
    "title": "Links (paging)",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "$ref": "#/components/schemas/Link"
        },
        "self": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

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

Brand Component state

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.

Draft

String

Published

String

Checked

String

Approved

String

Archived

String

json

{
    "enum": [
        "Draft",
        "Published",
        "Checked",
        "Approved",
        "Archived"
    ],
    "type": "string",
    "description": "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.",
    "title": "Brand Component state"
}

Brand Component

String

Id of the component.

Brand Component state

brand-component-state

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.

hashtags

String[]

Hashtags of the component.

description

String

Description of the component.

displayName

String

Display name of the component.

createdDateTime

String

Created datetime of the component.

supportedFileTypes

String[]

File types supported by the component.

lastModifiedDateTime

String

Last modified datetime of the component.

json

{
    "type": "object",
    "title": "Brand Component",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the component."
        },
        "state": {
            "enum": [
                "Draft",
                "Published",
                "Checked",
                "Approved",
                "Archived"
            ],
            "type": "string",
            "description": "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.",
            "title": "Brand Component state",
            "$ref": "#/components/schemas/brand-component-state"
        },
        "hashtags": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Hashtags of the component."
        },
        "description": {
            "type": "string",
            "description": "Description of the component."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the component."
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the component."
        },
        "supportedFileTypes": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "File types supported by the component."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the component."
        }
    },
    "additionalProperties": false
}

Component (summary)

String

Id of the component.

displayName

String

Display name of the component.

json

{
    "type": "object",
    "title": "Component (summary)",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the component."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the component."
        }
    },
    "additionalProperties": false
}

Components (prefer return=minimal)

_links

links-paging

components

component-summary[]

json

{
    "type": "object",
    "title": "Components (prefer return=minimal)",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/links-paging"
        },
        "components": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/component-summary"
            }
        }
    },
    "additionalProperties": false
}

Brand Components (prefer return=representation)

_links

links-paging

components

brand-component[]

json

{
    "type": "object",
    "title": "Brand Components (prefer return=representation)",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/links-paging"
        },
        "components": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/brand-component"
            }
        }
    },
    "additionalProperties": false
}

Was this page helpful?