Mercurial > hg > orthanc-book
comparison Sphinx/source/users/lua.rst @ 236:f58c0784453d
Merged in TomasZubiri/orthanc-book/TomasZubiri/documented-some-parameter-types-expected-1553029141048 (pull request #8)
Documented some parameter types, expected string formatting and added samples.
author | Sébastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 04 Apr 2019 14:19:16 +0000 |
parents | 15823481cf8f 17f8eda5fccb |
children | 1a701dfdfcad |
comparison
equal
deleted
inserted
replaced
234:4ee39154c570 | 236:f58c0784453d |
---|---|
132 * ``RestApiGet(uri, builtin)`` | 132 * ``RestApiGet(uri, builtin)`` |
133 * ``RestApiPost(uri, body, builtin)`` | 133 * ``RestApiPost(uri, body, builtin)`` |
134 * ``RestApiPut(uri, body, builtin)`` | 134 * ``RestApiPut(uri, body, builtin)`` |
135 * ``RestApiDelete(uri, builtin)`` | 135 * ``RestApiDelete(uri, builtin)`` |
136 | 136 |
137 The ``uri`` arguments specifies the URI against which to make the | 137 The parameters: |
138 request, and ``body`` is a string containing the body of POST/PUT | 138 |
139 request. The ``builtin`` parameter is an optional Boolean that | 139 * ``uri`` specifies the resource being accessed, do not include URL schema, hostname or port. (For example: '/instances' ) |
140 specifies whether the request targets only the built-in REST API of | 140 |
141 Orthanc (if set to ``true``), or the full the REST API after being | 141 * ``body`` is a json-formatted string containing the body of a POST or PUT request. (For example: '{"Keep":"StudyDate"}' ) |
142 tainted by the plugins (if set to ``false``). | 142 |
143 | 143 * ``builtin`` is an optional Boolean that specifies whether the request targets only the built-in REST API of Orthanc (if set to ``true``), or the full the REST API after being tainted by plugins (if set to ``false``). |
144 | |
145 For example: | |
146 | |
147 RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}') | |
144 | 148 |
145 General-purpose functions | 149 General-purpose functions |
146 ^^^^^^^^^^^^^^^^^^^^^^^^^ | 150 ^^^^^^^^^^^^^^^^^^^^^^^^^ |
147 | 151 |
148 The Lua engine of Orthanc contain several general-purpose ancillary | 152 The Lua engine of Orthanc contain several general-purpose ancillary |