Ordering - BlueCat Integrity - 25.1.0

Address Manager RESTful v2 API Guide

ft:locale
en-US
Product name
BlueCat Integrity
Version
25.1.0
Customize the order of resources returned by using the orderBy query parameter. By default, the order direction will be in ascending order. The order direction can be set using the asc() and desc() operators. Resources can be ordered by multiple fields by providing a comma-separated list of fields (including operators if applicable), with the first listed fields taking ordering priority. The following request fetches all IPv4/IPv6 blocks and sub blocks, and orders the result by block name in descending order.
GET http://{Address_Manager_IP}/api/v2/blocks?orderBy=desc(name)
Note: To view all supported orderBy fields for an endpoint, append supportedOrderByFields=true to receive a list of supported orderBy fields in the response:
GET http://{Address_Manager_IP}/api/v2/deployments?supportedOrderByFields=true

Name

Purpose

Syntax

Operators

Examples

orderBy Results ordering orderBy=<field>
  • asc

  • desc

  • orderBy=desc(id)
  • orderBy=asc(name)
  • orderBy=name,desc(id),asc(type)