Sign in

v1

latestOpenAPI 3.0.02026-07-132990743.4 KB
Studies

Split study

Start a new job so as to split the DICOM study whose Orthanc identifier is provided in the URL, by taking some of its children series or instances out of it and putting them into a brand new study (this new study is created by setting the StudyInstanceUID tag to a random identifier): https://orthanc.uclouvain.be/book/users/anonymization.html#splitting

post/studies/{id}/split

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.

Instancesstring[]

The list of instances to be separated from the parent study. These instances must all be children of the same source study, that is specified in the URI.

KeepLabelsboolean

Keep the labels of all resources level (defaults to false)

KeepSourceboolean

If set to true, instructs Orthanc to keep a copy of the original series/instances in the source study. By default, the original series/instances 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

Removestring[]

List of tags that must be removed in the new study (from the same modules as in the Replace option)

Replaceobject

Associative array to change the value of some DICOM tags in the new study. These tags must be part of the "Patient Module Attributes" or the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3.

Seriesstring[]

The list of series to be separated from the parent study. These series must all be children of the same source study, that is specified in the URI.

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