Orthanc - REST API : REST v1.2.0
Path | GET | DELETE | POST | PUT | Notes | |
/{resourceType}/{id}/attachments | y | n | n | n | List the files that are attached to this patient, study, series or instance | |
/{resourceType}/{id}/attachments/{name} | y | y | n | y | ||
/{resourceType}/{id}/attachments/{name}/compress | n | n | y | n | ||
/{resourceType}/{id}/attachments/{name}/compressed-data | y | n | n | n | Return the (possibly compressed) data, as stored on the disk | |
/{resourceType}/{id}/attachments/{name}/compressed-md5 | y | n | n | n | ||
/{resourceType}/{id}/attachments/{name}/compressed-size | y | n | n | n | ||
/{resourceType}/{id}/attachments/{name}/data | y | n | n | n | ||
/{resourceType}/{id}/attachments/{name}/is-compressed | y | n | n | n | Is this attachment compressed: "0" means uncompressed, "1" compressed | |
/{resourceType}/{id}/attachments/{name}/md5 | y | n | n | n | ||
/{resourceType}/{id}/attachments/{name}/size | y | n | n | n | ||
/{resourceType}/{id}/attachments/{name}/uncompress | n | n | y | n | ||
/{resourceType}/{id}/attachments/{name}/verify-md5 | n | n | y | n | Check that there is no corruption on the disk (HTTP status == 200 iff. no error) | |
/{resourceType}/{id}/metadata | y | n | n | n | ||
/{resourceType}/{id}/metadata/{name} | y | y | n | y | ||
/changes | y | y | n | n | "last", "limit" and "since" arguments | |
/exports | y | y | n | n | "last", "limit" and "since" arguments | |
/instances | y | n | y | n | GET: "last" and "limit" arguments; POST = Add the new DICOM file given in the POST body | |
/instances/{id} | y | y | n | n | ||
/instances/{id}/anonymize | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/instances/{id}/content/ | y | n | n | n | List the first-level DICOM tags | |
/instances/{id}/content/{group}-{element} | y | n | n | n | Raw access to the value of DICOM tags (comprising the padding character) | |
/instances/{id}/content/{group}-{element}/{index}/... | y | n | n | n | Raw access to the content of DICOM sequences | |
/instances/{id}/export | n | n | y | n | Write the DICOM file to the filesystem where Orthanc is running | |
/instances/{id}/file | y | n | n | n | ||
/instances/{id}/frames | y | n | n | n | ||
/instances/{id}/frames/{frameNumber}/image-int16 | y | n | n | n | Truncated image to the [-32768;32767] range | |
/instances/{id}/frames/{frameNumber}/image-uint16 | y | n | n | n | Truncated image to the [0;65535] range | |
/instances/{id}/frames/{frameNumber}/image-uint8 | y | n | n | n | Truncated image to the [0;255] range | |
/instances/{id}/frames/{frameNumber}/matlab | y | n | n | n | a = eval(urlread('http://localhost:8042/instances/.../frames/0/matlab')) | |
/instances/{id}/frames/{frameNumber}/preview | y | n | n | n | Rescaled image (so that all the range [0;255] is used) | |
/instances/{id}/frames/{frameNumber}/raw | y | n | n | n | Access to the raw content of one frame (bypass image decoding) | |
/instances/{id}/header | y | n | n | n | Get the meta information (header) of the DICOM file, "?simplify" argument to simplify output | |
/instances/{id}/image-int16 | y | n | n | n | Truncated image to the [-32768;32767] range | |
/instances/{id}/image-uint16 | y | n | n | n | Truncated image to the [0;65535] range | |
/instances/{id}/image-uint8 | y | n | n | n | Truncated image to the [0;255] range | |
/instances/{id}/matlab | y | n | n | n | a = eval(urlread('http://localhost:8042/instances/.../matlab')) | |
/instances/{id}/modify | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/instances/{id}/module | y | n | n | n | ||
/instances/{id}/patient | y | n | n | n | Retrieve the parent patient of this instance | |
/instances/{id}/pdf | y | n | n | n | Return the encapsulated PDF inside the DICOM file, if any | |
/instances/{id}/preview | y | n | n | n | Rescaled image (so that all the range [0;255] is used) | |
/instances/{id}/reconstruct | n | n | y | n | Force reconstruction of the main DICOM tags, JSON summary and metadata | |
/instances/{id}/series | y | n | n | n | Retrieve the parent series of this instance | |
/instances/{id}/simplified-tags | y | n | n | n | ||
/instances/{id}/statistics | y | n | n | n | ||
/instances/{id}/study | y | n | n | n | Retrieve the parent study of this instance | |
/instances/{id}/tags | y | n | n | n | "?simplify" argument to simplify output (same as "simplified-tags") | |
/modalities | y | n | n | n | ||
/modalities/{dicom} | y | y | n | y | ||
/modalities/{dicom}/echo | n | n | y | n | C-Echo SCU | |
/modalities/{dicom}/find | n | n | d | n | Deprecated | |
/modalities/{dicom}/find-patient | n | n | d | n | Deprecated | |
/modalities/{dicom}/find-series | n | n | d | n | Deprecated | |
/modalities/{dicom}/find-study | n | n | d | n | Deprecated | |
/modalities/{dicom}/move | n | n | y | n | DICOM C-Move SCU (Retrieve) | |
/modalities/{dicom}/query | n | n | y | n | DICOM C-Find SCU (Query), with subsequent possibility for Retrieve | |
/modalities/{dicom}/store | n | n | y | n | POST body = UUID series, UUID instance, or raw DICOM file | |
/patients | y | n | n | n | "since" and "limit" arguments + "expand" argument to retrieve the content of the patients | |
/patients/{id} | y | y | n | n | ||
/patients/{id}/anonymize | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/patients/{id}/archive | y | n | n | n | Create ZIP | |
/patients/{id}/instances | y | n | n | n | Retrieve all the instances of this patient in a single REST call | |
/patients/{id}/media | y | n | n | n | Create a ZIP archive for media storage with DICOMDIR | |
/patients/{id}/modify | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/patients/{id}/module | y | n | n | n | ||
/patients/{id}/protected | y | n | n | y | Protection against recycling: "0" means unprotected, "1" protected | |
/patients/{id}/reconstruct | n | n | y | n | Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances | |
/patients/{id}/series | y | n | n | n | Retrieve all the series of this patient in a single REST call | |
/patients/{id}/shared-tags | y | n | n | n | "?simplify" argument to simplify output | |
/patients/{id}/statistics | y | n | n | n | ||
/patients/{id}/studies | y | n | n | n | Retrieve all the studies of this patient in a single REST call | |
/peers | y | n | n | n | ||
/peers/{peer} | y | y | n | y | ||
/peers/{peer}/store | n | n | y | n | POST body = UUID series, UUID instance, or raw DICOM file | |
/plugins | y | n | n | n | Get the list of all the registered plugins | |
/plugins/{id} | y | n | n | n | Get information about some plugin | |
/plugins/explorer.js | y | n | n | n | Get the JavaScript code that is injected by plugins into Orthanc Explorer | |
/queries | y | n | n | n | ||
/queries/{id} | y | y | n | n | ||
/queries/{id}/answers | y | n | n | n | List all the answers for this C-Find SCU request | |
/queries/{id}/answers/{index}/content | y | n | n | n | Access 1 answer of C-Find SCU; "?simplify" argument to simplify output | |
/queries/{id}/answers/{index}/retrieve | n | n | y | n | C-Move SCU: Send this resource to another modality whose AET is in the body | |
/queries/{id}/level | y | n | n | n | Get the query retrieve level for this C-Find SCU request | |
/queries/{id}/modality | y | n | n | n | Get the modality to which this C-Find SCU request was issued (cf. /modalities) | |
/queries/{id}/query | y | n | n | n | Access the C-Find SCU query; "?simplify" argument to simplify output | |
/queries/{id}/retrieve | n | n | y | n | C-Move SCU: Send all the results to another modality whose AET is in the body | |
/series | y | n | n | n | "since" and "limit" arguments + "expand" argument to retrieve the content of the series | |
/series/{id} | y | y | n | n | ||
/series/{id}/anonymize | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/series/{id}/archive | y | n | n | n | Create a ZIP archive for media storage with DICOMDIR | |
/series/{id}/instances | y | n | n | n | Retrieve all the instances of this series in a single REST call | |
/series/{id}/media | y | n | n | n | Create archives for media storage with DICOMDIR | |
/series/{id}/modify | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/series/{id}/module | y | n | n | n | "?simplify" argument to simplify output | |
/series/{id}/ordered-slices | y | n | n | n | Order the slices of a 2D+t, 3D or 3D+t image | |
/series/{id}/patient | y | n | n | n | Retrieve the parent patient of this series | |
/series/{id}/reconstruct | n | n | y | n | Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances | |
/series/{id}/shared-tags | y | n | n | n | "?simplify" argument to simplify output | |
/series/{id}/statistics | y | n | n | n | ||
/series/{id}/study | y | n | n | n | Retrieve the parent study of this series | |
/statistics | y | n | n | n | ||
/studies | y | n | n | n | "since" and "limit" arguments + "expand" argument to retrieve the content of the studies | |
/studies/{id} | y | y | n | n | ||
/studies/{id}/anonymize | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/studies/{id}/archive | y | n | n | n | Create ZIP | |
/studies/{id}/instances | y | n | n | n | Retrieve all the instances of this patient in a single REST call | |
/studies/{id}/media | y | n | n | n | Create a ZIP archive for media storage with DICOMDIR | |
/studies/{id}/modify | n | n | y | n | http://book.orthanc-server.com/users/anonymization.html | |
/studies/{id}/module | y | n | n | n | "?simplify" argument to simplify output | |
/studies/{id}/module-patient | y | n | n | n | "?simplify" argument to simplify output | |
/studies/{id}/patient | y | n | n | n | Retrieve the parent patient of this study | |
/studies/{id}/reconstruct | n | n | y | n | Force reconstruction of the main DICOM tags, JSON summary and metadata of child instances | |
/studies/{id}/series | y | n | n | n | Retrieve all the series of this study in a single REST call | |
/studies/{id}/shared-tags | y | n | n | n | "?simplify" argument to simplify output | |
/studies/{id}/statistics | y | n | n | n | ||
/system | y | n | n | n | ||
/tools/create-archive | n | n | y | n | Create a ZIP from a set of unrelated DICOM resources | |
/tools/create-dicom | n | n | y | n | Create and store a new DICOM instance, possibly with an image or a PDF payload | |
/tools/create-media | n | n | y | n | Create a ZIP-with-DICOMDIR from a set of unrelated DICOM resources | |
/tools/default-encoding | y | n | n | y | Get the default encoding used by Orthanc, or temporarily change it until the next restart | |
/tools/dicom-conformance | y | n | n | n | DICOM conformance statement of this version of Orthanc | |
/tools/execute-script | n | n | y | n | Execute the Lua script in the POST body | |
/tools/find | n | n | y | n | Runs a C-Find call from the REST API | |
/tools/generate-uid | y | n | n | n | "level" argument among "patient", "study", "series" and "instance" | |
/tools/invalidate-tags | n | n | y | n | Invalidate the JSON summary of all the DICOM files (useful if private tags are registered) | |
/tools/lookup | n | n | y | n | Map DICOM UIDs to Orthanc identifiers | |
/tools/now | y | n | n | n | Returns the current datetime in the ISO 8601 format | |
/tools/reset | n | n | y | n | Hot restart of Orthanc, the configuration file will be read again | |
/tools/shutdown | n | n | y | n | Stop Orthanc |
Published by Google Sheets–举报滥用行为–每5分钟自动更新一次