Create Component Variation - Library

REST API Overview

Reference

Changelog

Library

Download API definition:

Create Component Variation

POST https://dev-api.bentley.com/library/components/{componentId}/variations

Creates a component variation in user's organization context.

Notes

To create a component variation, displayName is required property. If variation contains AdHocProperties, displayName and type are required properties of AdHocProperty.

AdHocProperty type values are: -StringType -IntegerType -DoubleType -FloatType -BooleanType

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 Upload 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

Variation (create/update)

displayName

String

Yes

Display name of the variation. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

associatedDesignDocument

String

Id of the associated design document.

adHocProperties

AdHocProperty[]

List of adhoc properties of the variation.

Example

json

{
    "displayName": "Construction_Chimney_Oli_INOX-VERTICAL-DRAIN-DW",
    "associatedDesignDocument": "bef75b3c-dc4b-a205-adac-7501a367284e",
    "adHocProperties": [{
            "displayName": "Virtual Socket",
            "value": "0",
            "type": "IntegerType",
            "unitOfMeasure": ""
        },
        {
            "displayName": "Type of Element",
            "value": "Junction",
            "type": "StringType",
            "unitOfMeasure": ""
        }
    ]
}

Response

Response 201 Created

Created

json

{
    "variation": {
        "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 403 Forbidden

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

json

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

Response 422 Unprocessable Entity

Invalid request to create WebLink.

json

{
    "error": {
        "code": "InvalidVariationRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "'displayName' in adHocProperty is missing.",
                "target": "adHocProperties"
            },
            {
                "code": "InvalidValue",
                "message": "'type' in adHocProperty is missing.",
                "target": "adHocProperties"
            },
            {
                "code": "InvalidValue",
                "message": "'type' in adHocProperty must be one of:  StringType, IntegerType, DoubleType, FloatType, BooleanType.",
                "target": "adHocProperties"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName is over '250' 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

Variation (response)

Retrieved variation response containing variation.

variation

Variation

Full representation of the variation.

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.

Variation (create/update)

displayName

String

Display name of the variation. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

associatedDesignDocument

String

Id of the associated design document.

adHocProperties

AdHocProperty[]

List of adhoc properties of the variation.

Adhoc Property type

Type of the adhoc property value.

StringType

String

IntegerType

String

DoubleType

String

FloatType

String

BooleanType

String

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.

Variation Links

Hyperlinks to related data which complements this entity.

associatedDesignDocument

Link

Link to associated design document.

Link

href

String

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.

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.