L'API Start Excel Process permet démarrer un processus de workflow Excel. Le fichier Excel soumis est soumis à la bibliothèque de solutions respective et un nouveau processus est lancé sur ce nouveau document. Cette API utilise la méthode POST pour lancer un processus de workflow.
Présentation de l'API
Vous trouverez ci-dessous une présentation de l'API Start Excel Process :
-
Elle prend en charge la fonction de modèle de nom du workflow Excel Workflow. La propriété ExcelWorkflowObj.DataFile.Title sera ignorée si le processus Excel cible est configuré avec le modèle de nom du fichier de données. En outre, le nom suivant du modèle de nom sera utilisé pour définir le nom du document.
-
L'API prend en charge la préférence « Contrôle de version : Contrôle de version pour les modèles de données », il s'agit d'une préférence au niveau de l'application et elle est prise en charge lorsque le fichier de données est soumis à la route API /au modèle.
Route/Fichier peut être également utilisé pour soumettre un fichier Excel pour celui qui ne sont pas créés à partir du fichier de modèle de données. Le fichier soumis à cet itinéraire sera considéré comme le dernier modèle de fichier. Ainsi, la préférence "Version Control for Data Templates" n'aura aucune signification pour elle.
-
L'utilisateur Evolve spécifié comme émetteur de fichier doit avoir un rôle de Créateur sur la solution.
-
L'utilisateur d'Evolve spécifié en tant que soumissionnaire du fichier doit avoir une licence nominative valide, (Runner ou Standard, etc.).
-
Le participant au processus ou l'utilisateur de couloir ne peut pas être spécifié dans la requête d'API. C'est la même chose que de soumettre un fichier Excel à partir du module complémentaire Studio Microsoft Excel.
-
Prend en charge la fonction de synchronisation des champs de la solution.
-
Prend en charge la clause Query Where (format RVT). Autorun pour un script Query ayant un fichier d'entréee via l'API Excel Process fonctionne correctement lorsque les informations RTV sont fournies.
-
Le fichier de données Excel créé à partir du "fichier Excel du modèle de solution" doit être soumis à la route : {API Route}/Template.
-
Le fichier de données Excel non créé à partir du "Fichier Excel de modèle de solution" doit être soumis à la route : {API Route}/File.
-
Cela ne prendra pas en charge le contrôle de version pour le modèle de données.
-
La structure de colonnes/données du fichier Excel soumis doivent être conformes au mappage défini pour les scripts de la solution Excel. Un fichier erroné entraînera des erreurs d'exécution du workflow ou des erreurs de publication des données.
-
-
Si Modèle ou Fichier n'est pas spécifié, le système traite la requête comme acheminé avec "{API Route}/File".
-
La ressoumission du fichier de données avec le même nom via l'API n'est pas autorisée.
-
Un workflow Excel 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.
Corps de la requête et de la réponse
Pour lancer un processus Excel avec un modèle Excel donné 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 |
|---|---|---|---|
| ExcelWorkflowObj | JObject | Obligatoire | Le fichier de données et les pièces jointes doivent être envoyés sous forme d'objet JSON. Les détails du schéma de l'objet JSON sont spécifiés à la fin de ce tableau. Le fichier de données et le document connexe doivent être encodés en base64String. |
| Nom d'utilisateur | chaîne | Obligatoire | Il s'agit du nom d'utilisateur d'Evolve. L'utilisateur doit avoir l'autorisation Créateur sur la solution pour laquelle le modèle est soumis. |
| AppName | chaîne | Obligatoire | Nom de l'application où ce processus Excel doit être initié. La solution ou la bibliothèque de modèles Excel doit exister uniquement dans cette application. |
| LibName | chaîne | Nécessaire uniquement pour le fichier Excel qui n'est pas un modèle de solution, c'est-à-dire {API Route}/Fichier | Nom de la bibliothèque de la solution Excel. |
| TemplateName | chaîne | Nécessaire uniquement pour le fichier Excel qui n'est pas un modèle de solution, c'est-à-dire {API Route}/Fichier | Nom de la solution Excel. |
Détails du schéma JSON du paramètre ExcelWorkflowObj :
"ExcelWorkflowObj":{ "DataFile":[{ "Title": "ExcelDataFileName1.xlsx", "RTVInfo": "", "Description": "", "DataFileBlob": "<<Base64EncodedString>>" }], "SupportingFiles":[{ "Title": "SupportingFileName1.xlsx", "Description": "", "FileBlob": "<<supporting file blob>>"}, { "Title": "SupportingFileName2.txt", "Description": "", "FileBlob": "<<Base64EncodedString>>" }] }ExcelWorkflowObj.DataFile : bien que ce soit un type de tableau, seul le premier élément du tableau est pris en charge et sera utilisé par l'API.
ExcelWorkflowObj.SupportingFiles : plusieurs fichiers connexes peuvent être soumis.
Contrat de données de la réponse :
| Nom | Type | Restriction | Description |
|---|---|---|---|
| DocumentItemId | Guid | - | ID de retour du document Excel |
Exemple de requête et de réponse
Les exemples ci-dessous illustrent l'utilisation de l'API :
Charge utile de la requête
{ "LibName":"Excel Workbooks", "UserName":"wsdt\\centraluser", "ExcelWorkflowObj": { "DataFile": [ { "Description":"", "DataFileBlob":"UEsDBBQABgAIAAAAIQComKncbgEAAJUFAAATAAgCW0NvbnRlbnRfVHlw...", "RTVInfo":"", "Title":"publish10474.xlsx" } ] }, "TemplateName":"MM02_EPIM", "AppName":"Arpit App" }Charge utile de la réponse
{ "DocumentItemId": "ea03a42e-7eca-4b5d-af8f-d8e778d75e84" }