Links

Search path

Description
Search for paths matching specified search criteria.
Endpoint
/path
Method
GET

Access Level Rules

Access Level
None

Processing Units

Processing units
0

Parameters

General Search
Vector Search (type=vector)
Raster Search (type=raster)
Name
Description
Required
Default
type
An array that indicates what you are looking for. "type": [ "vector", "raster", "folder" ]
false
Default ['vector', 'raster', 'folder'].
root
Array of roots to search through. Elements must be one of 'myDrive', 'sharedWithMe', 'trash', 'favorites' or 'public'. Public means not in a root.
false
Default ['public', 'sharedWithMe', 'myDrive', 'favorites', 'trash'].
name
Search for path with the given name.
false
Default null.
fuzzySearchOnName
Boolean whether to do fuzzy search on the 'name' parameter.
false
Default true.
userId
Search for paths owned by the given user. Default null.
false
Default null.
disabled
Boolean whether to only search for disabled or not disabled paths.
false
Default null.
canView
Boolean whether to only search for paths that you have access to.
false
Default null.
pageSize
The maximum number of paths to return. Maximum 100.
false
Default 100.
pageStart
The nextPageStart as returned in a previous request.
false
Default null.
hashtag
The hashtag saved to the blocks. Only applicable for types raster and vector.
false
Default null.
bounds
Object with xMin, xMax, yMin and yMax. Indication spatial bounds to search for (with longitude on the x-axis and latitude on the y-axis). Only applicable for types raster and vector.
false
Default null.
Name
Description
Required
Default
hasVectorLayers
Boolean to search for vector blocks that have or do not have vector layers.
false
Default null.
layerName
Search for vector blocks with the given layer name.
false
Default null.
fuzzySearchOnLayerName
Boolean whether to do fuzzy search on the 'layerName' parameter
false
Default true.
featureSize
Searches for vector blocks with a layer with at least the given amount of geometries in GB.
false
Default null.
seriesSize
Searches for vector blocks with a layer with at least the given amount of time series in GB.
false
Default null.
messageSize
Searches for vector blocks with a layer with at least the given amount of messages in GB.
false
Default null.
Name
Description
Required
Default
bands
Search for raster blocks with the given array of band names.
false
Default null.
resolution
Search for raster blocks with the given resolution range. Must be an array of two floats indicating the minimum and maximum resolution.
false
Default null.
dateFrom
Search for raster blocks that have raster data after the given date.
false
Default null.
dateTo
Search for raster blocks that have raster data before the given date.
false
Default null.
hasTimestamp
Boolean to search for raster blocks that have or do not have timestamps.
false
Default null.
timestampSize
Searches for raster blocks with a timestamp that has at least the given size in GB.
false
Default null.
Last modified 7mo ago