Get Record

Operation Name

Get Record

Function Overview

Get the record of kintone.

Data Model

Data model of this component is XML type.

Properties

For information about using 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 Global Resources.
Refer to "Global Resource Properties" for global resource settings .
  • [Add]:
    Adds new global resource.
  • [Edit list]:
    Global resource settings can be managed from "Edit Resource list".
 
Search Query Required Available Input query notation which is the refining condition of the getting record.
  • For query character string, please refer to kintone API specification "Specify conditions with query"(http://developers.cybozu.com/ja/kintone-api/apprec-readapi.html#i-2).
  • If you use offset in Query character string, please take out the check in [Enable paging].
Field list Required - Specify field.  
Field list/ Loading target Optional Not available Select whether to include each field as the loading target.
  • [Checked]:
    Includes as loading target.
  • [Not checked]:(default)
    Does not include as loading target.
  • There needs to be at least one checked column.
  • The checked column name is displayed in the Mapper schema.
  • Checking a checkbox in the header enables bulk operation.
Field list/ Field code Optional Not available Show field code.  
Field list/ Field type Optional Not available Show field type.  
Field list/ Sub-table Optional Not available Show field code of sub-table, if a field is included in sub-table.  
Property Action
Item name Description Remarks
Update field list Get field information from kintone application and set as [Field list].
  • There needs to be more than 1 line of record in the kintone application.
  • If sub-table exists in the kintone application, there needs to be more than 1 line of record in the sub-table.
Get Record settings
Item name Required / Optional Use of Variables Description Remarks
Enable paging Optional Not available Select whether to enable getting records more than the API restricting numbers by paging.
  • [Checked]:(default)
    Enables to get records more than the API restricting numbers.
  • [Not checked]:
    Disables to get records more than the API restricting numbers.
 
Attached file
Item name Required / Optional Use of Variables Description Remarks
Downloading the attached file Optional Not available Select whether to download the attached file.
  • [Checked]:
    Downloads the attached file
  • [Not checked]:(default)
    Does not download the attached file.
 
How to output attached file Optional Not available Select how to output the attached file.
  • [Data (Base64)]:(default)
    Outputs the got attached file contents in Base64 format to the result data.
  • [File]:
    Gets attached file as File.
  • Enables, if you check in the [Downloading attached file].
Downloading directory Required Available Select of input the attached file downloading directory.

If you click on [Browse], directory Selectr launches and enables you to select directory.

The path of downloaded attach file will be [Downloading directory]/<Record ID>/<Field code>/<File key>/<Attach file name>.
  • Enebled, if you select [File] to [How to output attached file].
  • Please specify the absolute path of the DataSpider file system as the file path.
  • Constrained Characters of DataSpider File System cannnot be used, except for the path separator "/"..
Data processing method
Item name Required/Optional Use of Variables Description Remarks
Mass data processing Required Not available Select a data processing method.
  • [Use script settings]: (default)
    Apply mass data processing settings of script property to adapter.
  • [Disable]:
    Mass data processing is not performed.
  • [Enable]:
    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 adapter.
The description will be reflected in the specifications.
 

Schema

Input schema

None.

Output Schema

For schemas this adapter uses, please refer to "Record schema".

Loading schema in Mapper

Schema is loaded automatically.
Specify the schema of the loading data.
Please refer to "Edit Schema" for any details.

Mass data processing

Mass data processing is supported.

PSP Usage

PSP is not supported.

Available Component variables

Component variable name Description Remarks
count Returns the number of records retrieved.
  • The value defaults to null.
message_category Stroes the category to which corresponding message code belongs to, when an error occurs.
  • The value defaults to null.
message_code Stores its corresponding message code of occured error.
  • The value defaults to null.
message_level Stores the severity of the corresponding message code of the occured error.
  • The value defaults to null.
error_type Stores the type of the occured error.
  • The value defaults to null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The message may vary depending on DataSpider Servista version.
error_message Stores the error message for the occured error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version.
error_trace Stores stack trace of the occurred error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

Main exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition could not be found.Name: []
[Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition could not be found.Name: [<name of Global Resources>]
Resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
<Property name> is not specified.
[<Property name>] is not specified. Specify the [<Property name>].
KintoneResponseStatusException
<Status code> <Status code content>
<Error content>
Error occurred during the process in kintone. According to the error message, please confirm the input value.
org.apache.http.client.ClientProtocolException [Sub-domain name] is false. Please check the [Sub-domain name]of [Destination].