Query parameters for some APIs

$query

Filters the output results by using the specified conditions.

See HQL syntax relationships and operators.

Not applicable.

$order-by

Sorts the output results by the specified attribute.

attribute [{ASC| DESC}](, attribute [{ASC| DESC}])

ASC: Ascending order

DESC: Descending order

ASC

$offset

Specifies the position of the initial object of the range of information collection. Specify the maximum number of objects in a response with $count. page is given priority over $offset.

0 to 2147483647

0

$count

Specifies the maximum number of objects in a response, starting from the initial object's position specified by $offset. pageSize has priority over $count. If the sum of $count and $offset exceeds 2,147,483,647, the IDs of the obtained objects range from the value of $offset to 2,147,483,647.

1 to 2147483647

100

page

Gets information about a specific page when resources are divided into pages. You also need to specify pageSize. page has priority over $offset.

1 to 2147483647

Not applicable.

pageSize

Specifies the maximum number of objects to be displayed on one page. pageSize has priority over $count.

1 to 2147483647

Not applicable.

#: If you want to specify a character string that cannot be expressed as a URL, use UTF-8 encoding and encode the character string.

pageSize refers to the maximum number of objects in one page. Page refers to the page number to display. If you set page and pageSize, the pagination object receives the total number of resources and pages. This value enables you to see whether there are any of the following pages:

As shown in the expression below, page and pageSize are converted the values of $offset.

$offset=pageSize*(page-1)

The status code 400 (Bad Request) is returned if page and pageSize are out of the range of $offset.