API reference (20230101-alpha)
- Overview
- Overview
- POSTAggregate features
- POSTCompute
- POSTCreate Coordinate Reference Systems
- POSTCreate feature types
- POSTCreate features
- POSTDelete Coordinate Reference Systems
- POSTDelete feature types
- POSTDelete features
- POSTDelete a raster from a feature property
- POSTGet Coordinate Reference Systems
- GETGet features
- POSTList feature types
- PUTPut a raster into a feature property
- POSTRetrieve feature types
- POSTRetrieve features
- POSTSearch and stream features
- POSTSearch features
- POSTUpdate feature types
- POSTUpdate features
- POSTFilter all features
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/{featureTypeExternalId}/features \
--header 'Authorization: Bearer <token>'{
"items": [
{
"externalId": "measurement_point_765",
"temperature": 5.65,
"location": {
"wkt": "POINT(60.547602 -5.423433)"
},
"createdTime": 1629784673505,
"lastUpdatedTime": 1629784673505
},
{
"externalId": "measurement_point_863",
"temperature": 5.03,
"location": {
"wkt": "POINT(60.585858 -6.474416)"
},
"createdTime": 1629784673505,
"lastUpdatedTime": 1629784673505
}
],
"nextCursor": "pwGTFXeL-JiWO8CZpgP23g"
}Required capabilities:
geospatialAcl:READ
Get features with paging support
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/{featureTypeExternalId}/features \
--header 'Authorization: Bearer <token>'{
"items": [
{
"externalId": "measurement_point_765",
"temperature": 5.65,
"location": {
"wkt": "POINT(60.547602 -5.423433)"
},
"createdTime": 1629784673505,
"lastUpdatedTime": 1629784673505
},
{
"externalId": "measurement_point_863",
"temperature": 5.03,
"location": {
"wkt": "POINT(60.585858 -6.474416)"
},
"createdTime": 1629784673505,
"lastUpdatedTime": 1629784673505
}
],
"nextCursor": "pwGTFXeL-JiWO8CZpgP23g"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project.
32^[A-Za-z][A-Za-z0-9_]{0,31}$"ocean_measures"
Query Parameters
Cursor for paging through results. In general, if a response contains a nextCursor
property, it means that there may be more results, and you should pass that value as the
cursor parameter in the next request.
Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Limits the number of results to be returned.
1 <= x <= 1000Optional parameter indicating if input geometry properties should be transformed into the respective Coordinate Reference Systems defined in the feature type specification. If the parameter is true, then input geometries will be transformed when the input and output Coordinate Reference Systems differ. When it is false, then requests with geometries in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code. Transformations apply to property geometries in case of create and update feature, as well as to geometries in spatial filters in search endpoints.
true
Optional parameter indicating if the spatial filter operators allow input geometries with a different dimensionality than the properties they are applied to. For instance, when set to true, if a feature type has a property of type POLYGONZM (4D), its features can be filtered using the stContains operator and a POLYGON (2D) value. This option defaults to false if not specified.
true
Was this page helpful?