Get Wi-Fi Network Templates

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Client Isolation Profiles

Manage client isolation profiles for tenant queries and policy visibility.

Operations

View VLAN Pool Profiles

Manage VLAN (Virtual Local Area Network) pool profiles for viewing and queries.

Operations

View SoftGRE Profile

Provides SoftGRE profile API operations for querying tenant configurations and results.

Operations

View Wi-Fi Profile

View Wi-Fi service and policy profile information including RADIUS authentication.

Operations

View Template

View template information using /rec/templates for REC templates when needed.

Operations

View Portal Service Profiles

Manage portal service profiles for tenant viewing and template queries.

Operations

View Venue Template

View venue template information using /rec/templates for REC templates when needed.

Operations

View Platform

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Wi-Fi

View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

Network

Network API (Application Programming Interface) for tenant network queries and counts.

Operations

View Ethernet Port Profile

Ethernet port profile API (Application Programming Interface) for tenant queries and management.

Operations

Quality of Service

View Quality of Service (QoS) information for network performance insights.

Operations

View Venue Topology

View venue topology information for mesh and standard network layouts.

Operations

View SNMP Agent Profiles

Manage SNMP (Simple Network Management Protocol) agent profiles for tenants.

Operations

View Venue

View venue information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Portal Service Template

View portal service template information using /rec/templates for REC templates when needed.

Operations

View Wi-Fi Template

View Wi-Fi template information using /rec/templates for REC templates when needed.

Operations

Get Access Control Profile Templates

Request

Get data for a list of access control profile templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(AccessControlProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Application Policy Templates

Request

Get data for a list of application policy templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(ApplicationPolicyQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Device Policy Templates

Request

Get data for a list of device policy templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(DevicePolicyQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get DHCP Configuration Service Profile Templates

Request

Query DHCP configuration service profile templates for the list.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(DhcpConfigServiceProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Ethernet Port Profile Templates

Request

Get data for a list of ethernet port profile templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(EthernetPortProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Layer Two Policy Templates

Request

Get data for a list of layer 2 policy templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(L2AclPolicyQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Layer Three Policy Templates

Request

Get data for a list of layer 3 policy templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(L3AclPolicyQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get RADIUS Server Profile Templates

Request

Get data for a list of RADIUS server profile templates with enhanced query data.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(RadiusServerProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Rogue Policy Templates

Request

Get the list of rogue policy templates in this tenant.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

Successful operation

Body

dataArray of objects(RoguePolicyQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Syslog Server Profile Templates

Request

Get data for a list of syslog server profile templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(SyslogServerProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Tunnel Profile Templates

Request

Get data for a list of tunnel profile templates. This is only permitted for users with feature flag edge role.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(TunnelProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get AP Group Templates

Request

Get AP group template information.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(ApGroupQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Query VLAN Pool Profile Templates

Request

Query VLAN pool profile templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

Successful operation

Body

dataArray of objects(VlanPoolProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Wifi Calling Profile Templates

Request

Get data for a list of wifi calling service profile templates.

Body

required

excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body

dataArray of objects(WifiCallingServiceProfileQueryData)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response

{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}