Query the Catalog
POST/catalog/services/ImageServer/query
Query the Catalog. See https://developers.arcgis.com/rest/services-reference/enterprise/query-image-service/.
Request
- application/x-www-form-urlencoded
Body
required
SQL where clause statement. For filtering on "area_cloud_cover_percentage" and "area_avg_off_nadir_angle" use the geometryBasedFilters parameter.
Provided input geometry in accepted format specified by "geometryType" parameter.
Supports a comma-delimited list of available field names. For exportImage you will only need "objectid". * returns all fields.
Possible values - esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope
The spatial reference of the input query geometry.
The returned spatial reference.
Orders results by one or multiple field names.
This parameter specifies how many records to be returned per response page (the max and default is 2000). If there are more records that meet the query criteria than the "resultRecordCount" value, the "nextPageUrl" value in the response can be used to fetch the next page of records. Once all records that meet your query criteria (potentially on many pages) have been returned the "nextPageUrl" value will be null.
This allows for filtering on calculated image attributes against provided geometry. This option can not be used if no input geometry is provided. Input is standard where clause format. The two supported options are - area_cloud_cover_percentage | area_off_nadir_angle
The spatial relationship to be applied on the input geometry while performing the query. Possible values - esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin
Response format
Responses
- 200
- 400
- 500
200 Response
Response Headers
Access-Control-Allow-Origin string
- application/json
- Schema
- Example (from schema)
Schema
- object
{}
400 Response
Response Headers
Access-Control-Allow-Origin string
- application/json
- Schema
- Example (from schema)
Schema
User-friendly error message
{
"message": "string"
}
The request could not be handled by the server.
Response Headers
Access-Control-Allow-Origin string
- application/json
- Schema
- Example (from schema)
Schema
{
"code": "string",
"description": "string"
}