API zum Abrufen von Dokumentdaten nach Prozess - Automate_Evolve - Automate_Studio_Manager - Latest

Benutzerhandbuch zu Automate Evolve

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Evolve
Automate > Automate Studio Manager
Version
Latest
Language
Deutsch
Product name
Automate Evolve
Title
Benutzerhandbuch zu Automate Evolve
Copyright
2024
First publish date
2018
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T16:24:42.750458

Die API zum Abrufen von Dokumentdaten nach Prozess gibt die aktuelle Version des Prozessdokuments für die angegebene Prozess-ID zurück. Diese API verwendet die GET- Methode für die Rückgabe der aktuellen Version des Prozessdokuments.

Übersicht über die API

  1. Bei formularbasierten Prozessen wird das Formulardokument gemäß dem für den Parameter „Format“ angegebenen Wert im JSON- oder XML-Format zurückgegeben. Wenn das Format nicht angegeben ist, betrachtet die Anwendung das JSON-Format als Standardformat.

  2. Beim Excel-Workflow wird das Dokument immer im Excel-Format zurückgegeben.

Anforderungs- und Antwortbeispiel

Die API gibt die aktuelle Version des Prozessdokuments für die angegebene Prozess-ID zurück. Die Anforderung und die Antwort sind wie folgt strukturiert:

Datenvertrag Anforderung:

Kein Anforderungstext erforderlich

Im Folgenden sind die Parameter für die Anforderungs-URL aufgeführt.

  • DocumentType: Dies kann Excel/Formular sein.

  • ProcessID: Dies ist die GUID des Prozesses.

  • Ergebnisformat (optional): Dies kann JSON oder XML sein. Funktioniert nur bei Formulardokumenten.

Im Folgenden finden Sie Beispiele für Anforderungen:

Beispiel 1

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

Beispiel 2

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

Beispiel 3

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

Datenvertrag Antwort:

  1. Formularlösung (JSON-Format):

    Daten in Formularfeldern (wie in der Formularlösung hinzugefügt) würden im JSON-Format zurückgegeben, wie unten gezeigt:

    {     "my:myFields":      {         <<Form Data in json as per Form solution feilds added to the Form solution.>>           } }
  2. Formularlösung (XML-Format):

    Daten in Formularfeldern (wie in der Formularlösung hinzugefügt) würden im XML-Format zurückgegeben, wie unten gezeigt:

    "<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\">

    Formulardaten in XML gemäß den Feldern der Formularlösung, die der Formularlösung hinzugefügt wurden.

    </my:myFields>
  3. Excel-Lösung:

    Dadurch werden die Daten Im Base64-Format zurückgegeben:

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