MMI Collection Browser Media Schema for 2.6

Owned by Jesse Martinez
Last updated: Sept 25, 2012

Status

This schema is...

 

under review

 

complete

Schema

The following fields determine which image is considered "primary" and if it should be displayed.

Procedure

MMI Field Name

CSpace field name

DB table.field

NXQL table:field

Notes

Required

Media

isPrimary

Is primary (boolean)

media_mmi.isprimary

media_mmi:isPrimary

related media records with a true value are displayed. One per collectionobject record.

Y

 

mediaStatus

Status (URN)

media_mmi.mediastatus

media_mmi:mediaStatus

either display, private. Only records set to display are used. Should never be both private and isPrimary == true

Y

(URN) indicates a field that uses a refname structure to indicate value and metadata for that field. See also /wiki/spaces/collectionspace/pages/666274945.

(boolean) indicates a boolean type field.

Finding media records from a given collectionobject record

The relations service provides the mechanism to find related records of a given type. With a known collectionobject csid, the API call would be

http://collectiontest.movingimage.us:8180/cspace-services/relations?sbj={{csid}}&objType=Media

Example

http://collectiontest.movingimage.us:8180/cspace-services/relations?sbj=24200004-47d3-45b0-b9c2-1ad79e1580af&objType=Media

If only one media record is displayed then it should be considered to be the primary media record.

REST API calls

An API call would follow the following format

Media record information
http://collectiontest.movingimage.us:8180/cspace-services/media/{{csid}}

Example

http://collectiontest.movingimage.us:8180/cspace-services/media/d75f7f1e-6ac9-4c7c-b0a3-b2cdcbd4d4d8
Blob content for Media record
http://collectiontest.movingimage.us:8180/cspace-services/media/{{csid}}/blob

Example

http://collectiontest.movingimage.us:8180/cspace-services/media/d75f7f1e-6ac9-4c7c-b0a3-b2cdcbd4d4d8/blob
Actual image data (original image image)
http://collectiontest.movingimage.us:8180/cspace-services/media/{{csid}}/blob/content

Example

http://collectiontest.movingimage.us:8180/cspace-services/media/d75f7f1e-6ac9-4c7c-b0a3-b2cdcbd4d4d8/blob/content
Derivative formats
http://collectiontest.movingimage.us:8180/cspace-services/media/{{csid}}/blob/derivatives/{{Medium||Original||Thumbnail||OriginalJpeg}}/content

Example

http://collectiontest.movingimage.us:8180/cspace-services/media/d75f7f1e-6ac9-4c7c-b0a3-b2cdcbd4d4d8/blob/derivatives/Thumbnail/content

Currently, MMI is using small quality and size jpg files as original media content, but larger quality and larger file sized images could be used in the future.
Unless otherwise noted, Medium sized derivatives should be used for the browser.

Media service RESTful API
Common services RESTful API
Relations services RESTful API