v1

latestOpenAPI 3.0.02026-07-142740323.4 KB
Instances

Modify instance

Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#modification-of-a-single-instance

post/instances/{id}/modify

Path parameters

idstring required

Orthanc identifier of the instance of interest

Request body

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.

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

Transcodestring

Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html