9.2.9 Query parameter
If you add search conditions to a request by using query parameters, you can filter or sort the output results of the response.
This section describes query parameters supported by JP1/AO.
Query parameter that can be specified for all APIs
The query parameter described in the following table can be specified for all APIs.
|
Parameter |
Description |
Specifiable value |
Default value |
|---|---|---|---|
|
alt |
Input/output data format can be specified in the same way as the Content-Type header and Accept header in a request. |
xml or json |
-- |
- Legend:
-
--: Not applicable.
Query parameters that can be used for some APIs
The query parameters in the table below can be specified for a part of APIs#.
- #
-
-
Acquisition of a list of services
-
Acquisition of a list of schedules
-
Acquisition of a list of tasks
-
Acquisition of a list of steps
-
Acquisition of task logs
-
Acquisition of a list of property definitions
-
Acquisition of a list of property values
-
|
Parameter |
Description |
Specifiable value#1 |
Default value |
|---|---|---|---|
|
HQL::filter |
Filters the output results by using the specified conditions. |
-- |
|
|
HQL::fields |
Specify this parameter when you want to filter members to be included in a response. You can specify multiple parameters by separating them by commas (,). |
Member-name |
-- |
|
HQL::sortBy |
Sorts the output results by the specified member name. |
Member-name [{ASC| DESC}](, member-name [{ASC| DESC}])
|
ASC |
|
HQL::offset#2 |
Specifies the position of the heading object whose information is to be acquired. Specify the maximum number of objects that can be included in a response with HQL::count. page takes preference over HQL::offset. |
0 to 2147483647 |
0 |
|
HQL::count#2 |
Specify the maximum number of objects to be included in a response from the position of the heading object specified with HQL::offset. pageSize takes preference over HQL::count. If the total of HQL::count and HQL::offset exceeds 2,147,483,647, the 2,147,483,647th object from the value specified with HQL::offset is acquired. |
1 to 2147483647 |
100 |
|
page#2 |
Acquires information about the specified page when a resource is divided into pages. You must also specify pageSize. page takes preference over HQL::offset. |
1 to 2147483647 |
-- |
|
pageSize#2 |
Specify the maximum number of objects that can be displayed in a page. pageSize takes preference over HQL::count. |
1 to 2147483647 |
-- |
- Legend:
-
--: Not applicable.
- #1
-
If you want to specify a character string that cannot be expressed as a URL, use UTF-8 encoding and encode the character string.
- #2
-
You cannot specify this parameter for API Acquisition of task logs and Acquisition of a list of steps.
For pageSize, specify the maximum number of objects that can be displayed in a page. For page, specify which of the divided pages is to be displayed. (The relationship between pageSize and page is almost the same as the relationship between Rows/page and Page of Services in a JP1/AO window.) If you specify page and pageSize, the number of all resources and pages are returned to the Pagination object. This value enables you to determine whether the next page exists.
Note that page and pageSize are used after converted to an HQL::offset value as follows:
HQL::offset = pageSize * (page - 1)
Therefore, if page and pageSize exceed the specifiable range for HQL::offset, status code 400 (Bad Request) is returned.
Related topic