1. Home
  2. Docs
  3. BlizWork API
  4. Datos Maestros
  5. Consulta

Consulta

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": "<Criterios de selección>",
   }
}
ParámetroExplicació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”.
<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”
}.
Explicación de los parámetros requeridos por la llamada.

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:

PlanMáximo de transacciones por segundo
Free0
Básico0,5
Medio1
Avanzado5
Empresa50
CorporativoMáxima capacidad
Estos límites están sujetos a cambio sin previo aviso.
Was this article helpful to you? Yes No

How can we help?

Agregar un comentario

Su dirección de correo no se hará público. Los campos requeridos están marcados *