comparison Sphinx/source/users/lua.rst @ 783:0fbe952b2906

list more lua functions
author Alain Mazy <am@osimis.io>
date Fri, 01 Oct 2021 16:53:46 +0200
parents 15a0635eef4b
children e7de02760b59
comparison
equal deleted inserted replaced
782:33040fbf85a8 783:0fbe952b2906
192 .. highlight:: bash 192 .. highlight:: bash
193 193
194 For instance:: 194 For instance::
195 195
196 RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}') 196 RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}')
197
198
199 Instance modification/routing
200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
201
202 The Lua engine offers a few function to modify and route DICOM instances.
203 :ref:`See this section <lua-auto-routing>`
204
205 * ``ModifyInstance(instanceId, replacements, removals, removePrivateTags)``
206 modifies an instance. Returns the instanceId of the modified instance
207 * ``SendToModality(instanceId, modality)`` performs a C-Store to the
208 target modality. Returns the instanceId.
209 * ``SendToPeer(instanceId, peer)`` sends the instance to a remote Orthanc peer.
210 Returns the instanceId.
211 * ``Delete(instanceId)`` deletes the instance.
197 212
198 213
199 General-purpose functions 214 General-purpose functions
200 ^^^^^^^^^^^^^^^^^^^^^^^^^ 215 ^^^^^^^^^^^^^^^^^^^^^^^^^
201 216