Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

...

titleADVERTENCIA

...

Estamos actualizando la documentación de esta API.

Introducción

Para desarrollar una aplicación cliente en Javascript, debes tener previamente los siguientes archivos JS en el directorio de la aplicación:

...

  • Join
  • Query
  • Insert
  • Update
  • UpdateById
  • Remove
  • RemoveById
  • Subscriptions

JOIN

La operación Join será la primera acción que se haga, porque permite conectarse al IoTClient definido. Si todo está bien, devolverá la sessionKey, identificando la sesión actual.




QUERY

La operación Query permite obtener los datos que se almacenaron y asociaron a una ontología determinada. Debes especificar la ontología asociada a la plantilla IoTClient/deviceTemplate en el ControlPanel.

...

TO-DO (EJEMPLO UPDATE/DELETE)


INSERT

La operación Insert permite insertar nuevos datos en la ontología. Asegúrate de que los datos tienen la estructura definida en el Esquema JSON de la ontología. De lo contrario no pasará la validación del Esquema. Para asegurarse de que el formato es correcto, la mejor opción es copiarlo directamente del Esquema de la Ontología (Ontology Schema), que devuelve el id de la instancia insertada.

...

Esta operación devolverá el ID (o los IDs en caso de que los datos sean un array), que podrás utilizar más tarde para realizar operaciones 'por id'.

...


UPDATE

Para actualizar una instancia existente, puede actualizar toda la instancia o actualizar los campos seleccionados.

...

En el segundo caso, puedes usar la función 'update'. Esta función sólo acepta consultas nativas. Si quieres hacer actualizaciones SQL, usa la función query.


DELETE

Si quieres borrar una sola instancia, puedes usar 'removeById'.

...

Por otro lado, si quieres eliminar todas las instancias que coincidan con un filtro en particular, usa la función 'remove'. Esta función, al igual que la de update, sólo acepta queries nativas.


SUBSCRIPTIONS

Este API te permite suscribirte a una Ontología. Al suscribirte, cualquier inserción/actualización relacionada con la ontología suscrita, se notificará a tu cliente, causando una ejecución de tu función de callback definidapasada para manejar las notificaciones de suscripción.

...