Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 3.14 KB

File metadata and controls

22 lines (19 loc) · 3.14 KB

# ToolsBulkModifyPostRequest

Properties

Name Type Description Notes
asynchronous bool 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. [optional]
force bool Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world [optional]
keep string[] 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. [optional]
keep_source bool If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc. [optional]
level string Level of the modification (`Patient`, `Study`, `Series` or `Instance`). If absent, the level defaults to `Instance`, but is set to `Patient` if `PatientID` is modified, to `Study` if `StudyInstanceUID` is modified, or to `Series` if `SeriesInstancesUID` is modified. (new in Orthanc 1.9.7) [optional]
permissive bool If `true`, ignore errors during the individual steps of the job. [optional]
priority float In asynchronous mode, the priority of the job. The lower the value, the higher the priority. [optional]
private_creator string The private creator to be used for private tags in `Replace` [optional]
remove string[] 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). [optional]
remove_private_tags bool Remove the private tags from the DICOM instances (defaults to `false`) [optional]
replace object 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). [optional]
resources string[] List of the Orthanc identifiers of the patients/studies/series/instances of interest. [optional]
synchronous bool 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. [optional]
transcode string Transcode the DICOM instances to the provided DICOM transfer syntax: https://book.orthanc-server.com/faq/transcoding.html [optional]

[Back to Model list] [Back to API list] [Back to README]