From 9f8db658bf07b13c3f7051e7bce8b678c2cfd453 Mon Sep 17 00:00:00 2001
From: Peter Hormanns <peter.hormanns@jalin.de>
Date: Mon, 09 Dec 2019 21:26:04 +0100
Subject: [PATCH] 1x die ToDos durchgegangen
---
source/referenz/hsadmin/q.rst | 27 +++++++++++++++++++++------
1 files changed, 21 insertions(+), 6 deletions(-)
diff --git a/source/referenz/hsadmin/q.rst b/source/referenz/hsadmin/q.rst
index d3efffe..2b66229 100644
--- a/source/referenz/hsadmin/q.rst
+++ b/source/referenz/hsadmin/q.rst
@@ -1,12 +1,27 @@
-===============
-HSAdmin-Modul q
-===============
-Das HSAdmin-Modul hat die Funktion ``search``. Hiermit ist die Suche nach HSAdmin-Aktionen möglich.
+.. _kap-modul-q:
-Beispiel:
+=======
+Modul q
+=======
+
+Funktionen
+==========
+
+.. option:: q.search
+
+ Das HSAdmin-Modul hat nur die Funktion ``search``.
+ Hiermit ist die Ausgabe der bereits ausgeführten HSAdmin-Aktionen möglich.
+ Die Ausgabe zeigt an, ob eine Aktion erfolgreich abgeschlossen werden konnte
+ oder ob beim Ausrollen der Konfiguration auf den Server Fehler aufgetreten sind.
+ Im Erfolgsfall wird als Status 'done' angezeigt. Wenn Fehler aufgetreten sind
+ wird er Status 'error' ausgegeben. Daneben wird eine interne Fehlermeldung
+ im Feld 'exception' angezeigt. Wenden Sie sich im Fehlerfall bitte an an den Service.
+
+
+Beispiele
+=========
.. code-block:: console
$ q.search ({where:{user:'xyz00'}})
-
--
Gitblit v1.9.3