Call API

Operation Name

Call API

Function Overview

Call kintone API (REST API).

For details on kintone API, refer to the developer website of Cybozu company (https://developer.kintone.io/hc/en-us/).

This operation is based on kintone API at the time of April 10, 2014.

Depending on improvement and addition of kintone API in the future, it might not execute correctly.

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.
Input data	Required	Not available	Select a component 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.
API type	Required	Not available	Set API type.	The following APIs cannot be specified. Get Record Get Records Add Record Add Records Update Record Update Records Delete Records Get Cursor Add Cursor Delete Cursor Download File Upload File Get API List Get API Schema Key will be displayed for API which is added later than April 10, 2014. For details on key, refer to “Get API List” (https://developer.kintone.io/hc/en-us/articles/115006107588).

Property actions

Item name	Description	Remarks
Update API types	Update API type list.

Guest space

Item name	Required/Optional	Use of variables	Description	Remarks
Enable guest space	Optional	Not available	Enable when API operation target is guest space.
Guest space ID	Optional	Available	Specify the guest space ID of API operation target.	Enabled when [Enable guest space] is checked.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Optional	Not available	Select data processing method.

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

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

Output schema

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

Loading schema in Mapper

Schema is loaded automatically.

For more details, refer to “Edit Schema”.

Mass Data Processing

Mass Data Processing is supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
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.

Specification Limits

You cannot upload an image in [Batch Add Guest Users] of [API type].

Major Exceptions

Exception name	Cause	Solution
InputDataNotFoundException	[Input data] is not specified.	Specify [Input data] or draw data flow.
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 and the input value according to the error message.
org.apache.http.client.ClientProtocolException	[Subdomain name] is invalid.	Check [Subdomain name] of [Destination].
RequestParameterRequiredException Required parameter of <input data> is not specified.	Required parameter of [<Input data>] is not specified.	Specify required parameter of [<Input data>].