actionGETv1.0.0
Access raw frame
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.
actionGETv1.0.0
Access raw frame (compressed)
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
actionGETv1.0.0
Create DICOMDIR media
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.
actionGETv1.0.0
Create DICOMDIR media
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.
actionGETv1.0.0
Create ZIP archive
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.
actionGETv1.0.0
Create ZIP archive
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.
actionGETv1.0.0
Decode a frame (int16)
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.
actionGETv1.0.0
Decode a frame (preview)
Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
actionGETv1.0.0
Decode a frame (uint16)
Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
actionGETv1.0.0
Decode a frame (uint8)
Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
actionGETv1.0.0
Decode an image (int16)
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.
actionGETv1.0.0
Decode an image (preview)
Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
actionGETv1.0.0
Decode an image (uint16)
Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
actionGETv1.0.0
Decode an image (uint8)
Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
actionGETv1.0.0
Decode frame for Matlab
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
actionGETv1.0.0
Decode frame for Matlab
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
actionGETv1.0.0
Decode frame for numpy
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).
actionGETv1.0.0
Decode instance for numpy
Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
actionGETv1.0.0
Get attachment
Get the (binary) content of one attachment associated with the given instance
actionGETv1.0.0
Get attachment
Get the (binary) content of one attachment associated with the given patient
actionGETv1.0.0
Get attachment
Get the (binary) content of one attachment associated with the given series
actionGETv1.0.0
Get attachment (no decompression)
Get the (binary) content of one attachment associated with the given instance. The attachment will not be decompressed if `StorageCompression` is `true`.
actionGETv1.0.0
Get attachment (no decompression)
Get the (binary) content of one attachment associated with the given patient. The attachment will not be decompressed if `StorageCompression` is `true`.
actionGETv1.0.0
Get attachment (no decompression)
Get the (binary) content of one attachment associated with the given series. The attachment will not be decompressed if `StorageCompression` is `true`.
actionGETv1.0.0
Get child instances
Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get child instances
Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get child series
Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get child studies
Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get DICOM meta-header
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.
actionGETv1.0.0
Get DICOM tags
Get the DICOM tags in the specified format. By default, the `full` format is used, which combines hexadecimal tags with human-readable description.
actionGETv1.0.0
Get embedded PDF
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.
actionGETv1.0.0
Get human-readable tags
Get the DICOM tags in human-readable format (same as the `/instances/{id}/tags?simplify` route)
actionGETv1.0.0
Get info about the attachment
Get all the information about the attachment associated with the given instance
actionGETv1.0.0
Get info about the attachment
Get all the information about the attachment associated with the given patient
actionGETv1.0.0
Get info about the attachment
Get all the information about the attachment associated with the given series
actionGETv1.0.0
Get information about some instance
Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get information about some patient
Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get information about some series
Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get instance module
Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get instance statistics
Get statistics about the given instance
actionGETv1.0.0
Get job
Retrieve detailed information about the job whose identifier is provided in the URL: https://book.orthanc-server.com/users/advanced-rest.html#jobs
actionGETv1.0.0
Get job output
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`).
actionGETv1.0.0
Get level of original query
Get the query level (value of the `QueryRetrieveLevel` tag) of the query/retrieve operation whose identifier is provided in the URL
actionGETv1.0.0
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given instance
actionGETv1.0.0
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given patient
actionGETv1.0.0
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given series
actionGETv1.0.0
Get MD5 of attachment on disk
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`.
actionGETv1.0.0
Get MD5 of attachment on disk
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`.
actionGETv1.0.0
Get MD5 of attachment on disk
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`.
actionGETv1.0.0
Get metadata
Get the value of a metadata that is associated with the given instance
actionGETv1.0.0
Get metadata
Get the value of a metadata that is associated with the given patient
actionGETv1.0.0
Get modality configuration
Get detailed information about the configuration of some DICOM modality
actionGETv1.0.0
Get modality of original query
Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL
actionGETv1.0.0
Get one answer
Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL
actionGETv1.0.0
Get original query arguments
Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL
actionGETv1.0.0
Get parent patient
Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get parent series
Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get parent study
Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get patient module
Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get patient statistics
Get statistics about the given patient
actionGETv1.0.0
Get peer configuration
Get detailed information about the configuration of some Orthanc peer
actionGETv1.0.0
Get peer system information
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.
actionGETv1.0.0
Get plugin
Get system information about the plugin whose identifier is provided in the URL
actionGETv1.0.0
Get raw tag
Get the raw content of one DICOM tag in the hierarchy of DICOM dataset
actionGETv1.0.0
Get shared tags
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
actionGETv1.0.0
Get size of attachment
Get the size of one attachment associated with the given instance
actionGETv1.0.0
Get size of attachment
Get the size of one attachment associated with the given patient
actionGETv1.0.0
Get size of attachment
Get the size of one attachment associated with the given series
actionGETv1.0.0
Get size of attachment on disk
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`.
actionGETv1.0.0
Get size of attachment on disk
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`.
actionGETv1.0.0
Get size of attachment on disk
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`.
actionGETv1.0.0
Get tags of instances
Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Get tags of instances
Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
actionGETv1.0.0
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
actionGETv1.0.0
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
actionGETv1.0.0
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
actionGETv1.0.0
Is the patient protected against recycling?
Is the patient protected against recycling?
actionGETv1.0.0
JavaScript extensions to Orthanc Explorer
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.
actionGETv1.0.0
List answers to a query
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
actionGETv1.0.0
List attachments
Get the list of attachments that are associated with the given instance
actionGETv1.0.0
List attachments
Get the list of attachments that are associated with the given patient
actionGETv1.0.0
List attachments
Get the list of attachments that are associated with the given series
actionGETv1.0.0
List available frames
List the frames that are available in the DICOM instance of interest
actionGETv1.0.0
List changes
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.
actionGETv1.0.0
List DICOM modalities
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`.
actionGETv1.0.0
List jobs
List all the available jobs
actionGETv1.0.0
List metadata
Get the list of metadata that are associated with the given instance
actionGETv1.0.0
List metadata
Get the list of metadata that are associated with the given patient
actionGETv1.0.0
List metadata
Get the list of metadata that are associated with the given series
actionGETv1.0.0
List operations
List the available operations under URI `/instances/{id}/frames/{frame}/`
actionGETv1.0.0
List operations on a query
List the available operations for the query/retrieve operation whose identifier is provided in the URL
actionGETv1.0.0
List operations on an answer
List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL
actionGETv1.0.0
List operations on attachments
Get the list of the operations that are available for attachments associated with the given instance
actionGETv1.0.0
List operations on attachments
Get the list of the operations that are available for attachments associated with the given patient
actionGETv1.0.0
List operations on attachments
Get the list of the operations that are available for attachments associated with the given series
actionGETv1.0.0
List operations on modality
List the operations that are available for a DICOM modality.
actionGETv1.0.0
List operations on peer
List the operations that are available for an Orthanc peer.
actionGETv1.0.0
List Orthanc peers
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`.
actionGETv1.0.0
List plugins
List all the installed plugins
actionGETv1.0.0
List query/retrieve operations
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
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec