v1
latestOpenAPI 3.0.02026-07-132990743.4 KBCreate DICOMDIR media
Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL
Path parameters
Orthanc identifier of the study of interest
Request body
If true, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
If true, will include additional tags such as SeriesDescription, leading to a so-called extended DICOMDIR. Default value is false.
Filename to set in the "Content-Disposition" HTTP header (including file extension)
If transcoding to a lossy transfer syntax, this entry defines the quality as an integer between 1 and 100. If not provided, the value is defined by the "DicomLossyTranscodingQuality" configuration. (new in 1.12.7)
In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
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.
If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
In asynchronous mode, user data that will be attached to the job.
If true, filenames will be encoded using UTF-8 in the ZIP archive, which may not be supported by your operating system or by your ZIP uncompression software. If false, filenames will be encoded using plain ASCII, which was the default in Orthanc <= 1.12.10. Default value is defined by the "ZipUseUtf8" configuration option. (new in 1.12.11)
Response
Identifier of the job
Path to access the job in the REST API