Get Record List Querykintone.app.getQueryCondition
Retrieves the record list filter conditions as a query string
Function
Desktop
kintone.app.getQueryCondition
Mobile
kintone.mobile.app.getQueryCondition
Parameters
None
Response
- String or null.
- An empty string is returned if there are no filter conditions for the record list.
- Null is returned for pages where it cannot be used.
Sample
Available Pages
- Record List
- Graph
Notes
- Use the API below if you need to retrieve the limit (# of records shown on the page) or the offset.
- If the filter condition includes several queries in parenthesis, the maximum conditions the API can retrieve is 14. An error will occur for 15 or more conditions.
Example: (xxx1 like "test" or xxx2 like "test") and (xxx1 like "test" or xxx2 like "test")
This query will be counted as 15 conditions.
Get Record List Query (with order by, limit, offset)kintone.app.getQuery
Retrieves the record list filter conditions as a query string, including "order by", "limit" and "offset"
Function
Desktop
kintone.app.getQuery
Mobile
kintone.mobile.app.getQuery
Parameters
None
Response
- String or null.
- Null is returned for pages where it cannot be used.
- If there are no filter conditions on the record list, a query list with only "order by", "limit" and "offset" will be returned.
- If there are no sort conditions on the record list, a query list with only "limit" and "offset" will be returned.
Sample
Available Pages
- Record List
- Graph
Get Record List Field Elementskintone.app.getFieldElements
Retrieves the field elements of fields in the record list as an array, by specifying a field code.
Function
kintone.app.getFieldElements(fieldCode)
Parameters
| PARAMETER | VALUE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| fieldCode | String | Yes | Specify the field code of the field you want to retrieve. |
Response
- An array of field elements, or null.
- Null is returned for pages where it cannot be used.
- An empty array will be returned if there are no records.
- Null is returned if the specified field is not in the record list.
Sample
Available Pages
- Record list
Notes
- The following fields cannot be retrieved, and null will be returned
- Tables
- Fields within tables
- If this API is used during an inline editing of the record list, the returned array will include an element containing the editing UI.
Get Record List Header Menu Elementkintone.app.getHeaderMenuSpaceElement
Retrieves the empty space element of the header of the record list, i.e. the space highlighted in the below image.
Function
kintone.app.getHeaderMenuSpaceElement
Parameters
None
Response
- The space element of the header.
- Null is returned for pages where it cannot be used.
Sample
Get Record List Header Elementkintone.app.getHeaderSpaceElement
Retrieves the empty space element below the header of the record list, i.e. the space highlighted in the below image.
Function
kintone.app.getHeaderSpaceElement
Parameters
None
Response
- The space element between the header and the record list.
- Null is returned for pages where it cannot be used.
Sample
Get Related Records Targetkintone.app.getRelatedRecordsTargetAppId()
Retrieves the App ID of the Datasource app of the specified Related records field, in the record list.
Function
Desktop
kintone.app.getRelatedRecordsTargetAppId(fieldCode)
Mobile
kintone.mobile.app.getRelatedRecordsTargetAppId(fieldCode)
Notes
See Get Record for more details.
Get Lookup Targetkintone.app.getLookupTargetAppId()
Retrieves the App ID of the Datasource app of the specified Lookup field, in the record list.
Function
Desktop
kintone.app.getLookupTargetAppId(fieldCode)
Mobile
kintone.mobile.app.getLookupTargetAppId(fieldCode)
Notes
See Get Record for more details.
Get Mobile Header Elementkintone.mobile.app.getHeaderSpaceElement()
Retrieves the empty space element below the header of the record list for mobiles.
Function
kintone.mobile.app.getHeaderSpaceElement()
Parameters
None
Response
- The element of the empty space element below the header of the record is returned.
- Null is returned for pages where it cannot be used.
Sample
Available Pages
- Record List
- Record Details
- Record Create
- Record Edit