Get Brand Component Documents - Library

Library

Download API definition:

Get Brand Component Documents

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

Retrieves documents for specified digital component from brand.

Downloading Associated File

Associated file url can be found in fileUrl property returned in the response.

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.

componentId

Yes

Id of the component.

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

{
    "documents": [{
            "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
            "displayName": "Electric Water Heater_DRE",
            "extension": "rfa",
            "purpose": "Design",
            "size": 890456,
            "available": true,
            "isActive": true,
            "version": "1",
            "previousVersionId": "2fa8dcff-5ebb-b236-ea2f-0bfbdf3c512c",
            "createdDateTime": "2019-11-26T17:12:40.8516569Z",
            "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z",
            "_links": {
                "fileUrl": {
                    "href": "https://componentscenprodeussa01.blob.core.windows.net/private-3920224a-6600-41c9-aadb-2510159e373c/f8546e53-fd19-06f2-8071-ace2d70b05b6/Electric Water Heater.rfa"
                }
            }
        },
        {
            "id": "3ea8dcff-5ebb-b236-ea2f-0bfbdf3c624b",
            "displayName": "Electric Water Heater_DRE",
            "extension": "png",
            "purpose": "Thumbnail",
            "size": 56932,
            "available": true,
            "isActive": true,
            "version": "1.0",
            "previousVersionId": "2fa8dcff-5ebb-b236-ea2f-0bfbdf3c512c",
            "createdDateTime": "2019-11-26T17:12:40.8516569Z",
            "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z",
            "_links": {
                "fileUrl": {
                    "href": "https://componentscenprodeussa01.blob.core.windows.net/private-3920224a-6600-41c9-aadb-2510159e373c/f8546e53-fd19-06f2-8071-ace2d70b05b6/Electric Water Heater.png"
                }
            }
        }
    ]
}

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 component documents.

json

{
    "error": {
        "code": "InvalidBrandComponentDocumentsRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "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

Documents

documents

Document[]

json

{
    "type": "object",
    "properties": {
        "documents": {
            "type": "array",
            "items": {
                "description": "List of documents.",
                "$ref": "#/components/schemas/Document"
            }
        }
    },
    "additionalProperties": false
}

Document purpose

Indicates the purpose of document.

Design

String

Thumbnail

String

Reference

String

GalleryImage

String

TypeCatalog

String

json

{
    "type": "string",
    "description": "Indicates the purpose of document.",
    "enum": [
        "Design",
        "Thumbnail",
        "Reference",
        "GalleryImage",
        "TypeCatalog"
    ],
    "title": "Document purpose"
}

Document

String

Id of the document.

displayName

String

Display name of the document.

extension

String

Extension of the associated file to the document.

version

String

Version of the document.

previousVersionId

String

This property is only used for design documents for up-version. Once a design document is up-versioned, this contains id of the previous design document.

Document purpose

Document-purpose

Indicates the purpose of document.

size

Number

Size of the document.

available

Boolean

This indicates if associated file to this document is available.

isActive

Boolean

This is always true for all documents except design documents. In case there are multiple versions of a design document, only one can be active.

createdDateTime

String

Created datetime of the document.

lastModifiedDateTime

String

Last modified datetime of the document.

_links

document-links

Contains the hyperlinks to the related data of document.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the document."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the document."
        },
        "extension": {
            "type": "string",
            "description": "Extension of the associated file to the document."
        },
        "version": {
            "type": "string",
            "description": "Version of the document."
        },
        "previousVersionId": {
            "type": "string",
            "description": "This property is only used for design documents for up-version. Once a design document is up-versioned, this contains id of the previous design document."
        },
        "purpose": {
            "type": "string",
            "description": "Indicates the purpose of document.",
            "enum": [
                "Design",
                "Thumbnail",
                "Reference",
                "GalleryImage",
                "TypeCatalog"
            ],
            "title": "Document purpose",
            "$ref": "#/components/schemas/Document-purpose"
        },
        "size": {
            "type": "number",
            "description": "Size of the document."
        },
        "available": {
            "type": "boolean",
            "description": "This indicates if associated file to this document is available."
        },
        "isActive": {
            "type": "boolean",
            "description": "This is always true for all documents except design documents. In case there are multiple versions of a design document, only one can be active."
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the document."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the document."
        },
        "_links": {
            "$ref": "#/components/schemas/document-links",
            "description": "Contains the hyperlinks to the related data of document."
        }
    },
    "additionalProperties": false
}

Document Links

Hyperlinks to related data which complements this entity.

associatedDesignDocument

Link

Link to associated design document.

fileUrl

Link

Link to download the file associated to this document.

json

{
    "type": "object",
    "title": "Document Links",
    "description": "Hyperlinks to related data which complements this entity.",
    "properties": {
        "associatedDesignDocument": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to associated design document."
        },
        "fileUrl": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to download the file associated to this document."
        }
    },
    "additionalProperties": false
}

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.

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?