Sign in

v1

latestOpenAPI 3.0.02026-07-132990743.4 KB
Studies

Modify study

Start a job that will modify all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series

post/studies/{id}/modify

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.

Forceboolean

Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world

Keepstring[]

Keep the original value of the specified tags, to be chosen among the StudyInstanceUID, SeriesInstanceUID and SOPInstanceUID tags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.

KeepSourceboolean

If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.

LossyQualitynumber

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 v1.12.7)

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

PrivateCreatorstring

The private creator to be used for private tags in Replace

Removestring[]

List of tags that must be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the dcmodify command-line tool (wildcards are supported as well).

RemovePrivateTagsboolean

Remove the private tags from the DICOM instances (defaults to false)

Replaceobject

Associative array to change the value of some DICOM tags in the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the dcmodify command-line tool (wildcards are supported as well).

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.

Transcodestring

Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html

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