Get Categories - Library | iTwin Platform

REST API Overview

Reference

Changelog

Library

Download API definition:

Get Categories

GET https://api.bentley.com/library/categories[?continuationToken]

Retrieves categories from user's organization context.

Notes

The response returns only 50 entities.To retrieve all the entities, continuation token should be used in the subsequent requests, which is returned in the response under _links as part of next request url.

Authentication

Requires Authorization header with valid Bearer token for scope library:read or 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

Request parameters

continuationToken

query

Response returns 50 results and a link to next page containing continuation token value. This value should be provided to the parameter to fetch next results. If there are no more results, response will not have a link to next url.

Request headers

Authorization

Yes

OAuth access token with library:read or itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "categories": [{
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Door's Category",
        "createdDateTime": "2019-11-26T17:12:40.8516569Z",
        "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z"
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/library/categories?continuationToken='1vf8dcff-5ebb-b236-ea2f-0bfbdf3c656k'"
        }
    }
}

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 categories not found.

json

{
    "error": {
        "code": "CategoriesNotFound",
        "message": "Requested Categories 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

retry-after

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

Definitions

TableSchema

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

error

Error

Error information.