Description

A GIngest document is a wrapper around a GMetaList or GMetaEntry which supplies attributes relevant to the ingest and indexing of metadata into the Globus Search service.

Field Name Required? Rules Description

@datatype

False

must be "GIngest" if present

@version

False

must be "2017-09-01" if present

ingest_type

True

must be one of {"GMetaList", "GMetaEntry"}

Describes the type of ingest_data

ingest_data

True

must be a document such that GIngest.ingest_data.datatype == ingest_type

where dot notation indicates attribute access

This is the data to add to the DataSearch Index

Examples

Example 1
{
  "@datatype": "GIngest",
  "@version": "2017-09-01",
  "ingest_type": "GMetaEntry",
  "ingest_data": {
    "@version": "2017-09-01",
    "subject": "https://search.api.globus.org/",
    "mimetype": "application/json",
    "visible_to": ["public"],
    "id": "stephen_test_doc_2016_11_13",
    "content": {
      "type": "file",
      "extension": "txt",
      "name" : "stephen's test document with spaces.txt"
    }
  }
}
Example 2
{
  "ingest_type": "GMetaEntry",
  "ingest_data": {
    "subject": "https://search.api.globus.org/",
    "mimetype": "application/json",
    "visible_to": ["public"],
    "id": "test_doc_2017_06_14",
    "content": {
      "type": "file",
      "extension": "txt",
      "name" : "another_document_without_spaces.txt"
    }
  }
}

© 2010- The University of Chicago Legal