Base de datos documental (DocDB) - Ejemplos de llamadas API REST - Colección Postman

Como ayuda para aquellos que quieren utilizar las funciones de la Base de datos documental (DocDB) dentro de InterSystems IRIS, y específicamente la API REST que proporciona, reuní una Colección Postman que ofrece muestras para varias llamadas básicas.

Por ejemplo:

En el ejemplo se utilizan documentos de "Color", por ejemplo, Rojo, Azul, etc., utilizando una estructura JSON de muestra desde aquí.

La Colección incluye llamadas de diferentes "categorías":

• Crear metadatos: crear la base de datos y las propiedades relacionadas
• Obtener metadatos: entender qué bases de datos y propiedades están definidas
• CUD: crear/actualizar/eliminar documentos
• Buscar y obtener documentos: recuperar documentos según el ID o ciertos valores o criterios
• Eliminar metadatos: eliminar propiedades o bases de datos

El orden de las solicitudes en la Colección tiene cierta lógica interna (por ejemplo, primero crear la base de datos y las propiedades, luego insertar algunos datos y después recuperarlos), pero por supuesto puedes utilizarlos en el orden o los cambios que desees.

El orden también funciona bien si se ejecuta Collection Runner de Postman. Añadí algunos scripts de prueba básicos, que permiten que Postman muestre el estado Aprobado o Fallido para cada llamada.

Por ejemplo:

Ten en cuenta que la última llamada elimina todas las bases de datos de documentos dentro de un Namespace, así que no ejecutes esto a menos que realmente quieras hacerlo... no lo hagas manualmente y tampoco como parte de la ejecución de toda la Colección.

Para conseguir que las llamadas funcionen en varios entornos, utilicé la función variables de Postman.

Esto permite cambiar el nombre/la IP del servidor, el puerto y el namespace -

Así que cada llamada se parece a esto:

Seguramente también necesitarás adaptar la parte de autenticación.

Actualmente tengo "Basic Authentication" simplemente con "SuperUser" y "sys":

 
Solo para añadir un cambio "multimodelo" a esto, aquí también hay un ejemplo de acceso a estos datos a través de SQL:

Esta es la estructura de la tabla (como se ve en la extensión SQL Tools en VSCode):

Este es un resultado SELECT sencillo:

Y aquí hay un SELECT con una cláusula WHERE sobre una de las propiedades que definimos: