Get - ABBYY Documentation

Ruft Informationen zu einer Aufgabe anhand der Task-ID ab. Mit dieser Methode können Sie den Status der Aufgabe anhand des Bezeichners prüfen, den Sie beim Starten der Aufgabe erhalten haben.

HTTP-Anfrage

GET https://api-{location-id}.flexicapture.com/v2/task/{id} wobei {location-id} die unterstützte Region ist.

Pfadparameter

Parameter

path, string

Erforderlich. Task-ID.

Antwort

Im Erfolgsfall enthält der Antworttext eine Instanz von CaptureTask.

CaptureTask JSON-Darstellung

{“id”: “string”,“number”: “string”,“verification_id”: “string”,“type”: “ic”,“properties”: {“property_name”: “string”},“email”: “string”,“account”: “string”,“application”: “string”,“created”: “YYYY-MM-DDT00:00:00.000”,“started”: “YYYY-MM-DDT00:00:00.000”,“action_required”: “YYYY-MM-DDT00:00:00.000”,“billed”: “YYYY-MM-DDT00:00:00.000”,“delivered”: “YYYY-MM-DDT00:00:00.000”,“deleted”: “YYYY-MM-DDT00:00:00.000”,“progress”: 0,“status”: “Submitted”,“is_deleted”: true,“is_demo”: true,“is_billed”: true,“documents_count”: 0,“pages_count”: 0,“documents”: [{“files”: {},“data”: {},“is_moved”: true}]}

CaptureTask-Felder


	Erforderlich. Eindeutige Task-ID.
	Erforderlich. Aufgabennummer.
	Erforderlich. Diese ID wird zum Öffnen der Verifizierungsseite verwendet, d. h. https://{cloud-host}/verification/{verification_id}.
	Erforderlich. Typ der Aufgabe. Unterstützte Typen: ic: Rechnungserfassung, dc: Dokumenterfassung.
	Optional. Verarbeitungseinstellungen oder benutzerdefinierte Registrierungsparameter. Beliebige Anzahl von Name-Wert-Paaren.
	Erforderlich. Die E-Mail-Adresse, die zum Erstellen der Aufgabe verwendet wird.
	Erforderlich. Die account-ID, mit der der Task erstellt wird.
	Erforderlich. Die Anwendungs-ID, mit der die Aufgabe erstellt wird.
	Erforderlich. Erstellungsdatum der Aufgabe.
	Optional. Startdatum der Aufgabe.
	Optional. Zeitpunkt, zu dem die Aufgabe den Status WaitForAction erhalten hat.
	Optional. Abrechnungsdatum der Aufgabe.
	Optional. Abschlussdatum der Aufgabe.
	Optional. Löschdatum der Daten.
	Erforderlich. Fortschritt der gesamten Aufgabe.
	Erforderlich. Abschlussstatus der Aufgabe. Verfügbare Statuswerte: Submitted, InProgress, WaitForAction, Done, Failed, Canceled.
	Erforderlich. Gibt an, ob die Aufgabendaten gelöscht wurden oder nicht.
	Erforderlich. Gibt an, ob der Task in der Demo-Anwendung erstellt wurde oder nicht.
	Erforderlich. Gibt an, ob der Task abgerechnet wurde oder nicht.
	Optional. Anzahl der Dokumente in der Aufgabe.
	Optional. Anzahl der Seiten im Task
	Erforderlich. Dokumente der Aufgabe.

	Erforderlich. Liste der mit dem Dokument verknüpften Dateien.
	Optional. Die Daten des Dokuments.
	Erforderlich. Das Dokument wurde während der Verifizierung entfernt.

	Erforderlich. Datei-ID.
	Erforderlich. Zugriffstoken der Datei.
	Erforderlich. Name der Datei.

⌘I