Get Single Metadata

Table of Contents

  1. Synopsis
    1. Submit
    2. Response
  2. Examples
    1. Command-line
  3. Notes

REST Api operation to get a single metadata entry for a record on the Shared Records server using http-get.

Synopsis

Submit

GET /<RESTServletPath>/<RecordID>/log/<Title>_<PaddedSequenceNumber>_<RollingChecksum> HTTP/1.1

Fields:

RESTServletPath
Path to the REST Servlet on the host. Example: records
RecordID
The unique ID of the stored record. (The SHA1 hash of the stored data)
RESTHost
IP address of Shared Records server. Example: sra.sharedrecords.org
RESTPort
Network port of the Shared Records server. Example: 8080
Title
The title of the metadata entry to retrieve.
PaddedSequenceNumber
The padded sequence number of the metadata entry.
RollingChecksum
The rolling checksum of the metadata entry.

Body:

None.

Response

HTTP/1.1 200 OK
Content-Type: <ContentType>
Content-Length: <ContentLength>

Headers:

Content-Type
The mime-type of the response body.
Content-Length
The length in bytes of the body.

Body:

The response will be in the S3 meta data format, specified on the MetaDataFormats page.

Response Codes:

Examples

Command-line

(not shown)

Notes

Note this is a low level API used primarily for synchronizing between servers. Most users will use the GetCurrentMetaData or GetAllMetaData calls.