Get Started
Documentation
Samples

Library

Overview
Tutorials
Samples
Reference
Changelog

Catalogs

Download API definition:
Create Catalog
POST https://api.bentley.com/library/catalogs

Creates a catalog in user's organization context.

Authentication

Requires Authorization header with valid Bearer token for scope library:modify.

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

Name
Required?
Description
Authorization
Yes

OAuth access token with scope library:modify

Accept
No

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

Request body

Catalog (create/update)

Name
Type
Required?
Description
displayName
String
Yes

Display name of the document. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

description
String
No

Description of the catalog. Maximum length of the description is 250.

region
String
No

Region of the catalog. Maximum length of the region is 250.

hashtags
String[]
No

Hashtags of the catalog. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.

Response

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
Response 403 Forbidden
This response indicates that user does not have required permissions to create catalog.
json
Response 409 Conflict
Catalog with the same name already exists within the organization.
json
Response 422 Unprocessable Entity
Invalid request to upload component.
json
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
json
Response headers
Name
Description
retry-after
The number of requests exceeds the rate-limit for the client subscription.
Definitions
Catalog (response)
Retrieved catalog response containing catalog.
TableSchema
Name
Type
Description
catalog
Catalog
Full representation of the catalog.
Catalog
TableSchema
Name
Type
Description
id
String
Id of the catalog.
displayName
String
Display name of the catalog.
description
String
Description of the catalog.
region
String
Region of the catalog.
createdDateTime
String
Created datetime of the catalog.
lastModifiedDateTime
String
Last modified datetime of the catalog.
hashtags
String[]
Hashtags of the catalog.
Catalog (create/update)
TableSchema
Name
Type
Description
displayName
String
Display name of the document. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.
description
String
Description of the catalog. Maximum length of the description is 250.
region
String
Region of the catalog. Maximum length of the region is 250.
hashtags
String[]
Hashtags of the catalog. Maximum length of a hashtag is 50, it must not include these special characters >, <, ^, $, ?, ||.
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
Error information.
Error
Contains error information and an optional array of more specific errors.
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
The target of the error.
details
ErrorDetails[]
Optional array of more specific errors.
Error Details
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
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
Error information.