List content - Cesium Curated Content

Cesium Curated Content

Download API definition:

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

List content

GET https://api.bentley.com/curated-content/cesium/

Retrieves all available content.

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 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

{
    "items": [{
            "id": 1,
            "type": "TERRAIN",
            "name": "Cesium World Terrain",
            "description": "High-resolution global terrain tileset curated from several data sources. See the official [Cesium World Terrain](https://cesium.com/content/cesium-world-terrain/) page for details.",
            "attribution": "Data available from the U.S. Geological Survey, © CGIAR-CSI, Produced using Copernicus data and information funded by the European Union - EU-DEM layers, Data available from Land Information New Zealand, Data available from data.gov.uk, Data courtesy Geoscience Australia",
            "status": "COMPLETE"
        },
        {
            "id": 2,
            "type": "3DTILES",
            "name": "Cesium OSM Buildings",
            "description": "3D buildings from OpenStreetMap with attributes such as height, name, and type of building. See the official [Cesium OSM Buildings](https://cesium.com/content/cesium-osm-buildings/) page for details.",
            "attribution": "Data available from OpenStreetMap contributors",
            "status": "COMPLETE"
        }
    ]
}

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 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": "InvalidCesiumCuratedContentRequest",
        "message": "Cannot retrieve Cesium curated content.",
        "details": [{
            "code": "InvalidValue",
            "message": "not-a-guid is not a valid iTwin id.",
            "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

retry-after

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

Definitions

Content

Number

The unique identifier for the content.

name

String

The name of the content.

description

String

A Markdown string describing the content.

attribution

String

A Markdown compatible string containing any required attribution for the content. Clients will be required to display the attribution to end users.

type

ContentType

status

ContentStatus

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "number",
            "description": "The unique identifier for the content."
        },
        "name": {
            "type": "string",
            "description": "The name of the content."
        },
        "description": {
            "type": "string",
            "description": "A Markdown string describing the content."
        },
        "attribution": {
            "type": "string",
            "description": "A Markdown compatible string containing any required attribution for the content. Clients will be required to display the attribution to end users."
        },
        "type": {
            "$ref": "#/components/schemas/ContentType"
        },
        "status": {
            "$ref": "#/components/schemas/ContentStatus"
        }
    },
    "additionalProperties": false
}

ContentType

The type of content.

3DTILES

String

GLTF

String

IMAGERY

String

TERRAIN

String

KML

String

CZML

String

GEOJSON

String

json

{
    "type": "string",
    "enum": [
        "3DTILES",
        "GLTF",
        "IMAGERY",
        "TERRAIN",
        "KML",
        "CZML",
        "GEOJSON"
    ],
    "description": "The type of content."
}

ContentStatus

Describes the state of the content during the upload and tiling processes.

AWAITING_FILES

String

NOT_STARTED

String

IN_PROGRESS

String

COMPLETE

String

ERROR

String

DATA_ERROR

String

json

{
    "type": "string",
    "enum": [
        "AWAITING_FILES",
        "NOT_STARTED",
        "IN_PROGRESS",
        "COMPLETE",
        "ERROR",
        "DATA_ERROR"
    ],
    "description": "Describes the state of the content during the upload and tiling processes."
}

ContentResponse

items

Content[]

List of content.

json

{
    "type": "object",
    "properties": {
        "items": {
            "type": "array",
            "description": "List of content.",
            "items": {
                "$ref": "#/components/schemas/Content"
            }
        }
    },
    "required": [
        "items"
    ],
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed 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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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?