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 PUT \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/octet-stream' \
--data '"<string>"'{
"srid": 3857,
"width": 4,
"height": 5,
"numBands": 1,
"scaleX": 1,
"scaleY": 1,
"skewX": 0,
"skewY": 0,
"upperLeftX": -0.5,
"upperLeftY": -0.5
}Put a raster into a feature property
Required capabilities:
geospatialAcl:READgeospatialAcl:WRITE
Put a raster into a feature property. The feature property must be of type RASTER.
curl --request PUT \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/octet-stream' \
--data '"<string>"'{
"srid": 3857,
"width": 4,
"height": 5,
"numBands": 1,
"scaleX": 1,
"scaleY": 1,
"skewX": 0,
"skewY": 0,
"upperLeftX": -0.5,
"upperLeftY": -0.5
}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"
External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type.
256^[A-Za-z][A-Za-z0-9_]{0,255}$"ocean_measure_W87H62"
Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type.
32^[A-Za-z][A-Za-z0-9_]{0,31}$"bathymetry"
Query Parameters
mandatory parameter that specifies the SRID of the coordinate reference system of a raster.
1 <= x <= 9999993857
mandatory parameter that specifies the format of the input raster.
XYZ "XYZ"
optional parameter that specifies the pixel scale x in storage. If not specified, the pixel scale remains the same as the input raster.
2
optional parameter that specifies the pixel scale y in storage. If not specified, the pixel scale remains the same as the input raster.
2
Optional parameter indicating if the input raster coordinates should be transformed into the Coordinate Reference Systems defined for the raster property in the feature type specification. The transformation will typically impact the pixel values. When the parameter is false, requests with rasters in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code.
true
Body
The body is of type file.
Was this page helpful?