GCIS API Reference

Search
Impacts, Risks, and Adaptation in the United States: The Fourth National Climate Assessment, Volume II
Featured Publications
All Publications
- reports
- indicators
- figures
- images
- books
- journals
- articles
- web pages
- references
- platforms
- instruments
- datasets
- models
- scenarios
- lexicons
contributors
- people
- organizations

API Reference

Below is a list of methods and URLs supported by the GCIS. The current version of this API is 1.57.1.

For definitions of the terms below, please read about the data model.

Click the method name on the left to see more information about a particular route.

There are also JSON and YAML versions of this page which may be viewed using swagger.

Methods	Path	Description
GET	/uuid	Generate a UUID.
GET	/report	Get a list of reports.
GET	/report /:report_identifier	Get a representation of a report.
GET	/report /:report_identifier /chapter	List chapters in a report
GET	/report /:report_identifier /chapter /:chapter_identifier	Get a representation of a chapter.
GET	/report /:report_identifier /chapter /:chapter_identifier /finding	List findings in a chapter
GET	/report /:report_identifier /chapter /:chapter_identifier /finding /:finding_identifier	Get a representation of a finding in a chapter.
GET	/report /:report_identifier /chapter /:chapter_identifier /finding /:finding_identifier /reference
GET	/report /:report_identifier /chapter /:chapter_identifier /finding /:finding_identifier /reference/:reference_identifier
GET	/report /:report_identifier /chapter /:chapter_identifier /figure	List figures in a chapter
GET	/report /:report_identifier /chapter /:chapter_identifier /figure /:figure_identifier	Get a representation of a figure in a chapter.
GET	/report /:report_identifier /chapter /:chapter_identifier /figure /:figure_identifier /original
GET	/report /:report_identifier /chapter /:chapter_identifier /figure /:figure_identifier /reference
GET	/report /:report_identifier /chapter /:chapter_identifier /figure /:figure_identifier /reference/:reference_identifier
GET	/report /:report_identifier /chapter /:chapter_identifier /table	List tables in a chapter
GET	/report /:report_identifier /chapter /:chapter_identifier /table /:table_identifier	Get a representation of a table in a chapter.
GET	/report /:report_identifier /chapter /:chapter_identifier /table /:table_identifier /reference
GET	/report /:report_identifier /chapter /:chapter_identifier /table /:table_identifier /reference/:reference_identifier
GET	/report /:report_identifier /chapter /:chapter_identifier /reference	List references in a chapter
GET	/report /:report_identifier /chapter /:chapter_identifier /reference/:reference_identifier
GET	/report /:report_identifier /finding	List findings in a report.
GET	/report /:report_identifier /figure	List figures in a report.
GET	/report /:report_identifier /table	List tables in a report.
GET	/report /:report_identifier /finding /:finding_identifier	Get a representation of a finding.
GET	/report /:report_identifier /figure /:figure_identifier	Get a representation of a figure.
GET	/report /:report_identifier /figure /:figure_identifier /original
GET	/report /:report_identifier /table /:table_identifier	Get a representation of a table.
GET	/report /:report_identifier /image	List images associated with a report.
GET	/report /:report_identifier /array	List arrays associated with a report.
GET	/report /:report_identifier /webpage	List webpages associated with a report.
GET	/report /:report_identifier /book	List books associated with a report.
GET	/report /:report_identifier /region
GET	/report /:report_identifier /reference	List references in a report.
GET	/report /:report_identifier /reference/:reference_identifier
GET	/figure	List all figures
GET	/publication/:publication_identifier	Redirect to a particular publication.
GET	/contributor/:contributor_identifier	Redirect to a particular contributor.
GET	/article	List articles.
GET	/article /:article_identifier	Get a representation of an article.
GET	/journal	List journals.
GET	/journal /:journal_identifier	Get a representation of a journal.
GET	/journal /:journal_identifier /reference
GET	/journal /:journal_identifier /reference/:reference_identifier
GET	/image	List images.
GET	/image /:image_identifier	Get a representation of an image.
GET	/array	List arrays.
GET	/array /:array_identifier	Get a representation of an array.
GET	/webpage	List web pages.
GET	/webpage /:webpage_identifier	Get a representation of a web page.
GET	/webpage /:webpage_identifier /reference
GET	/webpage /:webpage_identifier /reference/:reference_identifier
GET	/book	List books.
GET	/book /:book_identifier	Get a representation of a book.
GET	/book /:book_identifier /reference
GET	/book /:book_identifier /reference/:reference_identifier
GET	/activity	List activities.
GET	/activity /:activity_identifier	Get a representation of an activity.
GET	/platform	List platforms.
GET	/platform /:platform_identifier	Get a representation of a platform.
GET	/platform /:platform_identifier /instrument	List instruments on a platform.
GET	/platform /:platform_identifier /instrument /:instrument_identifier	Get a representation of an instrument on a platform.
GET	/instrument	List instruments.
GET	/instrument /:instrument_identifier	Get a representation of an instrument.
GET	/person	List people.
GET	/person /:person_identifier	Get a representation of a person.
GET	/person /:person_identifier /contributions/:role_type_identifier/:resource	Show contributions of a certain type by a person
GET	/person/:orcid	Redirect to a person based on an ORCID.
GET	/person/:name	Redirect to a person based on a name
GET	/organization	List organizations.
GET	/organization /:organization_identifier	Get a representation of an organization.
GET	/organization /:organization_identifier /contributions/:role_type_identifier/:resource	Show contributions of a certain type by an organization
GET	/organization_alternate_name
GET	/organization_alternate_name /:organization_alternate_name_identifier
GET	/gcmd_keyword	List GCMD keywords in the GCIS.
GET	/gcmd_keyword /:gcmd_keyword_identifier	Get a representation of a GCMD keyword.
GET	/gcmd_keyword/:gcmd_keyword/children
GET	/region	List regions.
GET	/region /:region_identifier	Get a representation of a region.
GET	/dataset	List datasets.
GET	/dataset /:dataset_identifier	Get a representation of a dataset.
GET	/dataset /:dataset_identifier /reference
GET	/dataset /:dataset_identifier /reference/:reference_identifier
GET	/dataset/lookup/:doi	Look up a dataset by DOI.
GET	/file /:file_identifier	Get a representation of a file.
GET	/reference	List references.
GET	/reference /:reference_identifier	Get a representation of a reference.
GET	/generic	List generic publications.
GET	/generic /:generic_identifier	Get a representation of a generic publication.
GET	/project	List projects.
GET	/project /:project_identifier	Get a representation of a project.
GET	/model	List models.
GET	/model /:model_identifier	Get a representation of a model.
GET	/model_run	List model runs.
GET	/model_run /:model_run_identifier	Get a representation of a model run.
GET	/scenario	List scenarios.
GET	/scenario /:scenario_identifier	Get a representation of a scenario.
GET	/model/:model_identifier/run	List model runs for a particular model.
GET	/scenario/:scenario_identifier/run	List model runs for a particular scenario.
GET	/model_run/:model_identifier/:scenario_identifier/:range_start/:range_end/:spatial_resolution/:time_resolution/:sequence	Get a representation of a model run.
GET	/role_type	List roles
GET	/role_type /:role_type_identifier
GET	/report_type
GET	/report_type /:report_type_identifier
GET	/lexicon	List lexicons.
GET	/lexicon /:lexicon_identifier	Get a representation of a lexicon.
GET	/lexicon /:lexicon_identifier /find/:context/:term	Lookup a GCID from a term
GET	/lexicon /:lexicon_identifier /:context/:term	Lookup a GCID from a term
GET	/lexicon /:lexicon_identifier /list/:context	List the terms within a context of a lexicon
GET	/metrics	Get overall metrics about GCIS data
GET	/indicator
GET	/api

API Reference

show_reference_finding