Update Catalog - Library | iTwin Platform

REST API Overview

Reference

Changelog

Library

Download API definition:

Update Catalog

PUT https://api.bentley.com/library/catalogs/{id}

Updates a catalog in user's organization context.

Notes

To update a catalog, request body must contain all the properties desired for the catalog since this will replace existing catalog with current catalog definition. DisplayName is required property.

Authentication

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

template

Yes

Id of the catalog.

Request headers

Authorization

Yes

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

Yes

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

Request body

Catalog (create/update)

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

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 >, <, ^, $, ?, ||.

Example

json

{
    "displayName": "Door's Catalog",
    "description": "Standard wooden doors",
    "region": "US East",
    "hashtags": ["door", "woodendoor"]
}

Response

Response 200 OK

json

{
    "catalog": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Door's Catalog",
        "description": "Standard wooden doors",
        "region": "US East",
        "hashtags": ["door", "woodendoor"],
        "createdDateTime": "2019-11-26T17:12:40.8516569Z",
        "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z"
    }
}

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 403 Forbidden

This response indicates that user does not have required permissions to create catalog.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the specified catalog not found.

json

{
    "error": {
        "code": "CatalogNotFound",
        "message": "Requested Catalog is not available."
    }
}

Response 409 Conflict

Catalog with the same name already exists within the organization.

json

{
    "error": {
        "code": "ApplicationExists",
        "message": "Application with the same name and version already exists within the organization."
    }
}

Response 422 Unprocessable Entity

Invalid request to upload component.

json

{
    "error": {
        "code": "InvalidUpdateCatalogRequest",
        "message": "Cannot create catalog.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName is over '250' length limit.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName must not include these special characters. >, <, ^, $, ?, ||.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "Description is over '250' length limit.",
                "target": "description"
            },
            {
                "code": "InvalidValue",
                "message": "Region is over '150' length limit.",
                "target": "region"
            },
            {
                "code": "InvalidValue",
                "message": "Hashtag is over '50' length limit.",
                "target": "hashtag"
            },
            {
                "code": "InvalidValue",
                "message": "Hashtag must not include these special characters. >, <, ^, $, ?, ||.",
                "target": "hashtag"
            }
        ]
    }
}

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

Catalog (response)

Retrieved catalog response containing catalog.

TableSchema

catalog

Catalog

Full representation of the catalog.

Catalog

TableSchema

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

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

Contains error information.

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.