Action Provider: Search - Ingest Task

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

Scope: https://auth.globus.org/scopes/actions.globus.org/search/ingest

Synchronous / Asynchronous: Asynchronous

This action provider supports adding records to an existing Globus Search index.

The input to the action provider must include the ID of the target Globus Search index together with the content to add. The user must have permission to write to the target index.

Globus Search does not support cancellation of tasks, so this action provider cannot support cancellation of its actions.

Usage Example

The example below demonstrates how to use the action provider.

Features of the flow:

  • In this example, glossary terms are added to the Search index based on user input. The user input is referenced using JSON paths: the keys that end with .$ indicate a variable will be referenced, and the values which start with $. indicate a path to the user input variables.

{
  "StartAt": "SearchIngest",
  "States": {
    "SearchIngest": {
      "Type": "Action",
      "ActionUrl": "https://actions.globus.org/search/ingest",
      "Parameters": {
        "search_index": "11111111-a85c-473f-9bb6-04dfc6344dd2",
        "visible_to": [
          "urn:globus:groups:id:22222222-0b3a-11ec-9a67-afcad34eca9b"
        ],
        "subject.$": "$.term",
        "content": {
          "term.$": "$.term",
          "definition.$": "$.definition"
        }
      },
      "End": true
    }
  }
}

Features of the input schema:

  • Titles, description, and a property order are included, which are used by the Globus Web App when rendering the guided input form when a user starts the flow.

Example Input
{
  "properties": {
    "term": {
      "title": "Term to add",
      "description": "The term will be added to the glossary",
      "type": "string"
    },
    "definition": {
      "title": "Definition",
      "type": "string"
    }
  },
  "required": [
    "term",
    "definition"
  ],
  "additionalProperties": false,
  "propertyOrder": [
    "term",
    "definition"
  ]
}
{
  "term": "numerator",
  "definition": "The top part of a fraction"
}