Mercurial > hg > orthanc-book

view Sphinx/source/users/rest-cheatsheet.rst @ 1032:6814e5adb789

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
end of dual licensing and cla
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 02 Feb 2024 16:37:39 +0100
parents eaa6cdfa7ba6
children
line wrap: on
line source

.. _cheatsheet:

Cheat sheet of the REST API
===========================

This quick reference of the :ref:`REST API of Orthanc <rest>` is
automatically generated from the source code of Orthanc. Clicking on
one of the HTTP methods will open its full OpenAPI documentation.

If you are looking for samples, check out the dedicated :ref:`FAQ
entry <rest-samples>`.


.. csv-table:: Reference
               :header-rows: 1
               :file: ./rest-cheatsheet.csv
               :widths: 10, 2, 2, 2, 2, 10
                        
NB: Up to Orthanc 1.8.1, this cheat sheet was manually published as an
`online spreadsheet
<https://docs.google.com/spreadsheets/d/e/2PACX-1vSBEymDKGZgskFEFF6yzge5JovGHPK_FIbEnW5a6SWUbPkX06tkoObUHh6T1XQhgj-HqFd0AWSnVFOv/pubhtml>`__. This
spreadsheet is still available online for history purpose, but is now
left unmaintained.