Studies

Merge study

Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#merging

post/studies/{id}/merge

Request

Base URL
https://orthanc.uclouvain.be/demo
Auth
none declared
TypeScript
https://skmtc.dev/uclouvain/apis/orthanc-api/docs/studies/:id/merge/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Orthanc identifier of the study 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.

KeepSourceboolean

If set to true, instructs Orthanc to keep a copy of the original resources in their source study. By default, the original resources are deleted from Orthanc.

Permissiveboolean

If true, ignore errors during the individual steps of the job. Default value is false.

Prioritynumber

In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is 0

Resourcesstring[]

The list of DICOM resources (studies, series, and/or instances) to be merged into the study of interest (mandatory option)

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.

UserDataobject

User data that will travel along with the job.

Response

IDstring

In asynchronous mode, identifier of the job

Pathstring

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

Changes

No recorded changes to this operation across all 3 revisions of this API.