Verwenden Sie zum Austausch von Dateien mit dem Application Server eine POST-Anfrage.
Bevor Sie Dateianfragen senden, stellen Sie eine Verbindung zur Web Services API her. Weitere Informationen finden Sie unter Herstellen einer Verbindung zur Web Services API.
Verwenden Sie POST-Anfragen, um die folgenden Aktionen auszuführen:
| Aktionswert | Beschreibung |
|---|
Load | Dateien vom Server laden. |
Save | Dateien auf dem Server speichern. |
Append | Daten an das Ende einer Datei anhängen. |
Checksum | Eine Prüfsumme für eine Datei vom Server abrufen. Die Prüfsumme wird mit der CRC32-Methode berechnet. |
- Bilder importieren. Bilddateien laden, auch in Teilen, und ihre Prüfsumme abrufen.
- Originalseitenbilder in jeder Phase der Verarbeitung abrufen.
- Mit Anhängen von Batches, Dokumenten und Seiten arbeiten (hochladen und herunterladen).
- Die XML-Beschreibung einer Verifizierungsaufgabe abrufen, das Dokument ändern und die Änderungen auf dem Server speichern.
Verwenden Sie für große Anhänge POST-Anfragen. Große Dateien werden in kleinere Teile aufgeteilt und auf den Server hochgeladen. Wenn Sie eine POST-Anfrage verwenden, um einem Objekt einen Anhang hinzuzufügen, rufen Sie nach der POST-Anfrage die Methode SaveAttachment auf und übergeben Sie als Parameter file eine leere Datei mit dem Namen der übertragenen Datei. Verwenden Sie in allen anderen Fällen die speziell für Anhänge entwickelten Methoden Anhang. Stellen Sie sicher, dass die Anforderungsfelder korrekt ausgefüllt sind.
| Name | Typ | Beschreibung |
|---|
Action | string | Typ der Aktion. Weitere Informationen finden Sie unter Aktionstypen. |
sessionId | int | Sitzungs-ID, die zum Überprüfen der Benutzerberechtigungen verwendet wird. |
projectId | int | Projekt-ID. |
batchId | int | Batch-ID. |
objectType | int | Typ des Objekts auf dem Server. Weitere Informationen finden Sie unter Objekttypen. |
objectId | int | Objekt-ID (eines Dokuments, einer Seite oder einer Aufgabe). |
parentId | int | ID des übergeordneten Dokuments. Geben Sie diese für Dokumentensätze an; verwenden Sie für Dokumente, die nicht Teil eines Dokumentensatzes sind, 0. |
version | int | Dateiversion. |
streamName | string | Name des codierten binären Datenstroms. Weitere Informationen finden Sie unter Stream-Namen. |
blob | — | Binäre Dateidaten (wenn Action Save oder Append ist). |
offset | int | Versatz ab dem Dateianfang, ab dem die Daten angehängt werden (wenn Action Append ist). |
objectType akzeptiert die folgenden Werte:
| Wert | Objekttyp |
|---|
0 | Dokument |
1 | Seite |
5 | Kleine Kopie der Seite, die als Miniaturansicht angezeigt wird (PNG-Datei) |
8 | Task-Anhang (XML-Dokument) |
13 | Datei, auf die alle Benutzer zugreifen können, z. B. eine Endbenutzer-Lizenzvereinbarung |
Objekttyp 8 (Task-Anhang) eignet sich am besten für große Anhänge. Verwenden Sie in allen anderen Fällen die speziell für Anhänge entwickelten Anhänge-Methoden. Setzen Sie für Dateien vom Objekttyp 13 projectId auf 0 und batchId auf 0 — diese Dateien gehören zu keinem Projekt, Batch oder Mandanten. Um eine Datei dieses Typs zu schreiben, muss der Administrator eine Sitzung öffnen. Um eine Datei dieses Typs zu lesen, übergeben Sie sessionId=0; eine Sitzung muss dafür nicht geöffnet werden.
streamName ist der Name des Binärdatenstroms. Verwenden Sie beim Speichern einer Datei auf dem Server die Base64-Kodierung und beim Laden einer Datei vom Server die UrlEncode-Kodierung. Die verfügbaren Werte hängen vom Objekttyp ab.
| Wert | Beschreibung |
|---|
BlackWhiteImage | Das Schwarzweißbild der Seite (PNG-Datei). |
ColorImage | Das Farbbild der Seite (JPG-Datei). |
Preview | Das Vorschaubild der Seite (PNG-Datei). |
Namen von Dokument-Streams
| Value | Description |
|---|
DocumentBody | Ein XML-Dokument, das Dokumentfelder beschreibt. Es wird erstellt, wenn die Aufgabe für die Webstationen vorbereitet wird. Nach der Verifizierung werden die Änderungen im Dokument verarbeitet. Versionen werden nicht unterstützt; setzen Sie den Parameter version auf 0. Speichern Sie die Ergebnisse der Dokumentverarbeitung in dieser Datei. |
Page pageID | pageID ist die ID einer Seite, die von der Methode AddNewPage zurückgegeben wird. Verwenden Sie diesen Stream-Namen, um vor der Vorverarbeitung ein Bild der Quellseite hochzuladen. |
FileName | FileName ist der Name einer Datei, die beim Erstellen des Dokuments mit der Methode AddNewDocument angegeben wird. Verwenden Sie diesen Stream-Namen, um eine mehrseitige Datei mit Bildern von Dokumentseiten hochzuladen. |
RecognizedWords | Ein XML-Dokument, das erkannte Wörter und ihre Koordinaten auf der Seite enthält. |
Verification — Ein XML-Dokument, das eine Verifizierungsaufgabe beschreibt. Es wird beim Vorbereiten der Aufgabe für die Webstationen erstellt. Nach der Verifizierung werden die Änderungen im Dokument verarbeitet. Versionen werden nicht unterstützt; setzen Sie den Parameter version auf 1. Speichern Sie die Verarbeitungsergebnisse der Aufgabe in dieser Datei.VerificationRequest — Entspricht einer der folgenden Anfragen:
- Ein XML-Dokument, das eine Anfrage zum Ausführen von Operationen innerhalb eines Batchs enthält, einschließlich Dokumententrennung und Neuanordnung von Seiten. Diese Art von Anfrage wird von der Webstation für Regelprüfungen verwendet.
- Ein XML-Dokument, das eine Routing-Anfrage enthält.
- Ein XML-Dokument, das eine
LineItems-Extrapolationsanfrage enthält.
- Ein XML-Dokument, das eine Anfrage zur Datenverifizierung enthält.
Der Dateispeicher enthält alle Dateien des Projekts. Der Dateiname codiert den Objekttyp, den Objektbezeichner und den Stream-Namen in der Form <object type>-<object id>-<stream name>version.
Seitendateien (objectType = 1) enthalten Kopien von Bildern, während Dokumentdateien (objectType = 0) Quellbilder enthalten. Aus diesem Grund können Sie ein Bild nicht per POST-Anfrage mit objectType = 1 ändern.
Um eine Datei einer Seite (objectType = 1) mit der ID id=4, streamName=C:\Temp\image.pdf und version=184201843 vom Server zu laden, verwenden Sie die folgende POST-Anfrage:
1-4-C:\Temp\image.pdf184201843
Eine Datei auf dem Server speichern
objectType = 0) mit id=4, projectId=3, batchId=6, version=522 und streamName=C:\Temp\image.pdf auf dem Server zu speichern, verwenden Sie die folgende POST-Anfrage:
resp = FileRequest(
action: "Save",
objectType: 0,
projectId: 3,
batchId: 6,
objectId: 4,
version: 522,
streamName: "C:\Temp\image.pdf",
file: new ByteArrayContent(buffer, 0, readed),
clientCredentials: clientCredentials,
endpointAddress: endpointAddress);
