IoT FND maintains a database of inventory information about network devices, groups, properties, metrics, and events. You can use NB API to retrieve network statistics and properties for deployed networked devices. You can also access the database using the IoT FND NB API (Database Queries).
The IoT FND NB API is a Simple Object Access Protocol (SOAP) API that provides methods for:
Read-only access to the IoT FND database
Push-based event reporting
Invoking management operations such as mesh firmware updates, rule creation, and mesh migration
Many APIs return lists of identifiers or objects. Because these lists could be very long in a large network, every method has three optional arguments: queryId, count, and offset. NB APIs use the Web Services Description Language (WDSL) to define network services.
When no argument is included, the call returns the first count list items. The maximum count is 1000 items.
To iterate through the full contents of a list, select a queryId, which is a random string. Then repeat the call using the same queryId, and increment the offset by count
for each call, starting from 0. When the call returns an empty list, the iteration is complete, and the queryId is invalidated on the server. Reusing queryId starts the request from the beginning. If a particular queryId is not used for 10 minutes, it is cleared to conserve resources.
The API uses HTTPS and HTTP Basic Authentication for username and password authorization, and for sending event data.
Figure 1. Database Queries
IoT FND Release 2.1.1-54 and later do not support TLSv1.0 or TLSv1.1 based connections. Only TLS1.2 based connections are supported.