Page tree
Skip to end of metadata
Go to start of metadata


KMS API URL Migration

The GCMD Keyword Management System (KMS) API, both the dynamic and static instances, were migrated to a new URL in June 2020. Redirects will be installed for a period of time to mitigate impacts to users and client applications. The new base URL is https://gcmd.earthdata.nasa.gov/kms/.


1 Introduction

The Keyword Management Service (KMS) is a RESTful web service for maintaining keywords (science keywords, platforms, instruments, data centers, locations, projects, services, resolution, etc.) in the GCMD/IDN system. It allows access to the keywords maintained in the Keyword Management System as SKOS Concepts (RDF, JSON, OWL) or as XML <Concept /> objects. Simple Knowledge Organization System (SKOS) is a standard defined for representation of thesauri, classification schemes, taxonomies, subject-heading systems, or any other type of controlled vocabulary. SKOS is built upon RDF and RDFS, and its main objective is to enable easy publication of controlled structured vocabularies for the Semantic Web. SKOS is currently developed within the W3C framework. Section 1.1 contains a list of attributes associated with a SKOS Concept.

1.1 SKOS Concept

    • concept scheme (e.g., science keywords, platforms, instruments, etc.)
    • concept id (globally unique, read only)
    • broader - list of broader concepts
    • narrower - list of narrower concepts
    • related - list of related concepts
    • definition- one per language
    • pref label - preferred, one per language
    • pref symbol - image of the concept, second phase but interface should support it's addition
    • alt labels - list, multiple per language
    • alt symbol - image, second phase but interface should support it's addition
    • hidden labels - list (common misspellings), second phase?
    • change note - list of changes, human and computer inserted sorted by time
      • date - computer managed
      • note

2 REST paths

Accessing the SKOS concepts is made possible through the following list of REST-based paths; 2.1 Connections,2.2 Concept Resource, 2.3 Concepts – Root, 2.4 Concepts - By Pattern, 2.5 Concepts - By Concept Scheme + Pattern, 2.6 Concepts By Alternate Label Resource, 2.7 Concepts By Full Path Resource, 2.8 Concepts Name Resource, 2.9 Concepts Relation Resource, 2.10 Concept Schemes Resource, 2.11 Concept Versions Resource, 2.12 Concepts in Concept Scheme Resource. See additional detailed information below.

2.1 Connections

The /KMS/ server infrastructure monitors inbound traffic and attempts to prevent over usage such as a Denial of Service (DoS) attack. To do this, the server will only allow so many connections per time interval and total connections at any given time. The current values are:

  • 64 connections at one time
  • 50 started connections within 5 seconds.

If processing records synchronously, then put a 100ms delay between each call. Alternatively mark the start time at the beginning of a block of records, then after processing 50 records check the elapsed execution time. If the elapsed execution time is less then 5 seconds, add a sleep for the difference. The generic logic of this work flow is below:

  1. Start
  2. Save timestamp1 (in ms), reset counter1
  3. Loop
    1. process record
    2. ++counter1
    3. if counter1 >= 50
      1. save timestamp2 (in ms)
      2. if timestamp2-timestamp1 < 5,000ms then sleep for 5,000ms-(timestamp2-timestamp1)
  4. End

2.2 Concept Resource

Complete details of the concept with the given conceptId

URL

/concepts/{conceptId}

Method

GET

HTTP Accepts

  • application/rdf+xml
  • application/xml

Path Params

  • conceptId

Query Params

  • version
  • case
  • format:
    • "xml"
    • "rdf (default)

Form Params

  • none

HTTP Headers

  • Content-MD5
  • Last-Modified

Returns

  • media types: "application/xml",
  • "application/rdf+xml"
  • “application/json”
  • Error code: 404 Not Found (identifier not found)

Examples

Request for a response in RDF format: https://gcmd.earthdata.nasa.gov/kms/concept/085edf65-1c8c-414a-b8e4-a1a08ff08f22?format=rdf 


<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:skos="http://www.w3.org/2004/02/skos/core#" xmlns:gcmd="http://gcmd.gsfc.nasa.gov/kms#">
<gcmd:gcmd>
<gcmd:termsOfUse>http://gcmd.nasa.gov/r/l/TermsOfUse</gcmd:termsOfUse>
<gcmd:keywordVersion>9.1.5</gcmd:keywordVersion>
<gcmd:schemeVersion>2020-06-19 13:47:51</gcmd:schemeVersion>
</gcmd:gcmd>
<skos:Concept rdf:about="085edf65-1c8c-414a-b8e4-a1a08ff08f22"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/sciencekeywords"/>
<skos:prefLabel xml:lang="en">POPULATION</skos:prefLabel>
<skos:definition xml:lang="en">Refers to the total number of inhabitants constituting a particular race, class, or group in a specified area.</skos:definition>
<skos:broader rdf:resource="fb93d937-c17c-45d0-a9e3-ca5c8a800ca8"/>
<skos:narrower rdf:resource="ae9f3a07-f23e-4116-b172-677435102b2f"/>
<skos:narrower rdf:resource="dd0b8bc9-90b3-4e7d-a021-e91dc676d622"/>
<skos:narrower rdf:resource="d2a5c7ec-ccf2-4ab7-8863-9063be91c022"/>
<skos:narrower rdf:resource="d7ad5cff-75df-4bb6-92f0-b5d56da2a588"/>
<skos:narrower rdf:resource="9d6eda76-cf5d-4170-92ce-9ac9197832bf"/>
<skos:narrower rdf:resource="3fd888c4-2fd2-4ce1-8753-3158e2826ef7"/>
<skos:narrower rdf:resource="35b7c7cd-49c8-476c-83f2-f2e1f4097307"/>
<skos:changeNote>2019-05-30 10:07:42.0 [mmorahan] Insert Concept
add narrower relation (POPULATION [085edf65-1c8c-414a-b8e4-a1a08ff08f22,362503] - Vulnerable Populations [35b7c7cd-49c8-476c-83f2-f2e1f4097307,368881]);
</skos:changeNote>
<skos:changeNote>2012-07-11 11:21:42.0 [tbs1979]
update Definition (Refers to the total number of inhabitants constituting a particular race, class, or group in a specified area.);
update Definition (Dictionary.com);
</skos:changeNote>
<skos:changeNote>2012-06-28 09:57:09.0 [tbs1979] Insert Concept
add narrower relation (POPULATION [085edf65-1c8c-414a-b8e4-a1a08ff08f22,21255] - MORTALITY [3fd888c4-2fd2-4ce1-8753-3158e2826ef7,40263]);
</skos:changeNote>
<skos:changeNote>2012-06-28 09:56:24.0 [tbs1979] Insert Concept
add narrower relation (POPULATION [085edf65-1c8c-414a-b8e4-a1a08ff08f22,21255] - NATALITY [9d6eda76-cf5d-4170-92ce-9ac9197832bf,40259]);
</skos:changeNote>
<skos:changeNote>2012-06-28 09:55:48.0 [tbs1979] Insert Concept
add narrower relation (POPULATION [085edf65-1c8c-414a-b8e4-a1a08ff08f22,21255] - POPULATION ESTIMATES [d7ad5cff-75df-4bb6-92f0-b5d56da2a588,40257]);
</skos:changeNote>
<skos:changeNote>2012-06-28 09:54:58.0 [tbs1979] Insert Concept
add narrower relation (POPULATION [085edf65-1c8c-414a-b8e4-a1a08ff08f22,21255] - POPULATION DENSITY [d2a5c7ec-ccf2-4ab7-8863-9063be91c022,40255]);
</skos:changeNote>
</skos:Concept>
</rdf:RDF>


2.3 Concepts - Root

Returns list of all root concepts (that are at the top of the hierarchy) as conceptBriefs

URL

/concepts/root

Method

GET

HTTP Accepts

  • application/rdf+xml
  • application/xml

Path Params

  • none

Query Params

  • version
  • case
  • format
    • "xml"
    • "rdf (default)

Form Params

  • none

HTTP Headers

  • Content-MD5
  • X-GCMD-Count
  • X-GCMD-Content-SHA

Returns

  • media types:
    • "application/xml"
    • "application/rdf+xml"

Examples

Request for the list of root concepts: https://gcmd.earthdata.nasa.gov/kms/concepts/root


<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:skos="http://www.w3.org/2004/02/skos/core#" xmlns:gcmd="http://gcmd.gsfc.nasa.gov/kms#">
<gcmd:gcmd>
<gcmd:termsOfUse>http://gcmd.nasa.gov/r/l/TermsOfUse</gcmd:termsOfUse>
<gcmd:keywordVersion>9.1.5</gcmd:keywordVersion>
</gcmd:gcmd>
<skos:Concept rdf:about="a9f88ca9-5d19-45fa-8fbb-3c6ff5f1f190"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/chronounits"/>
<skos:prefLabel xml:lang="en">Chronostratigraphic Units</skos:prefLabel>
<skos:narrower rdf:resource="0673738a-3751-4d6e-9df0-b2eda0bde993"/>
<skos:narrower rdf:resource="4407ca3c-3dc0-402c-bfc3-4dabd23f283a"/>
<skos:narrower rdf:resource="7160e90a-d7c4-4817-9b1c-e82211688bdb"/>
<skos:narrower rdf:resource="af145656-986a-4969-bb77-6e5b2cff1ede"/>
<skos:narrower rdf:resource="c7626c29-a1d3-4d0c-a263-616fe060f164"/>
<skos:changeNote>2015-08-19 09:35:37.0 [tbs1979] Insert Concept
add narrower relation (Chronostratigraphic Units [a9f88ca9-5d19-45fa-8fbb-3c6ff5f1f190,129837] - NOT APPLICABLE [0673738a-3751-4d6e-9df0-b2eda0bde993,158299]);
</skos:changeNote>
</skos:Concept>

</rdf:RDF>


2.4 Concepts - By Pattern

Returns a list of all concepts that match a given pattern across all concept schemes

URL

/concepts/pattern/{pattern}

Method

GET

HTTP Accepts

  • application/xml

Path Params

  • pattern
  • conceptScheme

Query Params

  • version
  • case
  • format
    • "xml"
    • "rdf" (default)

Form Params

  • none

HTTP Headers

  • Content-MD5

Returns

  • media types
  • "application/xml"
  • "application/rdf+xml"

Examples

Request concepts by pattern: https://gcmd.earthdata.nasa.gov/kms/concepts/pattern/OCEANS?format=rdf


<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:skos="http://www.w3.org/2004/02/skos/core#" xmlns:gcmd="http://gcmd.gsfc.nasa.gov/kms#">
<gcmd:gcmd>
<gcmd:termsOfUse>http://gcmd.nasa.gov/r/l/TermsOfUse</gcmd:termsOfUse>
<gcmd:keywordVersion>9.1.5</gcmd:keywordVersion>
</gcmd:gcmd>
<skos:Concept rdf:about="75aed409-af9f-430b-ba97-4b92cbfcf3a5"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/providers"/>
<skos:prefLabel xml:lang="en">AU/OCEANS</skos:prefLabel>
<gcmd:altLabel gcmd:category="primary"
gcmd:text="National Oceans Office, Department of the Environment and Heritage, Australian Government" xml:lang="en"/>
<gcmd:resource gcmd:type="PROVIDER" gcmd:url="http://www.cmar.csiro.au/"/>
<skos:broader rdf:resource="03e2acdd-67f7-4380-8c82-53aeb1d4730e"/>
</skos:Concept>
<skos:Concept rdf:about="dbff9ea9-3b00-4cd4-b3ed-21790a797207"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/isotopiccategory"/>
<skos:prefLabel xml:lang="en">OCEANS</skos:prefLabel>
<skos:broader rdf:resource="27fa831b-f131-4f6d-8020-cc4ab0896249"/>
</skos:Concept>
<skos:Concept rdf:about="91697b7d-8f2b-4954-850e-61d5f61c867d"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/sciencekeywords"/>
<skos:prefLabel xml:lang="en">OCEANS</skos:prefLabel>
<skos:definition xml:lang="en">Ocean is a very large expanse of sea, in particular, each of the main areas into which the sea is divided geographically.</skos:definition>
<skos:broader rdf:resource="e9f67a66-e9fc-435c-b720-ae32a2c3d8f5"/>
<skos:narrower rdf:resource="bfa56100-6fb5-4e49-9633-298fa3b45508"/>
<skos:narrower rdf:resource="d73e969a-4b66-4713-8d63-fa3cbb1e25e3"/>
<skos:narrower rdf:resource="6eb3919b-85ce-4988-8b78-9d0018fd8089"/>
<skos:narrower rdf:resource="b6fd22ab-dca7-4dfa-8812-913453b5695b"/>
<skos:narrower rdf:resource="bb04ee83-bf49-4f96-898d-20bb6e92bc93"/>
<skos:narrower rdf:resource="1ee8a323-f0ba-4a21-b597-50890c527c8e"/>
<skos:narrower rdf:resource="e3b178eb-2d47-41db-aba1-43a05e9e9256"/>
<skos:narrower rdf:resource="a46016d7-e571-403a-ab37-7223fd74e68e"/>
<skos:narrower rdf:resource="457883c4-b30c-4d26-bed8-6c2887ebbc90"/>
<skos:narrower rdf:resource="63bc0693-52eb-4ebd-a39e-e77e96409072"/>
<skos:narrower rdf:resource="68f93a0c-1525-4f5a-9545-5d94191a3dbf"/>
<skos:narrower rdf:resource="a031952d-9f00-4ba5-9966-5f87ab9dfdd4"/>
<skos:narrower rdf:resource="e3bef663-6116-4f15-995c-38c7cdc9652c"/>
<skos:narrower rdf:resource="251c87cd-03b3-464f-8390-8ede2fec28fc"/>
<skos:narrower rdf:resource="0517ae1f-7617-4f3b-80cb-649178032825"/>
<skos:narrower rdf:resource="c16bda61-353b-4668-af2f-bbb98785b6fa"/>
<skos:narrower rdf:resource="ca154e02-a226-4cc7-8e4a-4474e7eb1eeb"/>
<skos:narrower rdf:resource="346cade5-801a-4afc-9652-48d02905bc4f"/>
<skos:narrower rdf:resource="a04804d5-1064-48fd-a7a7-8da8e10399e1"/>
<skos:narrower rdf:resource="ce4b2c6e-3d69-4cf1-8416-c36e5f9b1b2c"/>
<skos:narrower rdf:resource="f27ad52c-3dfd-4788-851a-427e60ae1b8f"/>
<skos:changeNote>2017-03-15 12:12:57.0 [mgenazzi] Definition added
insert Definition (id: null
text: Ocean is a very large expanse of sea, in particular, each of the main areas into which the sea is divided geographically.
language code: en);
</skos:changeNote>
</skos:Concept>

...
</rdf:RDF>


2.5 Concepts - By Concept Scheme + Pattern

Returns list of all concepts within specified concept scheme that match a given pattern

URL

/concepts/concept_scheme/{conceptScheme}/pattern/{pattern}

Method

GET

HTTP Accepts

  • Accept:application/rdf+xml
  • Accept:application/xml

Path Params

  • conceptScheme: chronounits,

discipline, horizontalresolutionrange, idnnode, instruments, isotopiccategory, locations, platforms, projects, providers, rucontenttype, sciencekeywords, temporalresolutionrange, verticalresolutionrange

  • pattern

Query Params

  • version
  • case
  • format
    • "xml" - same as "Accept:application/xml
    • "rdf" (default) - Accept:application/rdf+xml
    • "text/csv" - report

Form Params

  • none

HTTP Headers

  • Content-MD5
  • Last-Modified


Returns

  • media types
    • "application/xml"
    • "application/rdf+xml"
    • “ application/json”

Examples

Request for a list of concepts that match a given pattern within a given concept scheme: https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/discipline/pattern/water?format=rdf


<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:skos="http://www.w3.org/2004/02/skos/core#" xmlns:gcmd="http://gcmd.gsfc.nasa.gov/kms#">
<gcmd:gcmd>
<gcmd:termsOfUse>http://gcmd.nasa.gov/r/l/TermsOfUse</gcmd:termsOfUse>
<gcmd:keywordVersion>9.1.5</gcmd:keywordVersion>
<gcmd:schemeVersion>2012-10-19 14:09:52</gcmd:schemeVersion>
</gcmd:gcmd>
<skos:Concept rdf:about="386b6504-2d13-442d-8ffa-9fab8d82f3a4"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/discipline"/>
<skos:prefLabel xml:lang="en">FRESHWATER</skos:prefLabel>
<skos:broader rdf:resource="e0b60b65-5850-4165-ba4b-e68adefd249b"/>
</skos:Concept>
<skos:Concept rdf:about="7209c13f-eee0-4dd0-ada8-732900b58e61"
xml:base="https://gcmd.earthdata.nasa.gov/kms/concept/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:skos="http://www.w3.org/2004/02/skos/core#">
<skos:inScheme rdf:resource="https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/discipline"/>
<skos:prefLabel xml:lang="en">FRESHWATER ECOLOGY</skos:prefLabel>
<skos:broader rdf:resource="d4d928d7-099b-4d4a-8f97-c92a09cdf8a7"/>
</skos:Concept>
</rdf:RDF>


Request a CSV format:

https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/discipline/pattern/water?format=csv


"Keyword Version: 9.1.5","Revision: 2012-10-19 14:09:52","Timestamp: 2020-06-25 11:33:16","Terms Of Use: http://gcmd.nasa.gov/r/l/TermsOfUse","The most up to date XML representations can be found here: https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/discipline/?format=xml"
Discipline_Name,Subdiscipline,UUID
"EARTH SCIENCE","FRESHWATER","386b6504-2d13-442d-8ffa-9fab8d82f3a4"
"ECOLOGY","FRESHWATER ECOLOGY","7209c13f-eee0-4dd0-ada8-732900b58e61"


2.6 Concepts By Alternate Label Resource

Returns a concept with an alternate label

URL

/concept/alt_label/{alt_label}

Method

GET

HTTP Accepts

  • application/json

Path Params

  • alt_label

Query Params


  • version
  • scheme
  • format

Form Params

  • none

HTTP Headers

  • Content-MD5

Returns

  • "application/json"

Examples

Request for a concept with an alt label: https://gcmd.earthdata.nasa.gov/kms/concept/short_name/Terra?scheme=platforms


{
"termsOfUse": "See http://gcmd.nasa.gov/r/l/TermsOfUse",
"keywordVersion": "9.1.5",
"schemeVersion": "2020-06-25 11:09:21",
"lastModifiedDate": "2020-02-04 17:40:37.0",
"id": 542065,
"uuid": "80eca755-c564-4616-b910-a4c4387b7c54",
"prefLabel": "Terra",
"altLabels": [
{
"text": "AM-1"
},
{
"text": "am-1"
},
{
"text": "TERRA"
},
{
"text": "TERRA (MORNING EQUATORIAL CROSSING TIME SATELLITE)"
},
{
"category": "primary",
"text": "Earth Observing System, Terra (AM-1)"
}
],
"resources": [
{
"type": "provider",
"url": "https://terra.nasa.gov/"
}
],
"isLeaf": "true",
"broader": [
{
"id": 541501,
"uuid": "3466eed1-2fbb-49bf-ab0b-dc08731d502b",
"prefLabel": "Earth Observation Satellites",
"conceptScheme": "platforms",
"isLeaf": "false"
}
],
"related": [
{
"id": 545697,
"uuid": "c811bdaf-649f-4e23-b495-940d64e675f4",
"prefLabel": "ASTER",
"type": "has_instrument",
"value": 1.0,
"conceptScheme": "instruments",
"isLeaf": "true"
},
{
"id": 544093,
"uuid": "52e34405-124d-485e-859b-63f34609b812",
"prefLabel": "CERES-FM1",
"type": "has_instrument",
"value": 1.0,
"conceptScheme": "instruments",
"isLeaf": "true"
},
{
"id": 544749,
"uuid": "815656a4-1382-4e05-94f9-5d4709e036f4",
"prefLabel": "CERES-FM2",
"type": "has_instrument",
"value": 1.0,
"conceptScheme": "instruments",
"isLeaf": "true"
},
{
"id": 544505,
"uuid": "6f912d59-3932-4f05-8924-20628d508b84",
"prefLabel": "MISR",
"type": "has_instrument",
"value": 1.0,
"conceptScheme": "instruments",
"isLeaf": "true"
},
{
"id": 543499,
"uuid": "2878f334-35dc-47a7-a3ae-8c5da1adccd3",
"prefLabel": "MODIS",
"type": "has_instrument",
"value": 1.0,
"conceptScheme": "instruments",
"isLeaf": "true"
},
{
"id": 543777,
"uuid": "3d148e55-a196-4779-ad6e-71a6acb5ec92",
"prefLabel": "MOPITT",
"type": "has_instrument",
"value": 1.0,
"conceptScheme": "instruments",
"isLeaf": "true"
}
],
"conceptScheme": {
"name": "platforms",
"longName": "Platforms"
}
}


2.7 Concepts By Full Path Resource

Returns a concept by the full path

URL

/concept/full_path/

Method

GET

HTTP Accepts

  • application/xml

Path Params

  • full_path

Query Params


  • version
  • format
  • case

Form Params

  • none

HTTP Headers

  • Content-MD5

Returns

  • "application/xml"

Examples

Request for a concept (Soil pH) by the full path: https://gcmd.earthdata.nasa.gov/kms/concept/full_path/EARTH+SCIENCE|AGRICULTURE|SOILS|SOIL+PH


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<concept status="" isRoot="false" checksum="" lang="en" uuid="2a9bce94-c391-4834-96bb-a9685d3590b1" id="555223" xsi:noNamespaceSchemaLocation="http://gcmd.gsfc.nasa.gov/Aboutus/xml/kms/kms.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<termsOfUse>http://gcmd.nasa.gov/r/l/TermsOfUse</termsOfUse>
<keywordVersion>9.1.5</keywordVersion>
<schemeVersion>2020-07-02 17:22:09</schemeVersion>
<prefLabel status="NO_CHANGE" id="555119">SOIL PH</prefLabel>
<altLabels/>
<definition id="437897" reference="" status="NO_CHANGE">The negative log of Hydrogen ion concentration</definition>
<altSymbols/>
<broader>
<conceptBrief status="" isLeaf="false" conceptScheme="sciencekeywords" conceptSchemeId="1445" prefLabel="SOILS" uuid="199e3af8-4cf3-48ba-8b28-b9b54756b3db" id="552575"/>
</broader>
<narrower/>
<related/>
<conceptScheme longName="Science Keywords" name="sciencekeywords" id="1445"/>
<resources/>
<changeNotes/>
</concept>

2.8 Concepts Name Resource

Returns a concept by the concept short name

URL

/concept/short_name

Method

GET

HTTP Accepts

  • application/json

Path Params

  • short_name

Query Params


  • version
  • scheme
  • format
  • case

Form Params

  • none

HTTP Headers

  • Content-MD5

Returns

  • "application/json"

 

Examples

Request for a concept by short name: https://gcmd.earthdata.nasa.gov/kms/concept/short_name/Hydra?scheme=instruments


{
"termsOfUse": "See http://gcmd.nasa.gov/r/l/TermsOfUse",
"keywordVersion": "9.1.5",
"schemeVersion": "2020-06-26 13:53:40",
"id": 543009,
"uuid": "01407ecf-45af-4fcc-8a1b-9b383636e2e4",
"prefLabel": "HYDRA",
"altLabels": [
{
"category": "primary",
"text": "Hot Plasma Analyzer"
}
],
"resources": [
{
"type": "IMAGE",
"url": "http://www-st.physics.uiowa.edu/www/images/ddeis2.jpg"
}
],
"isLeaf": "true",
"broader": [
{
"id": 544273,
"uuid": "5f5e4f2c-61b7-4694-8680-3fc5799f6171",
"prefLabel": "Particle Detectors",
"conceptScheme": "instruments",
"isLeaf": "false"
}
],
"conceptScheme": {
"name": "instruments",
"longName": "Instruments"
}
}


2.9 Concepts Relation Resource

Returns a list of concepts with their relationships

URL

/concept_relation/

Method

GET

HTTP Accepts

  • application/json

Path Params

  • none

Query Params


  • scheme
  • relation_type
  • case

Form Params

  • none

HTTP Headers

  • none

Returns

  • "application/json"

 

Examples

Request for a list of instruments and their relationship to a a platform (MODIS flies on AQUA and TERRA): https://gcmd.earthdata.nasa.gov/kms/concept_relation/?scheme=instruments&relation_type=is_on_platform


{ "prefLabel": "MODIS", "scheme": "instruments", "uuid": "2878f334-35dc-47a7-a3ae-8c5da1adccd3", "relatedConcepts": [ { "prefLabel": "AQUA", "relationType": "is_on_platform", "uuid": "ea7fd15d-190d-43f3-bdd3-75f5d88dc3f8", "scheme": "platforms" }, { "prefLabel": "TERRA", "relationType": "is_on_platform", "uuid": "80eca755-c564-4616-b910-a4c4387b7c54", "scheme": "platforms" }


Request for a list of platforms and their relationship to an instrument (AQUA has a MODIS instrument): https://gcmd.earthdata.nasa.gov/kms/concept_relation/?scheme=platforms&relation_type=has_instrument

 {
"prefLabel": "Aqua",
"scheme": "platforms",
"uuid": "ea7fd15d-190d-43f3-bdd3-75f5d88dc3f8",
"relatedConcepts": [
{
"prefLabel": "AMSR-E",
"relationType": "has_instrument",
"uuid": "736038ef-c1ae-47c7-a50e-729474eeb3b1",
"scheme": "instruments"
},
{
"prefLabel": "AMSU-A",
"relationType": "has_instrument",
"uuid": "2a393a42-ecf9-4137-b1ea-1c25692384b4",
"scheme": "instruments"
},
{
"prefLabel": "CERES-FM3",
"relationType": "has_instrument",
"uuid": "b4d51bd0-047f-4365-98cf-acfe4370eec0",
"scheme": "instruments"
},
{
"prefLabel": "CERES-FM4",
"relationType": "has_instrument",
"uuid": "b1a560d0-e9cb-4ce3-9c06-c354bcf1833f",
"scheme": "instruments"
},
{
"prefLabel": "HSB",
"relationType": "has_instrument",
"uuid": "e257079e-3775-4f95-b42d-b2e4ffab00e8",
"scheme": "instruments"
},
{
"prefLabel": "MODIS",
"relationType": "has_instrument",
"uuid": "2878f334-35dc-47a7-a3ae-8c5da1adccd3",
"scheme": "instruments"
},
{
"prefLabel": "AIRS",
"relationType": "has_instrument",
"uuid": "a9bd961e-1063-4f37-99b6-ecd77aa9eb40",
"scheme": "instruments"
}
]
}


2.10 Concept Schemes Resource

Returns a list of all the concept schemes

URL

/concept_schemes/

Method

GET

HTTP Accepts

  • application/xml

Path Params

  • none

Query Params


  • version

Form Params

  • none

HTTP Headers

  • none

Returns

  • "application/xml"

Examples

Request for a list of all the concept schemes: https://gcmd.earthdata.nasa.gov/kms/concept_schemes/

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<schemes xsi:noNamespaceSchemaLocation="http://gcmd.gsfc.nasa.gov/Aboutus/xml/kms/kms.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<scheme updateDate="2019-12-10" longName="Chained Operations" name="ChainedOperations" id="1457"/>
<scheme updateDate="2016-09-21" longName="Collection Data Type" name="CollectionDataType" id="1421"/>
<scheme updateDate="2016-09-22" longName="Contact Type" name="ContactType" id="1435"/>
<scheme updateDate="2016-09-21" longName="Coordinate System" name="CoordinateSystem" id="1423"/>
<scheme updateDate="2016-06-21" longName="Country" name="Country" id="1437"/>
<scheme updateDate="2018-07-19" longName="Dataset Format" name="DatasetFormat" id="1447"/>
<scheme updateDate="2016-09-21" longName="Dataset Language" name="DatasetLanguage" id="1407"/>
<scheme updateDate="2016-09-21" longName="Dataset Progress" name="DatasetProgress" id="1405"/>
<scheme updateDate="2016-09-22" longName="Distribution Size Unit" name="DistributionSizeUnit" id="1441"/>
<scheme updateDate="2016-09-21" longName="Duration Unit" name="DurationUnit" id="1417"/>
<scheme updateDate="2020-06-25" longName="Granule Data Format" name="GranuleDataFormat" id="1449"/>
<scheme updateDate="2016-09-21" longName="Granule Spatial Representation" name="GranuleSpatialRepresentation" id="1425"/>
<scheme updateDate="2019-12-11" longName="Measurement Name" name="MeasurementName" id="1451"/>
<scheme updateDate="2016-09-21" longName="Metadata Association Type" name="MetadataAssociationType" id="1409"/>
<scheme updateDate="2016-06-21" longName="Metadata Language" name="MetadataLanguage" id="1433"/>
<scheme updateDate="2016-06-10" longName="Metadata Version" name="MetadataVersion" id="1395"/>
<scheme updateDate="2018-10-22" longName="Mime Type" name="MimeType" id="1439"/>
<scheme updateDate="2016-09-23" longName="Multimedia Format" name="MultimediaFormat" id="1431"/>
<scheme updateDate="2019-12-10" longName="Operations" name="Operations" id="1459"/>
<scheme updateDate="2016-09-21" longName="Organization Personnel Role" name="OrganizationPersonnelRole" id="1411"/>
<scheme updateDate="2016-09-21" longName="Organization Type" name="OrganizationType" id="1415"/>
<scheme updateDate="2016-06-10" longName="Persistent Identifier" name="PersistentIdentifier" id="1397"/>
<scheme updateDate="2016-09-21" longName="Personnel Role" name="PersonnelRole" id="1413"/>
<scheme updateDate="2016-09-21" longName="Phone Type" name="PhoneType" id="1401"/>
<scheme updateDate="2016-09-21" longName="Platform Type" name="PlatformType" id="1419"/>
<scheme updateDate="2016-06-10" longName="Private" name="Private" id="1399"/>
<scheme updateDate="2016-09-21" longName="Product Flag" name="ProductFlag" id="1403"/>
<scheme updateDate="2016-10-26" longName="Product Level Id" name="ProductLevelId" id="1427"/>
<scheme updateDate="2019-12-10" longName="Projection Authority" name="ProjectionAuthority" id="1455"/>
<scheme updateDate="2019-12-18" longName="Projection Datum Names" name="ProjectionDatumNames" id="1461"/>
<scheme updateDate="2019-12-10" longName="Projection Name" name="ProjectionName" id="1453"/>
<scheme updateDate="2016-09-21" longName="Spatial Coverage Type" name="SpatialCoverageType" id="1429"/>
<scheme updateDate="2020-01-06" longName="Chronostratigraphic Units" name="chronounits" id="1369"/>
<scheme updateDate="2012-10-19" longName="Disciplines" name="discipline" id="1381"/>
<scheme updateDate="2013-03-19" longName="Horizontal Resolution Ranges" name="horizontalresolutionrange" id="1387"/>
<scheme updateDate="2018-07-06" longName="IDN Nodes" name="idnnode" id="1383"/>
<scheme updateDate="2020-06-26" longName="Instruments" name="instruments" id="1377"/>
<scheme updateDate="2016-10-28" longName="ISO Topic Categories" name="isotopiccategory" id="1385"/>
<scheme updateDate="2019-09-06" longName="Locations" name="locations" id="1371"/>
<scheme updateDate="2020-07-01" longName="Platforms" name="platforms" id="1375"/>
<scheme updateDate="2020-07-02" longName="Projects" name="projects" id="1379"/>
<scheme updateDate="2020-07-02" longName="Providers" name="providers" id="1373"/>
<scheme updateDate="2018-12-10" longName="Related URL Content Types" name="rucontenttype" id="1443"/>
<scheme updateDate="2020-07-02" longName="Science Keywords" name="sciencekeywords" id="1445"/>
<scheme updateDate="2017-06-01" longName="Temporal Resolution Ranges" name="temporalresolutionrange" id="1391"/>
<scheme updateDate="2012-10-19" longName="Vertical Resolution Ranges" name="verticalresolutionrange" id="1389"/>
</schemes>



2.11 Concept Versions Resource

Returns a list of the version types of the concepts

URL

/version_type/

Method

GET

HTTP Accepts

  • application/xml

Path Params

  • versionType

Query Params


  • none

Form Params

  • none

HTTP Headers

  • Content-MD5

Returns

  • "application/xml"

Examples

Request for a list of all the past published versions of the keywords: https://gcmd.earthdata.nasa.gov/kms/concept_versions/version_type/past_published


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<versions xsi:noNamespaceSchemaLocation="http://gcmd.gsfc.nasa.gov/Aboutus/xml/kms/kms.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<version type="PAST_PUBLISHED" creation_date="2019-12-10" id="41">9.1.4</version>
<version type="PAST_PUBLISHED" creation_date="2019-12-10" id="39">9.1.3</version>
<version type="PAST_PUBLISHED" creation_date="2019-12-10" id="37">9.1.2</version>
<version type="PAST_PUBLISHED" creation_date="2019-12-10" id="35">9.1.1</version>
<version type="PAST_PUBLISHED" creation_date="2019-10-31" id="33">9.0</version>
<version type="PAST_PUBLISHED" creation_date="2019-10-30" id="31">8.7</version>
<version type="PAST_PUBLISHED" creation_date="2018-03-15" id="29">8.6</version>
<version type="PAST_PUBLISHED" creation_date="2018-03-15" id="27">8.5.9</version>
<version type="PAST_PUBLISHED" creation_date="2017-04-24" id="25">8.5</version>
<version type="PAST_PUBLISHED" creation_date="2016-08-02" id="23">8.4.1</version>
<version type="PAST_PUBLISHED" creation_date="2016-07-07" id="19">8.4</version>
<version type="PAST_PUBLISHED" creation_date="2016-06-21" id="17">8.3</version>
<version type="PAST_PUBLISHED" creation_date="2016-06-07" id="15">8.2</version>
<version type="PAST_PUBLISHED" creation_date="2015-04-03" id="13">8.1</version>
<version type="PAST_PUBLISHED" creation_date="2013-04-15" id="7">8.0</version>
<version type="PAST_PUBLISHED" creation_date="2012-10-09" id="3">7.0</version>
<version type="PAST_PUBLISHED" creation_date="2012-06-12" id="1">Jun122012</version>
</versions>

Request a specific version of the keywords
https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/sciencekeywords/?format=xml&version=8.4.1


2.12 Concepts In Concept Scheme Resource

Returns a list of all the concepts for a given scheme

URL

/concepts/concept_scheme/

Method

GET

HTTP Accepts

  • application/xml

Path Params

  • conceptScheme

Query Params


  • version

  • format

  • case

  • page_num (1...n)
  • page_size (1...2000)

Form Params

  • none

HTTP Headers

  • Content-MD5

  • Total-Count (total number of concepts in scheme)
  • Result-Count (number of concept returned)

Returns

  • "application/xml"

  • “application/json”

  • “application/rdf+xml”

  • “text/csv”

Examples

https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/platforms?format=csv

"Keyword Version: 9.1.5","Revision: 2020-07-01 13:20:03","Timestamp: 2020-07-06 13:44:14","Terms Of Use: http://gcmd.nasa.gov/r/l/TermsOfUse","The most up to date XML representations can be found here: https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/platforms/?format=xml""Case native"
Category,Series_Entity,Short_Name,Long_Name,UUID
"Aircraft","","A340-600","Airbus A340-600","bab77f95-aa34-42aa-9a12-922d1c9fae63"
"Aircraft","","AC-500S","Rockwell Aero Commander AC-500S","20d7a6a7-1c69-469b-ac53-92078dcb2a67"
"Aircraft","","AC-680E","Rockwell Aero Commander AC-680E","3ecc7e27-1cf9-4c7d-817f-557752323560"
"Aircraft","","AC-690A","Aerocommander aircraft","6fa682b9-c6b5-46ca-971f-b7ecd4bf304d"
"Aircraft","","AEROSONDE","","6be3bc48-c307-4583-8357-34262cf8f35d"
"Aircraft","","AIRCRAFT","","8bce0691-74e9-4363-8d1f-d453a318c62b"
"Aircraft","","ALTUS","","46392889-f6e2-4b06-8f79-87f2ff9d4349"
"Aircraft","","AS350-B2","Helicopter AS350-B2","50ce4651-516f-4b05-a5e0-864617ec26eb"
"Aircraft","","AS350-B3","Helicopter AS350-B3","ad1d4887-ac0d-43a0-9e9b-b42172befebc"
"Aircraft","","AS355-F2","Helicopter AS355-F2","770c3b12-d083-4df9-8b36-27a4786794bb"
"Aircraft","","B-200","Beechcraft King Air B-200","d6aa2406-0323-43c1-b890-3509ee22784e"
"Aircraft","","BE-200","Beechcraft King Air BE-200","a2128496-3729-45ff-9feb-20b9b700470b"
"Aircraft","","BT-67","Basler BT-67","1bfe5750-3641-4ff1-b8bf-40deb163abf0"
"Aircraft","","C-130","Lockheed C-130 Hercules","a790e30f-5a13-4188-befb-2647a884034b"
"Aircraft","","C-131A","Convair C-131 Samaritan","0fa676d8-e487-4905-81c7-1a98150e86c8"
"Aircraft","","C-185","Cessna 185","04da5a44-7299-4d07-b85f-26db1552d00a"
"Aircraft","","C-23 Sherpa","Short Brothers C-23 Sherpa","abe97ffb-af51-43b2-a1d4-a922ddf9bc6e"


3 Governance of Keywords

The Global Change Master Directory (GCMD) Keyword Governance and Community Guide Document, Version 1.0 provides the community with a comprehensive resource that describes the governance structures and process for reviewing proposed changes to the GCMD Keywords. The document includes an overview of the structure of the keywords, requirements and recommendations to consider when requesting keyword changes, and instructions for submitting change requests. The process described in this document will be the basis of all future GCMD Keyword reviews. The community is invited to provide feedback.

4 Keyword URLs

4.1 KMS API Capabilities (Links to an XML formatted file)

4.2 KMS Static Directory

4.3 Keywords Community Forum


5 Contact Us

If you have additional questions about the Keyword API, please contact us at: support@earthdata.nasa.gov. or post your question on the Keywords Community Forum.



  • No labels

1 Comment

  1. i will fix this.