検索
Close
カテゴリー内の他の記事

フィールド形式

作成日
更新日

Index

利用できるフィールドの Type、Value について

フィールドは以下のような JSON 形式になります。type と value の部分がフィールドの型によって異なります。

  • データの取得、登録、更新には、「フィールドコード」を指定してください。
    ※「フィールドコード」はフィールドの「設定」で確認できます。
  • 次のフィールドタイプの場合には、「フィールド名」で指定してください。
    • カテゴリー
    • ステータス
    • 作業者
  • 登録、更新APIでJSONデータを送信する場合、「value」パラメータのみ送信してください。 「type」パラメータは必要ありません。
    ※後述の通りJavaScript APIの例外として、「テーブル」データを登録・更新する場合は「type」の指定が必要な場合があります。

レコード番号とレコードIDについて

  • レコード番号：レコードに自動的に割り当てられた、ほかのレコードと重複しない番号です。
    ただし、アプリコードを設定したアプリでは、アプリコードと番号の組み合わせがレコード番号になります。
    例：アプリコードが「APPCODE」のアプリのレコード番号は「APPCODE-1」のようになります。
  • レコード ID ：レコードに自動的に割り当てられた、ほかのレコードと重複しない番号で、必ず数値になります。
    API を処理する場合には、レコード ID をご利用ください。

フィールドの形式

レコード情報に関するフィールド

フィールド型 type value の例
※「value の例」の「フィールドコード」は「<>」で囲んでいますが、利用の際には不要です。
レコード番号 ※3 RECORD_NUMBER
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "RECORD_NUMBER",
    "value": "1"
}
アプリコードに「APPCODE」が指定されている場合の例です。 
"<フィールドコード>": {
    "type": "RECORD_NUMBER",
    "value": "APPCODE-1"
}
レコードID ※3 __ID__
  • 取得時のレスポンスのデータ
"$id": {
    "type": "__ID__",
    "value": "1"
}
リビジョン ※3 __REVISION__
  • 取得時のレスポンスのデータ
"$revision": {
    "type": "__REVISION__",
    "value": "5"
}
作成者 ※4 CREATOR
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "CREATOR",
    "value": {
        "code": "sato",
        "name": "Noboru Sato"
    }
}

ゲストユーザーの場合

"<フィールドコード>": {
    "type": "CREATOR",
    "value": {
        "code": "guest/sato@cybozu.com",
        "name": "Noboru Sato"
    }
}
  • 登録時のリクエストデータ
"<フィールドコード>": {
    "value": {
        "code": "sato"
    }
}
作成日時 ※4 CREATED_TIME
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "CREATED_TIME",
    "value": "2012-01-11T11:30:00Z"
}
・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」は固定値です。
・「HH:MM:SS」の後ろの「Z」は固定値で、UTCを表します。
  • 登録時のリクエストデータ
"<フィールドコード>": {
    "value": "2012-01-11T11:30:00Z"
}
・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」は固定値です。
・「HH:MM:SS」の後ろの「Z」は固定値で、UTCを表します。 
"<フィールドコード>": {
    "value": "2012-01-11T11:30:00+09:00"
}
・「±HH:MM」には、UTCとの時刻の差を指定します。 ・未来の日時は指定できません。
更新者 ※4 MODIFIER
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "MODIFIER",
    "value": {
        "code": "sato",
        "name": "Noboru Sato"
    }
}

ゲストユーザーの場合

"<フィールドコード>": {
    "type": "MODIFIER",
    "value": {
        "code": "guest/sato@cybozu.com",
        "name": "Noboru Sato"
    }
}
  • 登録時のリクエストデータ
"<フィールドコード>": {
    "value": {
        "code": "sato"
    }
}
更新日時 ※4 UPDATED_TIME
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "UPDATED_TIME",
    "value": "2012-01-11T11:30:00Z"
}
・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」は固定値です。
・「HH:MM:SS」の後ろの「Z」は固定値で、UTCを表します。
  • 登録時のリクエストデータ
"<フィールドコード>": {
    "value": "2012-01-11T11:30:00Z"
}
・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」は固定値です。
・「HH:MM:SS」の後ろの「Z」は固定値で、UTCを表します。 
"<フィールドコード>": {
    "value": "2012-01-11T11:30:00+09:00"
}
・「±HH:MM」には、UTCとの時刻の差を指定します。
・未来の日時は指定できません。

カスタムフィールド

フィールド型 type value
文字列（1行） SINGLE_LINE_TEXT
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "SINGLE_LINE_TEXT",
    "value": "テストです。"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "テストです。"
}
数値 NUMBER
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "NUMBER",
    "value": "123"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "123"
}
計算 ※3 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" の値は空文字になります。
  • 登録・更新時のリクエストデータ 登録、更新はできません。
文字列（複数行） MULTI_LINE_TEXT
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "MULTI_LINE_TEXT",
    "value": "テスト\nです。"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "テスト\nです。"
}
リッチエディター RICH_TEXT
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "RICH_TEXT",
    "value": "<a href=\"http://www.cybozu.com\">サイボウズ</a>"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "<a href=\"http://www.cybozu.com\">サイボウズ</a>"
}
チェックボックス ※1 CHECK_BOX
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
     "type": "CHECK_BOX",
     "value": [
         "選択肢1",
         "選択肢2"
     ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        "選択肢1",
        "選択肢2"
    ]
}
ラジオボタン ※1 RADIO_BUTTON
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "RADIO_BUTTON",
    "value": "選択肢3"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "選択肢3"
}

・空文字を指定した場合、初期値が設定されます。
ドロップダウン ※1 DROP_DOWN
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "DROP_DOWN",
    "value": "選択肢3"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "選択肢3"
}
複数選択 ※1 MULTI_SELECT
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "MULTI_SELECT",
    "value": [
        "選択肢1",
        "選択肢2"
    ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        "選択肢1",
        "選択肢2"
    ]
}
添付ファイル 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"
        }
    ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        {
            "fileKey":"84a0e9be-c687-4ae6-82be-3b7edab82c21",
        },
        {
            "fileKey": "722258d8-55e7-41ed-8208-adf3bd034e50",
        }
    ]
}
  • 取得時のレスポンスに含まれるファイルキーは、ファイルダウンロードにのみ利用できます。
リンク LINK
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "LINK",
    "value": "http://cybozu.co.jp/"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "http://cybozu.co.jp/"
}
日付 ※2 DATE
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "DATE",
    "value": "2012-01-11"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "2012-01-11"
}
時刻 ※2 TIME
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "TIME",
    "value": "11:30"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "11:30"
}
日時 ※2 DATETIME
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "DATETIME",
    "value": "2012-01-11T11:30:00Z"
}
・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」は固定値です。
・「HH:MM:SS」の後ろの「Z」は固定値で、UTCを表します。
・JSTで指定する場合は、ISO8601の表記に基づいて以下のように指定してください。
  2012-01-11T11:30:00+09:00
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "2012-01-11T11:30:00Z"
}
・「YYYY-MM-DD」と「HH:MM:SS」の間の「T」は固定値です。
・「HH:MM:SS」の後ろの「Z」は固定値で、UTCを表します。 
"<フィールドコード>": {
    "value": "2012-01-11T11:30:00+09:00"
}
・「±HH:MM」には、UTCとの時刻の差を指定します。
ユーザー選択 USER_SELECT
  • 取得時のレスポンスのデータ（ドメインのユーザー）
"<フィールドコード>": {
    "type": "USER_SELECT",
    "value": [
        {
            "code": "sato",
            "name": "Noboru Sato"
        },
        {
            "code": "kato",
            "name": "Misaki Kato"
        }
    ]
}

ゲストユーザーの場合

"<フィールドコード>": {
    "type": "USER_SELECT",
    "value": [
        {
            "code": "guest/sato@cybozu.com",
            "name": "Noboru Sato"
        },
        {
            "code": "guest/kato@cybozu.com",
            "name": "Misaki Kato"
        }
    ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        {
            "code": "sato"
        },
        {
            "code": "kato"
        }
    ]
}
カテゴリー ※3 CATEGORY
  • 取得時のレスポンスのデータ
"カテゴリー": {
    "type": "CATEGORY",
    "value": [
        "category1",
        "category2"
    ]
}
  • 登録・更新時のリクエストデータ 登録、更新はできません。
ステータス ※3 STATUS
  • 取得時のレスポンスのデータ
"ステータス": {
    "type": "STATUS",
    "value": "未処理"
}
  • 登録・更新時のリクエストデータ 登録、更新はできません。
作業者 ※3 STATUS_ASSIGNEE
  • 取得時のレスポンスのデータ
"作業者": {
    "type": "STATUS_ASSIGNEE",
    "value": [
        {
            "code": "sato",
            "name": "Noboru Sato"
        }
    ]
}
  • 登録・更新時のリクエストデータ 登録、更新はできません。
ルックアップ
※3

SINGLE_LINE_TEXT

もしくは

NUMBER

※キー項目のフィールドタイプによって異なります
※登録、更新の際には関連付けるアプリのコピー元のフィールドを重複禁止にする必要があります
  • 取得時のレスポンスのデータ
キー項目が、SINGLE_LINE_TEXT の場合 
"<フィールドコード>": {
    "type": "SINGLE_LINE_TEXT",
    "value": "Code001"
}
キー項目が、NUMBER の場合 
"<フィールドコード>": {
    "type": "NUMBER",
    "value": "10"
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": "Code001"
}
テーブル 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"
                     ]
                 }
             }
        }
    ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        {
            "id": "48291",
            "value": {
                "文字列__1行__0": {
                    "value": "サンプル０"
                },
                "数値_0": {
                    "value": "0"
                }
            }
        },
        {
            "value": {
                "文字列__1行__0": {
                    "value": "サンプル１"
                },
                "数値_0": {
                    "value": "1"
                }
            }
        },
        {
            "value": {
                "文字列__1行__0": {
                    "value": "サンプル２"
                },
                "数値_0": {
                    "value": "2"
                }
            }
        }
    ]
}
  • 1つのテーブルに登録できる行数の上限値は5,000行です。
  • JavaScript APIによる登録・更新：
    • テーブルへの追加、更新時には、既存のすべての行の値を指定する必要があります。
    • 行の並びは、リクエストデータの並び順となります。
    • テーブルへの追加、更新時には、フィールドタイプの指定が必要です。
      フィールドの値を書き換えるを参考にしてください。
  • REST API による登録・更新：
    • テーブルへの追加、更新時には、既存のすべての行の値を指定する必要があります。
    • 行の "id" を指定すると、指定された行の値を更新します。
    • 行の並びは、リクエストデータの並び順となります。
      行の並び替えのみを行う場合、行の "id" を並べ替えたリクエストデータを用意してください。
  • 行の追加・削除の記述方法
    • テーブルの「value」パラメータの値の配列に行オブジェクトを追加、削除することで、テーブルに行を追加・削除することができます。
       
      例）
      追加： record['テーブル']['value'].push(row);
      削除： record['テーブル']['value'].pop();
組織選択

ORGANIZATION_SELECT
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "ORGANIZATION_SELECT",
    "value": [
        {
            "code": "kaihatsu",
            "name": "開発部"
        },
        {
            "code": "jinji",
            "name": "人事部"
        }
    ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        {
            "code": "kaihatsu"
        },
        {
            "code": "jinji"
        }
    ]
}
グループ選択

GROUP_SELECT
  • 取得時のレスポンスのデータ
"<フィールドコード>": {
    "type": "GROUP_SELECT",
    "value": [
        {
            "code": "project_manager",
            "name": "プロジェクトマネージャー"
        },
        {
            "code": "team_leader",
            "name": "チームリーダー"
        }
    ]
}
  • 登録・更新時のリクエストデータ
"<フィールドコード>": {
    "value": [
        {
            "code": "project_manager"
        },
        {
            "code": "team_leader"
        }
    ]
}
関連レコード一覧

REFERENCE_TABLE

下記APIで使用。
グループ

GROUP

下記APIで使用。
ラベル

LABEL

下記APIで使用。
スペース

SPACER

下記APIで使用。
罫線

HR

下記APIで使用。

※1 「value」に指定する値は、kintoneのアプリのフォーム設定で、「項目と順番」で設定した値を指定します。
また、これらのフィールドは削除済みの選択肢についてもAPI及びCSVで指定することができます。

※2 日付、時刻、日時、作成日時、更新日時フィールドにおける、フォーマットやタイムゾーンの取り扱いは、日付のフォーマット を参照してください。

※3 次のフィールドは、値の取得のみできます。値の登録と更新はできません。

  • レコード番号
  • レコードID
  • リビジョン
  • 計算
  • カテゴリー
  • ステータス
  • 作業者
  • ルックアップフィールドによって値が入力されるフィールド

※4 次のフィールドは、値の取得と登録ができます。値の更新はできません。

  • 作成者
  • 作成日時
  • 更新者
  • 更新日時

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

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

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

※1 レコード編集画面でレコードの値を取得するAPI を使ってレコードを取得すると、valueはundefinedになります。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Avatar
近藤史人

システムを利用している現在時間を取得するような方法は無いのでしょうか？

ユーザーの誕生日の項目（birthday）を入力してもらい、現在時間からそれを引いて、年齢を計算するということをしたいと思っています。

 

 

Avatar
cybozu Development team

近藤史人さん

コメントいただきありがとうございます。cybozu developer network運営事務局です。

現在時間はkintoneに関係なく、DateオブジェクトやCDNにあるmoment.jsライブラリを用いて指定することになります。

こちらに類似の質問もありましたので、ご参照いただけると幸いです。
https://developer.cybozu.io/hc/ja/community/posts/115019360903

Avatar
近藤史人

早速のご回答、まことにありがとうございます。

いろいろな手がありそうですね。

試してみます。

 

まずは、お礼まで。

近藤

 

 

Avatar
cybozu Development team

近藤史人さん

試してみていただけると幸いです。
また何かあればぜひコミュニティの方でご質問ください。
https://developer.cybozu.io/hc/ja/community/topics

Avatar
AD

ルックアップフィールドへの登録・更新は、APIトークンでは不可ということですが、パスワード認証でAPIを発行する場合は、可能ということでしょうか。

Avatar
cybozu Development team

AD 様

いつもお世話になっております。
cybozu developer networkの運営事務局です。

＞ルックアップフィールドへの登録・更新は、APIトークンでは不可ということですが、
＞パスワード認証でAPIを発行する場合は、可能ということでしょうか。

ルックアップは、登録／更新時にコピー元からデータを取得し、コピー先フィールドにデータをコピーします。なので、アプリ単位の発行でアプリ内の操作しか権限指定できないAPIトークンではルックアップフィールドへの登録・更新ができません。ただ、コピー元の閲覧権限とコピー先の登録、または更新権限をもっているユーザーによるパスワード認証を使えば、 可能になります。(トークンの発行は不要です。)

こちらのコメントをご参考いただけると幸いです。
https://developer.cybozu.io/hc/ja/community/posts/115010536086

Avatar
Sota Fukuda

テーブルの値をGETで取得しようとすると、なぜかハッシュ値しか返ってきません。原因わかりますでしょうか。

Avatar
cybozu Development team

Sota Fukudaさま

当方でREST APIのGETでテーブルの値を取得してみましたが、特に問題なく取得できましたので、API自体に問題はないようです。

以下にいただきましたコメントと同一の件の場合、コミュニティをご活用されると良いかと考えます。

https://developer.cybozu.io/hc/ja/articles/202331474?page=2#comment_360000643831

あまりお役に立てず申し訳ありませんが、よろしくお願いいたします。

Avatar
進藤良平

ルックアップ項目を登録・更新する際に
コピー元フィールドではなくレコードIDで指定することは可能でしょうか
例えば下記のようにリクエストボディなどで指定できたりなど

"<フィールドコード>": { "type": "NUMBER", "value": "1" }

というのも、コピー元のフィールドはできれば重複禁止にしたくなく。

お手数おかけいたしますが、ご回答いただけますよう宜しくお願いいたします。

進藤良平により編集されました
Avatar
cybozu Development team

進藤良平 様

お世話になっております。cybozu developer network事務局でございます。

恐れ入りますが、APIでのルックアップフィールド操作をレコードID指定で行うことはできません。

コピー元のフィールドを重複禁止にしたくないということですので、以下の運用ではいかがでしょうか。

  • ルックアップフィールドコピー元フィールドを「レコード番号」にする
    （コピー先アプリには、コピー元からレコード番号をコピーして入れるためのフィールドを別途用意する）
  • 値を取得したいフィールドについては、「ほかのフィールドのコピー」で取得する

また、コミュニティにご投稿頂くと、有志の有識者からアドバイスを頂くことができます。
他にもアイディアを頂ける可能性がございますので、是非ご活用ください。
https://developer.cybozu.io/hc/ja/community/topics/200034345

以上、よろしくお願いいたします。

Avatar
進藤良平

遅くなりましたが、ご回答ありがとうございます。
承知いたしました。参考とさせていただきます。

Avatar
mariku

アプリのフィールドコードを取得するAPIはありますか？

Avatar
cybozu Development team

mariku 様

お世話になっております。
cybozu developer network 事務局です。

フォームの設定の取得APIを使ってフィールドコードの取得が可能です。

 

Avatar
cybozu Development team

Jason Yun様

お世話になっております。
cybozu developer network 事務局です。

通常であればご提示いただいている構造で問題ないように見受けられますが、
アプリの設定やプログラム等など何か別で問題があるのかもしれません。

恐れ入りますが、こちらのコメント欄は、記事自体へのフィードバック用となりますので、
技術的な問題などに関するご質問は、ぜひコミュニティをご活用ください。
https://developer.cybozu.io/hc/ja/community/topics

サインインしてコメントを残してください。