Saltar al contenido principal
CloudStudio

Obtener el último dato de múltiples Endpoints

Este servicio permite consultar los últimos datos registrados de hasta 5 dispositivos al mismo tiempo, usando una única llamada.

Su uso es principalmente recomendado cuando se precisa mostrar información en tiempo real de varios sensores en simultáneo, evitando hacer una llamada específica para cada uno, lo que redunda en un ahorro de tiempo y reduce el tráfico de red.

Para usar esta función se debe realizar una llamada a la Api a través de una dirección específica y se realiza a través del método GET

GET /api/v2/endpointData/multiple

por un tema de seguridad. para poder realizar el acceso se debe contar con una llave de acceso, que identifique al usuario que realiza la petición. Esta llave es el Access Token y se debe incluir en como parte de la dirección

GET https://gear-dev.cloud.studio/api/v2/endpointData/multiple?accessToken=123456789-1110-0022-3333-987654321012&endpointIds=351031,151040,252340,511088,720510

⚠️ Si falta la llave de acceso o no es válida, la API devuelve un error 500 con el código 8001 en el campo FaultCode. Consulte el apartado Errores para ver el formato de la respuesta.

Los parámetros que se precisan recibir son:

  • LLave de Acceso (Access Token): Clave que indica usuario autorizado.
  • Es de tipo String y es Obligatorio
  • EndpointsIDs: ID de los sensores de los dispositivos separados por coma, para los cuales se quiere recobrar los datos.
  • Es de tipo Lista y es obligatorio
  • NOTA: El límite de endpoints a solicitar por llamado es de 5 (cinco).

⚠️ Si se envían más de 5 endpointIds en la solicitud, la API devuelve un error 500 con el código 100004 en el campo FaultCode, que indica que se superó el límite de endpoints. Consulte el apartado Errores.

Una vez realizada de forma correcta la solicitud se recibe una lista de objetos (JSON). Cada objeto de la lista representará la información de uno de los sensores solicitados.

Respuesta JSON con la lista de endpoints, su descripción, número de secuencia, fecha y valor

La información de la lista es la siguiente:

  • EndpointID: Número de Identificación del sensor consultado
  • Description: Nombre del Sensor consultado
  • SequenceNumber: número secuencial que indica el orden en que se registraron los datos (de utilidad para seguimiento/históricos)
  • TimeStamp_UTC: fecha y hora exacta de registro del lastValue
  • Value: último valor reportado por el sensor

⚠️ Si un endpoint no tiene datos, los campos Value y timeStamp vendrán nulos.

️A tener en cuenta:️ La incorporación de esta funcionalidad afecta a todos los métodos de consulta de datos de endpoint  ya que ahora incluyen el campo description

Está excluído el endpoint de Cámara

Última actualización