Introduction
L'API Get All Assignments retourne toutes les affectations avec une prise en charge limitée du filtre OData. Elle permet de filtrer les données pour un utilisateur et une solution spécifiques en transmettant le filtre OData dans l'URL d'API. Cette API utilise la méthode GET retourne toutes les affectations ouvertes.
Corps de la requête et de la réponse
L'API renvoie toutes les affectations ouvertes avec une prise en charge limitée du filtre OData avec le format de réponse suivant :
Demander les contrats de données :
Aucun corps de requête demandé.
Contrat de données de la réponse :
L'utilisateur peut appliquer des filtres OData sur tous les champs disponibles dans le contrat de données de réponse.
| Nom | Type | Restriction | Description |
|---|---|---|---|
| ID | guid | - | ID d'affectation |
| AppId | guid | - | Id. de nom d'application Celui-ci doit être ajouté. |
| Cessionnaire | chaîne | - | Nom d’affichage de la personne qui attribue la tâche. |
| AssigneeUserName | chaîne | - | Nom d'utilisateur de la personne qui attribue la tâche. |
| ActivityName | chaîne | - | Nom de l’affectation |
| AppName | chaîne | - | Retourne le nom de l'application. |
| AssignedDate | datetime | - | Date d’affectation. |
| ReviewDate | datetime | - | Date de vérification de l’affectation. |
| DueDate | datetime | - | Date d’échéance de l’affectation. |
| ProcessId | guid | - | ID de processus d'affectation |
| AssignmentType | int | - |
Type d’affectation
|
| PerformerDefName | chaîne | - | Nom de couloir de l'affectation. |
Exemple de requête et de réponse
Exemples de requêtes avec filtres OData :
-
Pour extraire toutes les affectations ouvertes.
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments -
Pour extraire toutes les affectations ouvertes de l'utilisateur spécifique de toutes les applications :
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AssigneeUserName eq 'mydomain\UserName' -
Pour extraire toutes les affectations ouvertes d'une application spécifique :
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AppName eq 'My App Name' -
Pour extraire toutes les affectations ouvertes d'une application et d'un utilisateur spécifique :
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AppName eq 'My App Name' and AssigneeUserName eq 'mydomain\UserName' -
Pour extraire toutes les affectations ouvertes avec une date d'échéance spécifique :
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=DueDate eq 2021-06-17 -
Pour extraire une affectation ouverte avec le ProcessId spécifique :
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=ProcessId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b -
Pour extraire toutes les affectations ouvertes d'un type d'affectation spécifique :
{{RoutePrefix}}/api/v1/Processextn/GetAllAssignments?$filter=AssignmentType eq 4
Données de réponse
[ { "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" }, ]Erreur
Erreur
[{"ErrorCode":"SOMETHING_WENT_WRONG_ADMIN","Message":"An error has occured on the server","errorPrameters":null}]