Skip to content

Commit

Permalink
define collection alias and cdm number
Browse files Browse the repository at this point in the history
  • Loading branch information
owikle committed Dec 8, 2023
1 parent 42a21b4 commit fe69f2f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/metadata/object-paths.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,10 @@ One option is to create screenshots to use as derivative images--if image_thumb
## Path for CONTENTdm Objects

The CONTENTdm API can be used to retrieve display images and file downloads from any CONTENTdm repository.
To use the API you will need to know the "Collection Alias" and "CONTENTdm number" of each object, see our [CDM metadata docs]({{ '/docs/metadata/cdm_metadata/' | relative_url }}) for more info on finding that information.
To use the API you will need to know the "Collection Alias" and "CONTENTdm number" of each object:

- The "Collection Alias" is a path assigned by CONTENTdm and can be found in CONTENTdm Admin on the Collections > Profile page, or by looking at the URL of the collection on the web. For example "https://cdm17254.contentdm.oclc.org/digital/collection/ui_ep/search" the collection alias is given after "/collection/", so would be ui_ep.
- The values for "CONTENTdm number" are included by default when you export your collection's metadata from CONTENTdm.

Once you have columns in your metadata for "Collection Alias" and "CONTENTdm number" you can use formulas in Sheets or OpenRefine based on the CDM APIs to fill in `object_location`, `image_small`, and `image_thumb` columns for different item types.
In general, it is best to use IIIF for image objects and CDM "utils" API for non-image items.
Expand Down

0 comments on commit fe69f2f

Please sign in to comment.