Search API
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Batch Delete by Subject
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Entry Delete
    • Entry Show
    • Index Create
    • Index Delete
    • Index List
    • Index Reopen
    • Index Show
    • Ingest
    • Query - GET
    • Query - POST
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Subject Show
    • Task List
    • Task Show
  • Guides
    • Geospatial Search
    • Role Based Filtering
    • Searchable Files
  • Globus Search Limits
  • API Change History
Skip to main content
Globus Docs
  • APIs
    Auth Flows Groups Search Timers Transfer Globus Connect Server Compute Helper Pages
  • Applications
    Globus Connect Personal Globus Connect Server Premium Storage Connectors Compute Command Line Interface Python SDK JavaScript SDK
  • Guides
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus Services
  3. Globus Search
  4. API Reference
  5. Batch Delete by Subject

Batch Delete by Subject

Submit a delete-by-subject task which deletes multiple subjects.

You can then check the status of that Task using the Get Task API. Once your task is complete, the data will be removed from the search index and will no longer appear in query results.

Method

POST

URL

/v1/index/<index_id>/batch_delete_by_subject

Authentication required?

Yes

Required Roles

You must have owner, admin, or writer access

Request Body

a BatchDeleteBySubject document

Response Body

A BatchDeleteBySubjectResponse

Warning

Deleting a subject deletes all entries in that subject, including those those which are not visible to the current user.

Authentication & Authorization

Tokens for this call must have one of these scopes.

urn:globus:auth:scope:search.api.globus.org:all
urn:globus:auth:scope:search.api.globus.org:ingest

Request Schemas

BatchDeleteBySubject

A BatchDeleteBySubject request primarily contains a list of subject strings which should be deleted.

Field Name Type Description

subjects

Array of String

The list of subjects to delete

Example
{
  "subjects": [
    "very-cool-document",
    "less-cool-document",
    "document-wearing-sunglasses"
  ]
}

Response Schemas

BatchDeleteBySubjectResponse

Field Name Type Description

task_id

UUID

the ID of the submitted task

Example
{
  "task_id": "0c21ee5d-e847-415f-831f-b325af794716"
}
  • Globus Search
  • Overview
  • API Usage & Basics
  • Ingest
  • Query
  • Types, Type Detection, and Schemas
  • Error Handling
  • API Reference
    • Batch Delete by Subject
    • Create or Update Entry
    • Delete by Query
    • Delete by Subject
    • Entry Delete
    • Entry Show
    • Index Create
    • Index Delete
    • Index List
    • Index Reopen
    • Index Show
    • Ingest
    • Query - GET
    • Query - POST
    • Role Create
    • Role Delete
    • Role List
    • Scroll Query
    • Subject Show
    • Task List
    • Task Show
  • Guides
    • Geospatial Search
    • Role Based Filtering
    • Searchable Files
  • Globus Search Limits
  • API Change History
© 2010- The University of Chicago Legal Privacy Accessibility