Action Provider: Search

URL: https://actions.globus.org/search/delete

Scope: https://auth.globus.org/scopes/5fac2e64-c734-4e6b-90ea-ff12ddbf9653/search_delete

Synchronous / Asynchronous: Asynchronous

Subjects or entries may be removed from an existing Globus Search index using the Globus Search - Delete action provider. The input to the action provider includes the Search index id to delete the data from. The body also specifies the type of delete operation to execute via the delete_by parameter. Its value may be entry to delete a single entry, subject to delete a subject, or query to remove data matching a Search query.

The user calling the action provider must have permission to write to the index referenced. Globus Search will process the delete operation asynchronously, so this action provider also behaves in an asynchronous fashion. Requests for the state of an Action will look up the state of the task_id in Globus Search, ensuring the status remains up-to-date. Since Globus Search does not support cancellation of tasks, this action provider also does not support cancellation of its Actions.

Example Input to Delete by Subject

{
  "delete_by": "subject",
  "search_index": "00000000-0000-0000-0000-000000000000",
  "subject": "http://example.com/foo"
}

Example Input to Delete by Query

{
  "delete_by": "query",
  "search_index": "00000000-0000-0000-0000-000000000000",
  "q": "a search with filtering and faceting",
  "filters": [
    {
      "type": "range",
      "field_name": "path.to.date",
      "values": [
        {
          "from": "*",
          "to": "2014-11-07"
        }
      ]
    }
  ],
  "query_template": "some_query_template"
}