| Änderungstyp | Beschreibung |
|---|---|
| Eingeführt in Version 24.0 | API zum Abrufen von Dokumenten |
Über die API zum Abrufen von Dokumenten
Verknüpfen von Formeln/Ausdrücken auf den Seiten Entwurf und Dokument beim Öffnen eines bestimmten Elements. Die API zum Abrufen von Dokumenten gibt alle Dokumente 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 Dokumente.
Formel/Ausdruck verknüpfen
{baseUrl}/#/{appname}/winforms?procDefId=<procDefIdValue>&name=<name>&lid=<lid>&readOnly=<readOnly>&solutionId=<solutionId>&dataItemId=<dataItemId>&ftype=11&composerPkgId=<solutionId>&extcont=<extcont>&pid=<pid>&r=-1&v=<v>&type=documentWenn der Parameter formView nicht weitergegeben wird, muss abhängig vom Verknüpfungstyp ein neuer Parameter (Typ) zusammen mit dem zugewiesenen Wert hinzugefügt werden.
Anforderungs- und Antworttext
Die API gibt als Antworten alle Entwürfe mit eingeschränkter Unterstützung für den OData-Filter im folgenden Format zurück.
Datenvertrag Anforderung
Abfrageparameter| Name | Beschreibung | Typ |
| composerPkgId | Composer-Paket-ID (Wert identisch mit solutionId) | GUID |
| dataItemId | Datenelement-ID | GUID |
| extcont |
Hat externen Inhalt Legt fest, ob dem Workflow eine externe Datei hinzugefügt wurde. |
Boolesch |
| ftype | Formulartyp (Festwert: 11) | Ganzzahl |
| Deckel | Bibliotheks-ID | GUID |
| Name | Name | Zeichenfolge |
| pid | Prozess-ID | GUID |
| procDefId | Prozessdefinitions-ID | GUID |
| r | Referer (Festwert: -1) | Ganzzahl |
| readOnly | Schreibgeschützte Zeichenfolge | Boolesch |
| solutionId | Lösungs-ID | GUID |
| Typ | Typ (Festwert: Dokument) | Zeichenfolge |
| v | Datendateiversion | Ganzzahl |
Anforderungs- und Antwortbeispiel
Anforderungsbeispiele mit ODATA-Filtern:
- So erhalten Sie alle Dokumente
{{RoutePrefix}}/api/v1/Processextn/GetDocuments - So erhalten Sie Dokumente mit einer bestimmten Prozess-ID
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter=pid eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b - So erhalten Sie Dokumente mit einer bestimmten Composer-Paket-ID
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter= composerPkgId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b - So erhalten Sie Dokumente mit einer bestimmten Datenelement-ID
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter= dataItemId eq 7e8b0239-c81e-4d9f-965c-fa8932c4fa2b - So erhalten Sie alle Dokumente mit einem bestimmten Namen
{{RoutePrefix}}/api/v1/Processextn/GetDocuments?$filter=name eq testDoc
[{"ErrorCode":"SOMETHING_WENT_WRONG_ADMIN","Message":"An error has occured on the server","errorPrameters":null}]