- URL:
- https://<root>/rest/search
- Methods:
POST- Version Introduced:
- 12.1
Description
This operation is a site wide search that queries spatiotemporal information and other metadata.
Request parameters
| Parameter | Details |
|---|---|
| A token must be acquired via the /admin/generateToken/ endpoint. This will allow users to programmatically interact with the jobs endpoint. |
| The output format for this operation. The default value is Values: |
Response properties
| Parameter | Details |
|---|---|
(Required) | The types of desired geometry for the query to inspect, in the form of a string. Input will be in the form of paired latitude and longitudinal values, eg, "[-123.137633, 49.262336]". More information can be found in our REST API Documentation here and here. |
(Required) | The type of geometry specified by the geometry parameter. The geometry type can be an envelope, a point, a line, or a polygon. The default geometry type is an envelope. esriGeometryEnvelope |
(Optional) | The spatial operation to test. Currently, only |
(Optional) | The in spatial reference, indicating that the search will target items by their initial spatial reference during publication. |
(Optional) | The out spatial reference, indicating that the search will target items which had their spatial reference converted during publication. |
(Optional) | Time range within the On-Demand video layer to search for intersections with the provided geometry. The format is "startTime,endTime". Input should be in epoch time in milliseconds. Additional information on how time can be input and utilized can be found here. |
(Optional) | Searches the full text of metadata, allowing users to specify a string or partial string they wish to target for their search. Additional information regarding fullText can be found here. |
(Optional) | The maximum number of responses allowed by a given search operation. Defaults to 100. Note that there is maximum limit of '2147483647'. |
(Optional) | Must be true or false. If enabled, a count of layers within each service found by the search operation, along with their layer IDs and names, will be returned without additional information. |
Example usage
The following is sample JSON for the search operation:
{
"geometry"=null,
"geometryType"=null,
"spatialRel"="esriSpatialRelIntersects",
"time"=null,
"fullText"=
"[{"searchTerm":"fire","searchType":"simple"}]",
"limit"="100",
"f"="pjson"
}JSON Response syntax
{"results": [
{
"layers": {"<layerId>": {
"coverage": {
"coordinates": [[
[
<longitude value>,
<latitude value>
],
[
<longitude value>,
<latitude value>
],
]],
"type": "Point | Polygon | Polyline",
"crs": {
"type": "<name>",
"properties": {"name": "<coordinate system>"}
}
},
"description": "",
"platformcallsign": "<platformCallsign>",
"copyrightText": "",
"starttimestamp": <epochTimestamp>,
"endtimestamp": <epochTimestamp>
}},
"serviceName": "<serviceName>"
}
]}JSON Response example
{"results": [
{
"layers": {"0": {
"coverage": {
"coordinates": [[
[
-104.79913317832828,
41.144116115619674
],
[
-104.79913974019793,
41.14331104375485
],
]],
"type": "Polygon",
"crs": {
"type": "name",
"properties": {"name": "EPSG:4326"}
}
},
"description": "",
"platformcallsign": "Firebird",
"copyrightText": "",
"starttimestamp": 1.3480872441053E15,
"endtimestamp": 1348087328999262
}},
"serviceName": "testService"
}
]}