Passer au contenu principal
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ètreTypeDescription
idpath, stringObligatoire. 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

champTypeDescription
idstringObligatoire. ID de tâche unique.
numberstringObligatoire. Numéro de tâche.
verification_idstringObligatoire. Cet ID est utilisé pour ouvrir la page de vérification, c’est-à-dire https://{cloud-host}/verification/{verification_id}.
typestringObligatoire. Type de tâche. Types pris en charge : ic : capture de factures, dc : capture de documents.
propertiesobjectFacultatif. Paramètres de traitement ou paramètres d’enregistrement personnalisés. Nombre quelconque de paires nom-valeur.
emailstringObligatoire. L’adresse e-mail utilisée pour créer la tâche.
accountstringObligatoire. L’ID de compte utilisé pour créer la tâche.
applicationstringObligatoire. L’ID d’application utilisé pour créer la tâche.
createdstring ($date-time)Obligatoire. Date de création de la tâche.
startedstring ($date-time)Facultatif. Date de début de la tâche.
action_requiredstring ($date-time)Facultatif. Date à laquelle la tâche a reçu le statut WaitForAction.
billedstring ($date-time)Facultatif. Date de facturation de la tâche.
deliveredstring ($date-time)Facultatif. Date de fin de la tâche.
deletedstring ($date-time)Facultatif. Date de suppression des données.
progressnumber ($double)Obligatoire. Progression globale de la tâche.
statusstringObligatoire. Statut d’achèvement de la tâche. Statuts disponibles : Submitted, InProgress, WaitForAction, Done, Failed, Canceled.
is_deletedbooleanObligatoire. Indique si les données de la tâche ont été supprimées.
is_demobooleanObligatoire. Indique si la tâche a été créée dans l’application de démonstration.
is_billedbooleanObligatoire. Indique si la tâche a été facturée.
documents_countinteger ($int32)Facultatif. Nombre de documents dans la tâche.
pages_countinteger ($int32)Facultatif. Nombre de pages dans la tâche.
documents[]object (DataCaptureDocumentModel)Obligatoire. Documents inclus dans la tâche.

​
DataCaptureDocumentModel

champTypeDescription
filesobject (DataCaptureFileLinkModel)Obligatoire. Liste des fichiers liés au document.
datastringFacultatif. Données du document.
is_movedbooleanObligatoire. Le document a été retiré lors de la vérification.

​
DataCaptureFileLinkModel

champTypeDescription
idstringObligatoire. ID de fichier.
tokenstringObligatoire. Jeton d’accès au fichier.
namestringObligatoire. Nom du fichier.