updateSavedSearch

PUT
1
/{orgId}/{itemId}/searches/{searchId}

Update saved search

Update a saved search or chart by specifying the update values in the json body. All the properties except for optional properties must be passed in the body to update the search or chart. The searchId cannot be updated once it is created. The adminBasic or adminAdvanced privilege is required.

Update Saved Search Parameters:

ParameterDescriptionData Type
nameRequired. The display name for the saved search or chart.String
folderOptional. The folder the saved search or chart will be categorized under.String
definitionRequired if the searchType is Standard. The search definition to be saved. For details on search definition syntax, see Search for jobs in the system.String
searchTypeOptional. The type for the saved search or chart. The accepted values are Standard, Chart and All. If not defined, the default type is Standard.String
colorRampRequired if the searchType is Chart. The color ramp for the saved chart.String
sortIndexOptional. The sorting order for the saved search or chart.Integer

Query parameters

NameTypeRequired

token

string

Body parameters

Supported content types: application/json

NameTypeRequiredDescription

An object defining the seach to be updated

body

An object defining the seach to be updated

Path parameters

NameTypeRequired

searchId

string

orgId

string

itemId

string

Examples

Request

1
2
3
4
5
6
# You can also use wget
curl -X PUT /{orgId}/{itemId}/searches/{searchId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  --data '{"searchId":"string","name":"string","folder":"string","definition":{"q":"string","search":"string","fields":["string"],"displayNames":["string"],"sortFields":[{"field":"string","sortOrder":"Asc"}],"spatialExtent":"string","hasLocation":true,"start":0,"num":0},"searchType":"Chart","colorRamp":"string","sortIndex":0}'

Response

StatusMeaningDescriptionSchema

200

OK

success

Success

400

Bad Request

invalid object

WorkflowJsonExceptionDTO

404

Not Found

error

WorkflowExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close