Saltar al contenido principal
Devuelve información sobre la tarea mediante el ID de la tarea. Con este método, puede comprobar el estado de la tarea usando el identificador que recibió al iniciarla.

​
Solicitud HTTP

GET https://api-{location-id}.flexicapture.com/v2/task/{id}
Reemplace {location-id} por la ubicación compatible.

​
Parámetros de ruta

ParámetroTipoDescripción
idpath, stringObligatorio. ID de la tarea.

​
Respuesta

Si la solicitud se procesa correctamente, el cuerpo de la respuesta contiene una instancia 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

CampoTipoDescripción
idstringObligatorio. ID único de la tarea.
numberstringObligatorio. Número de tarea.
verification_idstringObligatorio. Este ID se utiliza para abrir la página de verificación, es decir, https://{cloud-host}/verification/{verification_id}.
typestringObligatorio. Tipo de tarea. Tipos admitidos: ic: captura de facturas, dc: captura de documentos.
propertiesobjectOpcional. Configuración de procesamiento o parámetros de registro personalizados. Cualquier cantidad de pares nombre-valor.
emailstringObligatorio. Dirección de correo electrónico utilizada para crear la tarea.
accountstringObligatorio. ID de la cuenta utilizado para crear la tarea.
applicationstringObligatorio. ID de la aplicación utilizado para crear la tarea.
createdstring ($date-time)Obligatorio. Fecha de creación de la tarea.
startedstring ($date-time)Opcional. Fecha de inicio de la tarea.
action_requiredstring ($date-time)Opcional. Fecha en la que la tarea pasó al estado WaitForAction.
billedstring ($date-time)Opcional. Fecha de facturación de la tarea.
deliveredstring ($date-time)Opcional. Fecha de finalización de la tarea.
deletedstring ($date-time)Opcional. Fecha de eliminación de los datos.
progressnumber ($double)Obligatorio. Progreso general de la tarea.
statusstringObligatorio. Estado de finalización de la tarea. Estados disponibles: Submitted, InProgress, WaitForAction, Done, Failed, Canceled.
is_deletedbooleanObligatorio. Especifica si se eliminaron los datos de la tarea.
is_demobooleanObligatorio. Especifica si la tarea se creó en la aplicación demo.
is_billedbooleanObligatorio. Especifica si la tarea se facturó.
documents_countinteger ($int32)Opcional. Número de documentos de la tarea.
pages_countinteger ($int32)Opcional. Número de páginas de la tarea.
documents[]object (DataCaptureDocumentModel)Obligatorio. Documentos de la tarea.

​
DataCaptureDocumentModel

CampoTipoDescripción
filesobjeto (DataCaptureFileLinkModel)Obligatorio. Lista de archivos vinculados al documento.
datacadenaOpcional. Datos del documento.
is_movedbooleanoObligatorio. El documento se eliminó durante la verificación.

​
DataCaptureFileLinkModel

CampoTipoDescripción
idstringObligatorio. ID del archivo.
tokenstringObligatorio. Token de acceso al archivo.
namestringObligatorio. Nombre del archivo.