API Get Document Data By Process - Automate_Evolve - Automate_Studio_Manager - 20.3

Guide d'utilisation d'Automate Evolve

Product type
Logiciels
Portfolio
Integrate
Product family
Automate
Product
Automate > Automate Evolve
Version
20.3
Language
Français
Product name
Automate Evolve
Title
Guide d'utilisation d'Automate Evolve
Topic type
Administration
Référence
Aperçu
First publish date
2018

L'API Get Document Data By Process retourne le dernier exemplaire du document du processus pour un ID de processus spécifique. Cette API utilise la méthode GET pour retourner le dernier exemplaire du Document de processus.

Présentation de l'API

  1. Pour les processus à base de Formulaire, le document formulaire sera retourné au format json ou xml, selon la valeur spécifiée pour le paramètre Format. Si le format n'est pas spécifié, l'application adoptera par défaut le format json.

  2. Pour le Workflow Excel, le document est toujours retourné au format Excel.

Exemple de requête et de réponse

Cette API retourne le dernier exemplaire du Document de processus pour l'id de processus spécifié. La structure de la requête et de la réponse sera comme suit :

Demander les contrats de données :

Aucun corps de requête demandé.

Vous trouverez ci-dessous tous les paramètres de l'URL de la requête.

  • DocumentType : il peut s'agir d'Excel/Formulaire.

  • ProcessID : il s'agit du GUID du processus.

  • Result Format (en option) : il peut s'agir de “json” ou “xml”. Ne fonctionne que pour un document Formulaire.

Voici quelques exemples de requête :

Exemple 1

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Excel/EDE8CF75-248C-407D-A5B8-0209759003D4

Exemple 2

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Form/DC135B5A-DE73-4D84-BCB5-01CB5A0EBFC0

Exemple 3

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Form/DC135B5A-DE73-4D84-BCB5-01CB5A0EBFC0/xml

Contrat de données de la réponse :

  1. Solution de formulaire (au format JSON) :

    Les données des champs de formulaire (tels qu'ajoutés à la solution de Formulaire) seront retournées au format JSON, comme illustré ci-dessous :

    {     "my:myFields":      {         <<Form Data in json as per Form solution feilds added to the Form solution.>>           } }
  2. Solution de formulaire (au format XML) :

    Les données des champs de formulaire (tels qu'ajoutés à la solution de Formulaire) seront retournées au format XML, comme illustré ci-dessous :

    "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"  xmlns:xhtml=\"http://www.w3.org/1999/xhtml\"  xmlns:pc=\"http://schemas.microsoft.com/office/infopath/2007/PartnerControls\"  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\">

    Données de formulaire au format xml, conformément aux champs de la solution de Formulaire ajoutés à la solution de Formulaire.

    </my:myFields>
  3. Solution Excel :

    Cela retournera les données en base64.

    {   “Title”:”DocumentName”,   “content”:”base64string” }