v1

latestOpenAPI 3.0.02026-07-142740323.4 KB

Instances

List the available instances

List the Orthanc identifiers of all the available DICOM instances

get/instances

Query parameters

expandstring

If present, retrieve detailed information about the individual instances

fullboolean

If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)

limitnumber

Limit the number of results

requestedTagsstring

If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return

shortboolean

If present, report the DICOM tags in hexadecimal format

sincenumber

Show only the resources since the provided index

Response

{"stackTrail":"paths:/instances:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","description":"JSON array containing either the Orthanc identifiers, or detailed information about the reported instances (if `expand` argument is provided)","example":["055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000","62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"]}

Example response

[
  "055bfbaf-2aae936c-82ed5a9a-9267f8b7-416a4000",
  "62dc1ec1-9fc2dd9d-aa66eae1-0db608b1-e17f8ce8"
]