/works
Returns a paginated list of works
query Parameters
| include | string Enum: "identifiers" "items" "holdings" "subjects" "genres" "contributors" "production" "languages" "notes" "images" "succeededBy" "precededBy" "partOf" "parts" A comma-separated list of extra fields to include |
| items.locations.locationType | string Filter by the LocationType of items on the retrieved works |
| workType | string Filter by the format of the searched works |
| type | string Enum: "Collection" "Series" "Section" Filter by the type of the searched works |
| aggregations | string Enum: "workType" "genres.label" "production.dates" "subjects.label" "contributors.agent.label" "items.locations.license" "languages" "availabilities" What aggregated data in correlation to the results should we return. |
| languages | string Filter the work by language. |
| genres.label | string Filter the work by genre. |
| genres.concepts.id | string Filter the work by canonical ID of genre. |
| subjects.label | string Filter the works by subject label (e.g. World history - Early works to 1800). |
| contributors.agent.label | string Filter the work by contributor. |
| identifiers | string Filter the work by identifiers. |
| items | string Filter for works with items with a given canonical ID. |
| items.identifiers | string Filter for works with items with a given identifier. |
| partOf | string Filter the work by partOf relation. |
| partOf.title | string Filter the work by the title of a partOf relation. |
| availabilities | string Filter the work by availabilities. |
| items.locations.accessConditions.status | string Enum: "open" "open-with-advisory" "restricted" "closed" "licensed-resources" "unavailable" "temporarily-unavailable" "by-appointment" "permission-required" Filter the work by access status. |
| items.locations.license | string Enum: "cc-by" "cc-by-nc" "cc-by-nc-nd" "cc-0" "pdm" "cc-by-nd" "cc-by-sa" "cc-by-nc-sa" "ogl" "opl" "inc" Filter the work by license. |
| sort | string Value: "production.dates" Which field to sort the results on |
| sortOrder | string Enum: "asc" "desc" The order that the results should be returned in. |
| production.dates.to | string Return all works with a production date before and including this date. Can be used in conjunction with |
| production.dates.from | string Return all works with a production date after and including this date. Can be used in conjunction with |
| query | string Full-text search query |
| page | integer <int64> >= 1 Default: 1 The page to return from the result list |
| pageSize | integer <int64> [ 1 .. 100 ] Default: 10 The number of works to return per page |
Responses
/works/{id}
Returns a single work
path Parameters
| id required | string The work to return |
query Parameters
| include | string Enum: "identifiers" "items" "holdings" "subjects" "genres" "contributors" "production" "languages" "notes" "images" "succeededBy" "precededBy" "partOf" "parts" A comma-separated list of extra fields to include |
Responses
/images
Returns a paginated list of images
query Parameters
| query | string Full-text search query |
| locations.license | string Enum: "cc-by" "cc-by-nc" "cc-by-nc-nd" "cc-0" "pdm" "cc-by-nd" "cc-by-sa" "cc-by-nc-sa" "ogl" "opl" "inc" Filter the images by license. |
| source.contributors.agent.label | string Filter the images by the source works' contributors |
| source.genres.label | string Filter the images by the source works' genres |
| source.subjects.label | string Filter the images by the source works' subjects |
| sort | string Value: "source.production.dates" Which field to sort the results on |
| sortOrder | string Enum: "asc" "desc" The order that the results should be returned in. |
| source.production.dates.to | string Return all images with a production date before and including this date. Can be used in conjunction with |
| source.production.dates.from | string Return all images with a production date after and including this date. Can be used in conjunction with |
| colors | string Filter the images by colors. |
| include | string Enum: "source.contributors" "source.languages" "source.genres" "source.subjects" A comma-separated list of extra fields to include |
| aggregations | string Enum: "locations.license" "source.contributors.agent.label" "source.genres.label" "source.subjects.label" What aggregated data in correlation to the results should we return. |
| page | integer <int64> >= 1 Default: 1 The page to return from the result list |
| pageSize | integer <int64> [ 1 .. 100 ] Default: 10 The number of images to return per page |
Responses
/images/{id}
Returns a single image
path Parameters
| id required | string The image to return |
query Parameters
| include | string Enum: "visuallySimilar" "withSimilarFeatures" "withSimilarColors" "source.contributors" "source.languages" "source.genres" "source.subjects" A comma-separated list of extra fields to include |
Responses
/concepts
Returns a paginated list of concepts
query Parameters
| query | string Full-text search query |
| identifiers.identifierType | string Filter the concepts by IdentifierType ID |
| page | integer <int64> >= 1 Default: 1 The page to return from the result list |
| pageSize | integer <int64> [ 1 .. 100 ] Default: 10 The number of concepts to return per page |