DELETE /ariel/saved_searches/{id}

Edit online

Deletes an Ariel saved search. To ensure safe deletion, a dependency check is carried out. The check might take some time. An asynchronous task is started to do this check.

Deletes an Ariel saved search. To ensure safe deletion, a dependency check is carried out. The check might take some time. An asynchronous task is started to do this check.

Table 1. DELETE /ariel/saved_searches/{id} resource details
MIME Type

application/json

Table 2. DELETE /ariel/saved_searches/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

id

path

Required

Number (Integer)

text/plain

null

fields

query

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. DELETE /ariel/saved_searches/{id} response codes
HTTP Response Code Unique Code Description

202

The Ariel saved search delete command was accepted and is in progress.

403

1009

You do not have the required capabilities to delete the Ariel saved search.

404

1002

The Ariel saved search does not exist.

500

1020

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

Response Description

A Delete Task Status object and the location header set to the task status url "/api/ariel/saved_search_delete_tasks/{task_id}". A Delete Task Status object contains the following fields:
  • id - Long - The ID of the task.
  • message - String - The localized task message.
  • status - String - The current state of the task.
  • name - String - The name of the task.
  • created_by - String - The name of the user who started the task.
  • created - Long - The time in milliseconds since epoch since the task was created.
  • started - Long - The time in milliseconds since epoch since the task was started.
  • modified - Long - The time in milliseconds since epoch since the task was modified.
  • completed - Long - The time in milliseconds since epoch since the task was completed.

Response Sample


{
    "completed": 42,
    "created": 42,
    "created_by": "String",
    "id": 42,
    "message": "String",
    "modified": 42,
    "name": "String",
    "started": 42,
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}