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

Name	Description	Required	Default
type	An array that indicates the path types you are looking for. "type": [ "vector", "raster", "folder", "file" ]	false	Default ['vector', 'raster', 'folder', 'file'].
root	Array of roots to search through. Elements must be one of 'myDrive', 'sharedWithMe', 'trash', 'favorites' or 'public'.	false	Default ['public', 'sharedWithMe', 'myDrive', 'favorites', 'trash'].
text	Search for paths containing words starting with the given words. Searches through the name of the path, the path and timestamp descriptions, style names and hashtags. Text must contain valid unicode letters or numbers, unicode symbols and punctuation is ignored.	false	Default null.
userId	Search for paths owned by the given user.	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	Searches for paths with the given hashtag.	false	Default null.

Map Search (for vectors and rasters)

Name	Description	Required	Default
active	Boolean to search for maps that have or do not have active data.	false	Default null.
resolution	Object with optional properties 'min' and 'max' defining the minimum/maximum resolution the maps should have.	false	Default null.
extent	Object with properties 'xMin', 'xMax', 'yMin' and 'yMax' defining the geographic extent with which the resulting maps should overlap.	false	Default null.
date	Object with optional properties 'from' and 'to' defining the time range which the timestamps of the map should overlap.	false	Default null.