Die API zum Abschließen von Aufgaben ermöglicht das Abschließen einer vorhandenen offenen Aufgabe. Sie schließt eine Aufgabe mit allen auswählbaren Optionen ab („Genehmigt“/„Abgelehnt“/„Abgeschlossen“). Diese API verwendet die POST-Methode, um eine vorhandene offene Aufgabe abzuschließen.
Übersicht über die API
Nachfolgend finden Sie eine Übersicht über die API zum Starten von Prozessen:
-
Sie schließt eine Aufgabe mit allen auswählbaren Optionen ab, d. h. „Genehmigt“/„Abgelehnt“/„Abgeschlossen“. Kommentare können auch während der Ausführung der Aufgabe mit den folgenden Optionen bereitgestellt werden:
-
nach Aufgaben-ID,
-
durch Angabe von Prozess-ID und Aufgabenname. Falls für diesen Aufgabennamen mehrere offene Aufgaben gefunden werden, wird eine beliebige Aufgabe abgeschlossen.
-
-
Die API unterstützt die Workflow-Aufgabeneigenschaft „Überprüfung erforderlich“, was bedeutet, dass eine Aufgabe nicht abgeschlossen werden kann, wenn das entsprechende Dokument noch nicht überprüft wurde.
-
Eine Aufgabe kann nicht so eingestellt werden, dass sie von APIs überprüft wird.
-
Für den „Excel-Workflow“ kann eine aktualisierte Excel-Datei bereitgestellt werden.
-
Die API unterstützt die Eigenschaft „AllowReplacement“ der Workfllow-Aufgabe, die Excel-Datei wird beispielsweise nur dann akzeptiert, wenn diese Eigenschaft „True“ ist; andernfalls gibt die API einen Fehler aus.
-
Die Excel-Datei sollte zu der Prozesslösung, Bibliothek und App dieser Aufgabe gehören.
-
-
Für den Formular-Workflow können Formulardaten bereitgestellt werden.
-
Formulardaten sollten im JSON-Format vorliegen. Auch für nicht wiederholte Formularfelder aktualisiert die API die einzigen bereitgestellten Felder im Formular (wenn ein Feld nicht bereitgestellt wird, wird der vorhandene Formularwert beibehalten). Und wenn wiederholte Tabellendaten in JSON bereitgestellt werden, werden die Tabellendaten des vorhandenen Formulars vollständig mit neuen Daten überschrieben.
-
Feldregeln, Ansichtsregeln usw. werden beim Aktualisieren von Formularfelddaten nicht ausgelöst. Das aufrufende System muss also sicherstellen, dass gültige Formulardaten gesendet werden.
-
Formulardaten im XML-Format werden nicht unterstützt.
-
-
Anhänge oder unterstützende Dokumente werden für diese API nicht unterstützt.
-
„Abfrage bei Genehmigung“ wird nicht auf die Digital-Access-API angewendet. Der Benutzer kann die Aufgabe über die Digital-Access-API abschließen, ohne die Anmeldeinformationen zu überprüfen. Es wird empfohlen, die Eigenschaft „Abfrage bei Genehmigung“ für API-Anwendungsfälle auf „False“ zu setzen oder den API-Zugriff solcher Lösungen zu deaktivieren.
Anforderungs- und Antworttext
Diese API wird verwendet, um eine vorhandene offene Aufgabe im folgenden Format für Anforderung und Antwort abzuschließen:
Datenvertrag Anforderung:
| Name | Typ | Einschränkung | Beschreibung |
|---|---|---|---|
| AssignmentId | guid. | - | ID der abzuschließenden Aufgabe. Entweder sollte die AssignmentId oder sowohl der AssignmentName als auch die ProcessId bereitgestellt werden. |
| FileContent | byte[] | - | Erforderlich für die Excel-Workflow-Aufgabe. Dazu gehört eine Excel-Datendatei, die bei Abschluss der Aufgabe aktualisiert werden soll. |
| Entscheidung | Zeichenfolge | Erforderlich | Benutzerentscheidungsstatus, der „Abgelehnt“/„Genehmigt“/„Abgeschlossen“ lauten kann. |
| Hinweis | Zeichenfolge | - | Kommentare zur Aufgabe. |
| TeamspaceId | guid. | - | App-ID. |
| ProcessId | guid. | - |
Prozess-ID der Aufgabe. AssignmentName muss mit dieser Eigenschaft bereitgestellt werden. Entweder sollte die AssignmentId oder sowohl der AssignmentName als auch die ProcessId bereitgestellt werden. |
| AssignmentName | Zeichenfolge | - |
Name der Aufgabe. ProcessId muss mit dieser Eigenschaft angegeben werden. Entweder sollte die AssignmentId oder sowohl der AssignmentName als auch die ProcessId bereitgestellt werden. |
| FormFields | JSON | - | Formulardaten im JSON-Format. |
Datenvertrag Antwort:
| Name | Typ | Einschränkung | Beschreibung |
|---|---|---|---|
| status | Boolesch | True (bei Erfolg), False (im Fehlerfall). |
Anforderungs- und Antwortbeispiel
In den folgenden Beispielen wird die Verwendung der API veranschaulicht.
Beispiel 1
Route: http://cha-en-vstwp418:8090/svr/api/v1/Processextn/CompleteAssignment
Anforderungsnutzlast
{ "FileContent" : null, "Decision": "Approved", "Note": "Completed through PE", "AssignmentId": "07b25c54-d862-4270-af32-4654b321b3d7", "Formfields": { "my:myFields": { "my:field_1": "test_new1", "my:field_2": "test_new2", "my:Repeating_Table_2": { "my:Repeating_Content": { "my:field_3": "R1_activity", "my:field_4": "R2_activity" } } } } }Antwortnutzlast
-
Wenn die Aufgabenaktion (d. h. „Abschließen“/„Genehmigen“/„Ablehnen“) erfolgreich abgeschlossen wird:
True -
Für bereits abgeschlossene Aufgabe:
[{"ErrorCode":"Task Process Already Completed","Message":"Task Process Already Completed","errorPrameters":[]}] -
Wenn die angegebene Aufgaben-ID nicht gefunden wurde:
[{"ErrorCode":"InvalidAssignment_AssignmentReassigned","Message":"Invalid assignment id: 2ffdba51-2f93-4502-b07e-02972ec8d1fa","errorPrameters":[]}]
Beispiel 2
Route: http://cha-en-vstwp418:8090/svr/api/v1/Processextn/CompleteAssignment
Anforderungsnutzlast
{ "FileContent" : null, "Decision": "Approved", "Note": "Completed through PE", "ProcessId": "07b25c54-d862-4270-af32-4654b321b3d7", "AssignmentName": "Activity 3", "Formfields": { "my:myFields": { "my:field_1": "test_new1", "my:field_2": "test_new2", "my:Repeating_Table_2": { "my:Repeating_Content": { "my:field_3": "R1_activity", "my:field_4": "R2_activity" } } } } }Fehlerbeispiel für den Fall, dass der Benutzer versehentlich einen GET-Aufruf anstelle eines POST-Aufrufs durchführt:
{ "Message": "The requested resource does not support http method 'GET'." }Fehlerbeispiel bei Angabe einer falschen Aufgaben-ID:
[{"ErrorCode":"InvalidAssignment_AssignmentReassigned","Message":"Invalid assignment id: 07b25c54-d862-4270-af32-4654b321b3d7","errorPrameters":[]}]