Table of contents
Library
Download API definition:
GET https://api.bentley.com/library/catalogs/{catalogId}/documents

Retrieves documents for specified digital catalog from user's organization context.

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.

Authorization

User must be an Organization Administrator for the Organization or have Read permission assigned at the organization level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki 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
catalogId
template
Yes

Id of the catalog.

Request headers

Name
Required?
Description
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
{
    "documents": [{
            "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
            "displayName": "Electric Water Heater_DRE",
            "extension": "pdf",
            "purpose": "Reference",
            "size": 890456,
            "available": true,
            "isActive": true,
            "version": "1",
            "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.pdf"
                }
            }
        },
        {
            "id": "3ea8dcff-5ebb-b236-ea2f-0bfbdf3c624b",
            "displayName": "Electric Water Heater_DRE",
            "extension": "png",
            "purpose": "Thumbnail",
            "size": 56932,
            "available": true,
            "isActive": true,
            "version": "1",
            "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"
                }
            }
        }
    ]
}

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 404 Not Found

This response indicates that the specified catalog documents not found.

json
{
    "error": {
        "code": "CatalogDocumentsNotFound",
        "message": "Requested Catalog Documents is not available."
    }
}

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.

Documents

TableSchema
Name
Type
Description
documents

Document

TableSchema
Name
Type
Description
id
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.

purpose
String

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

Contains the hyperlinks to the related data of document.

Document Links

Hyperlinks to related data which complements this entity.

TableSchema
Name
Type
Description
associatedDesignDocument

Link to associated design document.

fileUrl

Link to download the file associated to this document.

Link

TableSchema
Name
Type
Description
href
String

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

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.