L'API Start Form Process permet démarrer un processus de workflow de formulaire. Cette API utilise la méthode POST pour lancer un processus de workflow. Les données de formulaire initiales doivent être envoyées au format XML. Il doit s'agir d'un formulaire XML valide, car aucune validation des données n'est effectuée et aucune règle de champ n'est exécutée lors de l'enregistrement des données du formulaire.
Présentation de l'API
Vous trouverez ci-dessous une présentation de l'API Start Process :
-
Elle prend en charge la fonction Modèle de nom. Le modèle de nom doit être configuré avec le contrôle Nom du formulaire. La propriété du contrôle Nom du formulaire Exécuter à doit être définie sur Fin. Lors de l'appel de l'API Digital Access, le champ Formulaire mappé à la propriété Nom du champ du contrôle Nom du formulaire doit être vide.
-
L'utilisateur Evolve spécifié comme soumissionnaire de formulaire doit avoir un rôle de Créateur sur la solution pour laquelle le processus de nouveau formulaire doit être démarré.
-
Éventuellement, le participant au processus ou l'utilisateur du couloir peut également être spécifié dans la requête d'API.
-
Un workflow de formulaire démarré à partir de l'API sera étiqueté comme API Document et, s'il est soumis à nouveau manuellement, le document du processus annulé sera toujours considéré comme une API Document. Ces informations seront prises en compte pour la facturation des licences.
-
La copie d'un document de formulaire crée un nouveau document dans le système. Le document copié à partir d'un document API et lancé/soumis manuellement à partir de l'interface Web est considéré comme un document non-API (document soumis manuellement).
Corps de la requête et de la réponse
Pour démarrer un processus de formulaire via l'API, la structure de la requête et de la réponse sera la suivante :
Demander les contrats de données :
| Nom | Type | Restriction | Description |
|---|---|---|---|
| AppName | chaîne | Obligatoire | Nom d'application de la "solution de formulaire". |
| Commentaires | chaîne | - | Commentaires pour le nœud de début. |
| FormXml | chaîne | - | Il s'agit des données de formulaire du nouveau processus de formulaire. Il doit s'agir d'un formulaire XML valide pour la solution de formulaire. |
| LibName | chaîne | Obligatoire | Nom de la bibliothèque de la "solution de formulaire". |
| ParticipantsInfoArray | Jarray of { “SwimlaneName” : ”abc”, “UserName”: ”xyz” } | - |
Il doit s'agir du nom du couloir, qui doit être résolu avec les utilisateurs donnés.
Si ce paramètre est laissé vide ou si les détails des couloirs spécifiques ne sont pas spécifiés, dans ce cas l'application résoudra ces couloirs selon le comportement défini dans le workflow. Pour le couloir Type de personne dans le workflow du formulaire, la valeur de l'utilisateur du couloir ne peut pas être remplacée lors du lancement du formulaire via l'API. |
| TemplateName | chaîne | Obligatoire | Nom de la "solution de formulaire". |
| Nom d'utilisateur | chaîne | Obligatoire | Nom d'utilisateur de l'utilisateur qui sera défini comme Créateur du processus. L'utilisateur doit avoir un rôle de Créateur sur la solution pour laquelle le processus de nouveau formulaire doit être démarré. |
Contrat de données de la réponse :
| Nom | Type | Restriction | Description |
|---|---|---|---|
| ProcessId | Guid | - | ID de retour du processus. |
| FormItemId | Guid | - | ID de retour du document de formulaire. |
Exemple de requête et de réponse
Les exemples ci-dessous illustrent l'utilisation de l'API.
Route : http://Winshuttle.EvolveUrl/svr/api/v1/Processextn/StartFormProcess
Charge utile de la requête
{ "AppName":"My API", "LibName": "Form Process Ext", "TemplateName": "API Product Example", "UserName": "mydomain\\user1", "Comments": "Process from API2", "FormXml": "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xhtml=\"http://www.w3.org/1999/xhtml\" xmlns:d=\"http://schemas.microsoft.com/office/infopath/2003/ado/dataFields\" xmlns:dfs=\"http://schemas.microsoft.com/office/infopath/2003/dataFormSolution\" xmlns:my=\"http://schemas.microsoft.com/office/infopath/2003/myXSD\" xmlns:xd=\"http://schemas.microsoft.com/office/infopath/2003\" xmlns:msxsl=\"urn:schemas-microsoft-com:xslt\"> <my:Product_Name>Evolve</my:Product_Name><my:Product_Description>Evolve product desc</my:Product_Description></my:myFields>", "ParticipantsInfoArray": [ { "SwimLaneName": "PersonSwimlane", "UsersName": "mydomain\\user1" }, { "SwimLaneName": "TeamSwimlane", "UsersName": "mydomain\\user1,mydomain\\user2" } ] }Charge utile de la réponse
{ "ProcessId": "93ae1e24-366e-4e54-af5c-dbf34ec15797", "FormItemId": "0e6c9998-3e3d-4e89-9fd4-e8086312cb32" }