v1

latestOpenAPI 3.0.02026-07-142740323.4 KB

Networking

Retrieve all answers

Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move

post/queries/{id}/retrieve

Path parameters

idstring required

Identifier of the query of interest

Request body

Asynchronousboolean

If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.

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)

Permissiveboolean

If true, ignore errors during the individual steps of the job.

Prioritynumber

In asynchronous mode, the priority of the job. The lower the value, the higher the priority.

Simplifyboolean

If set to true, report the DICOM tags in human-readable format (using the symbolic name of the tags)

Synchronousboolean

If true, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is not desirable for long jobs, as it might lead to network timeouts.

TargetAetstring

AET of the target modality. By default, the AET of Orthanc is used, as defined in the DicomAet configuration option.

Timeoutnumber

Timeout for the C-MOVE command, in seconds

Response

IDstring

In asynchronous mode, identifier of the job

Pathstring

In asynchronous mode, path to access the job in the REST API