API Call

Operation name

API Call

Function Overview

Call kintone API(REST API).

For more information about kintone API, refer to Cybozu developer's site(https://cybozudev.zendesk.com/hc/ja/).

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

Depending on the future kintone API amendment or addition, the execution may not implement properly.

Data Model

The 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.
Input data	Required	Not available	Select the component 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".
API category	Required	Not available	Set up the API category	APIs except the following are available to call. Get Record Register Record Update Record Delete Record Upload File Download File Get API List Get API Schema Information The API added after 10th April, 2014 will only be shown as "key". About key, refer to "Get API List"(https://cybozudev.zendesk.com/hc/ja/articles/201941934-API-%E4%B8%80%E8%A6%A7%E3%81%AE%E5%8F%96%E5%BE%97).

Property Action

Item name	Description	Remarks
Update API category	Update API category list.

Guest space

Item name	Required / Optional	Use of Variables	Description	Remarks
Enable guest space	Required	Not available	Enables if the API operating target is guest space.
Guest space ID	Optional	Available	Specify the guest space ID of the API operating target.	Enables if you check in [Enable guest space].

Data Processing Method

Item name	Required/Optional	Use of Variables	Description	Remarks
Data Processing Method	Optional	Not available	Select the 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 schemas this adapter uses, please refer to "API schema".

Output Schema

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

Loading schema in Mapper

Schema is loaded automatically.

Please refer to "Edit Schema" for any details.

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	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

You cannot upload an image with [Add guest user at once] of [API Category].

Main exceptions

Exception name	Cause	Solution
InputDataNotFoundException	[Input data] is not specified.	Please specify [Input data], or draw a data flow.
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].
RequestParameterRequiredException Required parameter of <Input data>is not specified.	Required parameter of [<Input data>]is not specified.	Please specify the required parameter of [<Input data>].