Merge pull request #8172 from 4teamwork/es/TI-2000-documentation

Add missing documentation for the auto close task feature when resolv…

Author: elioschmutz

docs/public/dev-manual/api/api_changelog.rst

@@ -12,6 +12,7 @@ Breaking Changes
 
 Other Changes
 ^^^^^^^^^^^^^
+- The ``auto_close_tasks`` transition parameter for ``dossier-transition-resolve`` enables automatic closure of open tasks before resolving the dossier.
 - ``@possible-watchers``: endpoint only returns users having view permission on the given context.
 - ``@listing``: New field `document_version_count` is now available.
 

docs/public/dev-manual/api/dossiers.rst

@@ -130,3 +130,50 @@ existiert oder neu erstellt werden muss.
    .. sourcecode:: http
 
       HTTP/1.1 204 No content
+
+Dossier abschliessen und dabei automatisch alle offenen Aufgaben schliessen
+---------------------------------------------------------------------------
+Ein Dossier kann über den Workflow abgeschlossen werden. Der Abschluss ist jedoch nur möglich, wenn alle enthaltenen Aufgaben entweder abgeschlossen oder abgebrochen sind. Um diesen Vorgang zu erleichtern, unterstützt der Dossier-Workflow eine Option zum automatischen Schliessen offener Aufgaben.
+
+Wird versucht, ein Dossier mit noch offenen Aufgaben abzuschliessen, ohne diese Option zu nutzen, enthält die Antwort eine entsprechende Fehlermeldung:
+
+
+**Beispiel-Request**:
+
+   .. sourcecode:: http
+
+      POST /(path)/@workflow/dossier-transition-resolve HTTP/1.1
+      Accept: application/json
+
+
+**Beispiel-Response**:
+
+  .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Content-Type: application/json
+
+      {
+         "error": {
+            "errors": [
+                  "Es sind nicht alle Aufgaben abgeschlossen"
+            ],
+            "has_not_closed_tasks": true,
+            "message": "",
+            "type": "PreconditionsViolated"
+         }
+      }
+
+Um alle offenen Aufgaben beim Dossier-Abschluss automatisch zu schliessen, kann der Parameter ``auto_close_tasks``  mitgegeben werden:
+
+
+**Beispiel-Request**:
+
+   .. sourcecode:: http
+
+      POST /(path)/@workflow/dossier-transition-resolve HTTP/1.1
+      Accept: application/json
+
+      {
+        "auto_close_tasks": "true"
+      }