v1

latestOpenAPI 3.0.02026-07-142740323.4 KB
System

Create ZIP archive

Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body

post/tools/create-archive

Request body

Asynchronousboolean

If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.

Prioritynumber

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

Resourcesstring[]

The list of Orthanc identifiers of interest.

Synchronousboolean

If true, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.

Transcodestring

If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://book.orthanc-server.com/faq/transcoding.html

Response

IDstring

Identifier of the job

Pathstring

Path to access the job in the REST API