ARCHIVED: KMS REST: Document UUID

This content has been archived, and is no longer maintained by Indiana University. Information here may no longer be accurate, and links may no longer be available or reliable.

The document UUID allows REST customers to check that a cached version of a document matches the latest version. Every time a document is updated, the KMS generates a new UUID for it. Compare the UUID of the cached version to the UUID of the live version to check if the cached version is out of date.

To get the UUID, make a GET request to:

  /v0/document/uuid/$docid

$docid is the document ID.

The request requires basic access authentication; pass credentials in the URL or via the Basic HTTP header.

The response will be a JSON object, e.g.:

{
   "status": "ok",
   "message": "Document retrieved successfully.",
   "uuid": "7e9de5a7-2b4f-4a39-9399-87cdfee44517",
   "version": 0,
   "timestamp": "2016-02-26T15:28:08.201-05:00"
}