Get Component Variation - Library

Library

Download API definition:

get https://dev-api.bentley.com/library/components/{componentId}/variations/{variationId}[?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.

variationId

Yes

Id of the variation.

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

{
    "variation": {
        "id": "bef75b3c-dc4b-a205-adac-7501a367284e",
        "displayName": "Construction_Chimney_Oli_INOX-VERTICAL-DRAIN-DW (1)",
        "createdDateTime": "2019-12-02T11:50:03.4143965+00:00",
        "lastModifiedDateTime": "2019-12-02T11:50:03.4143965+00:00",
        "adHocProperties": [{
            "displayName": "Virtual Socket",
            "value": "0",
            "type": "IntegerType",
            "unitOfMeasure": ""
        }, {
            "displayName": "Type of Element",
            "value": "Junction",
            "type": "StringType",
            "unitOfMeasure": "M"
        }],
        "_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 webLink not found.

json

{
    "error": {
        "code": "ComponentVariationNotFound",
        "message": "Requested Component Variation is not available."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

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.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Variation

String

Id of the variation.

_links

variation-links

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.

json

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

Adhoc Property type

Type of the adhoc property value.

StringType

String

IntegerType

String

DoubleType

String

FloatType

String

BooleanType

String

json

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

Adhoc Property

adhoc property of the variation.

Adhoc Property type

AdHocProperty-type

Type of the adhoc property value.

value

String

value of the adhoc property.

displayName

String

Display name of the adhoc property.

unitOfMeasure

String

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

json

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

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",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Variation Links

Hyperlinks to related data which complements this entity.

associatedDesignDocument

Link

json

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

Variation (response)

Retrieved variation response containing variation.

variation

Variation

json

{
    "type": "object",
    "title": "Variation (response)",
    "properties": {
        "variation": {
            "$ref": "#/components/schemas/Variation"
        }
    },
    "description": "Retrieved variation response containing variation.",
    "additionalProperties": false
}

Was this page helpful?