L'API Complete Assignment permet de terminer une affectation existante ouverte. Elle permet de terminer une tâche avec toutes les options sélectionnables approuvées/rejetées/terminées. Cette API utilise la méthode POST pour terminer une affectation existante ouverte.
Présentation de l'API
Vous trouverez ci-dessous une présentation de l'API Start Process :
-
Elle exécute une tâche avec toutes les options sélectionnables, à savoir, approuvée/rejetée/terminée. Des commentaires peuvent également être ajoutés lorsque la tâche est terminée avec les options suivantes :
-
Par ID de tâche.
-
En spécifiant l'ID de processus et le nom de la tâche. Si plusieurs tâches correspondant à ce nom de tâche sont ouvertes, une tâche quelconque sera alors terminée.
-
-
L'API prend en charge la propriété de tâche de workflow "Vérification requise", ce qui signifie qu'une tâche ne peut pas être achevée si le document correspondant n'a pas encore été vérifié.
-
Il n'est pas possible de configurer une tâche pour qu'elle soit vérifiée à partir des API.
-
Pour un "workflow Excel", il est possible de spécifier un fichier excel mis à jour.
-
L'API prend en charge la propriété "AllowReplacement". Par exemple, si cette propriété est vraie uniquement, le fichier Excel est alors accepté. Autrement, l'API génère une erreur.
-
Le fichier Excel doit appartenir à cette solution, bibliothèque et application de processus de tâche.
-
-
Pour le formulaire, les données de formulaire de workflow peuvent être fournies.
-
Les données du formulaire doivent être au format JSON. En outre, pour les champs de formulaire non répétitifs, l'API ne mettra à jour que les champs renseignés dans le formulaire (si un champ n'est pas renseigné, c'est sa valeur de formulaire existante qui sera conservée) et si les données de table répétitive sont spécifiées au format JSON, les données de table de formulaire existantes seront complètement remplacées par de nouvelles données.
-
Les règles de champ, les règles de vue, etc. ne seront pas déclenchées lors de la mise à jour des données de champs de formulaire ; le système à l'origine de l'appel doit s'assurer d'envoyer des données de formulaire valides.
-
Les données de données au format XML ne sont pas prises en charge.
-
-
Les pièces jointes ou les documents connexes ne sont pas pris en charge par cette API.
-
L'authentification à l'approbation n'est pas appliquée à l'API Digital Access. L'utilisateur peut effectuer la tâche à partir de l'API Digital Access sans valider les informations d'identification. Il est recommandé d'affecter à la propriété « Authentification à l'approbation » la valeur False pour le cas d'utilisation d'API ou de désactiver l'accès à l'API de ces solutions.
Corps de la requête et de la réponse
Cette API permet de terminer une affectation ouverte existante en appliquant le format suivant pour la requête et la réponse :
Demander les contrats de données :
| Nom | Type | Restriction | Description |
|---|---|---|---|
| AssignmentId | guid | - | ID de l’attribution à terminer. Il faut soit spécifier AssignmentId ou spécifier à la fois AssignmentName et ProcessId. |
| FileContent | octet[] | - | Requis pour une tâche de workflow Excel. Cela inclut le fichier de données excel à mettre à jour lors de l'exécution de la tâche. |
| Décision | chaîne | Obligatoire | L'état de décision de l'utilisateur qui peut être rejeté/approuvé/terminé. |
| Remarque | chaîne | - | Commentaires de l'affectation. |
| TeamspaceId | guid | - | ID de l'application. |
| ProcessId | guid | - |
Id de processus de la tâche. AssignmentName doit être spécifié avec cette propriété. Il faut soit spécifier AssignmentId ou spécifier à la fois AssignmentName et ProcessId. |
| AssignmentName | chaîne | - |
Nom de la tâche. L'ID de processus doit être spécifié avec cette propriété. Il faut soit spécifier AssignmentId ou spécifier à la fois AssignmentName et ProcessId. |
| Formfields | JSON | - | Données du formulaire au format JSON. |
Contrat de données de la réponse :
| Nom | Type | Restriction | Description |
|---|---|---|---|
| statut | Booléen | True (en cas de réussite), False (en cas d'erreur). |
Exemple de requête et de réponse
Les exemples ci-dessous illustrent l'utilisation de l'API.
Exemple 1
Chemin : http://cha-en-vstwp418:8090/svr/api/v1/Processextn/CompleteAssignment
Charge utile de la requête
{ "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" } } } } }Charge utile de la réponse
-
Lorsque l'action de la tâche (c'est-à-dire exécuter/approuver/rejeter) aboutit :
True -
Pour une tâche déjà terminée :
[{"ErrorCode":"Task Process Already Completed","Message":"Task Process Already Completed","errorPrameters":[]}] -
Lorsque l'id d'affectation spécifié est introuvable
[{"ErrorCode":"InvalidAssignment_AssignmentReassigned","Message":"Invalid assignment id: 2ffdba51-2f93-4502-b07e-02972ec8d1fa","errorPrameters":[]}]
Exemple 2
Chemin : http://cha-en-vstwp418:8090/svr/api/v1/Processextn/CompleteAssignment
Charge utile de la requête
{ "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" } } } } }L'exemple d'erreur si un utilisateur lance un appel GET par erreur au lieu d'un appel POST :
{ "Message": "The requested resource does not support http method 'GET'." }Exemple d'erreur en cas d'ID d'affectation erroné mentionné :
[{"ErrorCode":"InvalidAssignment_AssignmentReassigned","Message":"Invalid assignment id: 07b25c54-d862-4270-af32-4654b321b3d7","errorPrameters":[]}]