API zum Abrufen von Entwürfen - 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

Einleitung

Ab Version 24.0 oder höher gilt die Verknüpfung von Formeln und Ausdrücken auf den Seiten Entwurf und Dokument beim Öffnen eines bestimmten Elements. Die API zum Abrufen von Entwürfen gibt alle Entwürfe mit eingeschränkter Unterstützung des OData-Filters zurück. Dadurch können Daten gefiltert werden, indem der OData-Filter in die API-URL übergeben wird. Diese API verwendet die GET-Methode für die Rückgabe aller Entwürfe.

Formel/Ausdruck verknüpfen

{baseUrl}/#/{appname}/winforms?procDefId=<procDefId>&lid=<lid>&solutionId=<solutionId>&dataItemId=<dataItemId>&ftype=1&did=<did>&allowAction=true&composerPkgId=<solutionId>&extcont=<extcont>&r=2&type=draft

Wenn der Parameter formView nicht weitergegeben wird, muss abhängig vom Verknüpfungstyp ein neuer Parameter (Typ) zusammen mit dem zugewiesenen Wert hinzugefügt werden.
Beispiel: &Typ=Entwurf muss am Ende des Entwurfslinks angehängt werden.

Anforderungs- und Antworttext

Die API gibt bei Antworten alle Entwürfe mit eingeschränkter Unterstützung für den OData-Filter im folgenden Format zurück

Datenvertrag Antwort

Abfrageparameter
Name Beschreibung Typ
procDefId Prozessdefinitions-ID GUID
Deckel Bibliotheks-ID GUID
solutionId Lösungs-ID GUID
dataItemId Datenelement-ID GUID
ftype Formulartyp (Festwert: 1) Ganzzahl
did Entwurfs-ID GUID
allowAction

Aktion zulassen (Wert: true)

Wenn die Benutzeraktion „Alle“ ist, ist der Wert „True“, anderenfalls ist er „False“.

Keine = 0, Neu zuweisen = 1, AutoApprove = 2, Alle = 65536

Boolesch
composerPkgId Composer-Paket-ID (Wert identisch mit solutionId) GUID
extcont

Hat externen Inhalt

Legt fest, ob dem Workflow eine externe Datei hinzugefügt wurde.

Boolesch
r Referer (Festwert: 2) Ganzzahl
Typ Typ (Festwert: Entwurf) Zeichenfolge

Anforderungs- und Antwortbeispiel

Anforderungsbeispiele mit ODATA-Filtern:
  1. So erhalten Sie alle Entwürfe
    {{RoutePrefix}}/api/v1/Processextn/GetDrafts
  2. So erhalten Sie Entwürfe mit einer bestimmten Entwurfs-ID:
    {{RoutePrefix}}/api/v1/Processextn/GetDrafts?$filter=did eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b
  3. So erhalten Sie Entwürfe mit einer bestimmten Lösungs-ID:
    {{RoutePrefix}}/api/v1/Processextn/GetDrafts?$filter=solutionId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b
  4. So erhalten Sie Entwürfe mit einer bestimmten Bibliotheks-ID:
    {{RoutePrefix}}/api/v1/Processextn/GetDrafts?$filter=lid eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b
  5. So erhalten Sie alle Entwürfe mit einem bestimmten Namen:
    {{RoutePrefix}}/api/v1/Processextn/GetDrafts?$filter=name eq Testdrafts

Fehler

[{"ErrorCode":"SOMETHING_WENT_WRONG_ADMIN","Message":"An error has occured on the server","errorPrameters":null}]