Este método permite obtener todos o parte de los registros almacenados en una Base de Datos Maestra.
Endpoint (Método y URI)
POST https://api.blizwork.com/master-data/<token>
Llamado
{
"userId": "<Id. del usuario autorizado>",
"table": "<Tabla a consultar>",
"filter": <Objeto con criterios de selección>
}
Parámetro | Explicación |
---|---|
<Id. del usuario autorizado> | Identificación (email) de un usuario autorizado a ejecutar esta consulta. Ejemplo: “usuario@organizacion.com”. |
<Tabla a consultar> | El nombre de la tabla desde la cual extraer los registros. La tabla debe estar creada previamente. Ejemplo: “Productos”. |
<Objeto con criterios de selección> | Opcional. La condición que deben cumplir los registros que se seleccionen. En caso que se incluya, debe cumplir con la sintaxis de selección de Mongo DB. Se puede incluir operadores lógicos como $and y $or. Ejemplo: { “Código”: 127, “Estado”: “Cerrado” }. |
Respuesta
{
"resultCode": 0,
"resultMessage": "<Mensaje>",
"payload": [
{
"Código": 123,
"Descripción": "Producto de prueba",
"Estado": "Abierto"
}
]
}
- 0: Operación realizada exitosamente.
- 1: Token inválido o expirado.
Notas
- En payload se entregará la lista de registros que cumplen con la condición de selección especificada.
- Si no se especifica una condición de selección, se recibirán todos los registros de la tabla. Se debe considerar el volumen de estos datos.
- Si ningún registro cumple con la condición indicada o si la tabla está vacía, se entregará una lista vacía: [].
Límites
Este método tiene los siguientes límites de consumo:
Plan | Máximo de transacciones por segundo |
---|---|
Free | 0 |
Básico | 0,5 |
Medio | 1 |
Avanzado | 5 |
Empresa | 50 |
Corporativo | Máxima capacidad |