Schemas

Record schema shows the details of records used in the Get Record, Add Record, and Update Record operations.

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <record>
    <schema type>
      :
  </record>
</root>

In this connector, schema type (element in record element) differs depending on Field type.

The schema type for each Field type is as follows:

Field type	Schema type
Record number	Value type
Record ID	Value type
Creator	User type
Modifier	User type
Created time	Value type
Updated time	Value type
Numeric value	Value type
Calculation	Value type
Rich text	Value type
Radio button	Value type
Multiple selection	Array type
Date	Value type
Date and Time	Value type
Link	Value type
String (one line)	Value type
String (multiple lines)	Value type
Check box	Array type
Drop-down	Value type
Attachment	FileArray type
Time	Value type
User selection	UserArray type
Department selection	OrganizationArray type
Group selection	GroupArray type
Look-up	Schema type supported in the target field
Subtable	SubTable type
Table Row ID	Value type
Category	Array type
Status	Value type
Operator	UserArray type

Value type

<value comment=""/>

Element name	Attribute name	Description	Remarks
value	-	Represents value of value type.

User type

<user comment="" name="">

Element name	Attribute name	Description	Remarks
user	-	Represents value of user type.	User ID will be set in the value.
-	name	Represents user name.	Because it can't be written, it doesn't appear in input schema.

Array type

<array comment="">
  <value/>
</array>

Element name	Attribute name	Description	Remarks
array	-	Represents array of Array type.
value	-	Represents element value in the array.

User Array type

<array comment="">
  <user name=""/>
</array>

Element name	Attribute name	Description	Remarks
array	-	Represents array of Array type.
user	-	Represents value of user type.	User ID will be set in the value.
-	name	Represents user name.	Because it can't be written, it doesn't appear in input schema.

Organization Array type

<array comment="">
  <organization name=""/>
</array>

Element name	Attribute name	Description	Remarks
array	-	Represents array of Array type.
organization	-	Represents value of department type.	Department code will be set in the value.
-	name	Represents department name.	Because it can't be written, it doesn't appear in input schema.

Group Array type

<array comment="">
  <group name=""/>
</array>

Element name	Attribute name	Description	Remarks
array	-	Represents array of Array type.
group	-	Represents value of group type.	Group code will be set in the value.
-	name	Represents group name.	Because it can't be written, it doesn't appear in input schema.

File Array type

<-- When Output destination of attachment or Input source of attachment is Data (Base64)-- >
<array comment="">
  <file name="" size="" contentType="">
    <content/>
  </file>
</array>
<-- When Output destination of attachment or Input source of attachment is File -->
<array comment="">
  <file name="" size="" contentType="">
    <path/>
  </file>
</array>

Element name	Attribute name	Description	Remarks
array	-	Represents array of Array type.
file	-	Represents value of file type.	Key to identify the file will be set in the value.
-	name	Represents the file name.
-	size	Represents the file size.	Because it can't be written, it doesn't appear in input schema.
-	contentType	Represents content type of the file.	Because it can't be written, it doesn't appear in input schema.
content	-	Represents the contents of attachment.
path	-	Represents the path of output destination or input source of the attachment.

SubTable type

<subTable comment="">
  <record>
    :
  </record>
</subTable>

Element name	Attribute name	Description	Remarks
subTable	-	Represents subtable.
record	-	Represents subtable record.	Elements for fields other than SubTable type appear in record element.

API schema

API schema shows input and output parameters of API used in the Call API operation.

= Remarks =

For more details, refer to Kintone REST API of API Docs (https://developer.kintone.io/hc/en-us/articles/212495178).

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <schema body>
    :
</root>

API parameters are displayed through mutual conversion of schema body (elements under root element) between JSON and XML.

Object type, array type, and string type of JSON format type are in the following formats.

Object type

<JSON member name/>

Element name	Attribute name	Description	Remarks
JSON member name	-	Represents JSON object type.

Array type

<JSON member name comment="array"/>

Element name	Attribute name	Description
JSON member name	-	Represents JSON array type.
-	comment	Represents array type when the value is array.
element	-	Represents array element.

String type

<JSON member name comment="attribute value that represents format">

Element name	Attribute name	Description	Remarks
JSON member name	-	Represents JSON array type.
-	comment	Attribute value that represents format	For more details on format, refer to the Kintone API specifications "Get API Schema" (https://developer.kintone.io/hc/en-us/articles/115006107628).