Sign in

v1

latestOpenAPI 3.0.02026-07-132990743.4 KB
Tracking changes

List changes

Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called Changes Log. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality. Please note that, when resources are deleted, their corresponding change entries are also removed from the Changes Log, which helps ensuring that this log does not grow indefinitely.

get/changes

Query parameters

lastnumber

Request only the last change id (this argument must be used alone)

limitnumber

Limit the number of results

sincenumber

Show only the resources since the provided index excluded

tonumber

Show only the resources till the provided index included (only available if your DB backend supports ExtendedChanges)

typestring

Show only the changes of the provided type (only available if your DB backend supports ExtendedChanges). Multiple values can be provided and must be separated by a ';'.

Response

Changesobject[]

The individual changes

Doneboolean

Whether the last reported change is the last of the full history.

Firstnumber

The index of the first reported change, its value-1 can be used for the to argument in subsequent calls to this route when browsing the changes in reverse order

Lastnumber

The index of the last reported change, can be used for the since argument in subsequent calls to this route

Example response

{
  "Changes": [
    {
      "ChangeType": "NewInstance",
      "Date": "20231109T160739",
      "ID": "26d2e33b-3239a2d5-64f57e0b-d8da59a7-2ef362e7",
      "Path": "/instances/26d2e33b-3239a2d5-64f57e0b-d8da59a7-2ef362e7",
      "ResourceType": "Instance",
      "Seq": 1
    },
    {
      "ChangeType": "NewSeries",
      "Date": "20231109T160739",
      "ID": "1de00990-03680ef4-0be6bd5b-73a7d350-fb46abfa",
      "Path": "/series/1de00990-03680ef4-0be6bd5b-73a7d350-fb46abfa",
      "ResourceType": "Series",
      "Seq": 2
    }
  ],
  "Done": false,
  "First": 1,
  "Last": 2
}
All 299 operations