Get

Récupère les informations sur une tâche à partir de son ID. Avec cette méthode, vous pouvez vérifier le statut de la tâche à l’aide de l’identifiant reçu au démarrage de la tâche.

Requête HTTP

GET https://api-{location-id}.flexicapture.com/v2/task/{id}

Remplacez {location-id} par votre région prise en charge.

Paramètres de chemin d’accès

Paramètre	Type	Description
`id`	path, string	Obligatoire. ID de tâche.

Réponse

En cas de succès, le corps de la réponse contient une instance de 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

champ	Type	Description
`id`	string	Obligatoire. ID de tâche unique.
`number`	string	Obligatoire. Numéro de tâche.
`verification_id`	string	Obligatoire. Cet ID est utilisé pour ouvrir la page de vérification, c’est-à-dire `https://{cloud-host}/verification/{verification_id}`.
`type`	string	Obligatoire. Type de tâche. Types pris en charge : `ic` : capture de factures, `dc` : capture de documents.
`properties`	object	Facultatif. Paramètres de traitement ou paramètres d’enregistrement personnalisés. Nombre quelconque de paires nom-valeur.
`email`	string	Obligatoire. L’adresse e-mail utilisée pour créer la tâche.
`account`	string	Obligatoire. L’ID de compte utilisé pour créer la tâche.
`application`	string	Obligatoire. L’ID d’application utilisé pour créer la tâche.
`created`	string ($date-time)	Obligatoire. Date de création de la tâche.
`started`	string ($date-time)	Facultatif. Date de début de la tâche.
`action_required`	string ($date-time)	Facultatif. Date à laquelle la tâche a reçu le statut WaitForAction.
`billed`	string ($date-time)	Facultatif. Date de facturation de la tâche.
`delivered`	string ($date-time)	Facultatif. Date de fin de la tâche.
`deleted`	string ($date-time)	Facultatif. Date de suppression des données.
`progress`	number ($double)	Obligatoire. Progression globale de la tâche.
`status`	string	Obligatoire. Statut d’achèvement de la tâche. Statuts disponibles : `Submitted`, `InProgress`, `WaitForAction`, `Done`, `Failed`, `Canceled`.
`is_deleted`	boolean	Obligatoire. Indique si les données de la tâche ont été supprimées.
`is_demo`	boolean	Obligatoire. Indique si la tâche a été créée dans l’application de démonstration.
`is_billed`	boolean	Obligatoire. Indique si la tâche a été facturée.
`documents_count`	integer ($int32)	Facultatif. Nombre de documents dans la tâche.
`pages_count`	integer ($int32)	Facultatif. Nombre de pages dans la tâche.
`documents[]`	object (DataCaptureDocumentModel)	Obligatoire. Documents inclus dans la tâche.

DataCaptureDocumentModel

champ	Type	Description
`files`	object (DataCaptureFileLinkModel)	Obligatoire. Liste des fichiers liés au document.
`data`	string	Facultatif. Données du document.
`is_moved`	boolean	Obligatoire. Le document a été retiré lors de la vérification.

DataCaptureFileLinkModel

champ	Type	Description
`id`	string	Obligatoire. ID de fichier.
`token`	string	Obligatoire. Jeton d’accès au fichier.
`name`	string	Obligatoire. Nom du fichier.

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

Requête HTTP

Paramètres de chemin d’accès

Réponse

CaptureTask

DataCaptureDocumentModel

DataCaptureFileLinkModel

​Requête HTTP

​Paramètres de chemin d’accès

​Réponse

​CaptureTask

​DataCaptureDocumentModel

​DataCaptureFileLinkModel

Requête HTTP

Paramètres de chemin d’accès

Réponse

CaptureTask

DataCaptureDocumentModel

DataCaptureFileLinkModel