Update Component - Library

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

Request parameters

Yes

Id of the component.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Component (create/update)

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

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

Component (create/update) state

component-create-update-state

Yes

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.

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

Response 200 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 client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Component (response)

Retrieved component response containing component.

component

Component

Full representation of the component.

json

{
    "description": "Retrieved component response containing component.",
    "title": "Component (response)",
    "type": "object",
    "properties": {
        "component": {
            "description": "Full representation of the component.",
            "$ref": "#/components/schemas/Component"
        }
    },
    "additionalProperties": false
}

Component state

Indicates the state of component.

Draft

String

Published

String

Checked

String

Approved

String

Archived

String

json

{
    "type": "string",
    "description": "Indicates the state of component.",
    "enum": [
        "Draft",
        "Published",
        "Checked",
        "Approved",
        "Archived"
    ],
    "title": "Component state"
}

Component

String

Id of the component.

displayName

String

Display name of the component.

description

String

Description of the component.

Component state

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

component-links

Contains the hyperlinks to the related data of component.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the component."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the component."
        },
        "description": {
            "type": "string",
            "description": "Description of the component."
        },
        "state": {
            "type": "string",
            "description": "Indicates the state of component.",
            "enum": [
                "Draft",
                "Published",
                "Checked",
                "Approved",
                "Archived"
            ],
            "title": "Component state",
            "$ref": "#/components/schemas/Component-state"
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the component."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the component."
        },
        "supportedFileTypes": {
            "type": "array",
            "description": "Supported file types of the component.",
            "items": {
                "type": "string"
            }
        },
        "hashtags": {
            "type": "array",
            "description": "Hashtags of the component.",
            "items": {
                "description": "List of hashtags.",
                "type": "string"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/component-links",
            "description": "Contains the hyperlinks to the related data of component."
        }
    },
    "additionalProperties": false
}

Component (create/update) state

Indicates the state of component.

Draft

String

Published

String

Checked

String

Approved

String

Archived

String

json

{
    "type": "string",
    "description": "Indicates the state of component.",
    "enum": [
        "Draft",
        "Published",
        "Checked",
        "Approved",
        "Archived"
    ],
    "title": "Component (create/update) state"
}

Component (create/update)

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.

Component (create/update) state

component-create-update-state

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.

Component Links

Hyperlinks to related data which complements this entity.

catalogs

Link[]

Links to associated catalogs.

application

Link

Link to associated application of the component.

Link

href

String

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

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.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?