Ir a la documentación
DocumentaciónReferencia de la APIConsultar estado de una operación
GETToken Bearer

Consultar estado de una operación

/api/v1/tasks/:taskKey

Consulta el estado persistente de una operación de la organización. state y taskStatus del proveedor tienen significados distintos. Nunca devuelve credenciales ni firmas de billetera.

Los nombres de campos, los tipos y el código de la API se mantienen iguales en todos los idiomas.

Ejemplo de petición

cURL
curl "https://tovahub.com/api/v1/tasks/server%3A507f1f77bcf86cd799439012%3Arestart%3Adocs_example_001" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Solo ejemplos. Esta página no envía peticiones.

Parámetros

taskKeyRuta · Obligatorio

string

Entre 8 y 240 caracteres: letras, dígitos, dos puntos, guion bajo o guion. Use exactamente el taskKey devuelto.

Respuesta

Estado HTTP 200

Consulta el estado persistente de una operación existente de la organización.

taskKeystring

Clave estable de la operación en la plataforma.

actionstring

Nombre de la acción registrada.

statestring ('started' | 'succeeded' | 'failed')

Estado de la operación en la plataforma, distinto del estado de la tarea del proveedor.

pendingboolean

true mientras siga sin resolverse la finalización en la plataforma o en el proveedor.

localFinishPendingboolean

Es true si la solicitud de instantánea está en succeeded, tiene una respuesta guardada y una fecha de finalización válida, no tiene ID de tarea del proveedor y falta completar el cierre local de la aceptación. Usa recover_snapshot con los valores originales de action y requestKey; el GET de la tarea sigue siendo de solo lectura.

taskIdstring | null

Identificador de la tarea del proveedor, si existe.

taskStatusstring | null

Último estado observado de la tarea del proveedor.

errorstring | null

Error registrado sin datos sensibles, si existe.

createdAtstring (ISO 8601)

Fecha y hora de creación de la operación en la plataforma.

finishedAtstring (ISO 8601) | null

Fecha y hora de finalización en la plataforma, si existen.

actorUserIdstring (ObjectId) | null

ID de la cuenta del autor original, o null si falta en el historial. El lector debe ser miembro activo del mismo equipo fijo.