Table of contents
Library
Download API definition:
GET https://api.bentley.com/library/components/{componentId}/weblinks/{webLinkId}[?projectId]

Retrieves webLink for specified digital component from user's organization or project context.

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 Read permission assigned at the organization level or have Read permission assigned at the project level, in case request is scoped to a project.

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.

projectId
query
No

Id of the project.

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.

Response 200 OK

OK

json
{
    "webLink": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Bentley Communities for OpenGround",
        "uri": "https://bentleysystems.service-now.com/community?id=openground_gint_keynetix_landing",
        "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 404 Not Found

This response indicates that the specified webLink not found.

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

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.

WebLink (response)

Retrieved webLink response containing webLink.

TableSchema
Name
Type
Description
webLink

Full representation of the webLink.

WebLink

TableSchema
Name
Type
Description
id
String

Id of the webLink.

displayName
String

Display name of the webLink.

uri
String

Url of the webLink.

createdDateTime
String

Created datetime of the webLink.

lastModifiedDateTime
String

Last modified datetime of the webLink.

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, null

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.