Action Provider: Search - Delete Task

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

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

Synchronous / Asynchronous: Asynchronous

This action provider supports deleting content from an existing Globus Search index. Content can be deleted by subject, by entry ID, or by query, depending on how the "Parameters" are structured in the action provider input.

The user calling the action provider must have permission to write to the index referenced. 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.

Usage Example

The example below demonstrates how to use the action provider.

{
  "StartAt": "SearchIngest",
  "States": {
    "SearchIngest": {
      "Type": "Action",
      "ActionUrl": "https://actions.globus.org/search/delete",
      "Parameters": {
        "search_index": "11111111-a85c-473f-9bb6-04dfc6344dd2",
        "delete_by": "subject",
        "subject.$": "$.term"
      },
      "End": true
    }
  }
}
Example Input
{
  "properties": {
    "term": {
      "title": "Term to delete",
      "description": "The term will be deleted from the glossary",
      "type": "string"
    }
  },
  "required": [
    "term"
  ],
  "additionalProperties": false
}
{
  "term": "numerator"
}