Skip to content
Overview/
/
/
Changed
Last updated

View Model Resources

GET /clients
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

GET /clients/{mac}
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

OK

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /guestUsers/query/csvFiles
Return Type:
  • Changed response : 200 OK

Successful operation

  • Changed content type : text/csv
  • Changed response : 404 Not Found

Requested resource or related entity not found

POST /qosStatistics/query
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

GET /venues/{venueId}/apModels
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

GET /venues/{venueId}/aps/models
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

GET /venues/{venueId}/meshTopologies
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

GET /venues/{venueId}/topologies
Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /accessControlProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

    • Property filterTerms (object)

    • Property searchString (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /applicationPolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /aps/aggregationDetails
Request:

Get grouped aps.

  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /aps/query/csvFiles
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • New content type : application/vnd.ruckus.v1+json
  • Changed response : 501 Not Implemented

not implemented

  • New content type : application/vnd.ruckus.v1+json
POST /clientIsolationProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /cloudpaths/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /devicePolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /dhcpConfigServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /edgeSdLanServices/query

Query Edge SD-LAN List

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

The operation was successful.

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedAccessControlProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedApplicationPolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedDevicePolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedDhcpConfigServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedIsolationAllowlists/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedL2AclPolicies/query

Get Layer 2 Policies

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedL3AclPolicies/query

Get Layer 3 Policies

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedMdnsProxyProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedRadiusServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedRogueApPolicyProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedSyslogServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedVlanPoolProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /enhancedWifiCallingProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /ethernetPortProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /guestUsers/query

Export Guest CSV

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

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

  • Added property sortDescriptors (object)

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

  • Changed property exists (object)

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

  • Changed property fields (object)

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

  • Changed property filters (object)

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

  • Changed property groupBy (object)

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

  • Changed property matchFields (object)

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

  • Changed property multiSortFields (object)

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

  • Changed property mustHaveFields (object)

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

  • Changed property mustNotHaveFields (object)

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

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

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

  • Changed property pageSize (object)

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

  • Changed property searchString (object)

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

  • Changed property searchTargetFields (object)

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

  • Changed property sortField (object)

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

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

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

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Deleted content type : text/vnd.ruckus.v1.1+csv

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /hotspot20IdentityProviders/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

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

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /hotspot20Operators/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /l2AclPolicies/query

Get Layer 2 Policies

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /l3AclPolicies/query

Get Layer 3 Policies

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /lbsServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /multicastDnsProxyProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /portalServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /radiusServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /roguePolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /snmpAgentProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /snmpAgents/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • New content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /softGreProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Request succeeded and returns SoftGRE profile data in the expected format.

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Feature not implemented for SoftGRE profile queries in this API.

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /switches/aggregationDetails
Request:

Get grouped switches.

  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /switches/clients/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /switches/ports/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /switches/query/csvFiles
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

POST /syslogServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/accessControlProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/applicationPolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/devicePolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/dhcpConfigServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/ethernetPortProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/l2AclPolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/l3AclPolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/portalServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/query

Get Templates

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 501 Not Implemented

not implemented

  • Changed content type : application/json

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property errors (object)

      List of detailed errors if the request encountered issues.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property requestId (object)

      Unique identifier for tracking this request.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property errors (object)

      List of detailed errors if the request encountered issues.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property requestId (object)

      Unique identifier for tracking this request.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/radiusServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1.1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1.1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/roguePolicies/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/syslogServerProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/venues/apGroups/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/venues/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 501 Not Implemented

internal server error

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property isEnforced (object)

    • Added property tagList (object)

    • Added property templateContext (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property isEnforced (object)

    • Added property tagList (object)

    • Added property templateContext (object)

POST /templates/vlanPoolProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/wifiCallingServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /tunnelServiceProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

The operation was successful.

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/apGroups/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/aps/clients/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/aps/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

POST /venues/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 501 Not Implemented

not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Added property isEnforced (object)

    • Added property tagList (object)

    • Added property templateContext (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property isEnforced (object)

    • Added property tagList (object)

    • Added property templateContext (object)

POST /venues/switches/aggregationDetails
Request:

Get grouped switches.

  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/switches/clients/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/switches/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/switches/query/csvFiles
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

POST /venues/switches/switchPorts/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /venues/{venueId}/rogueAps/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /vlanPoolProfiles/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 200 OK

Successful operation

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 501 Not Implemented

Not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

POST /templates/wifiNetworks/query

Get Wi-Fi Network Templates

Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 501 Not Implemented

not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Deleted property isManagedByTemplate (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property isManagedByTemplate (object)
POST /wifiNetworks/query
Request:
  • Changed content type : application/json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property excludeFilters (object)

    Exclusion filters as key value pairs defining values to omit from results.

  • Added property queryStringOrFilter (object)

  • Added property search_after (object)

    Search after values used to continue pagination without relying on offsets.

  • Added property sortDescriptors (object)

    List of sort descriptors defining multi level sort behaviors for query responses.

  • Changed property exists (object)

    Field name that must exist within each document matched by the query execution.

  • Changed property fields (object)

    Set of field names to include in response payload for each record.

  • Changed property filters (object)

    Filters provided as key value pairs defining inclusion criteria for query execution.

  • Changed property groupBy (object)

    Field name used to group aggregated results when producing grouped query responses.

  • Changed property matchFields (object)

    List of match field filters specifying terms that must align with query criteria.

  • Changed property multiSortFields (object)

    List of multiple field names applied for compound sorting logic in results.

  • Changed property mustHaveFields (object)

    List of fields that must exist on documents returned by the query.

  • Changed property mustNotHaveFields (object)

    List of fields that must not exist on documents included in results.

  • Changed property page (object)

    Page number indicating current position within paginated query results.

  • Changed property pageByDate (object)

    Pagination by date entry specifying anchor timestamp for search after pagination.

  • Changed property pageSize (object)

    Number of items per page controlling volume of results returned per page.

  • Changed property searchString (object)

    Search string representing the user query applied across designated target fields.

  • Changed property searchTargetFields (object)

    List of target field names that should be queried for search string matching.

  • Changed property sortField (object)

    Field name used to sort query results within the returned data.

  • Changed property sortOrder (object)

    Sort order specifying ascending or descending direction for query results.

  • Changed property terms (object)

    Filter terms represented as key value pairs applied to refine result sets.

Return Type:
  • Changed response : 404 Not Found

Requested resource or related entity not found

  • Changed response : 501 Not Implemented

not implemented

  • Changed content type : application/json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of detailed errors if the request encountered issues.

    • Added property requestId (object)

      Unique identifier for tracking this request.

    • Changed property data (object)

      List of data items returned by the query.

    • Changed property errorMessage (object)

      Error message if the request failed.

    • Changed property fields (object)

      Set of field names included in the response.

    • Changed property objectId (object)

      Unique identifier of the object being queried.

    • Changed property page (object)

      Current page number in the paginated results.

    • Changed property subsequentQueries (object)

      List of subsequent query options for drilling down into results.

    • Changed property totalCount (object)

      Total number of results matching the query.

  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Deleted property isManagedByTemplate (object)

  • Changed content type : application/vnd.ruckus.v1+json

    • Deleted property isManagedByTemplate (object)
Previous page
Next page