Official |[kintone] Call API

Operation name

Call API

Function overview

Calls 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 as of April 10, 2014.

Note

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

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.
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 connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
API type	Required	Not available	Set API type.	The following APIs can't be specified. Get Record, Get Records Add Record, Add Records Update Record, Update Records Delete Records Get Cursor, Add Cursor, Delete Cursor Upload File Download 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).

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.

API type

Required

Not available

Set API type.

The following APIs can't be specified.

Get Record, Get Records
Add Record, Add Records
Update Record, Update Records
Delete Records
Get Cursor, Add Cursor, Delete Cursor
Upload File
Download 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 this item 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 selected.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	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

Required

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

= Remarks =

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

Output schema

= Remarks =

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

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

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

Message codes, exception messages, and limitations

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