Mercurial > hg > orthanc-book
changeset 252:eaad8233e474
HTTP headers available for the RestApiXXX Lua function
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 24 Jun 2019 16:13:16 +0200 |
| parents | 974d97395060 |
| children | a64197133114 |
| files | Sphinx/source/users/lua.rst |
| diffstat | 1 files changed, 8 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/users/lua.rst Tue Jun 11 06:55:19 2019 +0200 +++ b/Sphinx/source/users/lua.rst Mon Jun 24 16:13:16 2019 +0200 @@ -129,10 +129,10 @@ Lua scripts have :ref:`full access to the REST API <rest>` of Orthanc through the following functions: -* ``RestApiGet(uri, builtin)`` -* ``RestApiPost(uri, body, builtin)`` -* ``RestApiPut(uri, body, builtin)`` -* ``RestApiDelete(uri, builtin)`` +* ``RestApiGet(uri, builtin, headers)`` +* ``RestApiPost(uri, body, builtin, headers)`` +* ``RestApiPut(uri, body, builtin, headers)`` +* ``RestApiDelete(uri, builtin, headers)`` Here is a description of the parameters: @@ -153,6 +153,9 @@ ``true``), or the full the REST API after being tainted by plugins (if set to ``false``). +* ``headers`` is an optional argument and was added in release + 1.5.7. It allows to provide the REST API endpoint with HTTP headers. + .. highlight:: bash For instance:: @@ -190,7 +193,7 @@ * ``SetHttpCredentials(username, password)`` can be used to setup the HTTP credentials. -The ``headers`` argument is optional and has been added in release +The ``headers`` argument is optional and was added in release 1.2.1. It allows to set the HTTP headers for the HTTP client request. .. _lua-origin: