/
REST History Service

REST History Service

Owned by bcarlsen (Unlicensed)
Oct 31, 2014

Overview

Documents the REST History Service.

For a self-documenting Swagger API, see http://snomed.terminology.tools/term-server-rest/index.html.

This is a placeholder page with basic information and will be developed to fully document this aspect of the system.

Details

The internal history API is used for querying the history of terminology components, including obtaining old versions of model objects, identifying components changed since a certain date in time. The delta release process leverages this service by obtaining components that are new or changed since a certain date and writing them out as RF2 with a particular effective time.

The REST API for the history service authorizes the user and then calls the corresponding internal action service method. The functionality available is as follows:

  • For each model object (concept, description, relationship, etc.)
    • Get components modified since a certain date - based on last modification date
    • Get release history – obtain a list of known releases
    • Get all component revisions in a date range for a particular id – all edits
    • Get all component release revisions in a date range for a particular id – only published states
    • Get the component revision corresponding to a particular id and point in time
    • Get concepts changed since certain date – performs a “deep” search for all concepts where it or any of its components have changed in the relevant period

TODO: more and show examples

  • n/a