Create iModel Share - iModels

REST API Overview

Reference

iModels

Download API definition:

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

POST https://qa-api.bentley.com/imodels/{id}/shares

Creates a new Share to allow public iModel access.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a shareKey property which allows anonymous access to the shared iModel using iModels API. To use the shareKey to access the iModel one has to provide shareKey via Authorization header: Authorization: Basic {shareKey}, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

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 have the imodels_manage permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Important: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

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

Yes

iModel id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Content-Type

Indicates request body content type. Supported media type is application/json.

Request body

Share (create)

name

String

Name of the Share.

expiresAt

Date-time

A universal datetime value specifying until when the Share will be valid. It is recommended to use ISO 8601 format specification e.g. 2022-10-01T15:35:35.7777777Z. Cannot be set further into the future than 6 months.

Share (create) permission

ShareCreate-permission

Specifies what permission will be available when accessing iModel via the share key. Possible values: imodels_webview, imodels_read.

Example

json

{
    "name": "iModel Share name",
    "expiresAt": "2020-10-20T10:51:33.1700000Z",
    "permission": "imodels_webview"
}

Response

Response 201 Created

Created

json

{
    "share": {
        "id": "846e5f15-ac4a-4971-8160-580d95624f81",
        "displayName": "iModel Share name",
        "name": "iModel Share name",
        "expiresAt": "2020-10-20T10:51:33.1700000Z",
        "shareKey": "<secret value>",
        "permission": "imodels_webview"
    }
}

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

User is not authorized to create an iModel Share.

json

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

Response 404 Not Found

Specified iModel was not found.

json

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

Response 409 Conflict

iModel is not initialized and modify operations are not allowed.

json

{
    "error": {
        "code": "iModelNotInitialized",
        "message": "iModel is not initialized."
    }
}

Response 415 Unsupported Media Type

This response indicates that the user has specified not supported media type in the request.

json

{
    "error": {
        "code": "UnsupportedMediaType",
        "message": "Media Type is not supported."
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot create Share.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided 'name' value is not valid. Expected a value of type 'string'.",
                "target": "name"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "name"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Failed to parse request body. Make sure it is a valid JSON."
            }
        ]
    }
}

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

Share (create) permission

Specifies what permission will be available when accessing iModel via the share key. Possible values: imodels_webview, imodels_read.

imodels_webview

String

imodels_read

String

Share (create)

Properties of the Share to be created.

name

String

Name of the Share.

expiresAt

Date-time

Share (create) permission

ShareCreate-permission

Specifies what permission will be available when accessing iModel via the share key. Possible values: imodels_webview, imodels_read.

Created Share Response

Container for Share object.

CreatedShare

Share properties.

Representation of the Share object that includes shareKey property. permission

Specifies what permission will be available when accessing iModel via the share key. Possible values: imodels_webview, imodels_read.

imodels_webview

String

imodels_read

String

Representation of the Share object that includes shareKey property.

Full representation of the Share.

String

Id of the Share

displayName

String

Display name of the Share. Corresponds to Name property.

name

String

Name of the share.

expiresAt

Date-time

A universal datetime value specifying until when the Share will be valid.

shareKey

String

A key that can be used to access the iModel that owns this instance of the Share.

Representation of the Share object that includes shareKey property. permission

CreatedShare-permission

Specifies what permission will be available when accessing iModel via the share key. Possible values: imodels_webview, imodels_read.

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.