| Method |
POST |
| URL root |
https://HOST:PORT/ROOT-CONTEXT/nm_rest/topology/locations/bounds/bounds/entityIds
Where:
HOST is the hostname
or IP address of the Dashboard Application Services Hub
server.PORT is the secure
port number of the Dashboard Application Services Hub
server. By default, this is 16311.ROOT-CONTEXT is the
path from the root of your file system to the Topology API. This path is usually
ibm/console.nm_rest/topology completes the path to
the Topology API.locations is the name of the function
that retrieves data related to geographic views. |
| Mandatory parameters |
bounds-
A rectangle specified by two locations, of the
following form:
((north-west latitude, north-west longitude), (south-east latitude, south-east longitude))
The latitudes and longitudes are in decimal degrees.
Positive latitudes are north of the equator, and
positive longitudes are east of the Greenwich
meridian. A single whitespace character is optional
after the commas for readability.
The following is an example of the bounds
parameter: ((34.461276680644175, -99.68994179687502), (37.13404478358378, -95.29541054687502))
entityIds- The entity IDs of the devices to retrieve. The IDs must
be a comma-separated list in the request body.
|
| Optional parameters |
The following parameters can be included in any order.
- level
- An integer value that determines the level of
aggregation of devices. Level 0 is the lowest level
of the hierarchy, which is usually individual
devices. Entities at level n+1 aggregate entities at
level n. The default is all levels.
aggToRegion - A boolean value that defines whether locations are
aggregated to their containing region. The default
is
true.
lazyLoad- A boolean value that defines whether to include
additional information in the query. The default is
true.
|
| Example URL |
https://myHost:16311/ibm/console/nm_rest/topology/locations?bounds=((34.461276680644175, -99.68994179687502), (37.13404478358378, -95.29541054687502))&entityIds?aggToRegion=false&lazyLoad=false
The entity IDs, for example,
1,2, must be included in the request
body.
|
| Content Type |
application/json |