Create Component WebLink - Library

Library

Download API definition:

Create Component WebLink

POST https://api.bentley.com/library/components/{componentId}/weblinks

Creates a component webLink in user's organization context.

Notes

To create a component webLink, 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

Request parameters

componentId

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

WebLink (create/update)

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://www.sampleweblink.com/sampleweblink"
}

Response

Response 201 Created

Created

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

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

json

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

Response 409 Conflict

WebLink with the same name already exists.

json

{
    "error": {
        "code": "WebLinkExists",
        "message": "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

retry-after

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

Definitions

WebLink (response)

Retrieved webLink response containing webLink.

webLink

WebLink

Full representation of the webLink.

json

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

WebLink

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.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the webLink."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the webLink."
        },
        "uri": {
            "type": "string",
            "description": "Url of the webLink."
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the webLink."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the webLink."
        }
    },
    "additionalProperties": false
}

WebLink (create/update)

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.

json

{
    "type": "object",
    "title": "WebLink (create/update)",
    "properties": {
        "displayName": {
            "type": "string",
            "description": "Display name of the webLink. Maximum length of the display name is 50, it must not include these special characters >, <, ^, $, ?, ||."
        },
        "uri": {
            "type": "string",
            "description": "Url of the webLink."
        }
    },
    "required": [
        "displayName",
        "uri"
    ],
    "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?