Status
This schema is... |
|
---|---|
under review |
|
complete |
|
Schema
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 |
Y |
|
mediaStatus |
Status (URN) |
media_mmi.mediastatus |
media_mmi:mediaStatus |
either |
Y |
(URN) indicates a field that uses a refname structure to indicate value and metadata for that field. See also refname.
(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://cspacetest.collectionspace.org:8180/cspace-services/relations?sbj={{csid}}&objType=MediaTenant42
The objType
value is the Media document type for the unique MMI tenant, MediaTenant42
.
REST API calls
An API call would follow the following format
Media record information
http://cspacetest.collectionspace.org:8180/cspace-services/media/{{csid}}
Blob content for Media record
http://cspacetest.collectionspace.org:8180/cspace-services/media/{{csid}}/blob
Actual image data (original image image)
http://cspacetest.collectionspace.org:8180/cspace-services/media/{{csid}}/blob/content
Derivative formats
http://cspacetest.collectionspace.org:8180/cspace-services/media/{{csid}}/blob/derivatives/{{Medium||Original||Thumbnail||OriginalJpeg}}/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.
Additional links
Media service RESTful API
Common services RESTful API
Relations services RESTful API