Responses

Field Reference

API CODEX


Codex Home
API Basics
Requests
Responses
Object Structure
Field Reference
Glossary
Policies
Philosophy
Technologies
Troubleshooting & FAQ
Issue Tracker
Contact

Metadata Application Profile (MAP)

The DPLA API is built following the DPLA Metadata Application Profile (MAP), our internal metadata application profile. Currently, the DPLA API implements DPLA MAP version 3.1. The DPLA MAP is designed to build on the experience of the Europeana Data Model (EDM) and to crosswalk with commonly used metadata standards, including Dublin Core (qualified and unqualified), MODS, and others. It references Dublin Core Terms, the Dublin Core Metadata Element Set, ORE, and a variety of controlled vocabularies and thesauri. The MAP will continue to evolve to implement more linked-data friendly methodologies to better share, expose, and connect DPLA’s content with users across the web.

Types

Both the sourceResource and facet fields, as well as objects in the docs array, contain a type field.  facet.type determines the structure of the returned facet, but the other types are just here so you know what values currently show up in the data.

Source Resource Types

  • text
  • image
  • sound
  • moving image
  • physical object

Document Types

  • item
  • collection

Facet Types

  • terms
  • date_histogram
  • geo_distance

Field Prefixes

You’ll see a bunch of field prefixes (or sigils) throughout these docs.  Here’s what they mean:

  • @: It’s a JSON-LD field.
  • _: Internal field – look away.
  • Anything else: probably part of the originalRecord field, and therefore you’re on the hook for figuring out the meaning.

 

Definitions

Field Definition Source
@context Simply speaking, a context is used to map terms to IRIs. Terms are case sensitive and any valid string that is not a reserved JSON-LD keyword can be used as a term. JSON-LD
@id Used to uniquely identify things that are being described in the document. To be able to externally reference nodes in a graph, it is important that nodes have an identifier. IRIs are a fundamental concept of Linked Data, for nodes to be truly linked, dereferencing the identifier should result in a representation of that node. This may allow an application to retrieve further information about a node. JSON-LD
count The number of matches for a query elasticsearch
dataProvider Provider of the SourceResource and WebResource edm
docs
hasView edm
hasView.@id edmJSON-LD
hasView.format Information about format. edm
hasView.rights Information about rights held in and over a SourceResource. Typically, rights information includes a statement about various property rights associated with the SourceResource, including intellectual property rights. dc
facets Groups of items collected by shared field values elasticsearch
id DPLA ID of a SourceResource within a given context DPLA
ingestDate Date on which the original record was imported into the DPLA database DPLA
ingestType Type of record created by ingestion (either item or collection). DPLA
intermediateProvider An intermediate organization that selects, collates, or curates data from a data provider that is then aggregated by a provider from which DPLA harvests. dpla
isShownAt An unambiguous URL reference to the digital object on the provider’s web site in its full information context. edm
isShownAt.@id Actual URL to the digital object on the provider’s web site in its full information context. edmJSON-LD
isShownAt.format MIME type of digital object. edm
isShownAt.rights Any rights asserted in the digital object referenced at isShownAt.@id. dc
limit The number of documents returned elasticsearch
object An unambiguous URL reference to the DPLA digital content preview of the item. edm
object.@id Actual URL to the digital object preview on the DPLA web site. edm
object.format MIME type of digital object. edm
object.rights Any rights asserted in the digital object referenced at object.@id. dc
originalRecord Complete original record as provided by the provider dpla
provider Service or content hub providing access to the Data Providers content. May contain the same value as Data Provider. (literal value in this version) edm
provider.@id URI for the provider page the DPLA API. edm
provider.name Human-readable version of provider name edm
score The relevance score assigned to the item by Elasticsearch elasticsearch
sourceResource This class is a subclass of “edm:ProvidedCHO,” which comprises the source resources [in EDM called "cultural heritage objects"] about which the DPLA collects descriptions. It is here that attributes of source resources are located, not the digital representations of them. dpla
sourceResource.collection Array of URIs of collection or aggregation of which SourceResource is a part dcmitype
sourceResource.collection.@id URI of collection or aggregation of which SourceResource is a part JSON-LD
sourceResource.collection.description Description of the collection or aggregation of which SourceResource is a part dc
sourceResource.collection.id DPLA identifier of collection or aggregation of which SourceResource is a part DPLA
sourceResource.collection.title Title of collection or aggregation of which SourceResource is a part dc
sourceResource.contributor Entity responsible for making contributions to the resource dc
sourceResource.creator Entity primarily responsible for making sourceResource dc
sourceResource.date Array containing point or period of time associated with an event in lifecycle of a sourceResource (literal value). dc
sourceResource.date.begin Date/time of the start of a time span (inclusive). edm
sourceResource.date.displayDate The date to be displayed by an application seeking to provide a date to accompany the sourceResource.
sourceResource.date.end Date/time of the end of a time span (inclusive) edm
sourceResource.description Includes but is not limited to: an abstract, a table of contents, or a free-text account of SourceResource dc
sourceResource.extent Size or duration of the SourceResource dcterms
sourceResource.format Array containing file format, physical medium or dimensions of a SourceResource. dc
sourceResource.identifier Original identifier of a SourceResource within a given context dc
sourceResource.language Array containing language(s) of source resource dc
sourceResource.language.name Language(s) of source resource dc
sourceResource.language.iso639_3 ISO 639-3 code for the specified language
sourceResource.physicalMedium A physical material or carrier in which source resource exists dc
sourceResource.publisher Entity responsible for making the source resource available, typically the publisher of a text (not dataProvider or provider) dcterms
sourceResource.rights Information about rights held in and over a SourceResource. Typically, rights information includes a statement about various property rights associated with the SourceResource, including intellectual property rights. dc
sourceResource.spatial Spatial characteristics of source resource (usually a literal value in this version) dcterms
sourceResource.spatial.coordinates Location coordinates in latitude, longitude form dpla
sourceResource.spatial.city Location city dpla
sourceResource.spatial.county Location county dpla
sourceResource.spatial.distance Distance from point defined in sourceResource.spatial.coordinates. dpla
sourceResource.spatial.country Location country dpla