Endpoints Cargue de Modelo
Requisitos
Autenticación:
Solo los usuarios autenticados pueden realizar estas operaciones.
Métodos Disponibles:
- Cargue de datos desde un fichero CSV.
- Cargue de datos mediante el envío de un listado.
- Eliminación de datos.
Endpoints Disponibles
Método por Envío de un Listado
Endpoint: POST /api/campaigns/{campaignId}/leadmodels/load
Este método permite cargar datos en la matriz del modelo enviando un listado de datos en el cuerpo de la solicitud.
Parámetros de Entrada
Path Parameters:
campaignId(String): ID de la campaña donde se cargará la matriz del modelo. Obligatorio.
Body Parameters (Array):
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| keyModel | String | Llave del modelo | Sí |
| category | String | Categoría de la llave (ejemplo: C, D) | Sí |
| probability | Numeric | Valor de la probabilidad | Sí |
Parámetros de Salida y Respuesta
El endpoint devuelve los siguientes posibles estados HTTP estándar y un array con la respuesta de inserción de cada lead enviado:
- 200 OK: La petición se ejecutó correctamente.
- 422 Unprocessable Entity: Error en la petición. Devuelve un objeto con el registro que posee el error:
Parámetro Tipo Descripción Obligatorio keyModel String ID de la llave con error Sí code String Código del error Sí message String Mensaje o código de respuesta en caso de error Sí - 500 Internal Server Error: Error interno del servidor. No devuelve cuerpo de respuesta.
Ejemplo de la Petición
Request: POST /api/campaigns/{campaignId}/leadmodels/load
Body Request:
[
{
"keyModel": "model_001",
"category": "C",
"probability": 0.85
},
{
"keyModel": "model_002",
"category": "D",
"probability": 0.75
}
]
Response:
-
HTTPS Status 200
[
{
"keyModel": "model_001",
"status": "success"
},
{
"keyModel": "model_002",
"status": "success"
}
] -
HTTPS Status 422
{
"keyModel": "model_001",
"code": "invalid_category",
"message": "La categoría proporcionada no es válida."
} -
HTTPS Status 500 No Body Response