Create iTwin repository - iTwins

REST API Overview

Reference

iTwins

Download API definition:

POST https://qa-api.bentley.com/itwins/{iTwinId}/repositories

Creates a new Repository URI.

A repository is a Uri link to iTwin data managed by another service. The links for most classes are autogenerated but some can only be added manually using this POST endpoint.

The following Classes/SubClasses can be added using this POST endpoint.

GeographicInformationSystem
- WebMapService
- WebMapTileService
- MapServer
Construction
- Performance
Subsurface
- EvoWorkspace

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

The user must have the itwins_modify permission in order to add a repository URI to the iTwin.

An Organization Administrator can modify iTwins owned by their Organization. This includes adding a repository URI.

Organization Administrators are power users for all iTwins owned by their organization. They will be able to create, modify or delete any iTwin. Example: john.doe@example.com is an Organization Administrator that works for Example Industries. John will be able to create iTwins and those iTwins will belong to Example Industries. John and any other Organization Administrator for Example Industries will be able to update or delete the iTwin. Any user (an employee of Example Industries, or an external participant) can be invited to collaborate on the iTwin.

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.

Request

Request parameters

iTwinId

Yes

The iTwin Id

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

iTwin-repository-create

iTwin-repository-create class

iTwin-repository-create-class

Yes

The class of your iTwin repository.

iTwin-repository-create subClass

iTwin-repository-create-subClass

The subClass of your iTwin repository.

uri

String

Yes

The uri to the custom repository.

Example

json

{
    "class": "GeographicInformationSystem",
    "subClass": "WebMapTileService",
    "uri": "https://developer.bentley.com"
}

Response

Response 201 Created

Repository successfully created.

json

{
    "repository": {
        "id": "e2ecdff7-2802-48bf-9bfa-d418c740c8cd",
        "class": "GeographicInformationSystem",
        "subClass": "WebMapTileService",
        "uri": "https://developer.bentley.com"
    }
}

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

The user is not authorized to create an iTwin Repository.

json

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

Response 404 Not Found

This response indicates that the specified repository was not found.

json

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

Response 409 Conflict

iTwin with the same name already exists.

json

{
    "error": {
        "code": "iTwinRepositoryExists",
        "message": "The specified iTwin Repository already exists."
    }
}

Response 422 Unprocessable Entity

Invalid request to create a iTwin. Review the 'Field Values' section near the top of this page.

json

{
    "error": {
        "code": "InvalidiTwinsRequest",
        "message": "Cannot add iTwin Repository.",
        "details": [{
                "code": "InvalidValue",
                "message": "Class value is incorrect.",
                "target": "class"
            },
            {
                "code": "InvalidValue",
                "message": "SubClass value is incorrect.",
                "target": "subClass"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A required property is missing or empty.",
                "target": "class"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A required property is missing or empty.",
                "target": "uri"
            }
        ]
    }
}

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

iTwin-repository-response

repository

iTwin-repository

iTwin-repository class

The class of your iTwin repository.

RealityData

String

iModels

String

Storage

String

Forms

String

Issues

String

Construction

String

GeographicInformationSystem

String

iTwin-repository subClass

The subClass of your iTwin repository.

WebMapService

String

WebMapTileService

String

MapServer

String

Performance

String

iTwin-repository

String

The iTwin repository id.

iTwin-repository class

iTwin-repository-class

The class of your iTwin repository.

iTwin-repository subClass

iTwin-repository-subClass

The subClass of your iTwin repository.

uri

String

The uri to the repository.

iTwin-repository-create class

The class of your iTwin repository.

RealityData

String

iModels

String

Storage

String

Forms

String

Issues

String

Construction

String

GeographicInformationSystem

String

iTwin-repository-create subClass

The subClass of your iTwin repository.

WebMapService

String

WebMapTileService

String

MapServer

String

Performance

String

iTwin-repository-create

iTwin-repository-create class

iTwin-repository-create-class

The class of your iTwin repository.

iTwin-repository-create subClass

iTwin-repository-create-subClass

The subClass of your iTwin repository.

uri

String

The uri to the custom repository.

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.