Descripción
Este endpoint inicia una tarea de generación de datos. La solicitud admite parámetros opcionales y permite obtener resultados en formato JSON o CSV. El sistema procesa la solicitud de forma asíncrona y devuelve un identificador de tarea (job ID) para su seguimiento.
Endpoint
POST https://yourdomain.pharmahrm.com/crm-api/db-function/run
Autenticación
Bearer Token (obligatorio)
Solicitud
Encabezados
| Clave | Valor |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type | application/json |
Cuerpo de la solicitud
{
"function": "api_get_tasks",
"format": "csv",
"arguments": {
"id": "123"
}
}
Parámetros
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| function | string | Sí | Método del backend que genera los datos (por ejemplo, api_get_tasks) |
| format | string | Sí | Formato de respuesta: json o csv |
| arguments | objects | No | Parámetros opcionales necesarios para funciones específicas |
Respuestas
Respuesta exitosa
200 OK
{
"job_id": 39
}
| Campo | Tipo | Descripción |
|---|---|---|
| job_id | integer | Identificador único de la tarea de generación de datos |
Use este job_id para obtener el estado de la tarea y descargar los resultados a través de otros endpoints.
Errores
4xx / 5xx
{
"message": "Error message string"
}
| Código | Descripción |
|---|---|
| 400 - 499 | Errores del cliente (por ejemplo, datos incorrectos) |
| 500 - 599 | Errores del servidor |