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}

Ersetzen Sie {location-id} durch Ihre unterstützte Region.

Pfadparameter

Parameter	Typ	Beschreibung
`id`	path, string	Erforderlich. Aufgaben-ID.

Antwort

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

{
  "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

Feld	Typ	Beschreibung
`id`	string	Erforderlich. Eindeutige Aufgaben-ID.
`number`	string	Erforderlich. Aufgabennummer.
`verification_id`	string	Erforderlich. Diese ID wird verwendet, um die Verifizierungsseite zu öffnen: `https://{cloud-host}/verification/{verification_id}`.
`type`	string	Erforderlich. Aufgabentyp. Unterstützte Typen: `ic`: Rechnungserfassung, `dc`: Dokumenterfassung.
`properties`	object	Optional. Verarbeitungseinstellungen oder benutzerdefinierte Registrierungsparameter. Beliebig viele Name-Wert-Paare.
`email`	string	Erforderlich. Die zum Erstellen der Aufgabe verwendete E-Mail-Adresse.
`account`	string	Erforderlich. Die zum Erstellen der Aufgabe verwendete Konto-ID.
`application`	string	Erforderlich. Die zum Erstellen der Aufgabe verwendete Application ID.
`created`	string ($date-time)	Erforderlich. Erstellungsdatum der Aufgabe.
`started`	string ($date-time)	Optional. Startdatum der Aufgabe.
`action_required`	string ($date-time)	Optional. Datum, an dem die Aufgabe den Status `WaitForAction` erhalten hat.
`billed`	string ($date-time)	Optional. Abrechnungsdatum der Aufgabe.
`delivered`	string ($date-time)	Optional. Abschlussdatum der Aufgabe.
`deleted`	string ($date-time)	Optional. Datum der Datenlöschung.
`progress`	number ($double)	Erforderlich. Gesamtfortschritt der Aufgabe.
`status`	string	Erforderlich. Abschlussstatus der Aufgabe. Verfügbare Status: `Submitted`, `InProgress`, `WaitForAction`, `Done`, `Failed`, `Canceled`.
`is_deleted`	boolean	Erforderlich. Gibt an, ob die Aufgabendaten gelöscht wurden.
`is_demo`	boolean	Erforderlich. Gibt an, ob die Aufgabe in der Demo application erstellt wurde.
`is_billed`	boolean	Erforderlich. Gibt an, ob die Aufgabe abgerechnet wurde.
`documents_count`	integer ($int32)	Optional. Anzahl der Dokumente in der Aufgabe.
`pages_count`	integer ($int32)	Optional. Anzahl der Seiten in der Aufgabe.
`documents[]`	object (DataCaptureDocumentModel)	Erforderlich. Dokumente in der Aufgabe.

DataCaptureDocumentModel

Feld	Typ	Beschreibung
`files`	object (DataCaptureFileLinkModel)	Erforderlich. Liste der mit dem Dokument verknüpften Dateien.
`data`	string	Optional. Dokumentdaten.
`is_moved`	boolean	Erforderlich. Das Dokument wurde während der Verifizierung entfernt.

DataCaptureFileLinkModel

Feld	Typ	Beschreibung
`id`	string	Erforderlich. Datei-ID.
`token`	string	Erforderlich. Zugriffstoken der Datei.
`name`	string	Erforderlich. Dateiname.

​HTTP-Anfrage

​Pfadparameter

​Antwort

​CaptureTask

​DataCaptureDocumentModel

​DataCaptureFileLinkModel