Raw schema
{
"type": "object",
"properties": {
"query": {
"description": "A natural language query. Best for exploratory / conceptual searches.",
"type": "string"
},
"fields": {
"type": "object",
"properties": {
"abstract": {
"description": "A summary of the work",
"type": "string"
},
"alternate_title": {
"description": "Alternate titles for the work",
"type": "string"
},
"caption": {
"description": "The caption for a work",
"type": "string"
},
"collection": {
"description": "The parent collection of the work",
"type": "string"
},
"contributor": {
"description": "An entity responsible for making contributions to the work",
"type": "string"
},
"creator": {
"description": "An entity primarily responsible for making the work",
"type": "string"
},
"description": {
"description": "An account of the work",
"type": "string"
},
"genre": {
"description": "Describes what the original object is, not what it is about",
"type": "string"
},
"keywords": {
"description": "Keywords or tags used to describe this content",
"type": "string"
},
"language": {
"description": "A language of the work",
"type": "string"
},
"library_unit": {
"description": "The library unit responsible for the work",
"type": "string",
"enum": [
"Special Collections",
"Faculty Collections",
"Government and Geographic Information Collection",
"Herskovits Library",
"Music Library",
"Transportation Library",
"University Archives",
"University Main Library"
]
},
"license": {
"description": "The Creative Commons license for the work",
"type": "string",
"enum": [
"All rights reserved",
"Attribution 3.0 United States",
"Attribution 4.0 International",
"Attribution-NoDerivatives 4.0 International",
"Attribution-NoDerivs 3.0 United States",
"Attribution-NonCommercial 3.0 United States",
"Attribution-NonCommercial 4.0 International",
"Attribution-NonCommercial-NoDerivatives 4.0 International",
"Attribution-NonCommercial-NoDerivs 3.0 United States",
"Attribution-NonCommercial-ShareAlike 3.0 United States",
"Attribution-NonCommercial-ShareAlike 4.0 International",
"Attribution-ShareAlike 3.0 United States",
"Attribution-ShareAlike 4.0 International",
"CC0 1.0 Universal",
"Public Domain Mark 1.0"
]
},
"location": {
"description": "Place of publication",
"type": "string"
},
"notes": {
"description": "Notes associated with the work",
"type": "string"
},
"publisher": {
"description": "An entity responsible for making the work available",
"type": "string"
},
"rights_statement": {
"description": "The rights statement of the work",
"type": "string",
"enum": [
"Copyright Not Evaluated",
"Copyright Undetermined",
"In Copyright",
"In Copyright - Educational Use Permitted",
"In Copyright - EU Orphan Work",
"In Copyright - Non-Commercial Use Permitted",
"In Copyright - Rights-holder(s) Unlocatable or Unidentifiable",
"No Copyright - Contractual Restrictions",
"No Copyright - Non-Commercial Use Only ",
"No Copyright - Other Known Legal Restrictions",
"No Copyright - United States",
"No Known Copyright"
]
},
"style_period": {
"description": "A defined style, historical period, group, school, dynasty, movement, etc. whose characteristics are represented in the work.",
"type": "string"
},
"subject": {
"description": "The subject of the work",
"type": "string"
},
"table_of_contents": {
"description": "Used to provide the titles of separate works or parts of a resource. Information provided may also contain statements of responsibility or other sequential designations.",
"type": "string"
},
"technique": {
"description": "The technique used in the creation of the work",
"type": "string"
},
"title": {
"description": "The title of the work",
"type": "string"
},
"work_type": {
"description": "The type of the work",
"type": "string",
"enum": [
"Audio",
"Image",
"Video"
]
},
"text": {
"description": "Full text associated with the work",
"type": "string"
},
"controlled_terms": {
"description": "All controlled terms associated with the work, across all fields. Useful for searching across all controlled fields simultaneously without specifying which field.",
"type": "string"
}
},
"description": "Structured field search. Best when searching for specific known items or values, or for narrowing a search by specifying particular fields to search within."
},
"public_only": {
"default": true,
"type": "boolean",
"description": "Only include publicly available works in search results"
},
"max_results": {
"default": 10,
"description": "The maximum number of search results to return per page",
"type": "number",
"minimum": 1,
"maximum": 20
},
"page": {
"default": 1,
"description": "The page of search results to return",
"type": "number",
"minimum": 1
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Search for items in the Digital Collections using either a natural language query or specific field values. If both a natural language query and specific field values are provided, the search will return items that match the natural language query and have the specified field values."
}