v1

latestOpenAPI 3.0.02026-07-132990743.4 KB

System

Count local resources

This URI can be used to count the resources that are matching criteria on the content of the local Orthanc server, in a way that is similar to tools/find

post/tools/count-resources

Request body

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)

MetadataQueryobject

Associative array containing the filter on the values of the metadata (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

Shortboolean

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

Response

{"stackTrail":"paths:/tools/count-resources:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","description":"A JSON object with the `Count` of matching resources"}