...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Div | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
The LibraryCloud Item API provides Library Cloud is a metadata service that provides open, programmatic access to the metadata about items in available within the Harvard Library collections. For the purposes of this API, an “item” is the metadata describing a catalog record within the Harvard Library. LibraryCloud Item API searches over 20,000,000 aggregated metadata records. Records are ecosystem. It normalizes metadata so that it can be found across silos, and enriches it with connections to information within the Library’s collection and beyond. If a resource that should be part of Library Cloud is added or updated, the metadata should be in LibraryCloud the next day.
LibraryCloud offers item and collection APIs that provide search access to Harvard collections metadata:
- The item API searches over 20 million aggregated metadata records sourced from Harvard Library's main catalog (Alma), JSTOR Forum (for visual information components), and ArchivesSpace (for archival finding aid components). When digitized content is available, these metadata records are enriched with information from Harvard Library's digital repository (DRS).
...
Base URI
http://api.lib.harvard.edu/v2/items
Simple Query
...
- The collection API provides access to metadata about groupings or sets of these items created for administrative and discovery purposes by Harvard staff.
| Div | ||
|---|---|---|
| ||
|
About the Collections API
The base URI for the collections API is https://api.lib.harvard.edu/v2/items?q=peanuts
The response will include all records where any field contains the text “peanuts”, as XMLMultiple terms may be used in a simple query:
httpcollections. Use this API to:
- Retrieve a list of all existing collections (sets), with full set metadata including set name, abbreviation (setSpec), set identifier, size, and description:
https://api.lib.harvard.edu/v2/
...
...
- limit=100 (include a limit parameter, otherwise this query returns the first 10 sets only).
- Retrieve collection metadata for a single set, by set identifier:
https://api.lib.harvard.edu/v2/collections/2/ (11/13/23 Note: currently unavailable, under investigation) - Retrieve a list of items
...
Simple Response
The response to any query contains the total number of matching records, the number of records included within this response, the page number of this response, and the matching records.
...
- in a specific set, by set identifier:
https://api.lib.harvard.edu/v2
...
Searching by Field
See the Field Reference for a list of field-based queries.
...
- /collections/2/items (returns a simple list of record identifiers for items in the set)
Note: The Items API supports querying full item records by associated set metadata. For example, the following items API queries use set metadata to return items in the English Crime and Execution Broadsides set:
- Retrieve items by collectionID:
https://api.lib.harvard.edu/v2/items?
...
...
- 2
- Retrieve items by collectionTitle:
https://api.lib.harvard.edu/v2/items?
...
- collectionTitle=English Crime and Execution Broadsides
- Retrieve items by setName:
https://api.lib.harvard.edu/v2/items?setName=English Crime and Execution Broadsides - Retrieve items by setSpec:
https://api.lib.harvard.edu/v2/items?
...
About the Items API
The base URI for items is https://api.lib.harvard.edu/v2/items.
Keyword Query
The simplest query to the API includes only a search term:
https://api.lib.harvard.edu/v2/items?title_exactq=Peanuts
This query returns all items with a title of “Peanuts”.
In the Field Reference list, the Exact Match Search column indicates if a field supports an exact match query.
Accented Characters and Punctuation
If your query terms contain accented characters, include these in the searchpeanuts
The response will include all items where any field contains the text “peanuts”.
Multiple terms may be used in a simple query:
https://api.lib.harvard.edu/v2/items?name=Saint-Exupéry, Antoine deq=Schulz peanuts
https://api.lib.harvard.edu/v2/items?nameq=MolièreIf your query includes an ampersand, the ampersand must be replaced by the URL-encoded equivalent (%26). For example, to search the title Saxo Grammaticus & the life of Hamlet:
Schulz+peanuts
https://api.lib.harvard.edu/v2/items?title_exact=Saxo+Grammaticus+%26+the+life+of+Hamlet
For searches that include other punctuation marks, if the search fails using the punctuation, try the search again without it.
Stemming, Stopwords and Wildcards
LibraryCloud uses standard Solr index stemming and stopword lists. The stemming algorithm is based on the Porter stemming algorithm.
Keywords may be wild-carded with an asterisk:
httpq=Schulz AND peanuts
All the above queries will return items where any field contains the text “Schulz” AND “peanuts”.
https://api.lib.harvard.edu/v2/items?title=peanut*
httpq=Schulz OR peanuts
The response will include all items where any field contains the text “Schulz” OR “peanuts.
https://api.lib.harvard.edu/v2/items?title=p*nut
Paging
By default, each q=Schulz NOT peanuts
The response will include the first 10 records available. A query can request more records in a response (up to 250), and page through the results.
httpall items where any field contains the text "Schulz" but NOT "peanuts".
Multiple terms can be combined with Boolean operators and parentheses in a complex query:
https://api.lib.harvard.edu/v2/items?title=peanuts?start=100&limit=50
Return the results for the query starting at item 100, with a page size of 50 (e.g. records 100 through 149).
| Parameter | Description |
|---|---|
| start | The row number to start returning results from. If omitted, will default to 1. |
| limit | The number of results to return. Default is 10. May be between 0 and 250. |
Sorting
Responses can sorted in ascending or descending order. See the Field Reference for a list of sortable fields.
httpq=(ethic*+OR+moral*)+AND+(bioengineering+OR+cloning)
Query Response
The response to any query contains the total number of matching records, the number of records included within this response, the page number of this response, and the matching records.
Sample XML response:
https://api.lib.harvard.edu/v2/items?q=peanuts
Sample JSON response:
https://api.lib.harvard.edu/v2/items.json?q=peanuts
Searching by Field
See the Field Reference for a list of field-based queries.
A query can be limited to a particular field:
https://api.lib.harvard.edu/v2/items?title=peanuts&sort.asc=resourceType
Sort results by the “resourceType” field, in ascending order.
| Parameter | Description |
|---|---|
| sort.asc OR sort | The field to use for sorting, in ascending order |
| sort.desc | The field to use for sorting, in descending order |
Facets
Many fields are available for faceting (see the Field Reference "Can Facet" column for details).
http
This query returns all items with the text “peanuts” in the title field.
Field-based queries support combining or excluding terms with AND, OR, NOT:
https://api.lib.harvard.edu/v2/items.json?title=peanuts&facets=name,resourceType
Facet search results by the “name” and “resourceType” fields
| Parameter | Description |
|---|---|
| facets | A comma-separated list of facets to return |
| facet_size | The maximum number of facets to be returned for each faceted field. Default is 10. May be between 1 and 100. |
Response Format
By default, all responses are in MODS format. Dublin Core (DC) can be requested by adding .dc to the base URI
httpsubject=schulz charles
https://api.lib.harvard.edu/v2/items.dc?titlesubject=peanuts
Response Serialization
By default, all responses are returned as XML. Responses can be returned as JSON either by adding “.json” to the base URI, or by setting the “Accept” HTTP header in the request to “application/json”. When specifying both the response format and serialization, the format should be added first.
httpschulz+charles
https://api.lib.harvard.edu/v2/items.json?title=peanuts
httpsubject=schulz AND charles
All the above queries will return items where any subject field contains the text “schulz” AND “charles”.
https://api.lib.harvard.edu/v2/items.dc.json??title=peanuts
Cross-domain queries
The API sets the necessary CORS header to allow cross-domain requests in supported browsers. Cross-domain queries can also use JSONP by specifying a callback function name in a “callback” parameter.
httparchaeology OR archeology
This query returns all items containing the text "archaeology" OR archeology in a title field.
https://api.lib.harvard.edu/v2/items.json?title=peanuts&callback=myfunction
| Parameter | Description |
|---|---|
| calback | Javascript function name. The response data will enclosed in a javascript function call with this name. |
API Versioning
The version number of the API is specified in the base URL (e.g. “v2”). A version number is always required when accessing the API. The version number will be incremented whenever breaking (non backwards-compatible) changes are made to the API.
...
This section describes the fields available for searching through the API. In some cases, fields available through the API aggregate multiple fields with the MODS records. When applicable, this is identified in the MODS field mapping column.
...
title
...
Yes
...
Yes
...
No
...
No
...
titleInfo.title
titleInfo.subTitle
titleInfo.partNumber
titleInfo.partName
https://api.lib.harvard.edu/v2/items?title=complete motown singles
...
name=updike NOT john
This query returns all items where any name field contains the text "updike" but NOT "john".
Multiple queries can be combined:
https://api.lib.harvard.edu/v2/items?title=peanuts&q=snack
This query returns all items with the text “peanuts” in a title field and “snack” anywhere in the record.
https://api.lib.harvard.edu/v2/items?title=peanuts&name=Schulz
This query returns all items with the text “peanuts” in the title field and “Schulz” in the name field.
Case-sensitive exact-match queries can be done on specific fields by appending _exact to the field name:
https://api.lib.harvard.edu/v2/items?title_exact=
...
name
...
Yes
...
Yes?
...
No
...
Yes
...
name.namePart
e.g. "Greenblatt, Stephen"
Will find term in any name field:
https://api.lib.harvard.edu/v2/items?name=shakespeare
...
Peanuts
This query returns all items with a title of exactly “Peanuts”. In the Field Reference list, the "Exact Match Search" column indicates if a field supports an exact match query. Note that an exact query can match on contents of a single MODS field only. In the conversion to LibraryCloud MODS, a single field may be split up – for example, a MARC subject heading and its subdivisions will each be fielded separately. In this case, there isn't an item API fielded query that will return only matches on the full subject heading and its subdivisions.
Accented Characters and Punctuation
If your query terms contain accented characters, include these in the search:
https://api.lib.harvard.edu/v2/items?name
...
...
role
...
Yes
...
Yes?
...
Yes**
...
Yes
...
name.namePart.role.roleTerm
...
Saint-Exupéry, Antoine de
https://api.lib.harvard.edu/v2/items?name=
...
**Can't be sortable; there are multiple roleTerms in some records
...
resourceType
...
Yes
...
Yes?
...
Yes**
...
Yes
...
If your query includes an ampersand, the ampersand must be replaced by the URL-encoded equivalent (%26). For example, to search the title Saxo Grammaticus & the life of Hamlet:
https://api.lib.harvard.edu/v2/items?
...
**get sorting error = can not sort on multivalued field
...
isCollection
(Values are “true” or “false”)
...
No
...
Yes?
...
No
...
Yes
...
typeOfResource.collection
Indicates whether or not a record describes a collection of items.
...
title_exact=Saxo+Grammaticus+%26+the+life+of+Hamlet
At this time, LibraryCloud queries can be sensitive to the presence of punctuation. Some MODS fields (e.g. Genre) include supplied punctuation (e.g., a terminal period or comma) that must be included in the query or it will fail.
Stemming, Stopwords and Wildcards
LibraryCloud uses standard Solr index stemming and stopword lists. The stemming algorithm is based on the Porter stemming algorithm.
Keywords may be wild-carded with an asterisk:
https://api.lib.harvard.edu/v2/items?title=peanut*
https://api.lib.harvard.edu/v2/items?
...
isManuscript
(Values are “true” or “false”)
...
No
...
Yes?
...
No
...
Yes
typeOfResource.manuscript
...
Pagination
By default, a query response will include the first 10 records available. You can increase the number of records returned (up to a max of 250) by using the optional limit parameter. For example, the following query will return the first set of 50 matching records:
https://api.lib.harvard.edu/v2/items?
...
genre
...
Yes
...
Yes
...
Yes**
...
Yes
...
genre
...
https://api.lib.harvard.edu/v2/items?q=fish+watercolor&genre=Drawings
Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?genre_exact=pendants (jewelry)
...
originPlace
...
Yes
...
Yes
...
No
...
Yes
...
originInfo.place
originInfo.place.placeTerm
https://api.lib.harvard.edu/v2/items?q=colonial+north+america&originPlace=Boston
...
You can combine limit with either the start or cursor parameters to paginate an entire result set. Do not combine start and cursor parameters in a single query.
| Parameter | Description |
|---|---|
| limit | The number of results to return. Omit limit and the default is 10 records. May be between 0 and 250. |
| start | The row number to start returning results from. If omitted, will default to 1. |
| cursor | Encoded pointer to a specific record in the search results set. On subsequent requests, the server returns results after the given pointer. |
Paginating with Start
Use the start parameter to set a numerical offset at which the next page will start and add the limit parameter to set the number of results per page. (Omit the limit parameter and the api will return 10 records per page by default.) For example, the following query will return results starting at item 100, with a page size of 50 (e.g., records 100 through 149):
https://api.lib.harvard.edu/v2/items?
...
publisher
...
Yes
...
Yes
...
No
...
Yes
...
originInfo.publisher
...
https://api.lib.harvard.edu/v2/items?q=shakespeare&publisher=Arden
Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?q=shakespeare&publisher_exact=Arden Shakespeare
...
originDate
...
Yes
...
Yes
...
No
...
Yes
...
originInfo.dateIssued
originInfo.dateCreated
originInfo.dateCaptured
originInfo.copyrightDate
originInfo.dateOther
...
https://api.lib.harvard.edu/v2/items?name=asimov+isaac&originDate=1961
Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?name=asimov+isaac&originDate_exact=[1961]
...
dateIssued
...
Yes
...
future?
...
Yes
...
Yes
...
title=peanuts&start=100&limit=50
Query results will include this top-level <pagination> block:
| Code Block | ||
|---|---|---|
| ||
<pagination>
<maxPageableSet>100000</maxPageableSet>
<numFound>768</numFound>
<query>start=100&limit=50&title=peanuts</query>
<limit>50</limit>
<start>100</start>
</pagination> |
As the <maxPageableSet> element indicates, for performance reasons this api can paginate result sets up to a maximum size of 100,000 records. Beyond this number, you'll need to adjust the query to reduce results to a size that can be paginated.
Pros: Pagination using the start parameter supports the default sort by relevancy or alphanumeric sort (when available).
Cons: Pagination using the start parameter does not scale well with larger result sets. For example, queries using start can time out at around 30,000 record hits.
Paginating with Cursor
A cursor is a pointer to a specific record in a result set. (In this case, the cursor is an encoded version of a record identifier.) The api uses the cursor to divide a list of results into records that fall before the cursor and records that fall after the cursor. In your initial query, include the parameter cursor=* (along with a limit parameter to define number of results per page) and the api will return the first page of results plus a <nextCursor> value. For example, the following query will return the first 50 records that match the query along with a nextCursor value that can be used as the cursor value in the next request:
https://api-qa.lib.harvard.edu/v2/items?title=peanuts&cursor=*&limit=50
Query results will include this top-level <pagination> block:
| Code Block | ||
|---|---|---|
| ||
<pagination>
<maxPageableSet>100000</maxPageableSet>
<nextCursor>AoEyOTkwMDM3NTk4NzAwMjAzOTQx</nextCursor>
<numFound>769</numFound>
<query>cursor=*&limit=50&title=peanuts</query>
<limit>50</limit>
<start>0</start>
</pagination> |
To get the next set of results, the client (web browser or application) would make another query that uses the <nextCursor> value as cursor parameter. For example, the following query will return the next 50 matching records:
https://api-qa.lib.harvard.edu/v2/items?title=peanuts&cursor=AoEyOTkwMDM3NTk4NzAwMjAzOTQx&limit=50
The <pagination> block in the next set of query results will include a new <nextCursor> value that can be used in the subsequent query, and so on.
Pros: Pagination using the cursor parameter works well with large result sets but note that the api can paginate result sets up to a maximum size of 100,000 records. Beyond this number, you'll need to adjust the query to reduce results to a size that can be paginated.
Cons: Pagination using the cursor parameter currently returns results in alphanumeric order by record identifier. Support for sort by relevancy is planned for the future. Also, at this time the api will return a <nextCursor> value even if there are no more results to return.
Sorting
By default, query responses are sorted by relevancy and sub-sorted by record identifier. In some cases, query responses can be sorted in ascending or descending alphanumeric order. See the "Alpha Sort" column in the Field Reference for an indication of which fields support alphanumeric sorting.
This query returns results sorted in ascending order by source of item:
https://api.lib.harvard.edu/v2/items?q=university AND choir&sort=source
This query returns results sorted in descending order by recordIdentifier of item:
https://api.lib.harvard.edu/v2/items?title=peanuts&sort.desc=recordIdentifier
| Parameter | Description |
|---|---|
| sort.asc OR sort | The field to use for sorting, in ascending order |
| sort.desc | The field to use for sorting, in descending order |
Facets
Facets are attributes of an item (name, genre, type of resource, language, date, etc.) that can be used to power a faceted search or browse option in a discovery system. The items API supports a facets parameter that will return a list of facet values present in the query results. Many item API fields are available for faceting – see the Field Reference "Can Facet" column for an indication of which fields can be faceted.
For example, this query will return items that contain "peanuts" in a title followed by a list of facet values (and counts) for the “name” and “resourceType” fields that are present in the query results:
https://api.lib.harvard.edu/v2/items.json?title=peanuts&facets=name,resourceType
| Parameter | Description |
|---|---|
| facets | A comma-separated list of facets to return |
| facet_size | The maximum number of facets to be returned for each faceted field. Default is 10. May be between 1 and 100. |
Response Format
By default, all responses are in MODS format. Dublin Core (DC) can be requested by adding .dc to the base URI
https://api.lib.harvard.edu/v2/items.dc?title=peanuts
Response Serialization
By default, all responses are returned as XML. Responses can be returned as JSON either by adding “.json” to the base URI, or by setting the “Accept” HTTP header in the request to “application/json”. When specifying both the response format and serialization, the format should be added first.
https://api.lib.harvard.edu/v2/items.json?title=peanuts
https://api.lib.harvard.edu/v2/items.dc.json?title=peanuts
API Request Rate Limit
The LibraryCloud API is limited to an average of 300 requests per 5 minutes; if, after 5 minutes, that limit is exceeded, the client will receive a 5 minute timeout before they can resume requests. Please limit your requests to no more once per second.
Cross-Domain Queries
The API sets the necessary CORS header to allow cross-domain requests in supported browsers. Cross-domain queries can also use JSONP by specifying a callback function name in a “callback” parameter.
https://api.lib.harvard.edu/v2/items.json?title=peanuts&callback=myfunction
| Parameter | Description |
|---|---|
| callback | Javascript function name. The response data will enclosed in a javascript function call with this name. |
API Versioning
The version number of the API is specified in the base URL (e.g. “v2”). A version number is always required when accessing the API. The version number will be incremented whenever breaking (non backwards-compatible) changes are made to the API.
| Anchor | ||||
|---|---|---|---|---|
|
This section describes the fields available for searching through the API. In some cases, fields available through the API aggregate multiple fields within the MODS records. When applicable, this is identified in the MODS field mapping column.
| Name | Exact Match Search | Alpha Sort | Can Facet | MODS Field Mapping | Examples/Notes |
|---|---|---|---|---|---|
abstractTOC | No | No | No | abstract | This query returns items with the keyword "justinian" in an abstract or table of contents field: https://api.lib.harvard.edu/v2/items?abstractTOC=Justinian |
classification | Yes | No | Yes | classification Physical organization code. Includes bibliographic-level classification but not holdings. See shelfLocator for holdings-level classification. | https://api.lib.harvard.edu/v2/items?classification=F1435.3 Case-sensitive exact match: |
collectionId | Yes | No | Yes | extension.sets.systemId Query by the set/collection ID assigned to items that have been grouped together for delivery via Harvard Digital Collections. | This query returns items associated with a specific set by its identifier: Case-sensitive exact match: |
collectionTitle | Yes | No | Yes | extension.sets.setName Query by the set/collection title assigned to items that have been grouped together for delivery via Harvard Digital Collections. | This query returns items associated with a specific set by set title: Case-sensitive exact match: |
copyrightDate | Yes | No | Yes | originInfo.copyrightDate Use YYYY format to search. | |
dateCaptured | Yes | No | Yes | originInfo.dateCaptured | https://api.lib.harvard.edu/v2/items?dateCaptured=2016&genre=performed+music Case-sensitive exact match: |
dateCreated | Yes | No | Yes | originInfo.dateCreated | https://api.lib.harvard.edu/v2/items?q=daguerreotypes&dateCreated=1806 Case-sensitive exact match: |
dateIssued | Yes | No | Yes | originInfo.dateIssued | https://api.lib.harvard.edu/v2/items?name=asimov isaac&dateIssued=1961 Case-sensitive exact match: |
| dateRange (future) | |||||
| dates.start | No | No | No | originInfo.dateIssued Use YYYY format to search. | This query returns all works by Molière published from 1990 forward: This query returns all works by Molière published from 1990 backward: This query returns all works by Molière published from 1990 to 2000: |
| dates.end | |||||
edition | Yes | No | Yes | originInfo.edition | https://api.lib.harvard.edu/v2/items?name=Molière&edition=7th. ed. Case-sensitive exact match: |
genre | Yes | No | Yes | genre | https://api.lib.harvard.edu/v2/items?q=fish+watercolor&genre=Drawings Case-sensitive exact match: |
identifier | Yes | No | No | identifier (Identifier of an item in another system) | This query returns an item by its ISBN: |
...
isCollection | Yes | No | Yes | typeOfResource (where collection="yes") Values are “true” or “false”. Indicates whether or not a record describes a collection of items. | https://api.lib.harvard.edu/v2/items? |
...
dateCreated
...
Yes
...
future?
...
Yes
...
Yes
...
| q=colonial+north+america&isCollection=true | |||||
isManuscript | Yes | No | Yes | typeOfResource (where manuscript="yes") Values are “true” or “false”. Indicates whether or not a record describes manuscript or archival material. | https://api.lib.harvard.edu/v2/items?q= |
...
Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?dateCreated_exact=late 18th-early 19th century
...
dateCaptured
...
Yes
...
future?
...
Yes
...
Yes
...
| colonial+north+america&isManuscript=true | |||||
isOnline | No | Yes† | Yes | "true" if location.url[@access = 'raw object'] exists, "false" otherwise Indicates whether or not an item is available in digital form; values are "true" or "false". See also inDRS. |
...
...
...
...
Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?dateCaptured_exact=201502--
...
copyrightDate
...
Yes
...
future?
...
†Will sort all @access=raw object items together in a result set. | ||||
issuance | Yes | No | Yes | originInfo. |
...
issuance | This query returns items with subject "astronomy" issued as a serial: https://api.lib.harvard.edu/v2/items? |
...
Exact match seems to work, but not needed (copyrightDate is always 4 digit year)
...
| subject=astronomy&issuance=serial | ||
languageCode | Yes | No |
...
Yes |
...
originInfo.dateIssued
originInfo.dateCreated
...
language.languageTerm (where languageTerm type="code") Search is based on language ISO code. | This query returns items of Shakespeare in Chinese: https://api.lib.harvard.edu/v2/items?name= |
...
| shakespeare&languageCode=chi | |||||
languageText | Yes | No | Yes | language.languageTerm (where languageTerm type="text") Facet as "language" rather than "languageText". For exact match, use "language_exact". Search is based on language name text. | This query returns |
...
items by or about Laozi in Chinese: |
...
...
...
...
Case-sensitive exact match: |
...
...
edition
...
Yes
...
Yes
...
Yes
...
Yes
...
originInfo.edition
...
name | Not available | No | Yes | name.namePart e.g. "Greenblatt, Stephen" | Will find term in any name field: |
originDate | Yes | No | Yes | originInfo.dateIssued |
...
...
Case-sensitive exact match: |
...
...
...
...
issuance
...
originPlace | Yes |
...
Yes
No | Yes | originInfo |
...
.place.placeTerm |
...
languageCode
(Searches based on language ISO code)
...
No
...
Yes
...
No
...
Yes
...
language.languageTerm (where languageTerm type="code")
...
q=colonial+north+america&originPlace=Boston Case-sensitive exact match: | |||||
physicalDescription | No | No | physicalDescription.form | This query returns items in print form with "peanut" in the title: https://api.lib.harvard.edu/v2/items? |
...
...
...
...
...
languageText
(Searches based on language name text)
...
Yes
...
Yes
...
physicalLocation | No | No | Yes |
...
language.languageTerm (where languageTerm type="text")
facet as "language" rather than "languageText"
location.physicalLocation Includes Harvard repository names but also non-Harvard locations, especially for artworks. | https://api.lib.harvard.edu/v2/items? |
...
...
...
...
...
physicalDescription
...
publisher | Yes | No |
...
Yes |
...
physicalDescription.form
physicalDescription.note
originInfo.publisher |
...
...
abstractTOC
...
Yes
...
No
...
No
...
No
...
abstract
tableOfContents
...
Case-sensitive exact match: |
...
classification
(Physical organization code)
...
No
...
Yes
...
Yes
...
No Yes
...
classification
recordIdentifier | Yes | No | No | recordInfo.recordIdentifier at the top level only priorrecordids.recordIdentifier e.g. recordIdentifier=sch00443c00117 (for finding aids), recordIdentifier=S26791_olvsurrogate827653 (for images), recordIdentifier=012956251 (for Aleph) Internal recordInfo.recordIdentifier elements in finding aid components and image records can be searched as keywords. |
...
...
identifier
(Identifier of an item in another system)
...
No
...
Yes
...
Yes
...
No
...
identifier
This query returns an item by it's ISBN:
...
In relatedItem[@type='series']:
titleInfo.title
titleInfo.subtitle
titleInfo.partName
titleInfo.partNumber
facet as "relatedItem" rather than "seriesTitle"
recordIdentifier=sch00227c00197 (for finding aids) https://api.lib.harvard.edu/v2/items?recordIdentifier=W42143_urn-3:FHCL:1176307 (for images) Use a keyword query to retrieve items based on record ID in finding aid components and image records: |
...
subject
...
Yes
...
repository | Yes | No | Yes |
...
...
Search: location.physicalLocation (where @type="repository") Facet: extension.librarycloud.HarvardRepositories.HarvardRepository Includes Harvard repositories only. A search will query the long form repository name (e.g.Eda Kuhn Loeb Music Library); faceting will return the short form repository name (e.g. Loeb Music). | https://api.lib.harvard.edu/v2/items?q=peanuts&repository=Oakes Ames | ||||
resourceType (4/11/19: not working correctly) | Yes | No | Yes | typeOfResource |
...
role | Yes | No | Yes | name.namePart.role.roleTerm |
...
? subject_exact and facets=subject do not work for keywords located in subject.name OR subject.titleInfo
...
subject.topic
...
| seriesTitle | Yes | No | Yes |
...
subject.topic
https://api.lib.harvard.edu/v2/items?subject.topic=Mochica pottery
...
In relatedItem[@type='series']: titleInfo.title facet as "relatedItem" rather than "seriesTitle" | https://api.lib.harvard.edu/v2/items? |
...
subject.temporal
...
| seriesTitle=Harvard-Yenching Institute Monograph Series | |||||||||
| Yes | No | Yes |
...
location. |
...
shelfLocator |
...
...
Case-sensitive exact match: |
...
...
...
subject.title subject.titleInfo
...
source | No | Yes | Yes |
...
No
...
Yes
...
subject.titleInfo.title
subject.titleInfo.subTitle
subject.titleInfo.partNumber
subject.titleInfo.partName
recordInfo.recordIdentifier source attribute Sources are currently MH:ALMA (from Alma), MH:VIA (image items from JSTOR forum), or MH:OASIS (finding aid components from ArchivesSpace). Attribute occurs only on top-level recordInfo.recordIdentifier elements | https://api.lib.harvard.edu/v2/items? |
...
| q=earhart amelia&source=MH:ALMA | ||||
subject | Yes | No | Yes | subject.topic |
...
Yes
...
Yes
...
No
...
Yes
...
subject.genre |
...
hierarchicalGeographic. |
...
https://api.lib.harvard.edu/v2/items?subject.name=kubrick stanley
Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?subject.name=Kubrick,%20Stanley
...
subject.name.role
...
Yes?
...
Yes
...
No
...
Yes
...
province |
...
...
Case-sensitive exact match: |
...
OTOH, subject.genre also has terminal periods on terms but the solr query works with or without:
https://api.lib.harvard.edu/v2/items?subject.genre=Folklore.
...
subject.genre
...
Yes
...
Yes?
Note: An exact query can match on contents of a single field only. In LibraryCloud MODS, a subject heading and its subdivision(s) are split into separate fields, e.g. the subject heading "Older people -- Services for" appears in the LibCloud MODS record as these fields: <mods:topic>Older people</mods:topic> | |||||
subject.genre | Yes | No | Yes | subject.genre |
...
Case-sensitive exact match |
...
...
subject.geographic |
...
Yes | No | Yes | subject.geographic | https://api.lib.harvard.edu/v2/items?subject.geographic=giza Case-sensitive exact match: | |
subject.hierarchicalGeographic |
...
Yes |
...
| No | No | subject.hierarchicalGeographic.continent |
...
...
subject.hierarchicalGeographic.area | Yes | No | Yes | subject.hierarchicalGeographic.area | https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic. |
...
| area=galicia | |||||
subject.hierarchicalGeographic.city | Yes | No | Yes | subject.hierarchicalGeographic.city | https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic. |
...
| city=Cochituate&q=maps | |||||
subject.hierarchicalGeographic.citySection | Yes | No | Yes | subject.hierarchicalGeographic.citySection | https://api.lib.harvard.edu/v2/items? |
...
...
| citySection=charlestown |
subject.hierarchicalGeographic.continent |
...
Yes | No | Yes | subject.hierarchicalGeographic |
...
.continent | https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.continent=africa |
subject.hierarchicalGeographic.country |
...
Yes |
...
Yes
No | Yes | subject.hierarchicalGeographic.country | https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.country=canada |
subject.hierarchicalGeographic. |
...
county | Yes |
...
Yes
No | Yes | subject.hierarchicalGeographic. |
...
NOT WORKING / Seems a valid SOLR field, but no values returned
...
...
| middlesex |
subject.hierarchicalGeographic. |
...
extraterrestrialArea | Yes | No | Yes | subject.hierarchicalGeographic. |
...
extraterrestrialArea | https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic. |
...
...
| * |
subject.hierarchicalGeographic. |
...
island |
...
Yes
Yes | No | Yes | subject.hierarchicalGeographic. |
...
...
subject.hierarchicalGeographic. |
...
province | Yes | No | Yes | subject.hierarchicalGeographic. |
...
...
...
subject.hierarchicalGeographic. |
...
region |
...
Yes
Yes | No | Yes | subject.hierarchicalGeographic. |
...
...
...
subject.hierarchicalGeographic. |
...
state | Yes | No | Yes | subject.hierarchicalGeographic. |
...
...
...
| massachusetts&q=maps |
subject.hierarchicalGeographic. |
...
territory | Yes | No | Yes | subject.hierarchicalGeographic. |
...
...
...
Yes
...
name | https://api.lib.harvard.edu/v2/items?subject.name=kubrick stanley Case-sensitive exact match: |
...
...
name. |
...
role |
...
Yes
Yes | No | Yes |
...
.name.role.roleTerm Terms may be expressed as a word (photographer.) or abbreviation ("cmp" for composer). |
...
...
...
subject.hierarchicalGeographic.citySection
...
Yes
...
Yes
...
No
...
Yes
...
subject.hierarchicalGeographic.citySection
Case-sensitive exact match: |
...
...
relatedItem
...
Yes
...
No
...
No
...
No
...
relatedItem.* Under revision 2018-05-23
...
physicalLocation
(Includes Harvard repository names but also non-Harvard locations)
...
subject.temporal | Yes | No | Yes |
...
No Yes
subject.temporal |
...
...
...
repository
(Includes Harvard repositories only)
...
Case-sensitive exact match: | |||
subject.titleInfo | Yes | No | Yes |
...
Search: location.physicalLocation (where @type="repository")
Facet: extension.librarycloud.HarvardRepositories.HarvardRepository
A search will query the long form repository name (e.g.Eda Kuhn Loeb Music Library); faceting will return the short form repository name (e.g. Loeb Music).
subject.titleInfo.title | https://api.lib.harvard.edu/v2/items?subject.titleInfo=Middlemarch Case-sensitive exact match: |
...
shelfLocator
...
subject.topic | Yes |
...
No | Yes |
...
No
...
subject. |
...
topic |
...
...
Case-sensitive exact match: |
...
...
...
title |
...
No
Yes | No | No |
...
titleInfo. |
...
https://api.lib.harvard.edu/v2/items?q=earhart amelia&url=*RAD.SCHL*
...
title |
...
url.access
...
No
...
Yes
...
No
...
Yes
...
location.url.access (range = <preview, raw object, object in context>) Not working except for url.access=preview.
facet as url.access.preview or url.access.raw_object
There's a typo in item api code: defined range values are "preview" and "raw object in context" but should be "preview", "raw object", and "object in context".
"preview" value works, e.g.:
...
Case-sensitive exact match: | |||||
url | Yes | No | No | location.url Can be URLs or URNs; includes links to digital content and catalog records. |
...
"raw object in context" works as a query but it returns items without url@access="raw object", e.g.:
...
Case-sensitive exact match: |
...
...
isOnline
(Indicates whether or not an item is available in digital form; values are "true" or "false)
...
url.access | Yes | No | Yes |
...
Yes
...
location.url |
...
"true" if location.url[@access = 'raw object'] exists, "false" otherwise
...
.access (range = <preview, raw object>) facet as url.access.preview or url.access.raw_object Query for records containing a url field with a specific @access attribute. Values are: "preview"= indicates link to image thumbnail | This query returns items containing a url with the attribute access="preview" (i.e., an image thumbnail link is present): |
...
source
...
No
...
No
...
Yes
...
Yes
...
recordInfo.recordIdentifier source attribute
Sources are currently MH:ALMA (from Alma), MH:VIA (image items from JSTOR forum), or MH:OASIS (finding aid components from ArchivesSpace).
Attribute occurs only on top-level recordInfo.recordIdentifier elements
...
This query returns items containing a url with the attribute access="raw object" (i.e., a link to full digital content is present): |
...
recordIdentifier
...
No
...
recordInfo.recordIdentifier at the top level only
priorrecordids.recordIdentifier
location.url Queries an item by its NRS URN (the URN only e.g. |
...
, " urn-3:FHCL:1155043" minus the actionable URL components). | https://api.lib.harvard.edu/v2/items? |
...
| urn=urn-3:FHCL:1155043 | |||||
| DRS Extensions | |||||
| drsFileId (valid if inDRS=true) | extension.HarvardDRS.drsFileId The database identifier in the DRS for a file. | This query will return a LibraryCloud item by the corresponding DRS file ID: https://api.lib.harvard.edu/v2/items? | |||
...
...
| 481890727 | |||||
| drsObjectId (valid if inDRS=true) | extension.HarvardDRS.drsObjectId The database identifier in the DRS for an object. | This query will return an item for the Harvard Book by corresponding DRS object ID: |
...
This query will return all items in Library Cloud that have a corresponding digital object in the DRS: |
...
urn
(?Queries an item by its NRS URN (the URN only e.g., " urn-3:FHCL:1155043" minus the actionable URL components)
...
| Yes | No |
...
| Yes | extension.HarvardDRS.accessFlag (range = <P, R, N>) P (publicly accessible), R (restricted to Harvard), N (not available for delivery) See also: availableTo to query human-readable version of DRS accessFlags. | https://api.lib.harvard.edu/v2/items? |
...
collectionTitle
(see /wiki/spaces/LibraryStaffDoc/pages/43288674)
(Query by the set/collection title assigned to items that have been grouped together for delivery via Harvard Digital Collections)
...
| genre=daguerreotype&accessFlag=P | |||||||||||
| Yes | No | Yes | extension.HarvardDRS.contentModel (range = <AUDIO, DOCUMENT, PDS DOCUMENT, PDS DOCUMENT LIST, STILL IMAGE, TEXT, VIDEO>) Use _exact query to find "DOCUMENT". See also: digitalFormat to query by human-readable value derived from the contentModel for an object in Harvard's Digital Repository Service (DRS). |
...
title=biodiversity&limit=100&contentModel=PDS DOCUMENT Use the case-sensitive exact match query to find "DOCUMENT": |
...
...
collectionId
(see /wiki/spaces/LibraryStaffDoc/pages/43288674)
(Query by the set/collection ID assigned to items that have been grouped together fo rdelivery via Harvard Digital Collections)
...
| contentModelCode (valid if inDRS=true) | extension.HarvardDRS.contentModelCode An identifier that uniquely identifies a specific DRS content model. For example, CMID-5.0 identifies the Still Image content model. See the DRS Content Guide for content model names and identifiers. | This query will return all items in Library Cloud that have a corresponding digital object in DRS with content model CMID-5.0 (Still Image): https://api.lib.harvard.edu/v2/items? |
...
| contentModelCode=CMID-5.0 | |||||
fileDeliveryURL (valid if inDRS=true) | Yes | No | No | extension.HarvardDRS.fileDeliveryURL, eg. "http://nrs.harvard.edu/urn-3:FHCL.HOUGH:1090399" Query an item by its full delivery URL. | https://api.lib.harvard.edu/v2/items? |
...
inDRS
(Query for items in Harvard Library's digital repository service)
...
| title=annual+report&fileDeliveryURL=https://nrs.harvard.edu/urn-3:HMS.COUNT:22923642 | |||||||||||
| harvardMetadataLinks | |||||||||||
| Yes | No | Yes | extension.HarvardDRS.inDRS (range = <"true", "false">) Query for items in Harvard Library's digital repository service. See also isOnline. | https://api |
...
| .lib.harvard.edu/v2/items?genre=daguerreotype&inDRS=true | |||||
| insertionDate | |||||
| lastModifiedDate | |||||
| maxImageDeliveryDimension (future) | Future | No | Future | extension.HarvardDRS.maxImageDeliveryDimension - e.g., "600". Value is in pixels. | |
metsLabel (valid if inDRS=true) |
See also: LibraryCloud Item API to query human-readable version of DRS accessFlags.
| Yes | No | No | extension.HarvardDRS |
...
.metsLabel eg. Any text string Query for items by keywords in the descriptive METS label - if defined in DRS metadata. |
...
extension.HarvardDRS.contentModel (range = <AUDIO, DOCUMENT, PDS DOCUMENT, PDS DOCUMENT LIST, STILL IMAGE, TEXT, VIDEO>) Use _exact query to find "DOCUMENT"
https://api.lib.harvard.edu/v2/items?title=biodiversity&limit=100&contentModel=PDS DOCUMENT
...
Case-sensitive exact match: | |||||
modified.after (valid if inDRS=true) | Yes | No | No | extension.HarvardDRS.lastModifiedDate - eg. "2016-05-03 Query items by the "last modified" date of a linked digital object in DRS (in YYYY-MM-DD format). | This query returns items in DRS last modified after 2016-01-05: |
...
uriType (valid if inDRS=true)
(Query for items by type of delivery urn, which is a proxy for type of delivery service)
...
extension.HarvardDRS.uriType (range = <FDS, IDS, PDS, PDS_LIST, SDS, SDS_VIDEO>)
...
This query returns items in DRS last modified before a specific date: This query returns items in DRS last modified on 2016-01-05: |
...
| modified.before (valid if inDRS=true) |
(Query an item by its full delivery URL)
| No |
...
...
...
| ownerCode (valid if inDRS=true |
...
| ) | Yes |
...
| No | Yes | extension.HarvardDRS.ownerCode, eg. "FHCL.HOUGH" | https://api.lib.harvard.edu/v2/items?q=cookbook*&ownerCode=RAD.SCHL |
| ownerCodeDisplayName (valid if inDRS=true) |
...
| Yes | No | Yes |
...
| extension.HarvardDRS.ownerCodeDisplayName, eg. "Houghton Library" | https://api.lib.harvard.edu/v2/items?q=daguerreotype&ownerCodeDisplayName=Schlesinger |
...
https://api.lib.harvard.edu/v2/items?metsLabel=seward
...
| ownerSuppliedName (valid if inDRS=true) |
(Query for items by keywords in the descriptive METS label - if defined in DRS metadata)
extension.HarvardDRS.ownerSuppliedName The distinctive name for the digital item provided by the owning Harvard repository responsible for the content. This is the DRS object owner supplied name (OSN). | This query returns the LibraryCloud item for the Harvard Book by its object owner supplied name: https://api.lib.harvard.edu/v2/items?ownerSuppliedName=124783.xml | ||||
| suppliedFilename (valid if inDRS=true) | extension.HarvardDRS.suppliedFilename | ||||
uriType (valid if inDRS=true) | Yes | No | Yes | extension.HarvardDRS.uriType (range = <FDS, IDS, PDS, PDS_LIST, SDS, SDS_VIDEO>) Query for items by type of delivery urn, which is a proxy for type of delivery service. Delivery service types: FDS (text documents), IDS (images), PDS (page-turned objects), PDS_LIST (list of page-turned objects), SDS (streaming audio), (SDS_VIDEO (streaming video) | https://api.lib.harvard.edu/v2/items? |
...
| subject=jazz&uriType=SDS |
| viewText (valid if inDRS=true |
...
| ) | extension.HarvardDRS.viewText (range = <on, off>) Query items by status of the View Text setting of the object in DRS. View Text is an object-level field that controls the View Text menu option in the PDS user interface. | This query returns items owned by Houghton that have the View Text control set "off": https://api.lib.harvard.edu/v2/items? |
...
...
...
| viewText=off | |||||||||||
| LibraryCloud Extensions | |||||||||||
| Yes | No | Yes | extension.librarycloud.availableTo Human-readable values for access to digital content in Harvard's Digital Repository Service (DRS). Values are "Everyone" (corresponds to accessFlag=P) and "Harvard only" (corresponds to accessFlag=R). See also: availableTo to query by DRS accessFlag. | https://api.lib.harvard.edu/v2/items? | ||||||
...
...
...
| availableTo=Everyone | ||||||||
| No |
...
| Yes | extension. |
...
librarycloud. |
...
extension.librarycloud.availableTo
Human-readable values for access to digital content in Harvard's Digital Repository Service (DRS).
...
digitalFormats.digitalFormat Human readable values derived from the contentModel for an object in Harvard's Digital Repository Service (DRS). Values are audio, books and documents, images, and video. See also: contentModel to query by the DRS content model of an object in Harvard's Digital Repository Service (DRS). | https://api.lib.harvard.edu/v2/items?subject=poetry&digitalFormat=audio | ||||
processed.after | Yes | No | No | extension.librarycloud.processingDate Use YYYY-MM-DD format to search. This processing date indicates the most recent re-ingest of a metadata record (an "item") into LibraryCloud from its source catalog. | This query returns items processed after the date specified: |
...
extension.librarycloud.digitalFormats.digitalFormat
Human readable values derived from the contentModel for an object in Harvard's Digital Repository Service (DRS).
...
This query returns items processed before the date specified: This query returns items processed between the specified dates: |
...
processed.before | |||||
| Sets Extensions | |||||
| setName | No | Yes | extension.sets.set.setName Human-readable names that identify a set of materials selected by, for example, a curator for administrative or discovery purposes or for harvesting via OAI-PMH. | https://api.lib.harvard.edu/v2/items?setName=chinese rare books | |
| setSpec | |||||
...
...
| No | Yes | extension.sets.set.setSpec Codes used to identify a set of materials selected by, for example, a curator for administrative or discovery purposes or for harvesting via OAI-PMH. | https://api.lib.harvard.edu/v2/items?setSpec=crb |
More Query Examples
...
#Search all of LibraryCloud for “peanuts” in the title:
...
https://api.lib.harvard.edu/v2/items?title=peanuts
...
#Search finding aid components for “peanuts” in the title:
...
https://api.lib.harvard.edu/v2/items?title=peanuts&source=MH:OASIS (can use MH:OASIS, MH:VIA, or MH:
...
ALMA)
...
#Search for a specific component identifier in
...
a finding aid:
https://api.lib.harvard.edu/v2/items?
...
source=MH:OASIS&recordIdentifier=sch00443c00072
...
#Search for a specific image component identifier in
...
JSTOR Forum (the identifier actually has the form "<viaRecordId>_<URN>", but the wildcard matches the URN portion if not known
...
:
...
https://api.lib.harvard.edu/v2/items?recordIdentifier=W188002*
...
#Search for all components in an OASIS record:
...
https://api.lib.harvard.edu/v2/items?recordIdentifier=sch00443*
...
#Look up the MODS for a PDS object given its URN:
...
https://api.lib.harvard.edu/v2/items?urn=urn-3:FHCL.HOUGH:25620083
...
#Search all of library cloud for VIA records that are public and have “peanuts” in the
...
title:
https://api.lib.harvard.edu/v2/items?title=peanuts&source=MH:VIA&accessFlag=P
#Get the facet counts for collections with various collection titles:
https://api.lib.harvard.edu/v2/items?facets=collectionTitle
#Get all manuscripts from Schlesinger Library that contain either the string "electronic finding aid available" OR "electronic container list available":
https://api.lib.harvard.edu/v2/items?physicalLocation=sch&isManuscript=true&q=(
...
Support
electronic finding aid available) OR (electronic container list available)