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

Updates a component webLink in user's organization context.

Notes

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

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
componentId
template
Yes

Id of the component.

webLinkId
template
Yes

Id of the webLink.

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

WebLink (create/update)

Name
Type
Required?
Description
displayName
String
Yes

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

uri
String
Yes

Url of the webLink.

Example

json
{
    "displayName": "Bentley Communities for OpenGround",
    "uri": "https://communities.bentley.com/products/digital-twin-cloud-services/itwin-services/"
}

Response 200 OK

OK

json
{
    "webLink": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Bentley Communities for OpenGround",
        "uri": "https://communities.bentley.com/products/digital-twin-cloud-services/itwin-services/",
        "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 update webLink.

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

Response 404 Not Found

This response indicates that the specified variation not found.

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

Response 409 Conflict

Component WebLink with the same name already exists.

json
{
    "error": {
        "code": "ComponentWebLinkExists",
        "message": "Component WebLink with the same name already exists."
    }
}

Response 422 Unprocessable Entity

Invalid request to create WebLink.

json
{
    "error": {
        "code": "InvalidWebLinkRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "displayName"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "uri"
            },
            {
                "code": "InvalidValue",
                "message": "Uri must be a valid web url, supported schemes are https, http and ftp.",
                "target": "uri"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName is over '50' length limit.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName must not include these special characters. >, <, ^, $, ?, ||.",
                "target": "displayName"
            }
        ]
    }
}

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.

Document (response)

Retrieved document response containing document.

TableSchema
Name
Type
Description
document

Full representation of the document.

Document

TableSchema
Name
Type
Description
id
String

Id of the document.

displayName
String

Display name of the document.

extension
String

Extension of the associated file to the document.

version
String

Version of the document.

previousVersionId
String

This property is only used for design documents for up-version. Once a design document is up-versioned, this contains id of the previous design document.

purpose
String

Indicates the purpose of document.

size
Number

Size of the document.

available
Boolean

This indicates if associated file to this document is available.

isActive
Boolean

This is always true for all documents except design documents. In case there are multiple versions of a design document, only one can be active.

createdDateTime
String

Created datetime of the document.

lastModifiedDateTime
String

Last modified datetime of the document.

_links

Contains the hyperlinks to the related data of document.

WebLink (create/update)

TableSchema
Name
Type
Description
displayName
String

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

uri
String

Url of the webLink.

Document Links

Hyperlinks to related data which complements this entity.

TableSchema
Name
Type
Description
associatedDesignDocument

Link to associated design document.

fileUrl

Link to download the file associated to this document.

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.