Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /ariel/saved_searches/{id}

Updates the Ariel saved search.

Updates the Ariel saved search.

Table 1: POST /ariel/saved_searches/{id} Resource Details

MIME Type

application/json

Table 2: POST /ariel/saved_searches/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

Required - The ID of the Ariel saved search to edit.

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /ariel/saved_searches/{id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

saved_search

Object

application/json

Required - Ariel Saved Search object.

{ "is_shared": true, "owner": "String", "is_quick_search": true, "is_default": true, "is_dashboard": true, }

Table 4: POST /ariel/saved_searches/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The Ariel saved search was updated.

403

1009

You do not have the required capabilities to update the Ariel Saved Search.

403

1012

You are not allowed to update the owner field

404

1002

The Ariel saved search does not exist.

409

1007

The provided user does not have the required capabilities to own the Ariel saved search.

422

2000

null

422

1006

Non group by searches cannot be added to the dashboard.

422

1011

The provided new owner is not an existing user

500

1020

An error occurred during the attempt to update the Ariel Saved Search.

Response Description

The Ariel saved search after it has been updated. An Ariel Saved Search object contains the following fields:

  • id - Long - The Id of the saved search.

  • uuid - String - The uid string of the saved search. There are two formats of uid strings: one is rfc4122 pseudo randomly generated UUID format; the other is a string-digit format, e.g. SEARCH-250.

  • name - String - The name of the Ariel saved search.

  • database - String - The database of the Ariel saved search, events or flows.

  • isShared - Boolean - True if the saved search is shared with everyone.

  • owner - String - Owner of the saved search. Only the admin user can change the owner from one to another. Even the owner itself cannot reassign it to another user.

  • aql - String - The AQL string or a null value. If it is an AQL string, the saved search is an AQL based search. If it is a null value, the saved search is a baisc search that is based on query parameters instead of an AQL.

  • description - String - The description of the Ariel saved search.

  • isAggregate - Boolean - True if the saved search is aggregated, so it could be in dashboard.

  • isDashboard - Boolean - True if the Ariel saved search is in the dashboard.

  • isDefault - Boolean - True if this saved search is the default saved search to the user who calls this endpoint. A user can have only one default saved search.

  • isQuickSearch - Boolean - True if the saved search should be in quick search.

Response Sample