Descripción
Este endpoint verifica el estado actual de una tarea de generación de datos enviada previamente. Devuelve el código de estado y otra información adicional, como la cantidad de lotes (para respuestas en formato JSON).
Endpoint
GET https://yourdomain.pharmahrm.com/crm-api/db-function/status/{{job_id}}
Autenticación
Bearer Token (obligatorio)
Solicitud
Encabezados
| Key | Value |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type |
application/json (opcional) |
Parámetro de ruta
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| job_id | integer | Sí | Identificador único de la tarea enviada |
Cuerpo
No se requiere cuerpo de solicitud.
Respuesta exitosa
200 OK
{
"id": 39,
"status": 3,
"batch_count": null
}Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| id | integer | Job ID — identificador de la tarea |
| status | integer | Estado actual de la tarea (ver códigos más abajo) |
| batch_count | integer o null | Cantidad de lotes (solo para JSON; un lote = 500 registros) |
Códigos de estado
| Código | Estado | Descripción |
|---|---|---|
| 1 | Pending (En espera) | La tarea está en cola |
| 2 | Running (En ejecución) | La tarea se está ejecutando |
| 3 | Finished (Finalizada) | La tarea se completó con éxito |
| 4 | Error (Error) | Ocurrió un error durante la ejecución |
Respuesta de error
40x / 50x
{
"message": "Error message string"
}| Código | Descripción |
|---|---|
| 400-499 | Errores del cliente (por ejemplo, job_id no válido) |
| 500–599 | Errores del servidor |