ProxyMetaData

ProxyApi operation which retrieves the metadata associated with a record using an http-get request. The metadata is presented as a TiddlyWiki file, with a Tiddler for each metadata entry.

Synopsis

Submit

GET /<ProxyServletPath>/?op=gettiddly&recorduid=<RecordID>#readOnly:no' HTTP/1.1
Host: <ProxyHost:ProxyPort>

ProxyServletPath

Path to the Proxy Servlet on the host. Example: /SharedRecordsProxyServer/

ProxyHost

IP address of Shared Records server. Example: sra.sharedrecords.org

ProxyPort

Network port of the Shared Records server. Example: 8080

RecordID

The Record ID for which metadata should be returned.

Response

HTTP/1.1 200 OK

Body

A TiddlyWiki file containing metadata entries in Tiddlers.

Examples

Command-line

The following command-line example uses the common unix "lynx" utility to retrieve the metadata for a record and save it in a file.

lynx -source "http://sra.sharedrecords.org:8080/SharedRecordsProxyServer/ \
?op=gettiddly&recorduid=944c6a2e93f69b40051e92ed3637f3ab32eb933b#readOnly:no" > tiddly.html

Note: the "\" character is used to indicate that the line continues. To copy-and-paste this command, remove those characters and remove whitespace in the URI.

Notes

Because the metadata is returned in a TiddlyWiki file, it must be viewed in an HTML browser which supports javascript (like Mozilla or Firefox). Once open, you can add metadata by creating new Tiddlers, then clicking the "sync" link in the menu to store data back to the server. Because of security considerations, you may have to explicitly allow certain Javascript operations while editing and syncing a TiddlyWiki file which was loaded locally.