Get Brand Component WebLinks - Library

Library

Download API definition:

Get Brand Component WebLinks

GET https://api.bentley.com/library/brands/{brandId}/components/{componentId}/weblinks

Retrieves webLinks for specified digital component from brand.

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.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request parameters

brandId

Yes

Id of the brand.

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.

Response 200 OK

json

{
    "webLinks": [{
            "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"
        },
        {
            "id": "3ea8dcff-5ebb-b236-ea2f-0bfbdf3c624b",
            "displayName": "Bentley Communities for iTwin Services",
            "uri": "https://bentleysystems.service-now.com/community?id=digital_twins_landing",
            "createdDateTime": "2019-11-26T17:12:40.8516569Z",
            "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z"
        }
    ]
}

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 422 Unprocessable Entity

Invalid request to get brand component weblinks.

json

{
    "error": {
        "code": "InvalidBrandComponentWeblinksRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided brandId value is not valid.",
            "target": "brandId"
        }]
    }
}

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

WebLinks

webLinks

WebLink[]

json

{
    "type": "object",
    "properties": {
        "webLinks": {
            "type": "array",
            "items": {
                "description": "List of webLinks.",
                "$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
}

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?