Get iModel Shares - iModels

REST API Overview

Reference

Changelog

iModels

Download API definition:

Get iModel Shares

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

GET https://api.bentley.com/imodels/{id}/shares[?$top][&$skip]

Retrieves a list of Shares of the given iModel created by the calling user.

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 imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

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

$top

The $top query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: $top=1. When $top parameter is not provided default is set to 100. $top value cannot exceed 1000.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. E.g. to return items from the collection starting at the third place provide the following query: $skip=2.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "shares": [{
            "id": "846e5f15-ac4a-4971-8160-580d95624f81",
            "displayName": "iModel Share name",
            "name": "iModel Share name",
            "expiresAt": "2020-10-20T10:51:33.1700000Z",
            "permission": "imodels_webview"
        },
        {
            "id": "364cff22-47a0-4aaa-a089-a95748078ff8",
            "displayName": "Second iModel Share name",
            "name": "Second iModel Share name",
            "expiresAt": "2020-10-22T12:51:44.1904400Z",
            "permission": "imodels_read"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/shares?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/shares?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/shares?$skip=100&$top=100"
        }
    }
}

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

Specified iModel was not found.

json

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

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 get Shares.",
        "details": [{
            "code": "InvalidValue",
            "message": "'-1' is not a valid '$skip' value. '$skip' must be a non-negative integer.",
            "target": "$skip"
        }]
    }
}

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

Shares Response

List of Shares.

Share[]

List of Shares.

_links

PagingLinks

Contains the hyperlinks to the previous and next pages of results.

Share 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

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.

Share permission

Share-permission

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

Paging Links

URLs for redoing the current request, getting to the previous or next page of results, if applicable.

self

Link

URL for redoing the current request.

Link

URL for getting the previous page of results.

Link

URL for getting the next page of results.

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.