Zum Hauptinhalt springen
Ein typisches Szenario für die Verarbeitung von Dokumenten mit separaten API-Aufrufen (zum Erstellen eines Vorgangs, Hochladen einer Datei und Starten eines Vorgangs) umfasst die folgenden Schritte:
  1. Abrufen einer Liste aller verfügbaren Skills
  2. Erstellen eines leeren Vorgangs
  3. Hinzufügen eines Satzes von Dateien, die im Vorgang verarbeitet werden sollen
  4. Starten des Vorgangs
  5. Überwachen des Vorgangsstatus
  6. Herunterladen von Quelldateien und Ergebnisdateien
Jede Anfrage an den Server muss Authentifizierungsinformationen enthalten (z. B. ein Zugriffstoken). Weitere Informationen finden Sie unter Authentication.

​
Eine Liste aller verfügbaren Skills abrufen

Senden Sie dazu eine GET-Anfrage an die Ressource skills: 
GET https://your-server/api/publicapi/v1/skills
Führen Sie den folgenden Befehl aus: Unter Windows: 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
Als Ergebnis erhalten Sie Informationen zu allen der Anwendungsinstanz hinzugefügten Skills.

​
Einen leeren Vorgang erstellen

Senden Sie dazu die folgende POST-Anfrage an die Ressource transactions: 
POST https://your-server/api/publicapi/v1/transactions
Führen Sie den folgenden Befehl aus: Für Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"
Unter Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'
Geben Sie im Body der Anfrage den Parameter skillId an, der vom vorherigen API-Aufruf zurückgegeben wurde. Als Ergebnis erhalten Sie eine Antwort, die die id der erstellten Transaction enthält.

​
Hinzufügen eines Dateisatzes, der im Vorgang verarbeitet werden soll

Wichtig! Die maximale Anzahl von Dateien in einem Vorgang beträgt 1000. Ein Dateisatz kann auf zwei Arten hinzugefügt werden:

​
Dateien direkt zur Transaction hinzufügen

Senden Sie dazu eine POST-Anfrage an die Ressource transactions/<transaction-id>/files: 
POST https://ihr-server/api/publicapi/v1/transactions/transaction-id/files
Senden Sie im Body der Anforderung die zu verarbeitende Datei. Details zu den verfügbaren Parametern zur Anpassung von Dateien finden Sie in der API Reference. Führen Sie den folgenden Befehl aus: Für Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Unter Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Als Ergebnis erhalten Sie eine Antwort mit einer Liste der hinzugefügten Dateien und deren Identifikatoren. Sie können beliebig viele Dateien hinzufügen, indem Sie diesen Aufruf mehrfach wiederholen. Zusätzliche Optionen zum Hochladen von Dateien:

​
Dateien zu einem Dokument hinzufügen

Erstellen Sie zunächst ein Document, indem Sie eine POST-Anfrage an die Ressource transactions/<transaction-id>/documents senden: 
POST https://ihr-server/api/publicapi/v1/transactions/transaction-id/documents
Unter Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"
Unter Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'
Als Ergebnis erhalten Sie eine Antwort mit der Document-ID. Fügen Sie anschließend dem Document Dateien hinzu, indem Sie eine POST-Anfrage an die Ressource transactions/<transaction-id>/documents/<document-id>/sourceFiles senden: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles
Unter Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Für Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

​
Starten des Vorgangs

Um den Vorgang mit dem angegebenen Skill und den Dateien zu starten, senden Sie die folgende POST-Anfrage an die Ressource transactions/<transaction-id>/start: 
POST https://your-server/api/publicapi/v1/transactions/vorgang-id/start
Unter Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

​
Überwachung des Vorgangsstatus

Um den Vorgangsstatus zu überwachen, verwenden Sie eine Schleife mit kurzem Timeout (prüfen Sie den Status nicht häufiger als einmal pro Sekunde) und senden Sie eine GET-Anfrage an die Ressource transactions/<transaction_id> mit dem Vorgangsbezeichner in der Anforderungs-URI: 
GET https://ihr-server/api/publicapi/v1/transactions/transaction-id
Unter Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
Als Ergebnis erhalten Sie eine Antwort mit dem Status des Vorgangs. Die Verarbeitung des Vorgangs kann einen der folgenden Status haben:
  • New. Der Vorgang wurde erstellt, aber noch nicht zur Verarbeitung in die Warteschlange eingereiht.
  • Queued. Der Vorgang ist zur Verarbeitung in der Warteschlange.
  • InProgress. Der Vorgang wird verarbeitet.
  • Processed. Der Vorgang wurde erfolgreich verarbeitet.
  • ProcessedWithWarnings. Der Vorgang wurde verarbeitet, es sind jedoch Warnungen aufgetreten.
  • NotProcessed. Der Vorgang wurde aufgrund eines Fehlers nicht verarbeitet.
  • Deleted. Der Vorgang wurde vom Benutzer oder automatisch durch die Aufbewahrungsrichtlinie gelöscht.
Wenn der Status des Vorgangs Processed oder ProcessedWithWarnings ist, fahren Sie mit Schritt 6 fort.

​
Quelldateien herunterladen

Um eine Liste von Dokumenten mit ihren Bezeichnern abzurufen, senden Sie eine GET-Anfrage an die Ressource transactions/<transaction-id>/documents und geben Sie die Vorgangs-ID an: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Unter Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'
Als Ergebnis erhalten Sie eine Liste aller Dokumente, die innerhalb dieses Vorgangs erstellt wurden. Die Antwort enthält außerdem die Kennungen dieser Dokumente, die benötigt werden können, um detaillierte Informationen zu bestimmten Dokumenten anzufordern. Um eine Liste der Dateien anzufordern, die einem bestimmten Dokument hinzugefügt wurden, senden Sie eine GET-Anfrage an die Ressource transactions/<transaction-id>/documents/<document-id>: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id
Für Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer token'
Als Ergebnis erhalten Sie Informationen zum Dokument. Die Antwort enthält außerdem die Kennungen der dem Dokument hinzugefügten Dateien. Um die Quelldatei herunterzuladen, senden Sie eine GET-Anfrage an die Ressource transactions/<transaction-id>/files/<file-id>/download: 
GET https://Ihr-Server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Unter Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
Für Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'