Automate Orthanc Server Orthanc
HumDay reads Orthanc Server Orthanc’s own published API description and derives 268 operations from it. Describe the outcome you want in plain words — you get a program that is written, proven on real data, and run for you.
What Orthanc Server Orthanc is
This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc. This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book. An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openap
API host: demo.orthanc-server.com
What HumDay can do in Orthanc Server Orthanc
109 documented operations change something in Orthanc Server Orthanc. The 55 most useful are listed here.
- POSTUpload DICOM instances
/instances - POSTCreate one DICOM instance
/tools/create-dicom - POSTCreate DICOMDIR media
/tools/create-media - POSTCreate ZIP archive
/tools/create-archive - DELETEDelete a query
/queries/{id} - POSTCreate DICOMDIR media
/tools/create-media-extended - DELETEClear changes
/changes - DELETEClear exports
/exports - POSTSend to Orthanc peer
/peers/{id}/store - POSTCreate DICOMDIR media
/series/{id}/media - POSTCreate DICOMDIR media
/studies/{id}/media - POSTCreate DICOMDIR media
/patients/{id}/media - POSTCreate ZIP archive
/series/{id}/archive - POSTCreate ZIP archive
/studies/{id}/archive - POSTTrigger C-FIND SCU
/modalities/{id}/query - POSTCreate ZIP archive
/patients/{id}/archive - POSTReconstruct tags & optionally files of series
/series/{id}/reconstruct - POSTReconstruct tags & optionally files of study
/studies/{id}/reconstruct - POSTReconstruct tags & optionally files of patient
/patients/{id}/reconstruct - POSTReconstruct tags & optionally files of instance
/instances/{id}/reconstruct - POSTLook for local resources
/tools/find - POSTRestart Orthanc
/tools/reset - POSTLook for DICOM identifiers
/tools/lookup - PUTEnable collection of metrics
/tools/metrics - POSTShutdown Orthanc
/tools/shutdown - PUTSet main log level
/tools/log-level - POSTTrigger C-ECHO SCU
/tools/dicom-echo - POSTDelete a set of resources
/tools/bulk-delete - POSTModify a set of resources
/tools/bulk-modify - POSTReconstruct all the index
/tools/reconstruct - POSTDescribe a set of resources
/tools/bulk-content - PUTSet log level for lua
/tools/log-level-lua - POSTAnonymize a set of resources
/tools/bulk-anonymize - POSTExecute Lua script
/tools/execute-script - PUTSet log level for http
/tools/log-level-http - PUTSet log level for jobs
/tools/log-level-jobs - POSTInvalidate DICOM-as-JSON summaries
/tools/invalidate-tags - PUTSet log level for dicom
/tools/log-level-dicom - PUTSet default encoding
/tools/default-encoding - PUTSet log level for sqlite
/tools/log-level-sqlite - PUTSet log level for generic
/tools/log-level-generic - PUTSet log level for plugins
/tools/log-level-plugins - DELETEDelete Orthanc peer
/peers/{id} - PUTUpdate Orthanc peer
/peers/{id} - DELETEDelete some series
/series/{id} - DELETEDelete some study
/studies/{id} - DELETEDelete some patient
/patients/{id} - DELETEDelete some instance
/instances/{id} - DELETEDelete DICOM modality
/modalities/{id} - PUTUpdate DICOM modality
/modalities/{id} - PUTSet accepted transfer syntaxes
/tools/accepted-transfer-syntaxes - PUTSet unknown SOP class accepted
/tools/unknown-sop-class-accepted - POSTPause job
/jobs/{id}/pause - POSTCancel job
/jobs/{id}/cancel - POSTResume job
/jobs/{id}/resume
What HumDay can read from Orthanc Server Orthanc
These are the operations a schedule or a trigger can watch.
- GETList query/retrieve operations
/queries - GETList operations on a query
/queries/{id} - GETList jobs
/jobs - GETList Orthanc peers
/peers - GETList operations
/tools - GETList the available series
/series - GETList changes
/changes - GETList exports
/exports - GETList plugins
/plugins - GETList the available studies
/studies - GETList the available patients
/patients - GETList the available instances
/instances - GETList DICOM modalities
/modalities - GETList answers to a query
/queries/{id}/answers - GETList operations on peer
/peers/{id} - GETList operations on modality
/modalities/{id} - GETGet system information
/system - GETGet database statistics
/statistics - GETCreate DICOMDIR media
/series/{id}/media - GETGet level of original query
/queries/{id}/level - GETGet original query arguments
/queries/{id}/query - GETCreate DICOMDIR media
/studies/{id}/media - GETDownload DICOM
/instances/{id}/file - GETCreate DICOMDIR media
/patients/{id}/media - GETCreate ZIP archive
/series/{id}/archive - GETList metadata
/series/{id}/metadata - GETCreate ZIP archive
/studies/{id}/archive - GETList available frames
/instances/{id}/frames - GETCreate ZIP archive
/patients/{id}/archive - GETGet modality of original query
/queries/{id}/modality - GETList metadata
/studies/{id}/metadata - GETList metadata
/patients/{id}/metadata - GETList metadata
/instances/{id}/metadata - GETList attachments
/series/{id}/attachments - GETList attachments
/studies/{id}/attachments - GETList attachments
/patients/{id}/attachments - GETList attachments
/instances/{id}/attachments - GETGet UTC time
/tools/now - GETAre metrics collected?
/tools/metrics - GETGet main log level
/tools/log-level - GETGet local time
/tools/now-local - GETGenerate an identifier
/tools/generate-uid - GETGet log level for lua
/tools/log-level-lua - GETGet log level for http
/tools/log-level-http - GETGet log level for jobs
/tools/log-level-jobs
How automating Orthanc Server Orthanc works
- Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
- Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
- See it proven. The program runs and shows you the result before it is allowed near your live Orthanc Server Orthanc account.
- Grant access, then go live. You approve the specific Orthanc Server Orthanc operations it may use — and only those.
Automate Orthanc Server Orthanc with these
Categories
Questions about Orthanc Server Orthanc automation
- Can HumDay connect to Orthanc Server Orthanc?
- Yes. HumDay reads Orthanc Server Orthanc's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 268 operations are documented.
- Do I need to write code to automate Orthanc Server Orthanc?
- No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your Orthanc Server Orthanc account.
- What can HumDay do in Orthanc Server Orthanc?
- 109 of the 268 documented operations change something in Orthanc Server Orthanc, and 159 read from it. HumDay only ever uses the specific operations your approved contract needs.
- Is my Orthanc Server Orthanc account safe?
- Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to Orthanc Server Orthanc is held behind that approval.
Where this came from
The operations above are read from a published API description for Orthanc Server Orthanc at api.orthanc-server.com/orthanc-openapi.json. Descriptions are the provider’s own words, not ours. Last published 2023-03-06.