Mercurial > hg > orthanc-book

changeset 783:0fbe952b2906

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
list more lua functions
author Alain Mazy <am@osimis.io>
date Fri, 01 Oct 2021 16:53:46 +0200
parents 33040fbf85a8
children c55ab0604d10
files Sphinx/source/users/lua.rst
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/users/lua.rst	Mon Sep 27 12:16:38 2021 +0200
+++ b/Sphinx/source/users/lua.rst	Fri Oct 01 16:53:46 2021 +0200
@@ -196,6 +196,21 @@
   RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}')
 
 
+Instance modification/routing
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The Lua engine offers a few function to modify and route DICOM instances.
+:ref:`See this section <lua-auto-routing>`
+
+* ``ModifyInstance(instanceId, replacements, removals, removePrivateTags)``
+  modifies an instance.  Returns the instanceId of the modified instance
+* ``SendToModality(instanceId, modality)`` performs a C-Store to the 
+  target modality.  Returns the instanceId.
+* ``SendToPeer(instanceId, peer)`` sends the instance to a remote Orthanc peer.
+  Returns the instanceId.
+* ``Delete(instanceId)`` deletes the instance.
+
+
 General-purpose functions
 ^^^^^^^^^^^^^^^^^^^^^^^^^