API de Mapeo de Instancia

API de Mapeo de Instancia

La API permitirá mapear las siguientes variables dentro del entorno:

Client ID / Client Description / Facility ID / Facility Description / Device ID / Device Description / Address / Endpoint ID / Endpoint Description.

Nota:

La API tiene una limitación de un máximo de 500 registros (si no se especifica, utilizará 100) para no afectar la performance de entorno con lo cual se deberá ejecutar varias veces para mapear la totalidad de la instancia.

El usuario puede ejecutar el servicio de la siguiente manera:

GET/api/v2/instance/mapping/{SequenceNumber}?accessToken={accessToken}

Parámetros

1. SequenceNumber = Numero de secuencia. Comienza en 0.
2. accessToken = Access Token de Administrador Global
3. MaxFetchItems = Cantidad máxima de elementos a obtener (Opcional. Default 100, Máximo 500)

Observaciones:

La cantidad de elementos que se obtenga podrá ser mayor ya que la Api devolverá las entidades dueñas de cada entidad, en el orden (Client, Facility, Device, Enpoint) y, debido a esto, los elementos pueden repetirse entre ejecuciones.

Teoría de operación

Para obtener una lista de detalle de la instancia (Endpoint, Device, Facility, Client) en forma incremental, se utiliza el campo SequenceNumber. Este campo es de tipo monotónico ascendente es decir que, al darse cambios en alguna de las entidades, su campo SequenceNumber cambiará a un valor mayor al de cualquier otra Entidad. Esto permite obtener datos basados en el SequenceNumber, en pequeños lotes, hasta que no se obtengan más datos, y luego continuar periódicamente, para obtener actualizaciones. Cuando el resultado de esta API es una lista vacía, esto significa que por el momento no existen actualizaciones.

Típicamente, una aplicación que consume esta API utiliza el siguiente flujo:

1. La aplicación comienza utilizando un SequenceNumber almacenado (típicamente en almacenamiento no volátil). En la primera ejecución, este valor es 0.
2. La aplicación ejecuta la API utilizando el (SequenceNumber almacenado 0).
3. La aplicación recibe una lista de entidades, y el ultimo SequenceNumber.
4. Si la lista recibida está vacía, la aplicación espera algunos segundos, y vuelve al paso 2.
5. Si la lista recibida no es vacía, la aplicación almacena el SequenceNumber recibido.
6. La aplicación vuelve inmediatamente al paso 2.
7. Cuando se crea una nueva entidad, o una existente es modificada, su SequenceNumber cambiará inmediatamente a un valor más alto que el último recibido, por lo cual su información será recibida inmediatamente en la próxima ejecución.

Request:

GET:/api/v2/instance/mapping/{SequenceNumber}?accessToken={accessToken}&maxCount={MaxFetchItems}

Parámetros

Response vacío de entidades: cuando retorna vacío luego de recorrer todas las entidades dentro de un entorno el usuario puede volver a hacer la consulta utilizando 0 “SequenceNumber”.

Nota:

Definiciones importantes.

No se obtendrá el árbol completo hasta que no termine de mapear toda la instancia.

No se visualizara ordenado pero si jerarquizado

Donde no haya un endpoint, no va a traer nada. Solo va a traer la rama completa.

Response: La respuesta contiene la lista de variables, como se muestra en este ejemplo: