Get features from a collection of geographic features from a specified dataset. This endpoint is part of the OGC API - Features (OAPIF) 3.0 standard, which provides a RESTful interface for accessing geospatial data.
Request parameters
iTwin id
Collection id
Limits the number of items returned.
Return only features in the supplied bounding box coordinates. The CRS of the values is WGS 84 longitude/latitude unless a different CRS is specifed in the parameter bbox-crs.
Parameter may be used to assert the CRS used for the coordinate values of the bbox parameter.
The coordinates of the geometries in the response document will be transformed into the requested CRS.
A token provided by the service to retrieve the next set of features in a paginated response.
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
OK
{ "type": "FeatureCollection", "features": [{ "type": "Feature", "id": 1, "geometry": { "type": "LineString", "coordinates": [ [ 0, 0, 0 ], [ 0, 0, 0 ] ] }, "properties": { "prop1": 0, "prop2": "" } }], "links": [{ "href": "https//example.com/items?limit=1&continuationToken=token", "rel": "next", "type": "application/geo+json" }, { "href": "https//example.com/items", "rel": "self", "type": "application/geo+json" } ], "numberMatched": 10, "numberReturned": 1 }
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.
{ "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.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 422 Unprocessable Entity
UnprocessableEntity
{ "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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Feature Collection type
Specifies the GeoJSON object type as a Feature Collection.
Feature Collection
A valid GeoJSON Feature Collection containing multiple features.
Specifies the GeoJSON object type as a Feature Collection.
The total number of features found in the collection.
The number of features returned in the current request.
Feature type
Specifies the GeoJSON object type as a Feature.
Feature
A valid GeoJSON Feature object.
A collection of properties associated with the feature.
GeoJSON Geometry
A valid GeoJSON Geometry object, which can be one of several geometry types.
Link
A link object to express relationships between resources.
The URL of the linked resource.
The relationship type of the link.
The media type of the linked resource.
A human-readable title for the link.
DetailedError
Contains error information and an array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
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
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.
Was this page helpful?