ON THIS PAGE
DELETE /dynamic_search/searches/{handle}
SUMMARY Deletes a search and any stored results.
Deletes a search and any stored results.
MIME Type |
---|
text/plain |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
handle |
path |
Required |
String |
text/plain |
The handle which uniquely identifies this search. |
HTTP Response Code | Unique Code | Description |
---|---|---|
204 |
Successful delete. |
|
404 |
1024 |
No search was found with the provided handle |
422 |
1040 |
null |
500 |
1060 |
null |
Response Description
Response Sample
[ { "description": "String", "handle": "String", "header": { "columns": [ { "column_name": "String", "field": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": { "argument": "Object", "left_filter": { "argument": "Object", "left_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "left_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } } }, "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" } } ] }, "query": { "fields": [ { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": { "argument": "Object", "left_filter": { "argument": "Object", "left_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "left_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } } }, "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" } ], "filters": [ { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "left_filter": { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "left_filter": { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "left_filter": { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": "Object", "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } } } ], "range": { "limit": 42, "offset": 42 }, "sorts": [ { "direction": "String", "field": { "argument_fields": [ { "contextual_type": "String", "data_type": "String", "localized_name": "String", "semantic_type": "String" } ], "contextual_type": "String", "data_type": "String", "filter": { "argument": "Object", "left_filter": { "argument": "Object", "left_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "left_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" }, "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String", "right_filter": { "argument": "Object", "operator": { "connective": "String <one of: AND, OR, NOT>", "data_type": "String", "localized_name": "String", "name": "String" }, "parameter": "String" } } }, "function": { "aggregate": true, "argument_types": [ { "position": 42, "type": "String" } ], "localized_name": "String", "name": "String", "return_data_type": "String" }, "localized_name": "String", "semantic_type": "String" } } ] }, "retention": { "creation_date": 42, "expires_at": 42, "last_accessed_date": 42, "retain_duration": 42 }, "search_type": "String <one of: SYNCH, ASYNCH>", "status": "String <one of: DONE, ERROR, QUEUED>" } ]