Get Collections - Geospatial Features

Geospatial Features

Download API definition:

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

Get Collections

GET https://dev-api.bentley.com/geospatial-features/itwins/{iTwinId}/ogc/collections

Retrieve all Collections (Feature Classes) that contain features within an iTwin.

Request parameters

iTwinId

Yes

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.

Response 200 OK

json

{
    "links": [{
        "href": "https//example.com/9169a6b2-9680-40d8-9669-b5c0a6d96014/ogc/collections",
        "rel": "self",
        "type": "application/json"
    }],
    "collections": [{
        "id": "90442b2b-a7e6-4471-b093-cb002a37762a",
        "title": "Title",
        "description": "Description",
        "links": [{
                "href": "https//example.com/9169a6b2-9680-40d8-9669-b5c0a6d96014/ogc/collections/90442b2b-a7e6-4471-b093-cb002a37762a",
                "rel": "self",
                "type": "application/json",
                "title": "Title"
            },
            {
                "href": "https//example.com/9169a6b2-9680-40d8-9669-b5c0a6d96014/ogc/collections/90442b2b-a7e6-4471-b093-cb002a37762a/items",
                "rel": "items",
                "type": "application/geo+json",
                "title": "title"
            }
        ],
        "extent": {
            "spatial": {
                "bbox": [
                    [
                        -50.08876885548398,
                        50.94487570541774,
                        0.0003396840931770839,
                        -50.08830149142197,
                        50.94521538951092,
                        0.0004673640620040942
                    ]
                ],
                "crs": "https://www.opengis.net/def/crs/OGC/1.3/CRS84"
            }
        },
        "crs": [
            "https://www.opengis.net/def/crs/EPSG/0/32615"
        ],
        "storageCrs": "https://www.opengis.net/def/crs/EPSG/0/32615"
    }]
}

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

This response indicates that user does not have required permissions to get specified connection.

json

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

Response 422 Unprocessable Entity

UnprocessableEntity

json

{
    "error": {
        "code": "InvalidGeospatialFeaturesRequest",
        "message": "Invalid 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

Link

A link object to express relationships between resources.

href

String

The URL of the linked resource.

rel

String

The relationship type of the link.

type

String

The media type of the linked resource.

title

String

A human-readable title for the link.

json

{
    "title": "Link",
    "description": "A link object to express relationships between resources.",
    "required": [
        "href"
    ],
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "The URL of the linked resource."
        },
        "rel": {
            "type": "string",
            "description": "The relationship type of the link."
        },
        "type": {
            "type": "string",
            "description": "The media type of the linked resource."
        },
        "title": {
            "type": "string",
            "description": "A human-readable title for the link."
        }
    },
    "additionalProperties": false
}

Collections

Represents a collection of OGC feature collections. This object contains metadata links and an array of individual feature collections.

links

Link[]

An array of metadata links related to the collections.

collections

Collection[]

An array of individual feature collections, each containing its own metadata and links.

json

{
    "type": "object",
    "description": "Represents a collection of OGC feature collections. This object contains metadata links and an array of individual feature collections.",
    "required": [
        "links",
        "collections"
    ],
    "properties": {
        "links": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Link"
            },
            "description": "An array of metadata links related to the collections."
        },
        "collections": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Collection"
            },
            "description": "An array of individual feature collections, each containing its own metadata and links."
        }
    },
    "additionalProperties": false
}

Collection

Represents an individual OGC feature collection. This object contains metadata such as the collection's ID, title, description, links, extent, item type, and coordinate reference systems.

String

A unique identifier for the feature collection.

title

String

The title of the feature collection.

description

String, null

A brief description of the feature collection.

links

Link[]

An array of metadata links related to the feature collection.

extent

Extent

The spatial and temporal extent of the feature collection.

itemType

String

The type of items contained in the feature collection.

crs

String[]

An array of coordinate reference systems used by the feature collection.

storageCrs

String

The coordinate reference system used for storage.

storageCrsCoordinateEpoch

String, null

The epoch of the storage coordinate reference system, if applicable.

json

{
    "type": "object",
    "description": "Represents an individual OGC feature collection. This object contains metadata such as the collection's ID, title, description, links, extent, item type, and coordinate reference systems.",
    "required": [
        "id",
        "links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "description": "A unique identifier for the feature collection."
        },
        "title": {
            "type": "string",
            "description": "The title of the feature collection."
        },
        "description": {
            "type": "string",
            "nullable": true,
            "description": "A brief description of the feature collection."
        },
        "links": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Link"
            },
            "description": "An array of metadata links related to the feature collection."
        },
        "extent": {
            "$ref": "#/components/schemas/Extent",
            "description": "The spatial and temporal extent of the feature collection."
        },
        "itemType": {
            "type": "string",
            "description": "The type of items contained in the feature collection."
        },
        "crs": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "An array of coordinate reference systems used by the feature collection."
        },
        "storageCrs": {
            "type": "string",
            "description": "The coordinate reference system used for storage."
        },
        "storageCrsCoordinateEpoch": {
            "type": "string",
            "nullable": true,
            "description": "The epoch of the storage coordinate reference system, if applicable."
        }
    },
    "additionalProperties": false
}

Extent

Represents the extents of a collection.

spatial

SpatialExtent

The spatial extent of the collection, defining the geographic area covered.

temporal

TemporalExtent, null

The temporal extent of the collection, defining the time period covered.

json

{
    "type": "object",
    "description": "Represents the extents of a collection.",
    "properties": {
        "spatial": {
            "$ref": "#/components/schemas/SpatialExtent",
            "description": "The spatial extent of the collection, defining the geographic area covered."
        },
        "temporal": {
            "$ref": "#/components/schemas/TemporalExtent",
            "nullable": true,
            "description": "The temporal extent of the collection, defining the time period covered."
        }
    },
    "additionalProperties": false
}

SpatialExtent

Spatial extent defines the geographic area covered by the collection.

bbox

Array[]

crs

String

json

{
    "type": "object",
    "description": "Spatial extent defines the geographic area covered by the collection.",
    "properties": {
        "bbox": {
            "type": "array",
            "items": {
                "type": "array",
                "items": {
                    "type": "number"
                }
            }
        },
        "crs": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

TemporalExtent

Temporal extent defines the time period covered by the collection.

interval

Array[]

trs

String

json

{
    "type": "object",
    "description": "Temporal extent defines the time period covered by the collection.",
    "properties": {
        "interval": {
            "type": "array",
            "items": {
                "type": "array",
                "items": {
                    "type": "number"
                }
            }
        },
        "trs": {
            "type": "string"
        }
    },
    "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?