フィールド形式
フィールドの情報
API でアプリのレコード情報を操作するとき、
フィールドの形式 に示す形式でフィールドの値を取得または設定します。
フィールドを指定するには、次の 2 つの方法があります。
- 方法 1:フィールド名を指定する。
次のフィールドでは、フィールド名を指定します。- カテゴリー
- ステータス
- 作業者
- 方法 2:フィールドコードを指定する。
方法 1 に挙げたフィールド以外のフィールドでは、フィールドコードを指定します。
フィールドコードは、 フィールドの設定で確認できます。
レコード ID とレコード番号
レコード ID は、レコードに自動的に割り当てられた、他のレコードと重複しない数値です。
API で特定のレコードを指定する場合には、レコード ID を利用します。
レコード番号は、レコードに自動的に割り当てられた、ほかのレコードと重複しない番号です。
アプリコードを設定しているかどうかで、値の形式が異なります。
- アプリコードを設定していない場合:レコード ID と同じです。
- アプリコードを設定している場合:アプリコードとレコード ID の組み合わせです。
たとえば、アプリコードを「APPCODE」に設定している場合、レコード ID が 1 のレコードでは、レコード番号は「APPCODE-1」です。
フォームを装飾するフィールド
次のフィールドは、フォームを装飾するフィールドです。
値の取得/登録/更新はできません。
- ラベル
- スペース
- 罫線
- グループ
フォームの設定情報を取得したり、変更する場合には、次の API を利用してください。
- ラベル、スペース、罫線
- グループ
関連レコード一覧
関連レコード一覧フィールドに対する、値の取得/登録/更新はできません。
フォームの設定情報を取得したり、変更する場合には、次の API を利用してください。
- フィールドの一覧を取得するAPI のレスポンス
- フィールドを追加するAPI のリクエスト
- フィールドの設定を変更するAPI のリクエスト
- フィールドを削除するAPI のリクエスト
フィールドの形式
値を取得するとき
フィールドコード
は、アプリのフィールドコードに置き換えてください。
レコード情報に関するフィールド
フィールドの種類 | type | value の例 | 備考 |
---|---|---|---|
レコード番号 | RECORD_NUMBER | アプリコードを設定していない場合"フィールドコード": {アプリコードに「APPCODE」を指定したとき "フィールドコード": { |
|
レコードID | __ID__ | "$id": { |
|
リビジョン | __REVISION__ | "$revision": { |
|
作成者 | CREATOR | 通常のユーザーの場合"フィールドコード": {ゲストユーザーの場合 "フィールドコード": { |
|
作成日時 | CREATED_TIME | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
更新者 | MODIFIER | 通常のユーザーの場合"フィールドコード": {ゲストユーザーの場合 "フィールドコード": { |
|
更新日時 | UPDATED_TIME | "フィールドコード": { |
カスタムフィールド
フィールドの種類 | type | value の例 | 備考 |
---|---|---|---|
文字列(1行) | SINGLE_LINE_TEXT | "フィールドコード": { |
|
文字列(複数行) | MULTI_LINE_TEXT | "フィールドコード": { |
|
リッチエディター | RICH_TEXT | "フィールドコード": { |
|
数値 | NUMBER | "フィールドコード": { |
|
計算 | CALC | "フィールドコード": { |
表示書式の設定により value の形式は異なります。
value の値は空文字になります。 |
チェックボックス | CHECK_BOX | "フィールドコード": { |
|
ラジオボタン | RADIO_BUTTON | "フィールドコード": { |
|
複数選択 | MULTI_SELECT | "フィールドコード": { |
|
ドロップダウン | DROP_DOWN | "フィールドコード": { |
|
ユーザー選択 | USER_SELECT | 通常のユーザーの場合"フィールドコード": {ゲストユーザーの場合 "フィールドコード": { |
|
組織選択 | ORGANIZATION_SELECT | "フィールドコード": { |
|
グループ選択 | GROUP_SELECT | "フィールドコード": { |
|
日付 | DATE | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
時刻 | TIME | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
日時 | DATETIME | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
リンク | LINK | "フィールドコード": { |
|
添付ファイル | FILE | "フィールドコード": { |
取得時のレスポンスに含まれるファイルキーは、ファイルダウンロードにのみ利用できます。 |
ルックアップ | SINGLE_LINE_TEXT NUMBER *1 |
キー項目が、SINGLE_LINE_TEXT の場合"フィールドコード": {キー項目が、NUMBER の場合 "フィールドコード": { |
|
テーブル | SUBTABLE | "フィールドコード": { |
|
関連レコード一覧 | REFERENCE_TABLE |
値の取得はできません。 | |
カテゴリー | CATEGORY | "カテゴリー": { |
|
ステータス | STATUS | "ステータス": { |
|
作業者 | STATUS_ASSIGNEE | "作業者": { |
|
ラベル | LABEL | 値の取得はできません。 | |
スペース | SPACER | 値の取得はできません。 | |
罫線 | HR | 値の取得はできません。 | |
グループ | GROUP | 値の取得はできません。 |
*1 キー項目のフィールドタイプによって異なります。 ^
値を登録、または更新するとき
フィールドコード
は、アプリのフィールドコードに置き換えてください。
レコード情報に関するフィールド
フィールドの種類 | type | value の例 | 備考 |
---|---|---|---|
レコード番号 | RECORD_NUMBER | なし | 値の登録、または更新はできません。 |
レコードID | __ID__ | なし | 値の登録、または更新はできません。 |
リビジョン | __REVISION__ | なし | 値の登録、または更新はできません。 |
作成者 | CREATOR | 通常のユーザーの場合"フィールドコード": {ゲストユーザーの場合 "フィールドコード": { |
値の更新はできません。 |
作成日時 | CREATED_TIME | "フィールドコード": { |
未来の日付を指定することはできません。 値の更新はできません。 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
更新者 | MODIFIER | 通常のユーザーの場合"フィールドコード": {ゲストユーザーの場合 "フィールドコード": { |
値の更新はできません。 |
更新日時 | UPDATED_TIME | "フィールドコード": { |
値の更新はできません。 フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
カスタムフィールド
フィールドの種類 | type | value の例 | 備考 |
---|---|---|---|
文字列(1行) | SINGLE_LINE_TEXT | "フィールドコード": { |
|
文字列(複数行) | MULTI_LINE_TEXT | "フィールドコード": { |
|
リッチエディター | RICH_TEXT | "フィールドコード": { |
|
数値 | NUMBER | "フィールドコード": { |
|
計算 | CALC | "フィールドコード": { |
値の登録、または更新はできません。 |
チェックボックス *1 | CHECK_BOX | "フィールドコード": { |
|
ラジオボタン *1 | RADIO_BUTTON | "フィールドコード": { |
空文字を指定した場合、初期値が設定されます。 |
複数選択 *1 | MULTI_SELECT | "フィールドコード": { |
|
ドロップダウン *1 | DROP_DOWN | "フィールドコード": { |
|
ユーザー選択 | USER_SELECT | 通常のユーザーの場合"フィールドコード": {ゲストユーザーの場合 "フィールドコード": { |
|
組織選択 | ORGANIZATION_SELECT | "フィールドコード": { |
|
グループ選択 | GROUP_SELECT | "フィールドコード": { |
|
日付 | DATE | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
時刻 | TIME | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
日時 | DATETIME | "フィールドコード": { |
フォーマットやタイムゾーンの取り扱いは、 日付のフォーマット を確認してください。 |
リンク | LINK | "フィールドコード": { |
|
添付ファイル | FILE | "フィールドコード": { |
|
ルックアップ | SINGLE_LINE_TEXT NUMBER *2 |
キー項目が、SINGLE_LINE_TEXT の場合"フィールドコード": {キー項目が、NUMBER の場合 "フィールドコード": { |
登録、または更新する場合には、関連付けるアプリのコピー元のフィールドを重複禁止にしてください。 |
テーブル | SUBTABLE | "フィールドコード": { |
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()
で行を追加する例です。
|
|
次のコードは、pop()
で行を削除例です。
|
|
フィールドの値が空の場合
空のフィールドの値を取得した場合、フィールドの value は次のようになります。
フィールドタイプ | value の値 |
---|---|
|
"value": ""「レコード追加画面」または「レコード編集画面」でJavaScript APIを使用した場合 "value": undefined |
|
"value": "" |
|
"value": null「レコード追加画面」または「レコード編集画面」でJavaScript APIを使用した場合 "value": undefined |
|
"value": ""REST APIを使用した場合 "value": null「レコード追加画面」または「レコード編集画面」でJavaScript APIを使用した場合 "value": undefined |
|
REST APIを使用した場合"value": nullJavaScript APIを使用した場合 "value": "" |
|
"value": [] |
フィールドの値を空に設定する場合
フィールドに空の値を設定する場合、フィールドの value を次のように設定します。
フィールドタイプ | valueの値 |
---|---|
|
"value": ""または "value": null |
|
"value": null |
|
"value": [] |
|
なし |