Versions Compared

Version Old Version 3 New Version 4
Changes made by

Tom Jones

Tom Jones

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Eventually derivative terms and the properties of these terms will be part of the CollectionSpace configuration mechanism. However this is currently out of scope for the 1.x version of the service. Derivative terms and their corresponding properties will be specific to the file/document type. For example, for an image file, a term set definition might look something like:

Code Block
Image Terms = {'thumbnail' = 64 x 64, 'small' = 128 x 128, 'medium' = 256 x 256 }

 Wiki Markup
{multi-excerpt-include:pageTitle=Media Service RESTful API|name=current-derivative-terms|nopanel=true}
...
This creates a blob record as well as stores and relates a copy of the posted file. The information in the blob record (see Blob Info Schema) is automatically populated by the Blob service based upon the file/document that is posted with the request.
POST to "/blobs" with MIME=multipart/form-data

 Code Block
Notes: Returns the csid of the blob record. The csid is part of the fully qualified URL that is returned in the location header of the HTTP response.
The blob service expects a POST similar to the one web browsers use to upload files. See the following HTML snippet for how you can use a web browser to post a new blob.
 Code Block
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
        <title>Blob Service POST Example</title>
    </head>

    <body>
        <h1>Blob Service POST Example</h1>
        <form method="POST" action="http://localhost:8180/cspace-services/blobs?blobUri="
            enctype="multipart/form-data">
            <label>Please select a file to post to the Blob service:</label>
            <input type="file" size="50" name="file" />
            <br />
            <input type="submit" value="Upload now!" />
        </form>
    </body>
</html>

 Anchor
post_blobUri
post_blobUri
You can also use a tool like cURL to POST an image.  Here is an example:
 Code Block
curl -X POST http://localhost:8180/cspace-services/blobs -i -u admin@core.collectionspace.org:Administrator -F file=@myImage.jpg

 2. Create new blob record - POST request contains no embedded document/file payload - Option #2
 Code Block
POST to "/blobs?blobUri=" with MIME=application/xml

Notes: Using the 'blobUri' query parameter, you can include a URI to a FILE resource or an HTTP resource that you want the service to use when creating the blob record. If the URI is set and valid, then the Blob service will try to use the URI to create a blob record as well as store and relate a copy of the document/file. The information in the blob record (see Blob Info Schema) is automatically populated by the Blob service and derived from the resource pointed to by the URI.
...
3. Get an existing blob record.
GET to "/blobs/{csid}"

 Code Block
Notes: Returns the blob record corresponding to the csid -see Blob Info Schema. If the blob record was created with a document/file then a URL to the blob's content (the document/file) is included in the resulting payload.
4. Get an existing blob's data content.
GET to "/blobs/{csid}/content"

 Code Block
Notes: If the blob record was created with a document/file then this returns the blob data content (a file/document) corresponding to the blob record's csid
5. Get the full set of raw metadata about an existing blob record's content.
GET to "/blobs/{csid}/content/metadata"

 Code Block
Notes: Returns the full set of raw metadata that exists for the content of the blob record with csid. This metatdata will essentially be a property bag specific to the media-type/MIME-type of the content.
6. Get a list of derivatives for an existing blob record.
GET to "/blobs/{csid}/derivatives"

 Code Block
Notes: Returns a list of blob derivatives corresponding to the blob record's csid. This will include a URL to each derivative.
7. Get a specific derivative record of an existing blob record.
GET to "/blobs/{csid}/derivatives/{derivative_term}"

 Code Block
Notes: Returns what is essentially a "blob record" for the specified blob derivative. Initially, the derivative term will be one of a small set of controlled terms -i.e., 'thumbnail', 'small', 'medium', etc. Derivative terms will be defined in a CollectionSpace configuration file.
8. Get a specific blob derivative's content.
 Code Block
GET to "/blobs/{csid}/derivatives/{derivative_term}/content"

Notes: Returns the data content of the derivative.
9. Get the full set of raw metadata about an existing blob derivative.
GET to "/blobs/{csid}/derivatives/{derivative_term}/content/metadata"

 Code Block
Notes: Returns the full set of raw metadata that exists for the derivative's content.
...
1. Update an existing blob record.
 Code Block
PUT to "/blobs/{csid}" with MIME=multipart/form-data

Notes: Returns the csid of the blob record.
...
2. Update an existing blob record:
PUT to "/blobs/{csid}" with MIME=multipart/xml

 Code Block
Notes: The payload must include a 'srcUri' parameter that is set to a valid and accessible URI.