Official |[kintone] Get Record

Operation name

Get Record

Function overview

Gets Kintone records.

Data model

The data model of this component is XML type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Search query	Optional	Available	Enter a query string as a filter condition to get records.	For more details on query string, refer to "Operators and functions for the query parameter" of Kintone API Docs (https://developer.kintone.io/hc/en-us/articles/213149287/). Note When you select Enable paging, don't use offset or limit as a query string.
Field list	Required	-	Specify fields.
Field list/Target	Optional	Not available	Select whether or not to include each field in target to read. Selected Include in the target to read. Not selected (Default) Don't include in the target to read.	The selected column names will be displayed in Mapper schema. You can operate all checkboxes at once by clicking the checkbox displayed in the header. Note One or more columns must be selected.
Field list/Field name	Optional	Not available	Field name is displayed.
Field list/Field code	Optional	Not available	Field code is displayed.
Field list/Field type	Optional	Not available	Field type is displayed.
Field list/Subtable	Optional	Not available	When a field is included in subtable, the field code of the subtable is displayed.

Property actions

Item name	Description	Remarks
Update field list	Get field information from the Kintone application and set it to Field list.

Get record settings

Item name	Required/Optional	Use of variables	Description	Remarks
Enable paging	Optional	Not available	Select whether or not to enable paging to get more records than the limited number of API. Selected (Default) Able to get more records than the limited number of API. Not selected Not able to get more records than the limited number of API.
Page size	Optional	Available	Specify the number of records that you get from a single API request when paging is enabled.	Enabled when Enable paging is selected. The default value is "500". If omitted, the number of records acquired when the operation is executed is the default number of records for Kintone API (100 records). You can enter a value in the range of 1 to 2147483647. However, the maximum number of records that you can actually acquire is determined according to the specifications of Kintone API. For details on the maximum record count, refer to the Kintone API specifications "Kintone REST API Overview" (https://developer.kintone.io/hc/en-us/articles/212495188#limitations).
Method for getting records by using paging	Optional	Not available	Specify the method for getting records when paging is enabled. Use offset (Default) Acquire records sequentially by specifying the offset of the query parameter. Use cursor API Create a cursor on Kintone, and then acquire records from the created cursor. Use record ID Sort record IDs in ascending order, and then acquire records according to the record ID order.	Enabled when Enable paging is selected. For details, refer to Paging method.

Item name

Required/Optional

Use of variables

Description

Remarks

Enable paging

Optional

Not available

Select whether or not to enable paging to get more records than the limited number of API.

Selected

(Default)

Able to get more records than the limited number of API.

Not selected

Not able to get more records than the limited number of API.

Page size

Optional

Available

Specify the number of records that you get from a single API request when paging is enabled.

Enabled when Enable paging is selected.
The default value is "500".
If omitted, the number of records acquired when the operation is executed is the default number of records for Kintone API (100 records).
You can enter a value in the range of 1 to 2147483647. However, the maximum number of records that you can actually acquire is determined according to the specifications of Kintone API.
For details on the maximum record count, refer to the Kintone API specifications "Kintone REST API Overview" (https://developer.kintone.io/hc/en-us/articles/212495188#limitations).

Method for getting records by using paging

Optional

Not available

Specify the method for getting records when paging is enabled.

Use offset

(Default)

Acquire records sequentially by specifying the offset of the query parameter.

Use cursor API

Create a cursor on Kintone, and then acquire records from the created cursor.

Use record ID

Sort record IDs in ascending order, and then acquire records according to the record ID order.

Enabled when Enable paging is selected.
For details, refer to Paging method.

Attachment

Item name	Required/Optional	Use of variables	Description	Remarks
Download attachment	Optional	Not available	Select whether or not to download attachments. Selected Attachments will be downloaded. Not selected (Default) Attachments won't be downloaded.
Output method for attachment	Optional	Not available	Select an output method for attachments. Data (Base64) (Default) Output the contents of attachments to the result data in Base64 format. File Get attachments as files.	Enabled when Download attachment is selected.
Download directory	Required	Available	Select or enter the directory to download attachments. The Browse button launches a directory chooser that allows you to select a directory. The paths of the downloaded attachments will be Download directory/<record ID>/<field code>/<file key>/<attached file name>.	Enabled when File is selected in Output method for attachment. Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Item name

Required/Optional

Use of variables

Description

Remarks

Download attachment

Optional

Not available

Select whether or not to download attachments.

Selected

Attachments will be downloaded.

Not selected

(Default)

Attachments won't be downloaded.

Output method for attachment

Optional

Not available

Select an output method for attachments.

Data (Base64)

(Default)

Output the contents of attachments to the result data in Base64 format.

File

Get attachments as files.

Enabled when Download attachment is selected.

Download directory

Required

Available

Select or enter the directory to download attachments.

The Browse button launches a directory chooser that allows you to select a directory.

The paths of the downloaded attachments will be Download directory/<record ID>/<field code>/<file key>/<attached file name>.

Enabled when File is selected in Output method for attachment.

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Optional	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Optional

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

= Remarks =

For more details on schema used by this connector, refer to Record schema.

Loading schema in Mapper

The schema is loaded automatically.

Specify the schema of the data to be loaded.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of read records is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Paging method

When paging is enabled, it's necessary to use the different methods of acquiring records depending on factors such as the total record count in the filtered results.

= Remarks =

For more details, refer to "Bulk record retrieval using the Cursor API method" (https://kintone.dev/en/tutorials/development-productivity/the-three-methods-for-bulk-record-retrieval/#the-cursor-api-method).

Method	Suitable usage scenario	Points for consideration
Use offset	When the total number of records to acquire is 10,000 records or less	There is an upper limit for the value that you can specify for offset. For details, refer to the Kintone API specifications "Get Records" (https://developer.kintone.io/hc/en-us/articles/360019245194).
Use cursor API	When the total number of records to acquire is more than 10,000 When you can estimate or control the number of cursors within a domain	There is an upper limit for the number of cursors that you can create at the same time. For details, refer to the Kintone API specifications "Limitations" (https://developer.kintone.io/hc/en-us/articles/360000280322).
Use record ID	When the total number of records to acquire is more than 10,000 When sorting record IDs in ascending order is acceptable When different sorting by another logic is available after records are acquired according to the record ID order	You need to enter "$id > $last_record_id" and "order by $id asc" in Search query. Example: updated_datetime >= "2019-10-20T09:00:00+0900" and updated_datetime < "2019-10-20T10:00:00+0900" and $id > $last_record_id order by $id asc, updated_datetime asc

The above contents are based on Kintone API specifications as of December 8, 2019.

Note

The contents are subject to change depending on future improvements and additions to Kintone API.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the kintone connector