Collection

Object

abstract

A brief description of the collection the metadata represents.

accessConstraints

Allows the author to constrain access to the collection. This includes any special restrictions, legal prerequisites, limitations and/or warnings on obtaining collection data. Some words that may be used in this element's value include: Public, In-house, Limited, None. The value field is used for special ACL rules (Access Control Lists ( http://en.wikipedia.org/wiki/Access_control_list )). For example it can be used to hide metadata when it isn't ready for public consumption.

additionalAttributes

The data’s distinctive attributes of the collection (i.e. attributes used to describe the unique characteristics of the collection which extend beyond those defined).

ancillaryKeywords

Allows authors to provide words or phrases outside of the controlled Science Keyword vocabulary, to further describe the collection.

archiveAndDistributionInformation

Allows a data provider to provide archive and distribution information up front to an end user, to help them decide if they can use the product.

archiveCenter

Find collections matching 'archive_center' param value.

associatedDois

This element stores DOIs that are associated with the collection such as from campaigns and other related sources.

associationDetails

The list of concepts and any data on the relationship between this collection and other permitted concepts

boxes

Spatial coverage of the collection.

browseFlag

True if the metadata contains browse imagery.

citations

Returns a list of associated citations from CMR.

cloudHosted

Data hosted in the cloud.

collectionCitations

Information required to properly cite the collection in professional scientific literature.

collectionDataType

Data type of the collection, e.g. NEAR_REAL_TIME

collectionProgress

This element describes the production status of the data set.

conceptId

The unique concept id assigned to the collection.

consortiums

Consortiums the collection is associated to.

contactGroups

Information about the personnel groups responsible for this collection and its metadata.

contactPersons

Information about the personnel responsible for this collection and its metadata.

coordinateSystem

Coordinate system of the metadata.

dataCenter

Provider associated with the metadata.

dataCenters

Information about the data centers responsible for this collection and its metadata.

dataDates

Dates related to activities involving the collection data.

dataLanguage

Describes the language used in the preparation, storage, and description of the collection. It is the language of the collection data themselves. It does not refer to the language used in the metadata record (although this may be the same language).

dataMaturity

The Data Maturity element is used to inform users on where the collection is in a collection's life cycle.

dataQualitySummaries

Returns the list of data quality summaries associated with the collection.

datasetId

The title of the collection described by the metadata.

directDistributionInformation

This element allows end users to get direct access to data products that are stored in the Amazon Web Service (AWS) S3 buckets. The sub elements include S3 credentials end point and a documentation URL as well as bucket prefix names and an AWS region.

directoryNames

Formerly called Internal Directory Name (IDN) Node (IDN_Node). This element has been used historically by the GCMD internally to identify association, responsibility and/or ownership of the dataset, service or supplemental information. Note: This field only occurs in the DIF. When a DIF record is retrieved in the ECHO10 or ISO 19115 formats, this element will not be translated. The controlled vocabulary for directory names is maintained in the Keyword Management System (KMS).

doi

This element stores the DOI (Digital Object Identifier) that identifies the collection. note: The values should start with the directory indicator which in ESDIS' case is 10. If the DOI was registered through ESDIS, the beginning of the string should be 10.5067. The DOI URL is not stored here; it should be stored as a RelatedURL. The DOI organization that is responsible for creating the DOI is described in the Authority element. For ESDIS records the value of https://doi.org/ should be used. While this element is not required, NASA metadata providers are strongly encouraged to include DOI and DOI Authority for their collections.

duplicateCollections

Returns possible duplicate collections based on matching metadata

entryId

Entry Id is the concatenation of short name, an underscore, and version of the corresponding collection

entryTitle

Entry Title

fileNamingConvention

The File Naming Convention refers to the naming convention of the data set's (Collection's) data files along with a description of the granule file construction.

generateVariableDrafts

Generates variable drafts on the collection using earthdata-varinfo

granules

Returns the list of granules associated with the collection.

A subset of the supported arguments for Collections will be passed through to the granule query by default. Those arguments are as follows:

• boundingBox
• circle
• point
• polygon
• temporal

hasFormats

True if there are multiple supported formats for any services associated with the collection.

hasGranules

True if there are granules associated with the collection.

hasSpatialSubsetting

True if any of its associated services support spatial subsetting.

hasTemporalSubsetting

True if any of its associated services support temporal subsetting.

hasTransforms

True if there are transformations (subset, interpolation or projection) in any of its associated services.

hasVariables

True if there are variables associated with the collection.

isoTopicCategories

Identifies the topic categories from the EN ISO 19115-1:2014 Geographic Information – Metadata – Part 1: Fundamentals ( http://www.isotc211.org/ ) Topic Category Code List that pertain to this collection, based on the Science Keywords associated with the collection. An ISO Topic Category is a high-level thematic classification to assist in the grouping of and search for available collections. The controlled vocabulary for ISO topic categories is maintained in the Keyword Management System (KMS).

lines

Spatial coverage of the collection.

locationKeywords

Controlled hierarchical keywords used to specify the spatial location of the collection. The controlled vocabulary for spatial keywords is maintained in the Keyword Management System (KMS). The Spatial Keyword hierarchy includes one or more of the following layers: Category (e.g., Continent), Type (e.g. Africa), Subregion1 (e.g., Central Africa), Subregion2 (e.g., Cameroon), and Subregion3. DetailedLocation exists outside the hierarchy.

metadataAssociations

This element is used to identify other services, collections, visualizations, granules, and other metadata types and resources that are associated with or dependent on the data described by the metadata. This element is also used to identify a parent metadata record if it exists. This usage should be reserved for instances where a group of metadata records are subsets that can be better represented by one parent metadata record, which describes the entire set. In some instances, a child may point to more than one parent. The EntryId is the same as the element described elsewhere in this document where it contains an ID and Version.

metadataDates

Dates related to activities involving the metadata record itself.

metadataFormat

The format of original collection metadata (Known in CMR as original format).

metadataLanguage

The language used in the metadata record.

nativeDataFormats

An array containing all of the different formats of the underlying data of a collection.

nativeId

The native id to set on the collection.

onlineAccessFlag

True if the data is available online.

organizations

Organizations associated with the metadata, including data centers.

originalFormat

Original metadata format.

otherIdentifiers

Provides additional or provider defined identifiers of the collection.

paleoTemporalCoverages

For paleoclimate or geologic data, PaleoTemporalCoverage is the length of time represented by the data collected. PaleoTemporalCoverage should be used when the data spans time frames earlier than yyyy-mm-dd = 0001-01-01.

platforms

Information about the relevant platform(s) used to acquire the data in the collection. The controlled vocabulary for platform types is maintained in the Keyword Management System (KMS), and includes Spacecraft, Aircraft, Vessel, Buoy, Platform, Station, Network, Human, etc.

points

Spatial coverage of the collection.

polygons

Spatial coverage of the collection.

processingLevel

The identifier for the processing level of the collection.

processingLevelId

An identifier indicating the level at which the data in the collection are processed, ranging from Level0 (raw instrument data at full resolution) to Level4 (model output or analysis results). The value of Processing Level Id is chosen from a controlled vocabulary.

projects

The name of the scientific program, field campaign, or project from which the data were collected.

provider

The identity of the provider in the CMR.

publicationReferences

Describes key bibliographic citations pertaining to the collection.

purpose

Suggested usage or purpose for the collection data or service.

quality

Free text description of the quality of the collection data.

relatedCollections

Returns the list of collections related to this collection.

relatedUrls

Describes any data/service related URLs that include project home pages, services, related data archives/servers, metadata extensions, direct links to online software packages, web mapping services, links to images, or other data.

revisionDate

Date which the Collection was last updated.

revisionId

The revision id of the Collection.

revisions

All revisions of this Collection.

scienceKeywords

Controlled Science Keywords describing the collection. The controlled vocabulary for Science Keywords is maintained in the Keyword Management System (KMS).

services

Returns the list of services associated with the collection.

shortName

Find collections matching any of the 'short_name' param values.

spatialExtent

Specifies the geographic and vertical (altitude, depth) coverage of the data.

spatialInformation

The reference frame or system in which altitudes (elevations) are given. The information contains the datum name, distance units and encoding method, which provide the definition for the system. This field also stores the characteristics of the reference frame or system from which depths are measured. The additional information in the field is geometry reference data etc.

standardProduct

This element is reserved for NASA records only. A Standard Product is a product that has been vetted to ensure that they are complete, consistent, maintain integrity, and satifies the goals of the Earth Observing System mission. The NASA product owners have also commmitted to archiving and maintaining the data products. More information can be found here: https://earthdata.nasa.gov/eosdis/science-system-description/eosdis-standard-products .

subscriptions

Returns the list of subscriptions associated with the collection.

summary

The summary of intentions with which this collection was developed.

tagDefinitions

Returns the list of tag definitions associated with the collection.

tags

Tags associated with the collection. It includes sub-elements of tagKey and optional data which is in embedded JSON.

temporalExtents

This class contains attributes which describe the temporal range of a specific collection. Temporal Extent includes a specification of the Temporal Range Type of the collection, which is one of Range Date Time, Single Date Time, or Periodic Date Time.

temporalKeywords

One or more words or phrases that describe the temporal resolution of the dataset.

tilingIdentificationSystems

Name of the two-dimensional tiling system for the collection.

timeEnd

End time of the metadata.

timeStart

Start time of the metadata.

title

The title of the collection described by the metadata.

tools

Returns the list of tools associated with the collection.

ummMetadata

Raw UMM Metadata of the Collection Record.

useConstraints

Designed to protect privacy and/or intellectual property by allowing the author to specify how the collection may or may not be used after access is granted. This includes any special restrictions, legal prerequisites, terms and conditions, and/or limitations on using the item. Providers may request acknowledgement of the item from users and claim no responsibility for quality and completeness. Note: Use Constraints describe how the item may be used once access has been granted; and is distinct from Access Constraints, which refers to any constraints in accessing the item.

userId

Id of the user who modified/published record

variables

Returns the list of variables associated with the collection.

version

The Version of the collection.

versionDescription

The version description of the collection.

versionId

Provider defined version id of the collection.

visualizations

Returns a list of associated visualizations.