Get Record

Operation Name

Get Record

Function Overview

Get kintone records.

Data Model

XML type.

Properties

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 the name to show on the script canvas.  
Required settings
Item name Required/Optional Use of variables Description Remarks
Destination Required Not available Select a global resource.
For details about how to configure global resource, refer to “Global Resource Properties”.
  • [Add]:
    Add a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
  
Search query Optional Available Enter query string of conditions 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/).
  • When you select [Enable paging], do not 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 targets.
  • [Checked]:
    Include in targets.
  • [Not checked]: (default)
    Do not include in targets.
  • One or more columns should be checked.
  • The checked column names will be displayed in Mapper schema.
  • Batch operation can be performed by clicking the checkbox displayed in the header.
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.
  • [Checked]: (default)
    Able to get more records than the limited number of API.
  • [Not checked]:
    Not able to get more records than the limited number of API.
  
Page size Optional Available Specify the record count 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 default number of records for kintone API (100 records) are acquired when the operation is executed.
  • You can enter a value in the range of 1 to 2147483647. However, the maximum record count that you can actually acquire is set 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.
Attachment
Item name Required/Optional Use of variables Description Remarks
Download attachment Optional Not available Select whether or not to download attachments.
  • [Checked]:
    Attachments will be downloaded.
  • [Not checked]: (default)
    Attachments will not be downloaded.
  
Output method for attachment Optional Not available Select output method for attachment.
  • [Data (Base64)]: (default)
    Output the contents of attachments to the result data in Base64 format.
  • [File]:
    Get attachments as file.
  • Enabled when [Download attachment] is checked.
Download directory Required Available Select or enter the directory where to download attachments.

You can click [Browse] button to launch the directory chooser and find the directory.

The paths of 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].
  • Specify the file path as an absolute path of DataSpider File System.
  • Except for the path separator "/”, restricted characters of DataSpider File System cannot be used.
Data processing method
Item name Required/Optional Use of variables Description Remarks
Data processing method Optional Not available Select data processing method.
  • [Apply script settings]: (default)
    Apply the mass data processing settings of the script property to the adapter.
  • [Do not perform mass data processing]:
    Mass data processing will not be performed.
  • [Perform mass data processing]:
    Mass data processing will be performed.
  
Comment
Item name Required/Optional Use of variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.		  

Schema

Input schema

None.

Output schema

For more details on schema used by this adapter, refer to “Record Schema”.

Loading schema in Mapper

Schema is loaded automatically.
Specify the schema of the data to be read.
For more details, refer to “Edit Schema”.

Mass Data Processing

Mass Data Processing is supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
count The number of read records is stored.
  • Default value is null.
message_category When an error occurs, the corresponding message code's category is stored.
  • Default value is null.
message_code When an error occurs, the corresponding message code is stored.
  • Default value is null.
message_level When an error occurs, the corresponding message code's severity is stored.
  • Default value is null.
error_type When an error occurs, the error type is stored.
  • Default value is null.
  • The error type will be in the following format.
    Example: “java.io.FileNotFoundException”
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the error message is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, the error's trace information is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

About paging method

When paging is enabled, it is necessary to use the different methods of acquiring records depending on such factors as the total record count in the filtered results.
For more details, refer to "Bulk record retrieval using the Cursor API method" (https://developer.kintone.io/hc/en-us/articles/360000361641).

Methods Suitable usage scenarios Points for consideration
[Use offset]
  • When the total record count to acquire is 10,000 records or less
  • There is a maximum 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 record count to acquire is more than 10,000
  • When you can estimate or control the number of cursors within a domain
  • There is a maximum number of cursors that you can create at the same time.
  • For details, refer to the kintone API specifications "Add Cursor" (https://developer.kintone.io/hc/en-us/articles/360000280322).
[Use record ID]
  • When the total record count 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.
The contents are subject to change depending on future improvements and additions to kintone API.

Specification Limits

Major Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name: [<global resource name>]		 The resource definition specified in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
<property name> is not specified.		 [<property name>] is not specified. Specify [<property name>].
KintoneResponseStatusException
<status code><contents of status code>
<contents of error>		 An error occurred during kintone processing. Check the settings according to the error message.
org.apache.http.client.ClientProtocolException [Subdomain name] is invalid. Check [Subdomain name] of [Destination].