Spatial
Find Records by where they are: inside a box, near a point, or crossing a geometry.
AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
bbox*stringThe bounding box, as west,south,east,north in degrees.
geometryInfo?stringHow the Item keeps its location, as a JSON object, when it is not a geometry.
"{}"query?stringA filter, as a JSON object.
limit?numberHow many to return.
skip?numberHow many to skip.
sort?stringThe order, as a JSON object of field names to 1 or -1.
format?stringjson for the Records, geojson for a FeatureCollection.
"json""json""geojson"The Records, and how many match.
application/json- response
@meta?The name and version of the service that answered.
total?integerHow many match, before skip and limit.
data?array<>The Records.
curl -X GET "https://platform.example.com/api/item/$ITEM_ID/actions/bbox/$BBOX" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "total": 0, "data": [ {} ]}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
bbox*stringThe bounding box, as west,south,east,north in degrees.
application/json- body
geometryInfo?How the Item keeps its location, when it is not a geometry: { "type": "selectLatLonField", "latitudeField": "lat", "longitudeField": "lon" }.
"{}"query?A filter.
limit?integerHow many to return.
skip?integerHow many to skip.
sort?The order, as a JSON object of field names to 1 or -1.
format?stringjson for the Records, geojson for a FeatureCollection.
"json""json""geojson"The Records, and how many match.
application/json- response
@meta?The name and version of the service that answered.
total?integerHow many match, before skip and limit.
data?array<>The Records.
curl -X POST "https://platform.example.com/api/item/$ITEM_ID/actions/bbox/$BBOX" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "geometryInfo": "{}", "query": {}, "limit": 0}'{ "@meta": {}, "total": 0, "data": [ {} ]}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
keyword?stringWords to look for.
query?stringA filter, as a JSON object.
select?stringThe fields to return, as a JSON object of field names to 1 or 0.
skip?integerHow many to skip.
limit?integerHow many to return; 10 when absent.
10sort?stringThe order, as a JSON object of field names to 1 or -1.
rawValue?booleanReturn the stored values, not the ones formatted for display.
falserawField?booleanName the fields by their id, not by their display name.
falseformat?stringThe format of the answer.
"json"formatOptions?stringOptions of the format, as a JSON object.
The extent.
application/json- response
@meta?The name and version of the service that answered.
data?curl -X GET "https://platform.example.com/api/item/$ITEM_ID/actions/getExtent" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "data": {}}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
application/json- body
keyword?stringWords to look for.
query?A filter, as a JSON object.
select?The fields to return, as a JSON object of field names to 1 or 0.
skip?integerHow many to skip.
limit?integerHow many to return; 10 when absent.
10sort?The order, as a JSON object of field names to 1 or -1.
rawValue?booleanReturn the stored values, not the ones formatted for display.
falserawField?booleanName the fields by their id, not by their display name.
falseformat?stringThe format of the answer.
"json"formatOptions?Options of the format, as a JSON object.
[key: string]?anyThe extent.
application/json- response
@meta?The name and version of the service that answered.
data?curl -X POST "https://platform.example.com/api/item/$ITEM_ID/actions/getExtent" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "keyword": "string", "query": {}, "select": {}}'{ "@meta": {}, "data": {}}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
application/json- body
geometry*A GeoJSON geometry.
query?A filter.
skip?integerHow many to skip.
limit?integerHow many to return.
format?stringjson for the Records, geojson for a FeatureCollection.
"json""json""geojson"The Records, and how many match.
application/json- response
@meta?The name and version of the service that answered.
total?integerHow many match, before skip and limit.
data?array<>The Records.
curl -X POST "https://platform.example.com/api/item/$ITEM_ID/actions/intersects" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "geometry": { "type": "Polygon", "coordinates": [ [ [ 100.4, 13.7 ], [ 100.6, 13.7 ], [ 100.6, 13.8 ], [ 100.4, 13.7 ] ] ] }}'{ "@meta": {}, "total": 0, "data": [ {} ]}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
application/json- body
geometry*A GeoJSON Point to measure from.
query?A filter.
distanceField?stringThe name of the field that gets the distance.
"distance"maxDistance?numberThe farthest, in metres.
minDistance?numberThe nearest, in metres.
skip?integerHow many to skip.
limit?integerHow many to return.
format?stringjson for the Records, geojson for a FeatureCollection.
"json""json""geojson"The Records, and how many match.
application/json- response
@meta?The name and version of the service that answered.
total?integerHow many match, before skip and limit.
data?array<>The Records, nearest first.
curl -X POST "https://platform.example.com/api/item/$ITEM_ID/actions/near" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "geometry": { "type": "Point", "coordinates": [ 100.5, 13.75 ] }}'{ "@meta": {}, "total": 0, "data": [ {} ]}