---
title: "Create DICOMDIR media"
method: POST
path: "/studies/{id}/media"
tags: ["Studies"]
---

# Create DICOMDIR media

`POST /studies/{id}/media`

Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL

## Path parameters

- `id` string, required

## Request body

- object
  - `Asynchronous` boolean — If `true`, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.
  - `Extended` boolean — If `true`, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR*. Default value is `false`.
  - `Filename` string — Filename to set in the "Content-Disposition" HTTP header (including file extension)
  - `LossyQuality` number — 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)
  - `Priority` number — In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
  - `Synchronous` boolean — 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.
  - `Transcode` string — If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
  - `UserData` object — In asynchronous mode, user data that will be attached to the job.
  - `Utf8` boolean — 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 `200`

- object — In asynchronous mode, information about the job that has been submitted to generate the archive: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
  - `ID` string — Identifier of the job
  - `Path` string — Path to access the job in the REST API

---

[API](https://skmtc.net/uclouvain/apis/orthanc-api.md) · [All operations](https://skmtc.net/uclouvain/apis/orthanc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uclouvain/orthanc-api/versions/9297c4930d96/schema)