Sign in

v1

latestOpenAPI 3.0.02026-07-132990743.4 KB
System

Look for local resources

This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://orthanc.uclouvain.be/book/users/rest.html#performing-finds-within-orthanc

post/tools/find

Request body

CaseSensitiveboolean

Enable case-sensitive search for PN value representations (defaults to configuration option CaseSensitivePN)

Expandboolean

If set to "true", retrieve detailed information about the individual resources, not only their Orthanc identifiers

Fullboolean

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

Labelsstring[]

List of strings specifying which labels to look for in the resources (new in Orthanc 1.12.0)

LabelsConstraintstring

Constraint on the labels, can be All, Any, or None (defaults to All, new in Orthanc 1.12.0). From 1.12.11: using None together with an empty list of labels looks for the resources that do not have any labels attached.

Levelstring

Level of the query (Patient, Study, Series or Instance)

Limitnumber

Limit the number of reported resources

MetadataQueryobject

Associative array containing the filter on the values of the metadata (new in Orthanc 1.12.5)

OrderByobject[]

Array of associative arrays containing the requested ordering (new in Orthanc 1.12.5)

ParentPatientstring

Limit the reported resources to descendants of this patient (new in Orthanc 1.12.5)

ParentSeriesstring

Limit the reported resources to descendants of this series (new in Orthanc 1.12.5)

ParentStudystring

Limit the reported resources to descendants of this study (new in Orthanc 1.12.5)

Queryobject

Associative array containing the filter on the values of the DICOM tags

RequestedTagsstring[]

A list of DICOM tags to include in the response (applicable only if "Expand" is set to true). 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 all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.

ResponseContentstring[]

Defines the content of response for each returned resource. (this field, if present, overrides the "Expand" field). Allowed values are MainDicomTags, Metadata, Children, Parent, Labels, Status, IsStable, IsProtected, Attachments. If not specified, Orthanc will return MainDicomTags, Metadata, Children, Parent, Labels, Status, IsStable, IsProtected.(new in Orthanc 1.12.5)

Shortboolean

If set to true, report the DICOM tags in hexadecimal format

Sincenumber

Show only the resources since the provided index (in conjunction with Limit)

Response

{"stackTrail":"paths:/tools/find:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","description":"JSON array containing either the Orthanc identifiers, or detailed information about the reported resources (if `Expand` argument is `true`)"}