Cheat sheet

Orthanc has a very useful cheat sheet for finding functionalities and REST API routes. This page contains the mappings between REST API paths and methods in the pyorthanc.Orthanc class.

Note that pyorthanc.Orthanc is the low level client with which users can interact with Orthanc. Higher level functionalities such as Patient, Study, Series, Instance, find_patients/studies/series/instances, or Modality might be more convenient to use.

Path	GET	POST	DELETE	PUT	Summary
/changes	here	-	here	-	List changes
/exports	here	-	here	-	List exports
/instances	here	here	-	-	List the available instances
/instances/{id}	here	-	here	-	Get information about some instance
/instances/{id}/anonymize	-	here	-	-	Anonymize instance
/instances/{id}/attachments	here	-	-	-	List attachments
/instances/{id}/attachments/{name}	here	-	here	here	List operations on attachments
/instances/{id}/attachments/{name}/compress	-	here	-	-	Compress attachment
/instances/{id}/attachments/{name}/compressed-data	here	-	-	-	Get attachment
/instances/{id}/attachments/{name}/compressed-md5	here	-	-	-	Get MD5 of attachment on disk
/instances/{id}/attachments/{name}/compressed-size	here	-	-	-	Get size of attachment on disk
/instances/{id}/attachments/{name}/data	here	-	-	-	Get attachment
/instances/{id}/attachments/{name}/info	here	-	-	-	Get info about the attachment
/instances/{id}/attachments/{name}/is-compressed	here	-	-	-	Is attachment compressed?
/instances/{id}/attachments/{name}/md5	here	-	-	-	Get MD5 of attachment
/instances/{id}/attachments/{name}/size	here	-	-	-	Get size of attachment
/instances/{id}/attachments/{name}/uncompress	-	here	-	-	Uncompress attachment
/instances/{id}/attachments/{name}/verify-md5	-	here	-	-	Verify attachment
/instances/{id}/content/{path}	here	-	-	-	Get raw tag
/instances/{id}/export	-	here	-	-	Write DICOM onto filesystem
/instances/{id}/file	here	-	-	-	Download DICOM
/instances/{id}/frames	here	-	-	-	List available frames
/instances/{id}/frames/{frame}	here	-	-	-	List operations
/instances/{id}/frames/{frame}/image-int16	here	-	-	-	Decode a frame
/instances/{id}/frames/{frame}/image-uint16	here	-	-	-	Decode a frame
/instances/{id}/frames/{frame}/image-uint8	here	-	-	-	Decode a frame
/instances/{id}/frames/{frame}/matlab	here	-	-	-	Decode frame for Matlab
/instances/{id}/frames/{frame}/numpy	here	-	-	-	Decode frame for numpy
/instances/{id}/frames/{frame}/preview	here	-	-	-	Decode a frame
/instances/{id}/frames/{frame}/raw	here	-	-	-	Access raw frame
/instances/{id}/frames/{frame}/raw.gz	here	-	-	-	Access raw frame
/instances/{id}/frames/{frame}/rendered	here	-	-	-	Render a frame
/instances/{id}/header	here	-	-	-	Get DICOM meta-header
/instances/{id}/image-int16	here	-	-	-	Decode an image
/instances/{id}/image-uint16	here	-	-	-	Decode an image
/instances/{id}/image-uint8	here	-	-	-	Decode an image
/instances/{id}/labels	here	-	-	-	List labels
/instances/{id}/labels/{label}	here	-	here	here	Test label
/instances/{id}/matlab	here	-	-	-	Decode frame for Matlab
/instances/{id}/metadata	here	-	-	-	List metadata
/instances/{id}/metadata/{name}	here	-	here	here	Get metadata
/instances/{id}/modify	-	here	-	-	Modify instance
/instances/{id}/module	here	-	-	-	Get instance module
/instances/{id}/numpy	here	-	-	-	Decode instance for numpy
/instances/{id}/patient	here	-	-	-	Get parent patient
/instances/{id}/pdf	here	-	-	-	Get embedded PDF
/instances/{id}/preview	here	-	-	-	Decode an image
/instances/{id}/reconstruct	-	here	-	-	Reconstruct tags & optionally files of instance
/instances/{id}/rendered	here	-	-	-	Render an image
/instances/{id}/series	here	-	-	-	Get parent series
/instances/{id}/simplified-tags	here	-	-	-	Get human-readable tags
/instances/{id}/statistics	here	-	-	-	Get instance statistics
/instances/{id}/study	here	-	-	-	Get parent study
/instances/{id}/tags	here	-	-	-	Get DICOM tags
/jobs	here	-	-	-	List jobs
/jobs/{id}	here	-	here	-	Get job
/jobs/{id}/cancel	-	here	-	-	Cancel job
/jobs/{id}/pause	-	here	-	-	Pause job
/jobs/{id}/resubmit	-	here	-	-	Resubmit job
/jobs/{id}/resume	-	here	-	-	Resume job
/jobs/{id}/{key}	here	-	here	-	Get job output
/modalities	here	-	-	-	List DICOM modalities
/modalities/{id}	here	-	here	here	List operations on modality
/modalities/{id}/configuration	here	-	-	-	Get modality configuration
/modalities/{id}/echo	-	here	-	-	Trigger C-ECHO SCU
/modalities/{id}/find	-	here	-	-	Hierarchical C-FIND SCU
/modalities/{id}/find-instance	-	here	-	-	C-FIND SCU for instances
/modalities/{id}/find-patient	-	here	-	-	C-FIND SCU for patients
/modalities/{id}/find-series	-	here	-	-	C-FIND SCU for series
/modalities/{id}/find-study	-	here	-	-	C-FIND SCU for studies
/modalities/{id}/find-worklist	-	here	-	-	C-FIND SCU for worklist
/modalities/{id}/move	-	here	-	-	Trigger C-MOVE SCU
/modalities/{id}/query	-	here	-	-	Trigger C-FIND SCU
/modalities/{id}/storage-commitment	-	here	-	-	Trigger storage commitment request
/modalities/{id}/store	-	here	-	-	Trigger C-STORE SCU
/modalities/{id}/store-straight	-	here	-	-	Straight C-STORE SCU
/patients	here	-	-	-	List the available patients
/patients/{id}	here	-	here	-	Get information about some patient
/patients/{id}/anonymize	-	here	-	-	Anonymize patient
/patients/{id}/archive	here	here	-	-	Create ZIP archive
/patients/{id}/attachments	here	-	-	-	List attachments
/patients/{id}/attachments/{name}	here	-	here	here	List operations on attachments
/patients/{id}/attachments/{name}/compress	-	here	-	-	Compress attachment
/patients/{id}/attachments/{name}/compressed-data	here	-	-	-	Get attachment
/patients/{id}/attachments/{name}/compressed-md5	here	-	-	-	Get MD5 of attachment on disk
/patients/{id}/attachments/{name}/compressed-size	here	-	-	-	Get size of attachment on disk
/patients/{id}/attachments/{name}/data	here	-	-	-	Get attachment
/patients/{id}/attachments/{name}/info	here	-	-	-	Get info about the attachment
/patients/{id}/attachments/{name}/is-compressed	here	-	-	-	Is attachment compressed?
/patients/{id}/attachments/{name}/md5	here	-	-	-	Get MD5 of attachment
/patients/{id}/attachments/{name}/size	here	-	-	-	Get size of attachment
/patients/{id}/attachments/{name}/uncompress	-	here	-	-	Uncompress attachment
/patients/{id}/attachments/{name}/verify-md5	-	here	-	-	Verify attachment
/patients/{id}/instances	here	-	-	-	Get child instances
/patients/{id}/instances-tags	here	-	-	-	Get tags of instances
/patients/{id}/labels	here	-	-	-	List labels
/patients/{id}/labels/{label}	here	-	here	here	Test label
/patients/{id}/media	here	here	-	-	Create DICOMDIR media
/patients/{id}/metadata	here	-	-	-	List metadata
/patients/{id}/metadata/{name}	here	-	here	here	Get metadata
/patients/{id}/modify	-	here	-	-	Modify patient
/patients/{id}/module	here	-	-	-	Get patient module
/patients/{id}/protected	here	-	-	here	Is the patient protected against recycling?
/patients/{id}/reconstruct	-	here	-	-	Reconstruct tags & optionally files of patient
/patients/{id}/series	here	-	-	-	Get child series
/patients/{id}/shared-tags	here	-	-	-	Get shared tags
/patients/{id}/statistics	here	-	-	-	Get patient statistics
/patients/{id}/studies	here	-	-	-	Get child studies
/peers	here	-	-	-	List Orthanc peers
/peers/{id}	here	-	here	here	List operations on peer
/peers/{id}/configuration	here	-	-	-	Get peer configuration
/peers/{id}/store	-	here	-	-	Send to Orthanc peer
/peers/{id}/store-straight	-	here	-	-	Straight store to peer
/peers/{id}/system	here	-	-	-	Get peer system information
/plugins	here	-	-	-	List plugins
/plugins/explorer.js	here	-	-	-	JavaScript extensions to Orthanc Explorer
/plugins/{id}	here	-	-	-	Get plugin
/queries	here	-	-	-	List query/retrieve operations
/queries/{id}	here	-	here	-	List operations on a query
/queries/{id}/answers	here	-	-	-	List answers to a query
/queries/{id}/answers/{index}	here	-	-	-	List operations on an answer
/queries/{id}/answers/{index}/content	here	-	-	-	Get answer content
/queries/{id}/answers/{index}/retrieve	-	here	-	-	Retrieve answer
/queries/{id}/level	here	-	-	-	Get query level
/queries/{id}/modality	here	-	-	-	Get query modality
/queries/{id}/query	here	-	-	-	Get query arguments
/queries/{id}/retrieve	-	here	-	-	Retrieve all answers
/series	here	-	-	-	List the available series
/series/{id}	here	-	here	-	Get information about series
/series/{id}/anonymize	-	here	-	-	Anonymize series
/series/{id}/archive	here	here	-	-	Create ZIP archive
/series/{id}/attachments	here	-	-	-	List attachments
/series/{id}/attachments/{name}	here	-	here	here	List operations on attachments
/series/{id}/attachments/{name}/compress	-	here	-	-	Compress attachment
/series/{id}/attachments/{name}/compressed-data	here	-	-	-	Get attachment
/series/{id}/attachments/{name}/compressed-md5	here	-	-	-	Get MD5 of attachment on disk
/series/{id}/attachments/{name}/compressed-size	here	-	-	-	Get size of attachment on disk
/series/{id}/attachments/{name}/data	here	-	-	-	Get attachment
/series/{id}/attachments/{name}/info	here	-	-	-	Get info about attachment
/series/{id}/attachments/{name}/is-compressed	here	-	-	-	Is attachment compressed?
/series/{id}/attachments/{name}/md5	here	-	-	-	Get MD5 of attachment
/series/{id}/attachments/{name}/size	here	-	-	-	Get size of attachment
/series/{id}/attachments/{name}/uncompress	-	here	-	-	Uncompress attachment
/series/{id}/attachments/{name}/verify-md5	-	here	-	-	Verify attachment
/series/{id}/instances	here	-	-	-	Get child instances
/series/{id}/instances-tags	here	-	-	-	Get tags of instances
/series/{id}/labels	here	-	-	-	List labels
/series/{id}/labels/{label}	here	-	here	here	Test label
/series/{id}/media	here	here	-	-	Create DICOMDIR media
/series/{id}/metadata	here	-	-	-	List metadata
/series/{id}/metadata/{name}	here	-	here	here	Get metadata
/series/{id}/modify	-	here	-	-	Modify series
/series/{id}/module	here	-	-	-	Get series module
/series/{id}/ordered-sliced	here	-	-	-	Order slices
/series/{id}/patient	here	-	-	-	Get parent patient
/series/{id}/reconstruct	-	here	-	-	Reconstruct tags & optionally files
/series/{id}/shared-tags	here	-	-	-	Get shared tags
/series/{id}/statistics	here	-	-	-	Get series statistics
/series/{id}/study	here	-	-	-	Get parent study
/statistics	here	-	-	-	Get database statistics
/studies	here	-	-	-	List available studies
/studies/{id}	here	-	here	-	Get information about study
/studies/{id}/anonymize	-	here	-	-	Anonymize study
/studies/{id}/archive	here	here	-	-	Create ZIP archive
/studies/{id}/attachments	here	-	-	-	List attachments
/studies/{id}/attachments/{name}	here	-	here	here	List operations on attachments
/studies/{id}/attachments/{name}/compress	-	here	-	-	Compress attachment
/studies/{id}/attachments/{name}/compressed-data	here	-	-	-	Get attachment
/studies/{id}/attachments/{name}/compressed-md5	here	-	-	-	Get MD5 of attachment on disk
/studies/{id}/attachments/{name}/compressed-size	here	-	-	-	Get size of attachment on disk
/studies/{id}/attachments/{name}/data	here	-	-	-	Get attachment
/studies/{id}/attachments/{name}/info	here	-	-	-	Get info about attachment
/studies/{id}/attachments/{name}/is-compressed	here	-	-	-	Is attachment compressed?
/studies/{id}/attachments/{name}/md5	here	-	-	-	Get MD5 of attachment
/studies/{id}/attachments/{name}/size	here	-	-	-	Get size of attachment
/studies/{id}/attachments/{name}/uncompress	-	here	-	-	Uncompress attachment
/studies/{id}/attachments/{name}/verify-md5	-	here	-	-	Verify attachment
/studies/{id}/instances	here	-	-	-	Get child instances
/studies/{id}/instances-tags	here	-	-	-	Get tags of instances
/studies/{id}/labels	here	-	-	-	List labels
/studies/{id}/labels/{label}	here	-	here	here	Test label
/studies/{id}/media	here	here	-	-	Create DICOMDIR media
/studies/{id}/metadata	here	-	-	-	List metadata
/studies/{id}/metadata/{name}	here	-	here	here	Get metadata
/studies/{id}/modify	-	here	-	-	Modify study
/studies/{id}/module	here	-	-	-	Get study module
/studies/{id}/module-patient	here	-	-	-	Get patient module
/studies/{id}/patient	here	-	-	-	Get parent patient
/studies/{id}/reconstruct	-	here	-	-	Reconstruct tags & optionally files
/studies/{id}/series	here	-	-	-	Get child series
/studies/{id}/shared-tags	here	-	-	-	Get shared tags
/studies/{id}/statistics	here	-	-	-	Get study statistics
/system	here	-	-	-	Get system information
/tools/accepted-transfer-syntaxes	here	-	-	here	Get/set accepted transfer syntaxes
/tools/bulk-content	-	here	-	-	Bulk content modifications
/tools/bulk-delete	-	here	-	-	Bulk delete
/tools/bulk-modify	-	here	-	-	Bulk modifications
/tools/create-archive	-	here	-	-	Create ZIP archive
/tools/create-dicom	-	here	-	-	Create one DICOM instance
/tools/create-media	-	here	-	-	Create DICOMDIR media
/tools/default-encoding	here	-	-	here	Get/set default encoding
/tools/dicom-conformance	here	-	-	-	Get DICOM conformance statement
/tools/execute-script	-	here	-	-	Execute Lua script
/tools/find	-	here	-	-	Look for local resources
/tools/generate-uid	here	-	-	-	Generate DICOM UID
/tools/lookup	-	here	-	-	Look for DICOM identifiers
/tools/metrics	here	-	-	-	Get real-time metrics
/tools/metrics-prometheus	here	-	-	-	Get metrics for Prometheus
/tools/now	here	-	-	-	Get UTC time
/tools/reconstruct	-	here	-	-	Reconstruct database
/tools/reset	-	here	-	-	Reset Orthanc
/tools/shutdown	-	here	-	-	Shutdown Orthanc
/tools/unknown-sop-class-accepted	here	-	-	here	Get/set unknown SOP class acceptance