Get Record List

Contents

Get Record List Query - kintone.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

1
2
3
4
5
var condition = kintone.app.getQueryCondition();
console.log(condition);

// Sample Response
// 'record_id <= "5" and creator in ("john-d")'

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

1
2
3
4
5
var query = kintone.app.getQuery();
console.log(query);

// Sample Response
// 'record_id <= "5" and creator in ("john-d") order by record_id desc limit 5 offset 10'

Available Pages

  • Record List
  • Graph

Get Record List Field Elements - kintone.app.getFieldElements()

Retrieves the field elements of fields in the record list as an array, by specifying a field code.

Function

Desktop

kintone.app.getFieldElements(fieldCode)

Mobile

kintone.mobile.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

1
kintone.app.getFieldElements('record_id');

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 Element - kintone.app.getHeaderMenuSpaceElement()

Retrieves the empty space element of the header of the record list, i.e. the space highlighted in the below image.

Header Menu Space Screenshot

Function

kintone.app.getHeaderMenuSpaceElement()

Parameters

None

Response

  • The space element of the header.
  • Null is returned for pages where it cannot be used.

Sample

1
var el = kintone.app.getHeaderMenuSpaceElement();

Get Record List Header Element - kintone.app.getHeaderSpaceElement()

Retrieves the empty space element below the header of the record list, i.e. the space highlighted in the below image.

Header Space Screenshot

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

1
var el = kintone.app.getHeaderSpaceElement();

Retrieves the App ID of the Datasource app of the specified Related records field, in the record list.

Desktop

kintone.app.getRelatedRecordsTargetAppId(fieldCode)

Mobile

kintone.mobile.app.getRelatedRecordsTargetAppId(fieldCode)

See Get Record for more details.

Get Lookup Target - kintone.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 Element - kintone.mobile.app.getHeaderSpaceElement()

Retrieves the empty space element between the View name and the Record List for mobiles.

Mobile Header Space ScreenShot

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

1
var el = kintone.mobile.app.getHeaderSpaceElement();

Available Pages

  • Record List
  • Record Details
  • Record Create
  • Record Edit