スキーマ

レコードスキーマ

レコードスキーマは、レコード取得処理、レコード追加処理、およびレコード更新処理で使われるレコードの内容を表すスキーマです。

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <record>
    <スキーマの型>
      :
  </record>
</root>

本アダプタでは、[フィールドの型]によりスキーマの型(record要素内の要素)が異なります。

各[フィールドの型]に対応するスキーマの型は、以下の通りです。

フィールドの型	スキーマの型
レコード番号	Value型
レコードID	Value型
作成者	User型
更新者	User型
作成日時	Value型
更新日時	Value型
数値	Value型
計算	Value型
リッチテキスト	Value型
ラジオボタン	Value型
複数選択	Array型
日付	Value型
日時	Value型
リンク	Value型
文字列 (1行)	Value型
文字列 (複数行)	Value型
チェックボックス	Array型
ドロップダウン	Value型
添付ファイル	FileArray型
時刻	Value型
ユーザー選択	UserArray型
組織選択	OrganizationArray型
グループ選択	GroupArray型
ルックアップ	参照先のフィールドに対応するスキーマの型
サブテーブル	SubTable型
テーブル行ID	Value型
カテゴリー	Array型
ステータス	Value型
作業者	UserArray型

Value型

<value comment=""/>

要素名	属性名	説明	備考
value	-	Value型の値を表します。

User型

<user comment="" name="">

要素名	属性名	説明	備考
user	-	ユーザー型の値を表します。	値にはユーザーIDが入ります。
-	name	ユーザー名を表します。	書き込み不可のため、入力スキーマには出現しません。

Array型

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

要素名	属性名	説明	備考
array	-	Array型の配列を表します。
value	-	配列内の要素の値を表します。

User Array型

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

要素名	属性名	説明	備考
array	-	Array型の配列を表します。
user	-	ユーザー型の値を表します。	値にはユーザーIDが入ります。
-	name	ユーザー名を表します。	書き込み不可のため、入力スキーマには出現しません。

Organization Array型

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

要素名	属性名	説明	備考
array	-	Array型の配列を表します。
organization	-	組織型の値を表します。	値には組織コードが入ります。
-	name	組織名を表します。	書き込み不可のため、入力スキーマには出現しません。

Group Array型

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

要素名	属性名	説明	備考
array	-	Array型の配列を表します。
group	-	グループ型の値を表します。	値にはグループコードが入ります。
-	name	グループ名を表します。	書き込み不可のため、入力スキーマには出現しません。

File Array型

<-- [添付ファイルの出力先]または[添付ファイルの入力元]が[データ(Base64)]の場合 -->
<array comment="">
  <file name="" size="" contentType="">
    <content/>
  </file>
</array>
<-- [添付ファイルの出力先]または[添付ファイルの入力元]が[ファイル]の場合 -->
<array comment="">
  <file name="" size="" contentType="">
    <path/>
  </file>
</array>

要素名	属性名	説明	備考
array	-	Array型の配列を表します。
file	-	ファイル型の値を表します。	値にはファイル特定するためのキーが入ります。
-	name	ファイル名を表します。
-	size	ファイルサイズを表します。	書き込み不可のため、入力スキーマには出現しません。
-	contentType	ファイルのコンテントタイプを表します。	書き込み不可のため、入力スキーマには出現しません。
content	-	添付ファイルの内容を表します。
path	-	添付ファイルの出力先または入力元のパスを表します。

SubTable型

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

要素名	属性名	説明	備考
subTable	-	サブテーブルを表します。
record	-	サブテーブルのレコードを表します。	record要素内はSubTable型以外のフィールドを表す要素が出現します。

APIスキーマ

APIスキーマは、API呼び出し処理で使われるAPIの入出力パラメータを表すスキーマです。

APIの詳細については、「kintone API」(https://cybozudev.zendesk.com/hc/ja/categories/200147600)のREST APIを参照してください。

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <スキーマの本体>
    :
</root>

スキーマの本体(root要素内の要素)はJSON形式とXML形式の相互変換が行われ、APIのパラメータとして表示します。
JSON形式の型としてのオブジェクト型・配列型・文字列型は、それぞれ以下のフォーマットになります。

オブジェクト型

<JSONメンバの名前/>

要素名	属性名	説明	備考
JSONメンバの名前	-	JSONのオブジェクト型を表します。

配列型

<JSONメンバの名前 comment="array"/>

要素名	属性名	説明
JSONメンバの名前	-	JSONの配列型を表します。
-	comment	値がarrayの場合、配列型を表します。
element	-	配列の要素を表します。

文字列型

<JSONメンバの名前 comment="フォーマットを表す属性値">

要素名	属性名	説明	備考
JSONメンバの名前	-	JSONの配列型を表します。
-	comment	フォーマットを表す属性値	フォーマットについては、kintone API仕様の「API スキーマ情報の取得」(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)ページを参照してください。