Skip to content

Latest commit

 

History

History
157 lines (125 loc) · 6.6 KB

image.md

File metadata and controls

157 lines (125 loc) · 6.6 KB

Image

Contains information on the images produced by and associated with the Harvard Art Museums.

Get Images

GET /image will get all images.

Include one or more of the following parameters to filter the items.

Parameter Value
apikey YOUR API KEY required
q FIELD:VALUE (see Elasticsearch Query String syntax for more options)
size 0-9+
page 0-9+
sort FIELD NAME or "random" or "random:[SEED NUMBER]"
sortorder asc or desc
fields comma separated list of data fields you want in the output
aggregation see Elasticsearch aggregations
id pipe separated list of record IDs

Examples

https://api.harvardartmuseums.org/image?q=width:>2000
Finds all images that are wider than 2000 pixels.

Response

{
    "info": {
        "totalrecordsperquery": 2,
        "totalrecords": 5274,
        "pages": 1056,
        "page": 1,
        "next": "https://api.harvardartmuseums.org/image?q=width%3A%3E2000&page=2&size=2",
        "responsetime": "5 ms"
    },
    "records": [
        {
            "id": 130722,
            "imageid": 130722,
            "fileid": 4880475,
            "idsid": 43183146,
            "caption": null,
            "alttext": null,
            "description": null,
            "copyright": "President and Fellows of Harvard College",
            "iiifbaseuri": "https://ids.lib.harvard.edu/ids/iiif/43183146",
            "baseimageurl": "https://nrs.harvard.edu/urn-3:HUAM:48875_dynmc",
            "renditionnumber": "48875",
            "date": "1995-05-01",
            "height": 2550,
            "width": 2154,
            "accesslevel": 1,
            "format": "image/jpeg",
            "technique": "Kodak Ektapan",
            "lastupdate": "2020-07-17T06:22:49-0400"
        },
        {
            "id": 441758,
            "imageid": 441758,
            "fileid": 4968319,
            "idsid": 400107499,
            "caption": null,
            "alttext": null,
            "description": null,
            "copyright": "President and Fellows of Harvard College",
            "iiifbaseuri": "https://ids.lib.harvard.edu/ids/iiif/400107499",
            "baseimageurl": "https://nrs.harvard.edu/urn-3:HUAM:755710",
            "renditionnumber": "755710",
            "date": "2014-06-02",
            "height": 1945,
            "width": 2450,
            "accesslevel": 1,
            "format": "image/jpeg",
            "technique": "Make:Sinar Photography AG;Model:Sinar CMV/ Sinarback eVolution 75H;Orientation:1;Software:Adobe Photoshop CS5 Macintosh;",
            "lastupdate": "2020-07-17T06:30:22-0400"
        }
    ]
}

Get Image

GET /image/IMAGE_ID will get the full record of the specified image.

A record represents the concept of an image. An image can be represented by one or more files that are accessible via one or more services.

imageid describes the numeric unique identifier for a record

idsid describes the unique numeric identifier for a file in the Harvard Digital Repository

fileid describes the unique numeric identifier for a file

accesslevel describes the accessibility of a record
0 – Restricted. Image record is restricted to certain API keys
1 – Public. Image record is available to all API keys

renditionnumber describes the unique name for the image; this often takes the form of a prefix + serial number; the prefix can provide hints as to when, why, and how we made the image

date describes either the date of creation of the image record in our collections management system OR the date of creation of the image itself (this is very fuzzy data)

baseimageurl describes the primary internet address for the image and is delivered through our default image delivery service

iiifbaseuri describes the root of the address for accessing the image through our IIIF image delivery service

format describes the media type/MIME type of the image (typically image/jpeg)

alttext describes the most relevant, prominent features or general characteristics of the image

description describes the image content in detail

caption describes the image, often listing more technical information about the view (recto, verso, profile, 3/4 view)

technique describes the photography equipment and software used during the production of the image

colors describes the colors programmatically extracted from the image
An image may have zero or more colors. The color of each pixel is read and then sorted in to buckets. Brightness and gradient variants are reduced so similar colors group together, and to keep the number of buckets under 20. Then those colors are mapped to the museums' color palette, the CSS3 color listing, and hue names.

percent - is the amount, between the range of 0 to 1, of the color found in the image
color - is the color found in the image
spectrum - is the closest match of the color value to the museums' design color spectrum
css3 - is the closest match to the colors listed in the CSS3 color module specification
hue - is the color value mapped to the name of a hue (Red, Orange, Yellow, Green, Blue, Violet, Brown, Grey, Black, White)

Examples

https://api.harvardartmuseums.org/image/465905
Returns the full record for image 465905 which depicts the object "Untitled [with Anna May Wong]”.

Response

{
    "id": 465905,
    "imageid": 465905,
    "fileid": 4997146,
    "idsid": 423290977,
    "caption": null,
    "alttext": null,
    "description": null,
    "copyright": "President and Fellows of Harvard College",
    "iiifbaseuri": "https://ids.lib.harvard.edu/ids/iiif/423290977",
    "baseimageurl": "https://nrs.harvard.edu/urn-3:HUAM:760994",
    "renditionnumber": "760994",
    "date": "2016-08-04",
    "height": 2550,
    "width": 1955,
    "accesslevel": 1,
    "format": "image/jpeg",
    "technique": "Make:Hasselblad;Model:Hasselblad H5D-50c MS;Orientation:1;Software:Adobe Photoshop CS6 (Macintosh);",
    "lastupdate": "2020-07-17T06:30:34-0400"
  }