Description

A GMetaEntry is a single assertion of metadata pertaining to a given subject.

Field Name Required? Rules Description

@datatype

False

must be "GMetaEntry" if present

@version

False

must be "2017-09-01" if present

subject

True

must be a string

The entity described by this metadata, typically a URI

visible_to

True

must be an array of strings

This is a list of security principals allowed to read the metadata. Each string will be in the form of a Principal URN, or the special string "public".

content

True

must be a GMetaContent

This is the actual metadata to assert about subject

id

False

must be a string

A unique identifier for this metadata entry. This value will be used on further API operations which reference this entry such as updates or delete. When id is not provided, it is assumed to have a default "null" value.

mimetype

False

must be a string

should be "application/json"

Examples

Example 1
{
  "subject": "https://search.api.globus.org/abc.txt",
  "visible_to": ["public"],
  "content": {
    "http://transfer.api.globus.org/metadata-schema/file#type": "file"
  }
}
Example 2
{
  "subject": "https://search.api.globus.org/abc.txt",
  "mimetype": "application/json",
  "visible_to": ["urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c"],
  "id" : "visible_to_globus@globus.org",
  "content": {
    "http://transfer.api.globus.org/metadata-schema/file#type": "file",
    "http://transfer.api.globus.org/metadata-schema/file#extension": "txt",
    "http://transfer.api.globus.org/metadata-schema/file#name" : "abc.txt"
  }
}

This document is a superset of Example 1, but is only visible to the user globus@globus.org. This demonstrates how multiple entries about the same subject, but with different IDs, can be useful: some data is only visible to certain users or groups, while other data is public.


© 2010- The University of Chicago Legal