Table of contents
Library
Download API definition:
GET https://qa-api.bentley.com/library/components[?$top][&$skip][&projectId][&$search][&catalogs]

Retrieves digital components from user's organization or project context.

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.

Authorization

User must be an Organization Administrator for the Organization or have Read permission assigned at the organization level or have Read permission assigned at the project level, in case request is scoped to a project.

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
Required?
Description
$top
No

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

$skip
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.

projectId
No

Id of the project.

$search
No

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

catalogs
No

Find all components that have the catalogs associated. Value of catalogs should be comma separated list of valid catalog Ids without spaces e.g., catalogs=bef75b3c-dc4b-a205-adac-7501a367284e,hsu75b3c-dc4b-a205-adac-7501a367275f.

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/components?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/Library/components?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/Library/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 404 Not Found

This response indicates that the specified components not found.

json
{
    "error": {
        "code": "ComponentsNotFound",
        "message": "Requested Components is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get components.

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

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.

Components (prefer return=representation)

Name
Type
Description
components
_links

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

Components (prefer return=minimal)

Name
Type
Description
components
_links

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

Component (summary)

Name
Type
Description
id
String

Id of the component.

displayName
String

Display name of the component.

Component state

Indicates the state of component.

Name
Type
Description
Draft
String
Published
String
Checked
String
Approved
String
Archived
String

Component

Name
Type
Description
id
String

Id of the component.

displayName
String

Display name of the component.

description
String

Description of the component.

Component state

Indicates the state of component.

createdDateTime
String

Created datetime of the component.

lastModifiedDateTime
String

Last modified datetime of the component.

supportedFileTypes
String[]

Supported file types of the component.

hashtags
String[]

Hashtags of the component.

_links

Contains the hyperlinks to the related data of component.

Component Links

Hyperlinks to related data which complements this entity.

Name
Type
Description
catalogs

Links to associated catalogs.

application

Link to associated application of the component.

category

Link to associated category of the component.

manufacturer

Link to associated manufacturer of the component.

Link

Name
Type
Description
href
String

Links (paging)

Name
Type
Description
self
next
prev

Error

Contains error information.

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.

Name
Type
Description
error

Error information.