Business Critical Services(BCS) Operational Insights API

Device Groups

When working with your Cisco Consulting Engineer, you often group devices together according to criteria important to you. This collection provides insights into the logical groups you have and which your network devices exist in what group.

It is sub-divided into two endpoints:

  • /deviceGroups/groupMembers
  • /deviceGroups/groups

Group Members

The groupMembers endpoint returns a list of JSON objects that describe which devices belong to what group.

Here is an example:

json
Copy{
    "deviceId": 24932787,
    "groupId": 366841,
    "groupName": "bci2"
},
{
    "deviceId": 24932789,
    "groupId": 366841,
    "groupName": "bci2"
},

The devices with ID 24932787 and 24932789 belong to group bci2 which has ID 366841.

Groups

The groups endpoint returns an aggregate view of the different groups and the number of devices contained in them.

Here is an example:

json
Copy{
    "groupDescription": "Test lab 2 for BCS",
    "groupId": 366841,
    "groupName": "bci2",
    "groupTotalDeviceCount": 2
},

The device group with ID 366841 with the name bci2 has a description Test lab 2 for BCS and contains two devices.

Next