Schema

Record Schema

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <record>
    <schema type>
      :
  </record>
</root>
In this adapter, 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 - Shows value of value type.

User type

<user comment="" name="">
Element name Attribute name Description Remarks
user - Shows value of user type.
  • User ID will be set in the value.
- name Shows user name.
  • As it could not be written, it doesn't appear in input schema.

Array type

<array comment="">
  <value/>
</array>
Element name Attribute name Description Remarks
array - Shows array of Array type.
value - Shows element value in the array.

User Array type

<array comment="">
  <user name=""/>
</array>
Element name Attribute name Description Remarks
array - Shows array of Array type.
user - Shows value of user type.
  • User ID will be set in the value.
- name Shows user name.
  • As it could not be written, it doesn't appear in input schema.

Organization Array type

<array comment="">
  <organization name=""/>
</array>
Element name Attribute name Description Remarks
array - Shows array of Array type.
organization - Shows value of department type.
  • Department code will be set in the value.
- name Shows department name.
  • As it could not be written, it doesn't appear in input schema.

Group Array type

<array comment="">
  <group name=""/>
</array>
Element name Attribute name Description Remarks
array - Shows array of Array type.
group - Shows value of group type.
  • Group code will be set in the value.
- name Shows group name.
  • As it could not 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 - Shows array of Array type.
file - Shows value of value type.
  • Key to identify the file will be set in the value.
- name Shows the file name.
- size Shows the file size.
  • As it could not be written, it doesn't appear in input schema.
- contentType Shows content type of the file.
  • As it could not be written, it doesn't appear in input schema.
content - Shows the contents of attachment
path - Shows 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 - Shows subtable.
record - Shows 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 Call API operation.
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 by mutual conversion between JSON and XML for schema body (elements under root element).
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 - Shows JSON object type.

Array type

<JSON member name comment="array"/>
Element name Attribute name Description Remarks
JSON member name - Shows JSON array type.
- comment Shows array type when the value is array.
element - Shows array element.

String type

<JSON member name comment="attribute value which shows format">
Element name Attribute name Description Remarks
JSON member name - Shows JSON array type.
- comment Attribute value which shows format
  • For more details on format, refer to “Get API schema information” (https://cybozudev.zendesk.com/hc/ja/articles/201941924-API-%E3%82%B9%E3%82%AD%E3%83%BC%E3%83%9E%E6%83%85%E5%A0%B1%E3%81%AE%E5%8F%96%E5%BE%97) page of kintone API specifications.
    		•