Get global repository - iTwins

iTwins

Download API definition:

Get global repository

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

GET https://dev-api.bentley.com/itwins/repositories/{repositoryId}

Gets the details of the specified repository.

The repository will only be returned if it contains at least one resource. Otherwise, it will return 404 (NotFound).

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 parameters

repositoryId

Yes

The repository Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "repository": {
        "id": "cesium",
        "class": "Cesium",
        "displayName": "Cesium",
        "uri": "https://api.bentley.com/curated-content/cesium",
        "capabilities": {
            "resources": {
                "uri": "https://api.bentley.com/itwins/repositories/cesium/resources"
            }
        }
    }
}

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

This response indicates that the specified repository was not found.

json

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

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

retry-after

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

Definitions

Global-repository-response

repository

Global-repository

json

{
    "type": "object",
    "properties": {
        "repository": {
            "$ref": "#/components/schemas/Global-repository"
        }
    },
    "required": [
        "repository"
    ],
    "additionalProperties": false
}

Global-repository

String

The global repository id.

class

String

The class of the global repository. Known values include: Cesium.

subClass

String

There are no global repositories that have a sub class at this time, but this field is reserved for future use and to be consistent with iTwin repositories.

displayName

String

The repository name that can be displayed to the user.

uri

String

The uri for the repository.

capabilities.resources

ResourcesCapability

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The global repository id."
        },
        "class": {
            "type": "string",
            "description": "The class of the global repository. Known values include: Cesium."
        },
        "subClass": {
            "type": "string",
            "description": "There are no global repositories that have a sub class at this time, but this field is reserved for future use and to be consistent with iTwin repositories."
        },
        "displayName": {
            "type": "string",
            "description": "The repository name that can be displayed to the user."
        },
        "uri": {
            "type": "string",
            "description": "The uri for the repository."
        },
        "capabilities": {
            "type": "object",
            "required": [
                "resources"
            ],
            "properties": {
                "resources": {
                    "$ref": "#/components/schemas/ResourcesCapability"
                }
            },
            "description": "Links to additional capabiblies provided by the repository. Currently, only the [resources](https://developer.bentley.com/apis/itwins/operations/get-repository-resources/) capability is suported. It is a read only value returned for certain classes.",
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}

ResourcesCapability

uri

String

A uri containing the endpoint that will return the list of resources in the repository.

json

{
    "type": "object",
    "properties": {
        "uri": {
            "type": "string",
            "description": "A uri containing the endpoint that will return the list of resources in the repository."
        }
    },
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?