Mercurial > hg > orthanc-book

annotate Sphinx/source/users/rest-cheatsheet.rst @ 577:7d27154e70f9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cheatsheet and full openapi
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 30 Dec 2020 07:55:12 +0100
parents
children eaa6cdfa7ba6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
577
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _cheatsheet:
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 Cheat sheet of the REST API
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 ===========================
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 This quick reference of the :ref:`REST API of Orthanc <rest>` is
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 automatically generated from the source code of Orthanc. Clicking on
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 one of the HTTP methods will open its full OpenAPI documentation.
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 If you are looking for samples, check out the dedicated :ref:`FAQ
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 entry <rest-samples>`.
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 .. csv-table:: Reference
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 :header-rows: 1
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 :file: ./rest-cheatsheet.csv
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 :widths: 10, 2, 2, 2, 2, 10
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 NB: Up to Orthanc 1.8.2, this cheat sheet was manually published as an
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 `online spreadsheet
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 <https://docs.google.com/spreadsheets/d/e/2PACX-1vSBEymDKGZgskFEFF6yzge5JovGHPK_FIbEnW5a6SWUbPkX06tkoObUHh6T1XQhgj-HqFd0AWSnVFOv/pubhtml>`__. This
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 spreadsheet is still available online for history purpose, but is now
7d27154e70f9 cheatsheet and full openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 left unmaintained.