Create Component Document - Library

REST API Overview

Reference

Changelog

Library

Download API definition:

Create Component Document

POST https://qa-api.bentley.com/library/components/{componentId}/documents

Creates a component document in user's organization context.

Notes

To create a component document, displayName extension and purpose are required properties.

Document purpose values are: -Design -Thumbnail -Reference -GalleryImage -TypeCatalog

Uploading Associated File

To complete the process, associated file should be uploaded to fileUrl (property in response) and a subsequent update document request should be made by setting 'available' property to true.

Document with purpose Thumbnail, GalleryImage and TypeCatalog can have associated design document, this should be a valid Id of existing design document. PreviousVersionId is only valid for Design documents and requires a valid Id of an existing design document, in case a design document needs up-version. In case there are multiple versions of the design document, only one design document and it's corresponding thumbnail can be active.

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

Document (create/update)

displayName

String

Yes

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

extension

String

Yes

Extension of the file associated with this document, e.g., rfa, dgn, txt etc.

version

String

Version of the document.

previousVersionId

Object, null

This is only used with document purpose 'Design'. Once a design document is being up-versioned, this should have value of previous active design document.

associatedDesignDocument

Object, null

This is only used with purpose 'Thumbnail' or 'TypeCatalog' and refers to associated design document.

Document (create/update) purpose

document-create-update-purpose

Yes

Indicates the purpose of document. Only one 'TypeCatalog' document can be added to a component with an existing design document. Display name of the type catalog and design document for a component must be same.

available

Boolean

This indicates if a file is associated to the document.

isActive

Boolean

This is by default true for all documents except where purpose is 'Design' or a 'Thumbnail' associated to the design document, in case there are multiple versions of the design document, only one can be active.

Example

json

{
    "displayName": "Electric Water Heater_DRE",
    "extension": "rfa",
    "purpose": "Design",
    "available": false,
    "isActive": true,
    "version": "2",
    "previousVersionId": null,
    "associatedDesignDocument": null
}

Response

Response 201 Created

Created

json

{
    "document": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Electric Water Heater_DRE",
        "extension": "rfa",
        "purpose": "Design",
        "size": 890456,
        "available": true,
        "isActive": true,
        "version": "2",
        "previousVersionId": "5ty8dcff-5ebb-b236-ea2f-0bfbdf3c645g",
        "createdDateTime": "2019-11-26T17:12:40.8516569Z",
        "lastModifiedDateTime": "2019-11-26T17:14:12.3846681Z",
        "_links": {
            "associatedDesignDocument": {
                "href": "https://api.bentley.com/library/components/r444f052-c026-40d6-b412-8c3c12004ebe/documents/2da8dcff-5ebb-b236-ea2f-0bfbdf3c667s"
            },
            "fileUrl": {
                "href": "https://componentscenprodeussa01.blob.core.windows.net/private-3920224a-6600-41c9-aadb-2510159e373c/f8546e53-fd19-06f2-8071-ace2d70b05b6/Electric Water Heater_DRE.rvt"
            }
        }
    }
}

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 document.

json

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

Response 409 Conflict

Document with the same name, extension and version already exists.

json

{
    "error": {
        "code": "ComponentDocumentExists",
        "message": "Component Document with the same name, extension and version already exists."
    }
}

Response 422 Unprocessable Entity

Invalid request to upload component.

json

{
    "error": {
        "code": "InvalidDocumentRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "displayName"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "purpose"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "extension"
            },
            {
                "code": "InvalidValue",
                "message": "Purpose must be one of:  Design, Thumbnail, Reference, GalleryImage, TypeCatalog.",
                "target": "purpose"
            },
            {
                "code": "InvalidValue",
                "message": "AssociatedDesignDocument value is not valid.",
                "target": "associatedDesignDocument"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName is not valid, document with purpose 'TypeCatalog' displayName match refereneced 'AssociatedDesignDocument' displayName.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "IsActive must be true for a document to upversion.",
                "target": "isActive"
            },
            {
                "code": "InvalidValue",
                "message": "PreviousVersionId is not valid, it should be valid and active design document Id.",
                "target": "previousVersionId"
            },
            {
                "code": "InvalidValue",
                "message": "Document with purpose 'TypeCatalog' must have associatedDesignDocument.",
                "target": "associatedDesignDocument"
            },
            {
                "code": "InvalidValue",
                "message": "Document with purpose 'TypeCatalog' only support extension 'txt'.",
                "target": "extension"
            },
            {
                "code": "InvalidValue",
                "message": "Provided PreviousVersionId is not valid.",
                "target": "previousVersionId"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName is over '250' length limit.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "DisplayName must not include these special characters. >, <, ^, $, ?, ||.",
                "target": "displayName"
            },
            {
                "code": "InvalidValue",
                "message": "Extension is over '250' length limit.",
                "target": "extension"
            }
        ]
    }
}

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

Document (response)

Retrieved document response containing document.

document

Document

Full representation of the document.

Document purpose

Indicates the purpose of document.

Design

String

Thumbnail

String

Reference

String

GalleryImage

String

TypeCatalog

String

Document

String

Id of the document.

displayName

String

Display name of the document.

extension

String

Extension of the associated file to the document.

version

String

Version of the document.

previousVersionId

String

This property is only used for design documents for up-version. Once a design document is up-versioned, this contains id of the previous design document.

Document purpose

Document-purpose

Indicates the purpose of document.

size

Number

Size of the document.

available

Boolean

This indicates if associated file to this document is available.

isActive

Boolean

This is always true for all documents except design documents. In case there are multiple versions of a design document, only one can be active.

createdDateTime

String

Created datetime of the document.

lastModifiedDateTime

String

Last modified datetime of the document.

_links

document-links

Contains the hyperlinks to the related data of document.

Document (create/update) purpose

Design

String

Thumbnail

String

Reference

String

GalleryImage

String

TypeCatalog

String

Document (create/update)

displayName

String

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

extension

String

Extension of the file associated with this document, e.g., rfa, dgn, txt etc.

version

String

Version of the document.

previousVersionId

Object, null

This is only used with document purpose 'Design'. Once a design document is being up-versioned, this should have value of previous active design document.

associatedDesignDocument

Object, null

This is only used with purpose 'Thumbnail' or 'TypeCatalog' and refers to associated design document.

Document (create/update) purpose

document-create-update-purpose

available

Boolean

This indicates if a file is associated to the document.

isActive

Boolean

Document Links

Hyperlinks to related data which complements this entity.

associatedDesignDocument

Link

Link to associated design document.

fileUrl

Link

Link to download the file associated to this 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.