• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Free Trial
    Table of contents
    Overview
    Samples
    Changelog
    iTwin.js Extensions
    Download API definition:
    Create Private Extension
    POST https://dev-api.bentley.com/extensions/

    Creates a new private extension.

    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.

    Request

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Create Private Extension Request Body.

    Request body

    create-private-extension-request

    Name
    Type
    Required?
    Description
    name
    String
    Yes
    iTwinId
    String
    Yes
    description
    String
    No

    Example

    json
    {
    "name": "highlight-element-info",
    "iTwinId": "67ef40a5-d47b-4ce9-83a0-803d558478a9",
    "description": "Extension provides additional information for highlighted elements."
}

    Response

    Response 201 Created

    Extension successfully created.

    json
    {
    "extension": {
        "id": "67ef40a5-d47b-4ce9-83a0-803d558478a9",
        "name": "highlight-element-info",
        "description": "Extension provides additional information for highlighted elements.",
        "iTwinId": "803548e2-3965-4344-9845-a65c26b3dd2a"
    }
}

    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

    iTwin could not be found.

    json
    {
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin is not available.",
        "target": "iTwinId"
    }
}

    Response 409 Conflict

    This response indicates that the user tried to create a resource that already exists.

    json
    {
    "error": {
        "code": "ExtensionExists",
        "message": "Extension with the same name already exists within the iTwin and cannot be created."
    }
}

    Response 422 Unprocessable Entity

    Invalid request to create Extension.

    json
    {
    "error": {
        "code": "InvalidExtensionsRequest",
        "message": "Cannot create extension.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided 'iTwinId' is not valid.",
            "target": "iTwinId"
        }]
    }
}

    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

    Name
    Description
    retry-after

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

    Definitions

    create-private-extension-request

    Name
    Type
    Description
    name
    String
    iTwinId
    String
    description
    String

    create-private-extension-response

    Name
    Type
    Description
    extension.id
    String
    extension.name
    String
    extension.description
    String
    extension.iTwinId
    String

    Error

    Contains error information.

    Name
    Type
    Description
    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.

    Name
    Type
    Description
    error
    Error

    Error information.

    Was this page helpful?