Search API Menu

Globus SearchOverviewAPI Usage & BasicsIngestQueryTypes, Type Detection, and SchemasError Handling
API Reference
Create or Update EntryDelete by QueryDelete by SubjectDelete EntryGet EntryGET QueryGet SubjectGet TaskIngestPOST QueryQuery Template APIsScroll QueryShow IndexTask List
Guides
Role Based Filtering
Globus Search LimitsAPI Change History
Globus Docs
  • APIs
    • Auth
    • Transfer
    • Groups
    • Search
    • Python SDK
    • Helper Pages
  • How To
  • Guides
    • Globus Connect Server Installation Guides
    • High Assurance Collections for Protected Data
    • Management Console Guide
    • Command Line Interface
    • Premium Storage Connectors
    • Security
    • Modern Research Data Portal
  • Support
    • FAQs
    • Mailing Lists
    • Contact Us
    • Check Support Tickets
  1. Home
  2. Globus APIs
  3. Globus Search
  4. API Reference

Task List

The Task API provides a method for getting a specific task by ID

Method

GET

URL

/v1/task_list/<index_id>

Authentication required?

Yes

Required Roles

admin or writer on the index

Response Body

a TaskList document

Authentication & Authorization

Tokens for this call must have one of these scopes.

urn:globus:scopes:search.api.globus.org:all
urn:globus:scopes:search.api.globus.org:ingest

You must have the admin or writer role on the index for the task.

Examples

Looking up tasks

Get a list of tasks for an index with an ID of 696af25c-8c24-469a-b5e0-67d3e4b71df7:

curl 'https://search.api.globus.org/v1/task_list/696af25c-8c24-469a-b5e0-67d3e4b71df7'

Response Schemas

Task

Field Name Type Description

task_id

UUID

The ID of the Task

state

String

The status of the Task.

See the Task States table for possible values

state_description

String

A short description of the state value

index_id

UUID

The ID of the Index which is the target of this task

message

String (optional)

A description of the Task, possibly an error message

additional_details

Object (optional)

Added information about the task which cannot be encoded into the message. Usually only populated on failures to include error information.

creation_date

String

The time at which the task was submitted (created)

completion_date

String

The time at which the task was completed

Example Task
{
  "state_description": "Task succeeded",
  "task_id": "05c1ec1b-2400-44e2-9797-922c29199042",
  "state": "SUCCESS",
  "creation_date": "2018-12-13T18:08:42.746911",
  "completion_date": "2018-12-13T18:08:44.539611",
  "additional_details": null,
  "message": null,
  "index_id": "696af25c-8c24-469a-b5e0-67d3e4b71df7"
}

Task States

CREATING

The task is still being initialized

PENDING

The task hasn’t started yet, it is waiting in the queue

PROGRESS

The task has started, but has not yet completed. Search queries may retrieve some of the contents which have been processed

SUCCESS

The task completed without errors or with only temporary errors which resolved

FAILED

The task failed to complete. Partial data may have been processed

TaskList

Field Name Type Description

index_id

UUID

The ID of the Index which is the target of these task

tasks

List of Task documents

The main body of the task list

Example TaskList
{
  "index_id": "696af25c-8c24-469a-b5e0-67d3e4b71df7",
  "tasks": [
    {
      "state_description": "Task succeeded",
      "task_id": "05c1ec1b-2400-44e2-9797-922c29199042",
      "state": "SUCCESS",
      "creation_date": "2018-12-13T18:08:42.746911",
      "completion_date": "2018-12-13T18:08:44.539611",
      "additional_details": null,
      "message": null,
      "index_id": "696af25c-8c24-469a-b5e0-67d3e4b71df7"
    }
  ]
}
Globus SearchOverviewAPI Usage & BasicsIngestQueryTypes, Type Detection, and SchemasError Handling
API Reference
Create or Update EntryDelete by QueryDelete by SubjectDelete EntryGet EntryGET QueryGet SubjectGet TaskIngestPOST QueryQuery Template APIsScroll QueryShow IndexTask List
Guides
Role Based Filtering
Globus Search LimitsAPI Change History
© 2010- The University of Chicago Legal Accessibility