Orthanc API

Tools (276)

Extracted live via the executor SDK.

• instances.deleteInstancesId

  Delete the DICOM instance whose Orthanc identifier is provided in the URL

• instances.deleteInstancesIdAttachmentsName

  Delete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).

• instances.deleteInstancesIdMetadataName

  Delete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).

• instances.getInstances

  List the Orthanc identifiers of all the available DICOM instances

• instances.getInstancesId

  Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL

• instances.getInstancesIdAttachments

  Get the list of attachments that are associated with the given instance

• instances.getInstancesIdAttachmentsNameCompressedData

  Get the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if StorageCompression is true.

• instances.getInstancesIdAttachmentsNameCompressedMd5

  Get the MD5 hash of one attachment associated with the given instance, as stored on the disk. This is different from .../md5 iff EnableStorage is true.

• instances.getInstancesIdAttachmentsNameCompressedSize

  Get the size of one attachment associated with the given instance, as stored on the disk. This is different from .../size iff EnableStorage is true.

• instances.getInstancesIdAttachmentsNameData

  Get the (binary) content of one attachment associated with the given instance

• instances.getInstancesIdAttachmentsNameInfo

  Get all the information about the attachment associated with the given instance

• instances.getInstancesIdAttachmentsNameIsCompressed

  Test whether the attachment has been stored as a compressed file on the disk.

• instances.getInstancesIdAttachmentsNameMd5

  Get the MD5 hash of one attachment associated with the given instance

• instances.getInstancesIdAttachmentsNameSize

  Get the size of one attachment associated with the given instance

• instances.getInstancesIdContent

  Get the raw content of one DICOM tag in the hierarchy of DICOM dataset

• instances.getInstancesIdFile

  Download one DICOM instance

• instances.getInstancesIdFrames

  List the frames that are available in the DICOM instance of interest

• instances.getInstancesIdFramesFrameImageInt16

  Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.

• instances.getInstancesIdFramesFrameImageUint16

  Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.

• instances.getInstancesIdFramesFrameImageUint8

  Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.

• instances.getInstancesIdFramesFrameMatlab

  Decode one frame of interest from the given DICOM instance, and export this frame as a Octave/Matlab matrix to be imported with eval(): https://book.orthanc-server.com/faq/matlab.html

• instances.getInstancesIdFramesFrameNumpy

  Decode one frame of interest from the given DICOM instance, for use with numpy in Python. The numpy array has 3 dimensions: (height, width, color channel).

• instances.getInstancesIdFramesFramePreview

  Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.

• instances.getInstancesIdFramesFrameRaw

  Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes.

• instances.getInstancesIdFramesFrameRawGz

  Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. The image is compressed using gzip

• instances.getInstancesIdFramesFrameRendered

  Render one frame of interest from the given DICOM instance. This function takes scaling into account (RescaleSlope and RescaleIntercept tags), as well as the default windowing stored in the DICOM file (WindowCenter and WindowWidthtags), and can be used to resize the resulting image. Color images are not affected by windowing.

• instances.getInstancesIdHeader

  Get the DICOM tags in the meta-header of the DICOM instance. By default, the full format is used, which combines hexadecimal tags with human-readable description.

• instances.getInstancesIdImageInt16

  Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.

• instances.getInstancesIdImageUint16

  Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.

• instances.getInstancesIdImageUint8

  Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.

• instances.getInstancesIdMatlab

  Decode the first frame of the given DICOM instance., and export this frame as a Octave/Matlab matrix to be imported with eval(): https://book.orthanc-server.com/faq/matlab.html

• instances.getInstancesIdMetadata

  Get the list of metadata that are associated with the given instance

• instances.getInstancesIdMetadataName

  Get the value of a metadata that is associated with the given instance

• instances.getInstancesIdModule

  Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL

• instances.getInstancesIdNumpy

  Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).

• instances.getInstancesIdPatient

  Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL

• instances.getInstancesIdPdf

  Get the PDF file that is embedded in one DICOM instance. If the DICOM instance doesn't contain the EncapsulatedDocument tag or if the MIMETypeOfEncapsulatedDocument tag doesn't correspond to the PDF type, a 404 HTTP error is raised.

• instances.getInstancesIdPreview

  Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.

• instances.getInstancesIdRendered

  Render the first frame of the given DICOM instance. This function takes scaling into account (RescaleSlope and RescaleIntercept tags), as well as the default windowing stored in the DICOM file (WindowCenter and WindowWidthtags), and can be used to resize the resulting image. Color images are not affected by windowing.

• instances.getInstancesIdSeries

  Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL

• instances.getInstancesIdSimplifiedTags

  Get the DICOM tags in human-readable format (same as the /instances/{id}/tags?simplify route)

• instances.getInstancesIdStatistics

  Get statistics about the given instance

• instances.getInstancesIdStudy

  Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL

• instances.getInstancesIdTags

  Get the DICOM tags in the specified format. By default, the full format is used, which combines hexadecimal tags with human-readable description.

• instances.postInstances

  Upload DICOM instances

• instances.postInstancesIdAnonymize

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

• instances.postInstancesIdAttachmentsNameCompress

  Change the compression scheme that is used to store an attachment.

• instances.postInstancesIdAttachmentsNameUncompress

  Change the compression scheme that is used to store an attachment.

• instances.postInstancesIdAttachmentsNameVerifyMd5

  Verify that the attachment is not corrupted, by validating its MD5 hash

• instances.postInstancesIdExport

  Write the DICOM file onto the filesystem where Orthanc is running

• instances.postInstancesIdModify

  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

• instances.postInstancesIdReconstruct

  Reconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.

• instances.putInstancesIdAttachmentsName

  Attach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).

• instances.putInstancesIdMetadataName

  Set the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).

• jobs.getJobs

  List all the available jobs

• jobs.getJobsId

  Retrieve detailed information about the job whose identifier is provided in the URL: https://book.orthanc-server.com/users/advanced-rest.html#jobs

• jobs.getJobsIdKey

  Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with key equals to archive).

• jobs.postJobsIdCancel

  Cancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs

• jobs.postJobsIdPause

  Pause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs

• jobs.postJobsIdResubmit

  Resubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs

• jobs.postJobsIdResume

  Resume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://book.orthanc-server.com/users/advanced-rest.html#jobs

• logs.getToolsLogLevel

  Get the main log level of Orthanc

• logs.getToolsLogLevelDicom

  Get the log level of the log category dicom

• logs.getToolsLogLevelGeneric

  Get the log level of the log category generic

• logs.getToolsLogLevelHttp

  Get the log level of the log category http

• logs.getToolsLogLevelJobs

  Get the log level of the log category jobs

• logs.getToolsLogLevelLua

  Get the log level of the log category lua

• logs.getToolsLogLevelPlugins

  Get the log level of the log category plugins

• logs.getToolsLogLevelSqlite

  Get the log level of the log category sqlite

• logs.putToolsLogLevel

  Set the main log level of Orthanc

• logs.putToolsLogLevelDicom

  Set the log level of the log category dicom

• logs.putToolsLogLevelGeneric

  Set the log level of the log category generic

• logs.putToolsLogLevelHttp

  Set the log level of the log category http

• logs.putToolsLogLevelJobs

  Set the log level of the log category jobs

• logs.putToolsLogLevelLua

  Set the log level of the log category lua

• logs.putToolsLogLevelPlugins

  Set the log level of the log category plugins

• logs.putToolsLogLevelSqlite

  Set the log level of the log category sqlite

• networking.deleteModalitiesId

  Delete one DICOM modality. This change is permanent iff. DicomModalitiesInDatabase is true, otherwise it is lost at the next restart of Orthanc.

• networking.deletePeersId

  Delete one Orthanc peer. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart of Orthanc.

• networking.deleteQueriesId

  Delete the query/retrieve operation whose identifier is provided in the URL

• networking.getModalities

  List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the DicomModalities configuration option, or to the information stored in the database if DicomModalitiesInDatabase is true.

• networking.getModalitiesId

  List the operations that are available for a DICOM modality.

• networking.getModalitiesIdConfiguration

  Get detailed information about the configuration of some DICOM modality

• networking.getPeers

  List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the OrthancPeers configuration option, or to the information stored in the database if OrthancPeersInDatabase is true.

• networking.getPeersId

  List the operations that are available for an Orthanc peer.

• networking.getPeersIdConfiguration

  Get detailed information about the configuration of some Orthanc peer

• networking.getPeersIdSystem

  Get system information about some Orthanc peer. This corresponds to doing a GET request against the /system URI of the remote peer. This route can be used to test connectivity.

• networking.getQueries

  List the identifiers of all the query/retrieve operations on DICOM modalities, as initiated by calls to /modalities/{id}/query. The length of this list is bounded by the QueryRetrieveSize configuration option of Orthanc. https://book.orthanc-server.com/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest

• networking.getQueriesId

  List the available operations for the query/retrieve operation whose identifier is provided in the URL

• networking.getQueriesIdAnswers

  List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL

• networking.getQueriesIdAnswersIndex

  List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL

• networking.getQueriesIdAnswersIndexContent

  Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL

• networking.getQueriesIdLevel

  Get the query level (value of the QueryRetrieveLevel tag) of the query/retrieve operation whose identifier is provided in the URL

• networking.getQueriesIdModality

  Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL

• networking.getQueriesIdQuery

  Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL

• networking.getStorageCommitmentId

  Get the storage commitment report whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu

• networking.postModalitiesIdEcho

  Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-c-echo

• networking.postModalitiesIdFind

  Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of matching patients/studies/series. Deprecated in favor of /modalities/{id}/query.

• networking.postModalitiesIdFindInstance

  Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of /modalities/{id}/query.

• networking.postModalitiesIdFindPatient

  Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of /modalities/{id}/query.

• networking.postModalitiesIdFindSeries

  Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of /modalities/{id}/query.

• networking.postModalitiesIdFindStudy

  Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of /modalities/{id}/query.

• networking.postModalitiesIdFindWorklist

  Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL

• networking.postModalitiesIdMove

  Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-c-move

• networking.postModalitiesIdQuery

  Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: https://book.orthanc-server.com/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest

• networking.postModalitiesIdStorageCommitment

  Trigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/storage-commitment.html#storage-commitment-scu

• networking.postModalitiesIdStore

  Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#rest-store-scu

• networking.postModalitiesIdStoreStraight

  Synchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as storescu from DCMTK or dcm4che.

• networking.postPeersIdStore

  Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#sending-one-resource

• networking.postPeersIdStoreStraight

  Synchronously send the DICOM instance in the POST body to the Orthanc peer whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as curl.

• networking.postQueriesIdAnswersIndexQueryInstances

  Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL

• networking.postQueriesIdAnswersIndexQuerySeries

  Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL

• networking.postQueriesIdAnswersIndexQueryStudies

  Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL

• networking.postQueriesIdAnswersIndexRetrieve

  Start a C-MOVE SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move

• networking.postQueriesIdRetrieve

  Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://book.orthanc-server.com/users/rest.html#performing-retrieve-c-move

• networking.postStorageCommitmentIdRemove

  Remove out of Orthanc, the DICOM instances that have been reported to have been properly received the storage commitment report whose identifier is provided in the URL. This is only possible if the Status of the storage commitment report is Success. https://book.orthanc-server.com/users/storage-commitment.html#removing-the-instances

• networking.putModalitiesId

  Define a new DICOM modality, or update an existing one. This change is permanent iff. DicomModalitiesInDatabase is true, otherwise it is lost at the next restart of Orthanc.

• networking.putPeersId

  Define a new Orthanc peer, or update an existing one. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart of Orthanc.

• other.getInstancesIdAttachmentsName

  Get the list of the operations that are available for attachments associated with the given instance

• other.getInstancesIdFramesFrame

  List the available operations under URI /instances/{id}/frames/{frame}/

• other.getPatientsIdAttachmentsName

  Get the list of the operations that are available for attachments associated with the given patient

• other.getSeriesIdAttachmentsName

  Get the list of the operations that are available for attachments associated with the given series

• other.getStudiesIdAttachmentsName

  Get the list of the operations that are available for attachments associated with the given study

• other.getTools

  List the available operations under URI /tools/

• patients.deletePatientsId

  Delete the DICOM patient whose Orthanc identifier is provided in the URL

• patients.deletePatientsIdAttachmentsName

  Delete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).

• patients.deletePatientsIdMetadataName

  Delete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).

• patients.getPatients

  List the Orthanc identifiers of all the available DICOM patients

• patients.getPatientsId

  Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL

• patients.getPatientsIdArchive

  Synchronously create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method.

• patients.getPatientsIdAttachments

  Get the list of attachments that are associated with the given patient

• patients.getPatientsIdAttachmentsNameCompressedData

  Get the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if StorageCompression is true.

• patients.getPatientsIdAttachmentsNameCompressedMd5

  Get the MD5 hash of one attachment associated with the given patient, as stored on the disk. This is different from .../md5 iff EnableStorage is true.

• patients.getPatientsIdAttachmentsNameCompressedSize

  Get the size of one attachment associated with the given patient, as stored on the disk. This is different from .../size iff EnableStorage is true.

• patients.getPatientsIdAttachmentsNameData

  Get the (binary) content of one attachment associated with the given patient

• patients.getPatientsIdAttachmentsNameInfo

  Get all the information about the attachment associated with the given patient

• patients.getPatientsIdAttachmentsNameIsCompressed

  Test whether the attachment has been stored as a compressed file on the disk.

• patients.getPatientsIdAttachmentsNameMd5

  Get the MD5 hash of one attachment associated with the given patient

• patients.getPatientsIdAttachmentsNameSize

  Get the size of one attachment associated with the given patient

• patients.getPatientsIdInstances

  Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL

• patients.getPatientsIdInstancesTags

  Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL

• patients.getPatientsIdMedia

  Synchronously create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method.

• patients.getPatientsIdMetadata

  Get the list of metadata that are associated with the given patient

• patients.getPatientsIdMetadataName

  Get the value of a metadata that is associated with the given patient

• patients.getPatientsIdModule

  Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL

• patients.getPatientsIdProtected

  Is the patient protected against recycling?

• patients.getPatientsIdSeries

  Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL

• patients.getPatientsIdSharedTags

  Extract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL

• patients.getPatientsIdStatistics

  Get statistics about the given patient

• patients.getPatientsIdStudies

  Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL

• patients.postPatientsIdAnonymize

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

• patients.postPatientsIdArchive

  Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL

• patients.postPatientsIdAttachmentsNameCompress

  Change the compression scheme that is used to store an attachment.

• patients.postPatientsIdAttachmentsNameUncompress

  Change the compression scheme that is used to store an attachment.

• patients.postPatientsIdAttachmentsNameVerifyMd5

  Verify that the attachment is not corrupted, by validating its MD5 hash

• patients.postPatientsIdMedia

  Create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL

• patients.postPatientsIdModify

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

• patients.postPatientsIdReconstruct

  Reconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.

• patients.putPatientsIdAttachmentsName

  Attach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).

• patients.putPatientsIdMetadataName

  Set the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).

• patients.putPatientsIdProtected

  Check out configuration options MaximumStorageSize and MaximumPatientCount

• series.deleteSeriesId

  Delete the DICOM series whose Orthanc identifier is provided in the URL

• series.deleteSeriesIdAttachmentsName

  Delete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).

• series.deleteSeriesIdMetadataName

  Delete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).

• series.getSeries

  List the Orthanc identifiers of all the available DICOM series

• series.getSeriesId

  Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL

• series.getSeriesIdArchive

  Synchronously create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method.

• series.getSeriesIdAttachments

  Get the list of attachments that are associated with the given series

• series.getSeriesIdAttachmentsNameCompressedData

  Get the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if StorageCompression is true.

• series.getSeriesIdAttachmentsNameCompressedMd5

  Get the MD5 hash of one attachment associated with the given series, as stored on the disk. This is different from .../md5 iff EnableStorage is true.

• series.getSeriesIdAttachmentsNameCompressedSize

  Get the size of one attachment associated with the given series, as stored on the disk. This is different from .../size iff EnableStorage is true.

• series.getSeriesIdAttachmentsNameData

  Get the (binary) content of one attachment associated with the given series

• series.getSeriesIdAttachmentsNameInfo

  Get all the information about the attachment associated with the given series

• series.getSeriesIdAttachmentsNameIsCompressed

  Test whether the attachment has been stored as a compressed file on the disk.

• series.getSeriesIdAttachmentsNameMd5

  Get the MD5 hash of one attachment associated with the given series

• series.getSeriesIdAttachmentsNameSize

  Get the size of one attachment associated with the given series

• series.getSeriesIdInstances

  Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL

• series.getSeriesIdInstancesTags

  Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL

• series.getSeriesIdMedia

  Synchronously create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method.

• series.getSeriesIdMetadata

  Get the list of metadata that are associated with the given series

• series.getSeriesIdMetadataName

  Get the value of a metadata that is associated with the given series

• series.getSeriesIdModule

  Get the series module of the DICOM series whose Orthanc identifier is provided in the URL

• series.getSeriesIdNumpy

  Decode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).

• series.getSeriesIdOrderedSlices

  Sort the instances and frames (slices) of the DICOM series whose Orthanc identifier is provided in the URL. This URI is essentially used by the Orthanc Web viewer and by the Osimis Web viewer.

• series.getSeriesIdPatient

  Get detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL

• series.getSeriesIdSharedTags

  Extract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL

• series.getSeriesIdStatistics

  Get statistics about the given series

• series.getSeriesIdStudy

  Get detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL

• series.postSeriesIdAnonymize

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

• series.postSeriesIdArchive

  Create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL

• series.postSeriesIdAttachmentsNameCompress

  Change the compression scheme that is used to store an attachment.

• series.postSeriesIdAttachmentsNameUncompress

  Change the compression scheme that is used to store an attachment.

• series.postSeriesIdAttachmentsNameVerifyMd5

  Verify that the attachment is not corrupted, by validating its MD5 hash

• series.postSeriesIdMedia

  Create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL

• series.postSeriesIdModify

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

• series.postSeriesIdReconstruct

  Reconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.

• series.putSeriesIdAttachmentsName

  Attach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).

• series.putSeriesIdMetadataName

  Set the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).

• studies.deleteStudiesId

  Delete the DICOM study whose Orthanc identifier is provided in the URL

• studies.deleteStudiesIdAttachmentsName

  Delete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).

• studies.deleteStudiesIdMetadataName

  Delete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).

• studies.getStudies

  List the Orthanc identifiers of all the available DICOM studies

• studies.getStudiesId

  Get detailed information about the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdArchive

  Synchronously create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method.

• studies.getStudiesIdAttachments

  Get the list of attachments that are associated with the given study

• studies.getStudiesIdAttachmentsNameCompressedData

  Get the (binary) content of one attachment associated with the given study. The attachment will not be decompressed if StorageCompression is true.

• studies.getStudiesIdAttachmentsNameCompressedMd5

  Get the MD5 hash of one attachment associated with the given study, as stored on the disk. This is different from .../md5 iff EnableStorage is true.

• studies.getStudiesIdAttachmentsNameCompressedSize

  Get the size of one attachment associated with the given study, as stored on the disk. This is different from .../size iff EnableStorage is true.

• studies.getStudiesIdAttachmentsNameData

  Get the (binary) content of one attachment associated with the given study

• studies.getStudiesIdAttachmentsNameInfo

  Get all the information about the attachment associated with the given study

• studies.getStudiesIdAttachmentsNameIsCompressed

  Test whether the attachment has been stored as a compressed file on the disk.

• studies.getStudiesIdAttachmentsNameMd5

  Get the MD5 hash of one attachment associated with the given study

• studies.getStudiesIdAttachmentsNameSize

  Get the size of one attachment associated with the given study

• studies.getStudiesIdInstances

  Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdInstancesTags

  Get the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdMedia

  Synchronously create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL. This flavor is synchronous, which might not be desirable to archive large amount of data, as it might lead to network timeouts. Prefer the asynchronous version using POST method.

• studies.getStudiesIdMetadata

  Get the list of metadata that are associated with the given study

• studies.getStudiesIdMetadataName

  Get the value of a metadata that is associated with the given study

• studies.getStudiesIdModule

  Get the study module of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdModulePatient

  Get the patient module of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdPatient

  Get detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdSeries

  Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdSharedTags

  Extract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL

• studies.getStudiesIdStatistics

  Get statistics about the given study

• studies.postStudiesIdAnonymize

  Start a job that will anonymize 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://book.orthanc-server.com/users/anonymization.html#anonymization-of-patients-studies-or-series

• studies.postStudiesIdArchive

  Create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL

• studies.postStudiesIdAttachmentsNameCompress

  Change the compression scheme that is used to store an attachment.

• studies.postStudiesIdAttachmentsNameUncompress

  Change the compression scheme that is used to store an attachment.

• studies.postStudiesIdAttachmentsNameVerifyMd5

  Verify that the attachment is not corrupted, by validating its MD5 hash

• studies.postStudiesIdMedia

  Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL

• studies.postStudiesIdMerge

  Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier is provided in the URL: https://book.orthanc-server.com/users/anonymization.html#merging

• studies.postStudiesIdModify

  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://book.orthanc-server.com/users/anonymization.html#modification-of-studies-or-series

• studies.postStudiesIdReconstruct

  Reconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.

• studies.postStudiesIdSplit

  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://book.orthanc-server.com/users/anonymization.html#splitting

• studies.putStudiesIdAttachmentsName

  Attach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).

• studies.putStudiesIdMetadataName

  Set the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).

• system.getPlugins

  List all the installed plugins

• system.getPluginsExplorerJs

  Get the JavaScript extensions that are installed by all the plugins using the OrthancPluginExtendOrthancExplorer() function of the plugin SDK. This route is for internal use of Orthanc Explorer.

• system.getPluginsId

  Get system information about the plugin whose identifier is provided in the URL

• system.getStatistics

  Get statistics related to the database of Orthanc

• system.getSystem

  Get system information about Orthanc

• system.getToolsAcceptedTransferSyntaxes

  Get the list of UIDs of the DICOM transfer syntaxes that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options AcceptedTransferSyntaxes and XXXTransferSyntaxAccepted.

• system.getToolsDefaultEncoding

  Get the default encoding that is used by Orthanc if parsing a DICOM instance without the SpecificCharacterEncoding tag, or during C-FIND. This corresponds to the configuration option DefaultEncoding.

• system.getToolsDicomConformance

  Get the DICOM conformance statement of Orthanc

• system.getToolsGenerateUid

  Generate a random DICOM identifier

• system.getToolsMetrics

  Returns a Boolean specifying whether Prometheus metrics are collected and exposed at /tools/metrics-prometheus

• system.getToolsMetricsPrometheus

  Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://book.orthanc-server.com/users/advanced-rest.html#instrumentation-with-prometheus

• system.getToolsNow

  Get UTC time

• system.getToolsNowLocal

  Get local time

• system.getToolsUnknownSopClassAccepted

  Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?

• system.postToolsBulkAnonymize

  Start a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.

• system.postToolsBulkContent

  Get the content all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field, in one single call.

• system.postToolsBulkDelete

  Delete all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.

• system.postToolsBulkModify

  Start a job that will modify all the DICOM patients, studies, series or instances whose identifiers are provided in the Resources field.

• system.postToolsCreateArchive

  Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body

• system.postToolsCreateDicom

  Create one DICOM instance, and store it into Orthanc

• system.postToolsCreateMedia

  Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body

• system.postToolsCreateMediaExtended

  Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body

• system.postToolsDicomEcho

  Trigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some /modalities/{id} (new in Orthanc 1.8.1)

• system.postToolsExecuteScript

  Execute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible, cf. configuration option ExecuteLuaEnabled

• system.postToolsFind

  This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://book.orthanc-server.com/users/rest.html#performing-finds-within-orthanc

• system.postToolsInvalidateTags

  Remove all the attachments of the type "DICOM-as-JSON" that are associated will all the DICOM instances stored in Orthanc. These summaries will be automatically re-created on the next access. This is notably useful after changes to the Dictionary configuration option. https://book.orthanc-server.com/faq/orthanc-storage.html#storage-area

• system.postToolsLookup

  This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources

• system.postToolsReconstruct

  Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource

• system.postToolsReset

  Restart Orthanc

• system.postToolsShutdown

  Shutdown Orthanc

• system.putToolsAcceptedTransferSyntaxes

  Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP

• system.putToolsDefaultEncoding

  Change the default encoding that is used by Orthanc if parsing a DICOM instance without the SpecificCharacterEncoding tag, or during C-FIND. This corresponds to the configuration option DefaultEncoding.

• system.putToolsMetrics

  Enable or disable the collection and publication of metrics at /tools/metrics-prometheus

• system.putToolsUnknownSopClassAccepted

  Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID

• trackingChanges.deleteChanges

  Clear the full history stored in the changes log

• trackingChanges.deleteExports

  Clear the full history stored in the exports log

• trackingChanges.getChanges

  Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called Changes Log. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality.

• trackingChanges.getExports

  For medical traceability, Orthanc can be configured to store a log of all the resources that have been exported to remote modalities. In auto-routing scenarios, it is important to prevent this log to grow indefinitely as incoming instances are routed. You can either disable this logging by setting the option LogExportedResources to false in the configuration file, or periodically clear this log by DELETE-ing this URI. This route might be removed in future versions of Orthanc.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools