# HG changeset patch # User Sebastien Jodogne # Date 1700597414 -3600 # Node ID 953f57a1f30adec3379dfd9a7ddd7c1ed4d9bbf4 # Parent 1316bc62b5d5001aeb6895ad5614466a38143ce0 cont diff -r 1316bc62b5d5 -r 953f57a1f30a Sphinx/source/users/rest-cheatsheet.csv --- a/Sphinx/source/users/rest-cheatsheet.csv Tue Nov 21 21:09:02 2023 +0100 +++ b/Sphinx/source/users/rest-cheatsheet.csv Tue Nov 21 21:10:14 2023 +0100 @@ -1,11 +1,11 @@ Path,GET,POST,DELETE,PUT,Summary -``/changes``,`GET `__,,`DELETE `__,,List changes -``/exports``,`GET `__,,`DELETE `__,,List exports -``/instances``,`GET `__,`POST `__,,,List the available instances -``/instances/{id}``,`GET `__,,`DELETE `__,,Get information about some instance +``/changes``,`GET `__,,`DELETE `__,,List changes +``/exports``,`GET `__,,`DELETE `__,,List exports +``/instances``,`GET `__,`POST `__,,,List the available instances +``/instances/{id}``,`GET `__,,`DELETE `__,,Get information about some instance ``/instances/{id}/anonymize``,,`POST `__,,,Anonymize instance ``/instances/{id}/attachments``,`GET `__,,,,List attachments -``/instances/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments +``/instances/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments ``/instances/{id}/attachments/{name}/compress``,,`POST `__,,,Compress attachment ``/instances/{id}/attachments/{name}/compressed-data``,`GET `__,,,,Get attachment (no decompression) ``/instances/{id}/attachments/{name}/compressed-md5``,`GET `__,,,,Get MD5 of attachment on disk @@ -36,10 +36,10 @@ ``/instances/{id}/image-uint16``,`GET `__,,,,Decode an image (uint16) ``/instances/{id}/image-uint8``,`GET `__,,,,Decode an image (uint8) ``/instances/{id}/labels``,`GET `__,,,,List labels -``/instances/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label +``/instances/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label ``/instances/{id}/matlab``,`GET `__,,,,Decode frame for Matlab ``/instances/{id}/metadata``,`GET `__,,,,List metadata -``/instances/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata +``/instances/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata ``/instances/{id}/modify``,,`POST `__,,,Modify instance ``/instances/{id}/module``,`GET `__,,,,Get instance module ``/instances/{id}/numpy``,`GET `__,,,,Decode instance for numpy @@ -59,9 +59,9 @@ ``/jobs/{id}/pause``,,`POST `__,,,Pause job ``/jobs/{id}/resubmit``,,`POST `__,,,Resubmit job ``/jobs/{id}/resume``,,`POST `__,,,Resume job -``/jobs/{id}/{key}``,`GET `__,,`DELETE `__,,Get job output +``/jobs/{id}/{key}``,`GET `__,,`DELETE `__,,Get job output ``/modalities``,`GET `__,,,,List DICOM modalities -``/modalities/{id}``,`GET `__,,`DELETE `__,`PUT `__,List operations on modality +``/modalities/{id}``,`GET `__,,`DELETE `__,`PUT `__,List operations on modality ``/modalities/{id}/configuration``,`GET `__,,,,Get modality configuration ``/modalities/{id}/echo``,,`POST `__,,,Trigger C-ECHO SCU ``/modalities/{id}/find``,,`(post) `__,,,*(deprecated)* Hierarchical C-FIND SCU @@ -76,11 +76,11 @@ ``/modalities/{id}/store``,,`POST `__,,,Trigger C-STORE SCU ``/modalities/{id}/store-straight``,,`POST `__,,,Straight C-STORE SCU ``/patients``,`GET `__,,,,List the available patients -``/patients/{id}``,`GET `__,,`DELETE `__,,Get information about some patient +``/patients/{id}``,`GET `__,,`DELETE `__,,Get information about some patient ``/patients/{id}/anonymize``,,`POST `__,,,Anonymize patient -``/patients/{id}/archive``,`GET `__,`POST `__,,,Create ZIP archive +``/patients/{id}/archive``,`GET `__,`POST `__,,,Create ZIP archive ``/patients/{id}/attachments``,`GET `__,,,,List attachments -``/patients/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments +``/patients/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments ``/patients/{id}/attachments/{name}/compress``,,`POST `__,,,Compress attachment ``/patients/{id}/attachments/{name}/compressed-data``,`GET `__,,,,Get attachment (no decompression) ``/patients/{id}/attachments/{name}/compressed-md5``,`GET `__,,,,Get MD5 of attachment on disk @@ -95,20 +95,20 @@ ``/patients/{id}/instances``,`GET `__,,,,Get child instances ``/patients/{id}/instances-tags``,`GET `__,,,,Get tags of instances ``/patients/{id}/labels``,`GET `__,,,,List labels -``/patients/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label -``/patients/{id}/media``,`GET `__,`POST `__,,,Create DICOMDIR media +``/patients/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label +``/patients/{id}/media``,`GET `__,`POST `__,,,Create DICOMDIR media ``/patients/{id}/metadata``,`GET `__,,,,List metadata -``/patients/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata +``/patients/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata ``/patients/{id}/modify``,,`POST `__,,,Modify patient ``/patients/{id}/module``,`GET `__,,,,Get patient module -``/patients/{id}/protected``,`GET `__,,,`PUT `__,Is the patient protected against recycling? +``/patients/{id}/protected``,`GET `__,,,`PUT `__,Is the patient protected against recycling? ``/patients/{id}/reconstruct``,,`POST `__,,,Reconstruct tags & optionally files of patient ``/patients/{id}/series``,`GET `__,,,,Get child series ``/patients/{id}/shared-tags``,`GET `__,,,,Get shared tags ``/patients/{id}/statistics``,`GET `__,,,,Get patient statistics ``/patients/{id}/studies``,`GET `__,,,,Get child studies ``/peers``,`GET `__,,,,List Orthanc peers -``/peers/{id}``,`GET `__,,`DELETE `__,`PUT `__,List operations on peer +``/peers/{id}``,`GET `__,,`DELETE `__,`PUT `__,List operations on peer ``/peers/{id}/configuration``,`GET `__,,,,Get peer configuration ``/peers/{id}/store``,,`POST `__,,,Send to Orthanc peer ``/peers/{id}/store-straight``,,`POST `__,,,Straight store to peer @@ -117,7 +117,7 @@ ``/plugins/explorer.js``,`GET `__,,,,JavaScript extensions to Orthanc Explorer ``/plugins/{id}``,`GET `__,,,,Get plugin ``/queries``,`GET `__,,,,List query/retrieve operations -``/queries/{id}``,`GET `__,,`DELETE `__,,List operations on a query +``/queries/{id}``,`GET `__,,`DELETE `__,,List operations on a query ``/queries/{id}/answers``,`GET `__,,,,List answers to a query ``/queries/{id}/answers/{index}``,`GET `__,,,,List operations on an answer ``/queries/{id}/answers/{index}/content``,`GET `__,,,,Get one answer @@ -130,11 +130,11 @@ ``/queries/{id}/query``,`GET `__,,,,Get original query arguments ``/queries/{id}/retrieve``,,`POST `__,,,Retrieve all answers ``/series``,`GET `__,,,,List the available series -``/series/{id}``,`GET `__,,`DELETE `__,,Get information about some series +``/series/{id}``,`GET `__,,`DELETE `__,,Get information about some series ``/series/{id}/anonymize``,,`POST `__,,,Anonymize series -``/series/{id}/archive``,`GET `__,`POST `__,,,Create ZIP archive +``/series/{id}/archive``,`GET `__,`POST `__,,,Create ZIP archive ``/series/{id}/attachments``,`GET `__,,,,List attachments -``/series/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments +``/series/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments ``/series/{id}/attachments/{name}/compress``,,`POST `__,,,Compress attachment ``/series/{id}/attachments/{name}/compressed-data``,`GET `__,,,,Get attachment (no decompression) ``/series/{id}/attachments/{name}/compressed-md5``,`GET `__,,,,Get MD5 of attachment on disk @@ -149,10 +149,10 @@ ``/series/{id}/instances``,`GET `__,,,,Get child instances ``/series/{id}/instances-tags``,`GET `__,,,,Get tags of instances ``/series/{id}/labels``,`GET `__,,,,List labels -``/series/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label -``/series/{id}/media``,`GET `__,`POST `__,,,Create DICOMDIR media +``/series/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label +``/series/{id}/media``,`GET `__,`POST `__,,,Create DICOMDIR media ``/series/{id}/metadata``,`GET `__,,,,List metadata -``/series/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata +``/series/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata ``/series/{id}/modify``,,`POST `__,,,Modify series ``/series/{id}/module``,`GET `__,,,,Get series module ``/series/{id}/numpy``,`GET `__,,,,Decode series for numpy @@ -166,11 +166,11 @@ ``/storage-commitment/{id}``,`GET `__,,,,Get storage commitment report ``/storage-commitment/{id}/remove``,,`POST `__,,,Remove after storage commitment ``/studies``,`GET `__,,,,List the available studies -``/studies/{id}``,`GET `__,,`DELETE `__,,Get information about some study +``/studies/{id}``,`GET `__,,`DELETE `__,,Get information about some study ``/studies/{id}/anonymize``,,`POST `__,,,Anonymize study -``/studies/{id}/archive``,`GET `__,`POST `__,,,Create ZIP archive +``/studies/{id}/archive``,`GET `__,`POST `__,,,Create ZIP archive ``/studies/{id}/attachments``,`GET `__,,,,List attachments -``/studies/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments +``/studies/{id}/attachments/{name}``,`GET `__,,`DELETE `__,`PUT `__,List operations on attachments ``/studies/{id}/attachments/{name}/compress``,,`POST `__,,,Compress attachment ``/studies/{id}/attachments/{name}/compressed-data``,`GET `__,,,,Get attachment (no decompression) ``/studies/{id}/attachments/{name}/compressed-md5``,`GET `__,,,,Get MD5 of attachment on disk @@ -185,11 +185,11 @@ ``/studies/{id}/instances``,`GET `__,,,,Get child instances ``/studies/{id}/instances-tags``,`GET `__,,,,Get tags of instances ``/studies/{id}/labels``,`GET `__,,,,List labels -``/studies/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label -``/studies/{id}/media``,`GET `__,`POST `__,,,Create DICOMDIR media +``/studies/{id}/labels/{label}``,`GET `__,,`DELETE `__,`PUT `__,Test label +``/studies/{id}/media``,`GET `__,`POST `__,,,Create DICOMDIR media ``/studies/{id}/merge``,,`POST `__,,,Merge study ``/studies/{id}/metadata``,`GET `__,,,,List metadata -``/studies/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata +``/studies/{id}/metadata/{name}``,`GET `__,,`DELETE `__,`PUT `__,Get metadata ``/studies/{id}/modify``,,`POST `__,,,Modify study ``/studies/{id}/module``,`GET `__,,,,Get study module ``/studies/{id}/module-patient``,`GET `__,,,,Get patient module of study @@ -201,7 +201,7 @@ ``/studies/{id}/statistics``,`GET `__,,,,Get study statistics ``/system``,`GET `__,,,,Get system information ``/tools``,`GET `__,,,,List operations -``/tools/accepted-transfer-syntaxes``,`GET `__,,,`PUT `__,Get accepted transfer syntaxes +``/tools/accepted-transfer-syntaxes``,`GET `__,,,`PUT `__,Get accepted transfer syntaxes ``/tools/bulk-anonymize``,,`POST `__,,,Anonymize a set of resources ``/tools/bulk-content``,,`POST `__,,,Describe a set of resources ``/tools/bulk-delete``,,`POST `__,,,Delete a set of resources @@ -210,7 +210,7 @@ ``/tools/create-dicom``,,`POST `__,,,Create one DICOM instance ``/tools/create-media``,,`POST `__,,,Create DICOMDIR media ``/tools/create-media-extended``,,`POST `__,,,Create DICOMDIR media -``/tools/default-encoding``,`GET `__,,,`PUT `__,Get default encoding +``/tools/default-encoding``,`GET `__,,,`PUT `__,Get default encoding ``/tools/dicom-conformance``,`GET `__,,,,Get DICOM conformance ``/tools/dicom-echo``,,`POST `__,,,Trigger C-ECHO SCU ``/tools/execute-script``,,`POST `__,,,Execute Lua script @@ -218,20 +218,20 @@ ``/tools/generate-uid``,`GET `__,,,,Generate an identifier ``/tools/invalidate-tags``,,`POST `__,,,Invalidate DICOM-as-JSON summaries ``/tools/labels``,`GET `__,,,,Get all the used labels -``/tools/log-level``,`GET `__,,,`PUT `__,Get main log level -``/tools/log-level-dicom``,`GET `__,,,`PUT `__,Get log level for `dicom` -``/tools/log-level-generic``,`GET `__,,,`PUT `__,Get log level for `generic` -``/tools/log-level-http``,`GET `__,,,`PUT `__,Get log level for `http` -``/tools/log-level-jobs``,`GET `__,,,`PUT `__,Get log level for `jobs` -``/tools/log-level-lua``,`GET `__,,,`PUT `__,Get log level for `lua` -``/tools/log-level-plugins``,`GET `__,,,`PUT `__,Get log level for `plugins` -``/tools/log-level-sqlite``,`GET `__,,,`PUT `__,Get log level for `sqlite` +``/tools/log-level``,`GET `__,,,`PUT `__,Get main log level +``/tools/log-level-dicom``,`GET `__,,,`PUT `__,Get log level for `dicom` +``/tools/log-level-generic``,`GET `__,,,`PUT `__,Get log level for `generic` +``/tools/log-level-http``,`GET `__,,,`PUT `__,Get log level for `http` +``/tools/log-level-jobs``,`GET `__,,,`PUT `__,Get log level for `jobs` +``/tools/log-level-lua``,`GET `__,,,`PUT `__,Get log level for `lua` +``/tools/log-level-plugins``,`GET `__,,,`PUT `__,Get log level for `plugins` +``/tools/log-level-sqlite``,`GET `__,,,`PUT `__,Get log level for `sqlite` ``/tools/lookup``,,`POST `__,,,Look for DICOM identifiers -``/tools/metrics``,`GET `__,,,`PUT `__,Are metrics collected? +``/tools/metrics``,`GET `__,,,`PUT `__,Are metrics collected? ``/tools/metrics-prometheus``,`GET `__,,,,Get usage metrics ``/tools/now``,`GET `__,,,,Get UTC time ``/tools/now-local``,`GET `__,,,,Get local time ``/tools/reconstruct``,,`POST `__,,,Reconstruct all the index ``/tools/reset``,,`POST `__,,,Restart Orthanc ``/tools/shutdown``,,`POST `__,,,Shutdown Orthanc -``/tools/unknown-sop-class-accepted``,`GET `__,,,`PUT `__,Is unknown SOP class accepted? +``/tools/unknown-sop-class-accepted``,`GET `__,,,`PUT `__,Is unknown SOP class accepted?