v1
latestOpenAPI 3.0.02026-07-132990743.4 KBAnonymize a set of resources
Start a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.
Request body
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.
Version of the DICOM standard to be used for anonymization. Check out configuration option DeidentifyLogsDicomVersion for possible values.
Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
List of DICOM tags whose value must not be destroyed by the anonymization. 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).
Keep the labels of all resources level (defaults to false)
Keep the private tags from the DICOM instances (defaults to false)
If set to false, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
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)
If true, ignore errors during the individual steps of the job. Default value is false.
In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is 0
The private creator to be used for private tags in Replace
List of additional tags to 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).
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).
List of the Orthanc identifiers of the patients/studies/series/instances of interest.
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.
Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
User data that will travel along with the job.
Response
In asynchronous mode, identifier of the job
In asynchronous mode, path to access the job in the REST API