General API Features

Filtering Result Set

The filtering capability allows the API consumer to filter the JSON response based on one or more optional parameters mentioned in the API request section. This feature is applicable for all the APIs listed in this document.

Example: https://apx.cisco.com/cs/api/v1/inventory?customerId=1234&inventoryId=456&deviceId=990

Filtering Data Attributes

API consumer can filter the specific response parameters that they want to see in the JSON response. Refer to each API response parameters to use this capability in association with the keyword “fields”. This feature is applicable for all the APIs listed in this document.

Example: https://apx.cisco.com/cs/api/v1/inventory?customerId=1234&fields=deviceId,equipmentId,ipAddress