kintone API ドキュメント

フィールド形式

目次

フィールドの情報

API でアプリのレコード情報を操作するとき、 フィールドの形式 に示す形式でフィールドの値を取得または設定します。
フィールドを指定するには、次の 2 つの方法があります。

  • 方法 1：フィールド名を指定する。
    次のフィールドでは、フィールド名を指定します。
    • カテゴリー
    • ステータス
    • 作業者
  • 方法 2：フィールドコードを指定する。
    方法 1 に挙げたフィールド以外のフィールドでは、フィールドコードを指定します。
    フィールドコードは、 フィールドの設定 (External link) で確認できます。

レコード ID とレコード番号

レコード ID は、レコードに自動的に割り当てられた、他のレコードと重複しない数値です。
API で特定のレコードを指定する場合には、レコード ID を利用します。

レコード番号は、レコードに自動的に割り当てられた、ほかのレコードと重複しない番号です。
アプリコードを設定しているかどうかで、値の形式が異なります。

  • アプリコードを設定していない場合：レコード ID と同じです。
  • アプリコードを設定している場合：アプリコードとレコード ID の組み合わせです。
    たとえば、アプリコードを「APPCODE」に設定している場合、レコード ID が 1 のレコードでは、レコード番号は「APPCODE-1」です。

フォームを装飾するフィールド

次のフィールドは、フォームを装飾するフィールドです。
値の取得／登録／更新はできません。

  • ラベル
  • スペース
  • 罫線
  • グループ

フォームの設定情報を取得したり、変更する場合には、次の API を利用してください。

関連レコード一覧

関連レコード一覧フィールドに対する、値の取得／登録／更新はできません。

フォームの設定情報を取得したり、変更する場合には、次の API を利用してください。

フィールドの形式

値を取得するとき

フィールドコード は、アプリのフィールドコードに置き換えてください。

レコード情報に関するフィールド
フィールドの種類 type value の例 備考
レコード番号 RECORD_NUMBER アプリコードを設定していない場合
"フィールドコード": {
  "type": "RECORD_NUMBER",
  "value": "1"
}
アプリコードに「APPCODE」を指定したとき
"フィールドコード": {
  "type": "RECORD_NUMBER",
  "value": "APPCODE-1"
}
レコードID __ID__ 
"$id": {
  "type": "__ID__",
  "value": "1"
}
リビジョン __REVISION__ 
"$revision": {
  "type": "__REVISION__",
  "value": "5"
}
作成者 CREATOR 通常のユーザーの場合
"フィールドコード": {
  "type": "CREATOR",
  "value": {
    "code": "sato",
    "name": "Noboru Sato"
  }
}
ゲストユーザーの場合
"フィールドコード": {
  "type": "CREATOR",
  "value": {
    "code": "guest/sato@example.com",
    "name": "Noboru Sato"
  }
}
作成日時 CREATED_TIME 
"フィールドコード": {
  "type": "CREATED_TIME",
  "value": "2012-01-11T11:30:00Z"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
更新者 MODIFIER 通常のユーザーの場合
"フィールドコード": {
  "type": "MODIFIER",
  "value": {
    "code": "sato",
    "name": "Noboru Sato"
  }
}
ゲストユーザーの場合
"フィールドコード": {
  "type": "MODIFIER",
  "value": {
    "code": "guest/sato@example.com",
    "name": "Noboru Sato"
  }
}
更新日時 UPDATED_TIME 
"フィールドコード": {
  "type": "UPDATED_TIME",
  "value": "2012-01-11T11:30:00Z"
}
カスタムフィールド
フィールドの種類 type value の例 備考
文字列（1行） SINGLE_LINE_TEXT 
"フィールドコード": {
  "type": "SINGLE_LINE_TEXT",
  "value": "テストです。"
}
文字列（複数行） MULTI_LINE_TEXT 
"フィールドコード": {
  "type": "MULTI_LINE_TEXT",
  "value": "テスト\n です。"
}
リッチエディター RICH_TEXT 
"フィールドコード": {
  "type": "RICH_TEXT",
  "value": "<a href=\"http://www.example.com\">サンプル</a>"
}
数値 NUMBER 
"フィールドコード": {
  "type": "NUMBER",
  "value": "123"
}
計算 CALC 
"フィールドコード": {
  "type": "CALC",
  "value": "123"
}
 表示書式の設定により value の形式は異なります。
  • 数値：「1234」
  • 数値（カンマ区切り）：「1234」
  • 日時：「2012-01-11T11:30:00Z」
  • 日付：「2012-01-11」
  • 時刻：「11:30」
  • 時間（時分）：「49:30」（画面表示上は「49時間30分」）
  • 時間（日時分）：「49:30」（画面表示上は「2日1時間30分」）
下記イベントでは value の値は空文字になります。
チェックボックス CHECK_BOX 
"フィールドコード": {
  "type": "CHECK_BOX",
  "value": [
    "選択肢1",
    "選択肢2"
   ]
}
ラジオボタン RADIO_BUTTON 
"フィールドコード": {
  "type": "RADIO_BUTTON",
  "value": "選択肢3"
}
複数選択 MULTI_SELECT 
"フィールドコード": {
  "type": "MULTI_SELECT",
  "value": [
    "選択肢1",
    "選択肢2"
  ]
}
ドロップダウン DROP_DOWN 
"フィールドコード": {
  "type": "DROP_DOWN",
  "value": "選択肢3"
}
ユーザー選択 USER_SELECT 通常のユーザーの場合
"フィールドコード": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "sato",
     "name": "Noboru Sato"
    },
   {
      "code": "kato",
     "name": "Misaki Kato"
    }
  ]
}
ゲストユーザーの場合
"フィールドコード": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "guest/sato@example.com",
      "name": "Noboru Sato"
    },
    {
      "code": "guest/kato@example.com",
      "name": "Misaki Kato"
    }
  ]
}
組織選択 ORGANIZATION_SELECT 
"フィールドコード": {
  "type": "ORGANIZATION_SELECT",
  "value": [
    {
      "code": "kaihatsu",
      "name": "開発部"
    },
    {
      "code": "jinji",
      "name": "人事部"
    }
  ]
}
グループ選択 GROUP_SELECT 
"フィールドコード": {
  "type": "GROUP_SELECT",
  "value": [
    {
      "code": "project_manager",
      "name": "プロジェクトマネージャー"
    },
    {
      "code": "team_leader",
      "name": "チームリーダー"
    }
  ]
}
日付 DATE 
"フィールドコード": {
  "type": "DATE",
  "value": "2012-01-11"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
時刻 TIME 
"フィールドコード": {
  "type": "TIME",
  "value": "11:30"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
日時 DATETIME 
"フィールドコード": {
  "type": "DATETIME",
  "value": "2012-01-11T11:30:00Z"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
リンク LINK 
"フィールドコード": {
  "type": "LINK",
  "value": "http://www.example.com/"
}
添付ファイル FILE 
"フィールドコード": {
  "type": "FILE",
  "value": [
    {
      "contentType": "text/plain",
      "fileKey":"201202061155587E339F9067544F1A92C743460E3D12B3297",
      "name": "17to20_VerupLog （1）.txt",
      "size": "23175"
    },
    {
      "contentType": "text/plain",
      "fileKey": "201202061155583C763E30196F419E83E91D2E4A03746C273",
      "name": "17to20_VerupLog.txt",
      "size": "23175"
    }
  ]
}
 取得時のレスポンスに含まれるファイルキーは、ファイルダウンロードにのみ利用できます。
ルックアップ SINGLE_LINE_TEXT
NUMBER *1 		キー項目が、SINGLE_LINE_TEXT の場合
"フィールドコード": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Code001"
}
キー項目が、NUMBER の場合
"フィールドコード": {
  "type": "NUMBER",
  "value": "10"
}
テーブル SUBTABLE 
"フィールドコード": {
  "type": "SUBTABLE",
  "value": [
    {
      "id": "48290",
      "value": {
        "文字列__1行__0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "サンプル１"
        },
        "数値_0": {
          "type": "NUMBER",
          "value": "1"
        },
        "チェックボックス_0": {
          "type": "CHECK_BOX",
          "value": ["選択肢1"]
        }
      }
    },
    {
      "id": "48291",
      "value": {
        "文字列__1行__0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "サンプル２"
        },
        "数値_0": {
          "type": "NUMBER",
          "value": "2"
        },
        "チェックボックス_0": {
          "type": "CHECK_BOX",
          "value": ["選択肢2"]
        }
      }
    }
  ]
}
関連レコード一覧 REFERENCE_TABLE
 値の取得はできません。
カテゴリー CATEGORY 
"カテゴリー": {
  "type": "CATEGORY",
  "value": [
    "category1",
    "category2"
  ]
}
ステータス STATUS 
"ステータス": {
  "type": "STATUS",
  "value": "未処理"
}
作業者 STATUS_ASSIGNEE 
"作業者": {
  "type": "STATUS_ASSIGNEE",
  "value": [
    {
      "code": "sato",
      "name": "Noboru Sato"
    }
  ]
}
ラベル LABEL 値の取得はできません。
スペース SPACER 値の取得はできません。
罫線 HR 値の取得はできません。
グループ GROUP 値の取得はできません。

*1 キー項目のフィールドタイプによって異なります。 ^

値を登録、または更新するとき

フィールドコード は、アプリのフィールドコードに置き換えてください。

レコード情報に関するフィールド
フィールドの種類 type value の例 備考
レコード番号 RECORD_NUMBER なし 値の登録、または更新はできません。
レコードID __ID__ なし 値の登録、または更新はできません。
リビジョン __REVISION__ なし 値の登録、または更新はできません。
作成者 CREATOR 通常のユーザーの場合
"フィールドコード": {
  "value": {
  "code": "sato",
  "name": "Noboru Sato"
  }
}
ゲストユーザーの場合
"フィールドコード": {
  "type": "CREATOR",
  "value": {
  "code": "guest/sato@example.com",
  "name": "Noboru Sato"
  }
}
 値の更新はできません。
作成日時 CREATED_TIME 
"フィールドコード": {
  "value": "2012-01-11T11:30:00Z"
}
 未来の日付を指定することはできません。
値の更新はできません。
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
更新者 MODIFIER 通常のユーザーの場合
"フィールドコード": {
  "value": {
    "code": "sato",
    "name": "Noboru Sato"
  }
}
ゲストユーザーの場合
"フィールドコード": {
  "type": "MODIFIER",
  "value": {
    "code": "guest/sato@example.com",
    "name": "Noboru Sato"
  }
}
 値の更新はできません。
更新日時 UPDATED_TIME 
"フィールドコード": {
  "value": "2012-01-11T11:30:00Z"
}
 値の更新はできません。
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
カスタムフィールド
フィールドの種類 type value の例 備考
文字列（1行） SINGLE_LINE_TEXT 
"フィールドコード": {
  "value": "テストです。"
}
文字列（複数行） MULTI_LINE_TEXT 
"フィールドコード": {
  "value": "テスト\n です。"
}
リッチエディター RICH_TEXT 
"フィールドコード": {
  "value": "<a href=\"http://www.example.com\">サンプル</a>"
}
数値 NUMBER 
"フィールドコード": {
  "value": "123"
}
計算 CALC 
"フィールドコード": {
  "value": "123"
}
 値の登録、または更新はできません。
チェックボックス *1 CHECK_BOX 
"フィールドコード": {
  "value": [
    "選択肢1",
    "選択肢2"
   ]
}
ラジオボタン *1 RADIO_BUTTON 
"フィールドコード": {
  "value": "選択肢3"
}
 空文字を指定した場合、初期値が設定されます。
複数選択 *1 MULTI_SELECT 
"フィールドコード": {
  "value": [
    "選択肢1",
    "選択肢2"
  ]
}
ドロップダウン *1 DROP_DOWN 
"フィールドコード": {
  "value": "選択肢3"
}</pre
ユーザー選択 USER_SELECT 通常のユーザーの場合
"フィールドコード": {
  "value": [
   {
      "code": "sato",
      "name": "Noboru Sato"
    },
   {
      "code": "kato",
      "name": "Misaki Kato"
    }
  ]
}
ゲストユーザーの場合
"フィールドコード": {
  "type": "USER_SELECT",
  "value": [
    {
      "code": "guest/sato@example.com",
      "name": "Noboru Sato"
    },
    {
      "code": "guest/kato@example.com",
      "name": "Misaki Kato"
    }
  ]
}
組織選択 ORGANIZATION_SELECT 
"フィールドコード": {
  "value": [
    {
      "code": "kaihatsu",
      "name": "開発部"
    },
    {
      "code": "jinji",
      "name": "人事部"
    }
  ]
}
グループ選択 GROUP_SELECT 
"フィールドコード": {
  "value": [
    {
      "code": "project_manager",
      "name": "プロジェクトマネージャー"
    },
    {
      "code": "team_leader",
      "name": "チームリーダー"
    }
  ]
}
日付 DATE 
"フィールドコード": {
  "value": "2012-01-11"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
時刻 TIME 
"フィールドコード": {
  "value": "11:30"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
日時 DATETIME 
"フィールドコード": {
  "value": "2012-01-11T11:30:00Z"
}
 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。
リンク LINK 
"フィールドコード": {
  "value": "http://www.example.com/"
}
添付ファイル FILE 
"フィールドコード": {
  "value": [
    {
      "fileKey":"84a0e9be-c687-4ae6-82be-3b7edab82c21",
    },
    {
      "fileKey": "722258d8-55e7-41ed-8208-adf3bd034e50",
    }
  ]
}
ルックアップ SINGLE_LINE_TEXT
NUMBER *2 		キー項目が、SINGLE_LINE_TEXT の場合
"フィールドコード": {
  "type": "SINGLE_LINE_TEXT",
  "value": "Code001"
}
キー項目が、NUMBER の場合
"フィールドコード": {
  "type": "NUMBER",
  "value": "10"
}
 登録、または更新する場合には、関連付けるアプリのコピー元のフィールドを重複禁止にしてください。
テーブル SUBTABLE 
"フィールドコード": {
  "value": [
    {
      "id": "48290",
      "value": {
        "文字列__1行__0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "サンプル１"
        },
        "数値_0": {
          "type": "NUMBER",
          "value": "1"
        },
        "チェックボックス_0": {
          "type": "CHECK_BOX",
          "value": ["選択肢1"]
        }
      }
    },
    {
      "id": "48291",
      "value": {
        "文字列__1行__0": {
          "type": "SINGLE_LINE_TEXT",
          "value": "サンプル２"
        },
        "数値_0": {
          "type": "NUMBER",
          "value": "2"
        },
        "チェックボックス_0": {
          "type": "CHECK_BOX",
          "value": ["選択肢2"]
        }
      }
    }
  ]
}
 1 つのテーブルに大量の行を追加しないでください。
アプリの構成によっては、負荷がかかり、レコードの表示や REST API を使った操作など、レコードの処理に影響します。
REST API や JavaScript API でテーブルを操作するときの注意事項は、 テーブルの操作 を参照してください。
関連レコード一覧 REFERENCE_TABLE 値の登録または更新はできません。
カテゴリー CATEGORY 値の登録または更新はできません。
ステータス STATUS 値の登録または更新はできません。
作業者 STATUS_ASSIGNEE 値の登録または更新はできません。
ラベル LABEL 値の登録または更新はできません。
スペース SPACER 値の登録または更新はできません。
罫線 HR 値の登録または更新はできません。
グループ GROUP 値の登録または更新はできません。

*1 value には、kintone のアプリのフォーム設定で、「項目と順番」で設定した値を指定してください。
削除した選択肢の項目も API で指定できます。 ^

*2 キー項目のフィールドタイプによって異なります。 ^

テーブルの操作
JavaScript APIによる登録や更新
  • テーブルへの追加、更新時には、既存のすべての行の値を指定してください。
  • 行の並びは、リクエストデータの並び順となります。
  • テーブルへの追加、更新時には、フィールドタイプの指定が必要です。
    フィールドの値を書き換える を参照してください。
REST API による登録や更新
  • テーブルへの追加、更新時には、既存のすべての行の値を指定してください。
  • 行の id を指定すると、指定された行の値を更新します。
  • 行の並びは、リクエストデータの並び順となります。
  • 行の並び替えのみを行う場合、行の id を並べ替えたリクエストデータを用意してください。
行を追加、削除するとき

テーブルの「value」パラメーターの値の配列に行オブジェクトを追加、削除することで、テーブルに行を追加・削除できます。

次のコードは、push() で行を追加する例です。

1

record['テーブル']['value'].push(row);

次のコードは、pop() で行を削除例です。

1

record['テーブル']['value'].pop();

フィールドの値が空の場合

空のフィールドの値を取得した場合、フィールドの value は次のようになります。

フィールドタイプ value の値
  • 文字列（1行）
  • 文字列（複数行）
  • 数値
  • 日時
  • リンク
  • ルックアップ
 
"value": ""
「レコード追加画面」または「レコード編集画面」でJavaScript APIを使用した場合
"value": undefined
  • リッチエディター
 
"value": ""
  • 日付
  • 時刻
 
"value": null
「レコード追加画面」または「レコード編集画面」でJavaScript APIを使用した場合
"value": undefined
  • ドロップダウン
 
"value": ""
REST APIを使用した場合
"value": null
「レコード追加画面」または「レコード編集画面」でJavaScript APIを使用した場合
"value": undefined
  • ラジオボタン
 REST APIを使用した場合
"value": null
JavaScript APIを使用した場合
"value": ""
  • チェックボックス
  • 複数選択
  • ユーザー選択
  • 組織選択
  • グループ選択
  • 添付ファイル
  • テーブル
  • カテゴリー
  • 作業者
 
"value": []

フィールドの値を空に設定する場合

フィールドに空の値を設定する場合、フィールドの value を次のように設定します。

フィールドタイプ valueの値
  • 文字列（1行）
  • 文字列（複数行）
  • リッチエディター
  • 数値
  • ドロップダウン
  • 日時
  • リンク
  • ルックアップ
 
"value": ""
または
"value": null
  • 日付
  • 時刻
 
"value": null
  • チェックボックス
  • 複数選択
  • ユーザー選択
  • 組織選択
  • グループ選択
  • 添付ファイル
  • テーブル
 
"value": []
  • ラジオボタン
  • カテゴリー
  • 作業者
 なし