Owner's Manual

Filtering Results

REST APIs support result filtering. The software supports filters for regular expressions, offset/limit

pagination, and selected fields. The REST API retrieves all available information, then applies the filter to

the results. To filter results, use the URI format <URI to Resource>/*?<filter>. You can combine

filters. In each query, you can only use each filter once.

• For a regular expression filter, use the query format *?key=<fieldName>&value=<Regular

Expression

>, where fieldName is the attribute in the response used as the filter criteria.

• To apply pagination, use the query format *?offset=<num1>&limit=<num2>, where num1 is the

starting item number and

num2 is the number of records to display. For example,

offset=1000&limit=10 displays items from 1000 to 1010.

• To limit fields, use the query format *?fields=<field>,<field>,<field> where field can be

any field included in the results.

The following are examples of REST APIs that use filters:

• To view the names, IDs, and descriptions associated with all tenants, enter http://

{ControllerIP}/afcui/sdnc/v1/providers/*?

fields=providerName,providerId,providerDescription

• To view for first 50 networks of provider pro-1, enter http://{ControllerIP}/afcui/sdnc/v1/

networks/*@pro-1?offset=0&limit=50

• To view all the networks of provider pro-1 where networkID starts with 09, enter http://

{ControllerIP}/afcui/sdnc/v1/networks/*@pro-1?key=networkId&value=09.*

• To view the first five networks of provider pro-1 where networkID starts with 09, enter http://

{ControllerIP}/afcui/sdnc/v1/networks/*@pro-1?

key=networkId&value=09.*&offset=0&limit=5

• To view the first five networks of provider pro-1 where networkID starts with 09, but return only the

field networkName, enter http://{ControllerIP}/afcui/sdnc/v1/networks/*@pro-1?

key=networkId&value=09.* &offset=0&limit=5&fields=networkName

REST Request URIs

This section lists the uniform resource identifiers (URIs) corresponding to the implemented REST

resources. The URI is used for GET, POST, PUT, and DELETE actions.

Requirements

• All POST, GET, and PUT actions require input parameters in JSON object format. For more information,

refer to REST Resource Attributes.

• The PUT action is an incremental update: attributes are either created or replace the existing value.

• Provider resources use the following format: {resourceID}@{providerID} (where {resourceID}

is the resource ID number and {providerID} is the provider ID number.

• Tenant resources use the following format: {resourceID}@{tenantID}@{providerID} (where

{resourceID} is the resource ID number, {tenantID} is the tenant ID number, and {providerID}

is the provider ID number.

System Resources and URIs

REST APIs