Field Reference

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

@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
Relates an Aggregation with a WebResource. May include any associated WebResource, such as a thumbnail or a full-size image. (EDM)
hasView.@id
Associates an unambiguous URL reference to the WebResource of the item. (edm; JSON-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. isShownAt is intended to reference a digital object with extra information (such as header, banner etc) or for digital objects embedded in HTML pages (even where the page is extremely simple). (EDM)
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. (EDM)
originalRecord
Complete original record as provided by the provider. (DPLA)
provider
Service or content hub providing access to the Data Provider’s content. May contain the same value as Data Provider. (literal value in this version) (EDM)
provider.@id
URI for the provider page in 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. (DPLA)
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. (ISO639)
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)
sourceResource.spatial.name
Location name. (DPLA)
sourceResource.spatial.region
Location region. (DPLA)
sourceResource.spatial.state
Location state. (DPLA)
sourceResource.stateLocatedIn.name
Name of the U.S. state in which the sourceResource is held. (EDM)
sourceResource.subject
Array containing topic(s) of a SourceResource. (DC)
sourceResource.subject.@id
Identifier of a subject of a SourceResource. (Note: not yet specified in the database.) (DC; JSON-LD)
sourceResource.subject.@type
Identifier of a subject of a SourceResource. (Note: not yet specified in the database.) (DC)
sourceResource.subject.name
Topic or subject of a SourceResource. (DC)
sourceResource.temporal
Temporal characteristics of source resource (usually a literal value in this version). (DPLA)
sourceResource.temporal.begin
Date/time of the start of a time span (inclusive). (DPLA)
sourceResource.temporal.end
Date/time of the end of a time span (inclusive). (DPLA)
sourceResource.title
Name given to a SourceResource. (DC)
sourceResource.type
Nature or genre of source resource. (DC)
start
The index of the first document. (ElasticSearch)