Search Fields
The table below shows all possible fields for a document returned by the OneStop Search API, along with whether they are searchable, and if so, whether an exact match is required (text fields only). Field names that are bold are returned when the search request summary
flag is true
(default value). Fields marked with a G
are only returned for granules. Those marked with a C
are only returned for collections. All fields are returned for flattened-granules, as a flattened granule is a granule and its collection flattened together. Note that for a returned document, if a field is not present it means it is null/was not given in the original metadata.
All Record Types
Collections and Flattened Granules Only
Granules Only
Field | Searchable | Exact | Notes |
---|---|---|---|
fileIdentifier | Y | Y | |
parentIdentifierG | Y | Y | |
internalParentIdentifierG | Y | Y | Field matching the id value of the parent collection. Search against this using the collectionFilter option in the search request schema. |
doi | Y | Y | |
title | Y | N | |
description | Y | N | |
keywords | Y | N | All keywords found in the metadata, including GCMD values. |
gcmdScience | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdScienceServices | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdLocations | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdInstruments | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdPlatforms | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdProjects | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdDataCenters | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdHorizontalResolution | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdVerticalResolution | Y | Y | Search against this using the facetFilter option in the search request schema. |
gcmdTemporalResolution | Y | Y | Search against this using the facetFilter option in the search request schema. |
beginDate | Y | - | Search against this using the dateTimeFilter option in the search request schema. |
beginYear | Y | - | Year of beginDate. May be populated even if beginDate is null in event of a paleo date. To be supported in future by dateTimeFilter option in the search request schema. |
endDate | Y | - | Search against this using the dateTimeFilter option in the search request schema. |
endYear | Y | - | Year of endDate. May be populated even if endDate is null in event of a paleo date. To be supported in future by dateTimeFilter option in the search request schema. |
spatialBounding | Y | - | Search against this using the geometryFilter option in the search request schema. |
isGlobal | Y | - | Search against this using the excludeGlobalFilter option in the search request schema. |
dataFormats.name | Y | Y | |
dataFormats.version | Y | Y | |
links.linkName | N | - | |
links.linkProtocol | N | - | |
links.linkUrl | N | - | |
links.linkDescription | N | - | |
links.linkFunction | N | - | |
serviceLinks.title | N | - | |
serviceLinks.alternateTitle | N | - | |
serviceLinks.description | N | - | |
serviceLinks.links.linkName | N | - | |
serviceLinks.links.linkProtocol | N | - | |
serviceLinks.links.linkUrl | N | - | |
serviceLinks.links.linkDescription | N | - | |
serviceLinks.links.linkFunction | N | - | |
individualNamesC | Y | N | |
organizationNamesC | Y | N | |
thumbnail | N | - | |
citeAsStatements | N | - | |
crossReferences.titleC | N | - | |
crossReferences.codeC | N | - | |
crossReferences.publicationDateC | N | - | |
crossReferences.link.linkNameC | N | - | |
crossReferences.link.linkProtocolC | N | - | |
crossReferences.link.linkUrlC | N | - | |
crossReferences.link.linkDescriptionC | N | - | |
crossReferences.link.linkFunctionC | N | - | |
largerWorks.titleC | N | - | |
largerWorks.codeC | N | - | |
largerWorks.publicationDateC | N | - | |
largerWorks.link.linkNameC | N | - | |
largerWorks.link.linkProtocolC | N | - | |
largerWorks.link.linkUrlC | N | - | |
largerWorks.link.linkDescriptionC | N | - | |
largerWorks.link.linkFunctionC | N | - | |
useLimitationC | N | - | |
legalConstraintsC | N | - | |
accessFeeStatementC | N | - | |
orderingInstructionsC | N | - | |
editionC | N | - | |
dsmmAverageC | Y | - |