Einleitung
Die API zum Abrufen sämtlicher Aufgaben gibt alle offenen Aufgaben mit eingeschränkter Unterstützung des OData-Filters zurück. Dadurch können Daten für einen bestimmten Benutzer oder eine bestimmte Lösung gefiltert werden, indem der OData-Filter in die API-URL übergeben wird. Diese API verwendet die GET-Methode für die Rückgabe aller offenen Aufgaben.
Anforderungs- und Antworttext
Die API gibt bei Antworten alle offenen Aufgaben mit eingeschränkter Unterstützung für den OData-Filter im folgenden Format zurück:
Datenvertrag Anforderung:
Kein Anforderungstext erforderlich.
Datenvertrag Antwort:
Der Benutzer kann Odata-Filter auf alle im Antwort-Datenvertrag verfügbaren Felder anwenden.
| Name | Typ | Einschränkung | Beschreibung |
|---|---|---|---|
| Id | guid. | - | Arbeitsauftrag-ID. |
| AppId | guid. | - | ID des App-Namens. Diese sollte hinzugefügt werden. |
| Zugewiesener | Zeichenfolge | - | Aufgabenempfänger-Anzeigename. |
| AssigneeUserName | Zeichenfolge | - | Benutzername des Aufgabenempfängers. |
| ActivityName | Zeichenfolge | - | Arbeitsauftragsname. |
| AppName | Zeichenfolge | - | Gibt den App-Namen zurück. |
| AssignedDate | Datum und Zeit | - | Zugewiesenes Datum. |
| ReviewDate | Datum und Zeit | - | Überprüfungsdatum des Arbeitsauftrags. |
| DueDate | Datum und Zeit | - | Fälligkeitsdatum des Arbeitsauftrags. |
| ProcessId | guid. | - | Prozess-ID der Aufgabe |
| AssignmentType | int | - |
Aufgabentyp
|
| PerformerDefName | Zeichenfolge | - | Swimlane-Name der Aufgabe. |
Anforderungs- und Antwortbeispiel
Anforderungsbeispiele mit ODATA-Filtern:
-
Zum Abrufen aller offenen Aufgaben:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments -
Zum Abrufen aller offenen Aufgaben bestimmter Benutzer aus allen Apps:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AssigneeUserName eq 'mydomain\UserName' -
Zum Abrufen aller offenen Aufgaben einer bestimmten App:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AppName eq 'My App Name' -
Zum Abrufen aller offenen Aufgaben einer App und eines bestimmten Benutzers:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AppName eq 'My App Name' and AssigneeUserName eq 'mydomain\UserName' -
Zum Abrufen aller offenen Aufgaben eines bestimmten Fälligkeitsdatums:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=DueDate eq 2021-06-17 -
Zum Abrufen einer offenen Aufgabe mit einer bestimmten Prozess-ID:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=ProcessId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b -
Zum Abrufen aller offenen Aufgaben mit einem bestimmten Aufgabentyp:
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AssignmentType eq 4
Antwortdaten
[ { "Id": "0b013c34-85ff-4c01-8aa5-00e3c5f0e4e9", "AppId": "7e8b0239-c81e-4d9f-965c-fa8932c4fa2b", "Assignee": "Central User", "AssigneeUserName": "WSDT\\centraluser", "ActivityName": "Lösungsprüfung", "AppName": "Arpit App", "AssignedDate": "2021-06-17T11:22:34.47", "ReviewDate": null, "DueDate": "2021-06-18T11:22:34.47", "ProcessId": "4039c8b3-0b14-418d-b8c4-aefd23e7da5c", "AssignmentType": 4, "PerformerDefName": "Reviewer_User" }, { "Id": "13851040-240b-4b3c-94fd-01f88b7c6333", "AppId": "7e8b0239-c81e-4d9f-965c-fa8932c4fa2b", "Assignee": "Central User", "AssigneeUserName": "WSDT\\centraluser", "ActivityName": "Lösungsprüfung", "AppName": "Arpit App", "AssignedDate": "2021-06-17T12:57:31.937", "ReviewDate": null, "DueDate": "2021-06-18T12:57:31.937", "ProcessId": "49cd38ce-1cb6-496d-916b-9b87f6785079", "AssignmentType": 4, "PerformerDefName": "Reviewer_User" }, ]Fehler
Fehler
[{"ErrorCode":"SOMETHING_WENT_WRONG_ADMIN","Message":"An error has occured on the server","errorPrameters":null}]