Get Component Variations - Library

Library

Download API definition:

GET https://api.bentley.com/library/components/{componentId}/variations[?projectId]

Retrieves variations 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.

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

Request parameters

componentId

Yes

Id of the component.

projectId

Id of the project.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "variations": [{
        "id": "bef75b3c-dc4b-a205-adac-7501a367284e",
        "displayName": "Construction_Chimney_Oli_INOX-VERTICAL-DRAIN-DW (1)",
        "createdDateTime": "2019-12-02T11:50:03.4143965Z",
        "lastModifiedDateTime": "2019-12-02T11:50:03.4143965Z",
        "adHocProperties": [{
                "displayName": "Virtual Socket",
                "value": "0",
                "type": "IntegerType",
                "unitOfMeasure": ""
            },
            {
                "displayName": "Type of Element",
                "value": "Junction",
                "type": "StringType",
                "unitOfMeasure": ""
            }
        ],
        "_links": {
            "associatedDesignDocument": {
                "href": "https://api.bentley.com/library/components/r444f052-c026-40d6-b412-8c3c12004ebe/documents/2da8dcff-5ebb-b236-ea2f-0bfbdf3c667s"
            }
        }
    }]
}

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 component variations not found.

json

{
    "error": {
        "code": "ComponentVariationsNotFound",
        "message": "Requested Component Variations is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get component variations.

json

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

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

Variations

variations

Variation[]

json

{
    "type": "object",
    "properties": {
        "variations": {
            "type": "array",
            "items": {
                "description": "List of variations.",
                "$ref": "#/components/schemas/Variation"
            }
        }
    },
    "additionalProperties": false
}

Variation

String

Id of the variation.

displayName

String

Display name of the variation.

adHocProperties

AdHocProperty[]

List of adhoc properties of the variation.

createdDateTime

String

Created datetime of the variation.

lastModifiedDateTime

String

Last modified datetime of the variation.

_links

variation-links

Contains the hyperlinks to the related data of document.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the variation."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the variation."
        },
        "adHocProperties": {
            "type": "array",
            "description": "List of adhoc properties of the variation.",
            "items": {
                "description": "List of adhoc properties of the variation.",
                "$ref": "#/components/schemas/AdHocProperty"
            }
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the variation."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the variation."
        },
        "_links": {
            "$ref": "#/components/schemas/variation-links",
            "description": "Contains the hyperlinks to the related data of document."
        }
    },
    "additionalProperties": false
}

Adhoc Property type

Type of the adhoc property value.

StringType

String

IntegerType

String

DoubleType

String

FloatType

String

BooleanType

String

json

{
    "type": "string",
    "description": "Type of the adhoc property value.",
    "enum": [
        "StringType",
        "IntegerType",
        "DoubleType",
        "FloatType",
        "BooleanType"
    ],
    "title": "Adhoc Property type"
}

Adhoc Property

adhoc property of the variation.

displayName

String

Display name of the adhoc property.

value

String

value of the adhoc property.

Adhoc Property type

AdHocProperty-type

Type of the adhoc property value.

unitOfMeasure

String

Unit to measure this particular property, e.g., 'Millimeters', 'Inches' etc.

json

{
    "type": "object",
    "title": "Adhoc Property",
    "description": "adhoc property of the variation.",
    "properties": {
        "displayName": {
            "type": "string",
            "description": "Display name of the adhoc property."
        },
        "value": {
            "type": "string",
            "description": "value of the adhoc property."
        },
        "type": {
            "type": "string",
            "description": "Type of the adhoc property value.",
            "enum": [
                "StringType",
                "IntegerType",
                "DoubleType",
                "FloatType",
                "BooleanType"
            ],
            "title": "Adhoc Property type",
            "$ref": "#/components/schemas/AdHocProperty-type"
        },
        "unitOfMeasure": {
            "type": "string",
            "description": "Unit to measure this particular property, e.g., 'Millimeters', 'Inches' etc."
        }
    },
    "required": [
        "displayName",
        "type"
    ],
    "additionalProperties": false
}

Variation Links

Hyperlinks to related data which complements this entity.

associatedDesignDocument

Link

Link to associated design document.

json

{
    "type": "object",
    "title": "Variation Links",
    "description": "Hyperlinks to related data which complements this entity.",
    "properties": {
        "associatedDesignDocument": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to associated design document."
        }
    },
    "additionalProperties": false
}

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?