Table of contents
Library
Download API definition:
PUT https://api.bentley.com/library/components/{id}

Updates existing component in user's organization context.

Notes

To update a component request body must contain all the properties desired for the component since this will replace existing component with current component definition. DisplayName and status are required properties.

Component status values are: -Draft -Published -Checked -Approved -Archived

Associated Entities

A component can have associated entities, e.g catalogs, application, category, manufacturer. These values should be valid Ids of existing entities.

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 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 parameters

Name
In
Required?
Description
id
template
Yes

Id of the component.

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.

Request body

Component (create/update)

Name
Type
Required?
Description
displayName
String
Yes

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

description
String
No

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

state
String
Yes

Indicates the state of component.

catalogs
String[]
No

List of associated catalog Ids, must be string values of valid GUIDs of existing catalogs.

application
String
No

Associated application Id, must be a string value of valid GUID of existing application.

category
String
No

Associated category Id, must be a string value of valid GUID of existing category.

manufacturer
String
No

Associated manufacturer Id, must be a string value of valid GUID of existing manufacturer.

hashtags
String[]
No

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

Example

json
{
    "displayName": "Door",
    "description": "A standard wooden door",
    "state": "Draft",
    "catalogs": [
        "c7391e2d-e3e2-4c38-b5d9-0573a01e590d",
        "ht391e2d-e3e2-4c38-b5d9-0573a01e597j"
    ],
    "category": "jy491e2d-e3e2-4c38-b5d9-0573a01e523g",
    "application": "ku591e2d-e3e2-4c38-b5d9-0573a01e545b",
    "manufacturer": "li791e2d-e3e2-4c38-b5d9-0573a01e512n",
    "hashtags": [
        "door",
        "woodendoor"
    ]
}

Response 200 OK

OK

json
{
    "component": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Door",
        "description": "A standard wooden door",
        "hashtags": [
            "door",
            "woodendoor"
        ],
        "state": "Published",
        "supportedFileTypes": [
            "RFA"
        ],
        "createdDateTime": "2019-11-26T17:12:40.8516569Z",
        "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z",
        "_links": {
            "catalogs": [{
                    "href": "https://api.bentley.com/library/catalogs/c7391e2d-e3e2-4c38-b5d9-0573a01e590d"
                },
                {
                    "href": "https://api.bentley.com/library/catalogs/ht391e2d-e3e2-4c38-b5d9-0573a01e597j"
                }
            ],
            "application": {
                "href": "https://api.bentley.com/library/applications/jy491e2d-e3e2-4c38-b5d9-0573a01e586h"
            },
            "category": {
                "href": "https://api.bentley.com/library/categories/r444f052-c026-40d6-b412-8c3c12004ebe"
            },
            "manufacturer": {
                "href": "https://api.bentley.com/library/manufacturers/e944f052-c026-40d6-b412-8c3c12004cac"
            }
        }
    }
}

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 update component.

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

Response 404 Not Found

This response indicates that the specified component not found.

json
{
    "error": {
        "code": "ComponentNotFound",
        "message": "Requested Component is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to upload component.

json
{
    "error": {
        "code": "InvalidUpdateComponentRequest",
        "message": "Cannot update component.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "displayName"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "state"
            },
            {
                "code": "InvalidValue",
                "message": "State must be one of:  Draft, Published, Checked, Approved, Archived.",
                "target": "state"
            },
            {
                "code": "InvalidValue",
                "message": "Provided Referenced entities not valid."
            }, {
                "code": "InvalidValue",
                "message": "DisplayName is over '150' 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": "Category must be string value of a valid GUID.",
                "target": "category"
            },
            {
                "code": "InvalidValue",
                "message": "Application must be string value of a valid GUID.",
                "target": "application"
            },
            {
                "code": "InvalidValue",
                "message": "Manufacturer must be string value of a valid GUID.",
                "target": "manufacturer"
            },
            {
                "code": "InvalidValue",
                "message": "Catalog 'catalogname' must be string value of a valid GUID.",
                "target": "catalogs"
            },
            {
                "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

Name
Description
retry-after

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

Component (response)

Retrieved component response containing component.

TableSchema
Name
Type
Description
component

Full representation of the component.

Component

TableSchema
Name
Type
Description
id
String

Id of the component.

displayName
String

Display name of the component.

description
String

Description of the component.

state
String

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 (create/update)

TableSchema
Name
Type
Description
displayName
String

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

description
String

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

state
String

Indicates the state of component.

catalogs
String[]

List of associated catalog Ids, must be string values of valid GUIDs of existing catalogs.

application
String

Associated application Id, must be a string value of valid GUID of existing application.

category
String

Associated category Id, must be a string value of valid GUID of existing category.

manufacturer
String

Associated manufacturer Id, must be a string value of valid GUID of existing manufacturer.

hashtags
String[]

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

Component Links

Hyperlinks to related data which complements this entity.

TableSchema
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

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

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.