レコード取得 API – Canbus. ヘルプセンター

レコード取得 API を使用すると、指定されたアプリからレコードのデータを取得できます。

エンドポイント URL - https://<tenant-id>.canbus.com/api/records/detail
メソッド - GET

リクエストヘッダーの形式

以下のリクエストヘッダーが必要です。

Content-Type: application/json

リクエストボディの形式

レコード取得 API のリクエストボディ形式は次のとおりです。

{
    "tenant_id": <tenant-id>,
    "app_id": <app-id>,
    "api_key": <api-key>,
    "api_secret": <api-secret>,
    "records": [
        <record-object-id>,
        ...
    ]
}

淡色部分には、Canbus. API の認証情報を挿入します。認証情報の送信方法については、認証を参照してください。

records は文字列の配列です。取得するレコードのレコード ID を要素として指定します。

取得するレコードのレコード ID を確認するには、最初にレコード一覧 API を使用して対象レコードを取得してください。レコード作成 API を使用してレコードを作成した場合は、作成されたレコードの ID がレコード作成 API のレスポンスボディに格納されています。ID がレコード作成後に変更されることはありません。レコードの ID はレコード番号とは異なります。

レスポンスボディの形式

レコード取得 API のレスポンスボディ形式は次のとおりです。

{
    "authen": "OK",
    "results": [
        {
            "result": <result-code>,
            "id": <record-object-id>,
            "data": [
                {
                    "_id": <record-object-id>,
                    <form-item-id>: <form-item-value>,
                    ...
                }
            ]
        }, ...
    ]
}

results は取得結果を表すオブジェクト配列です。リクエストボディの records 配列の要素数と results の要素数は同じになり、互いの各要素が 1 対 1 で対応します。

レコード取得 API では、取得しようとしたレコードごとに以下の result コードが返されます。

0 - 取得に成功
7005 - 指定された ID のレコードが存在しない

各要素の id は、リクエストボディの records 配列で指定されたレコード ID です。この値は、指定されたレコードの ID が実際に取得されたかどうかに関わらず、レスポンスボディに含まれます。

各要素の data は、取得されたレコードの内容を表すオブジェクト配列です。現在のレコード取得 API では、data の要素数は 0（レコードが取得できなかった場合）または 1（レコードが取得された場合）のいずれかです。2 以上の要素が返されることはありません。

レコードが取得された場合、data のただ 1 つの要素は _id とその他のプロパティを持つオブジェクトです。

_id は、取得されたレコードの ID です。results の各要素が持つ id の値とは異なり、data 要素の _id の値はレコードが正常に取得された場合にのみ返されます。

その他のプロパティとして、レコード取得 API を呼び出したテーブルの各フォーム項目の ID がそのまま返されます。プロパティの値は、各フォーム項目に対してレコードで入力されている値です。

未入力項目の値

レコードに未入力項目がある場合、その項目を表すプロパティ自体が data 要素に含まれません。プロパティの値がブランク、空の文字列、null になるわけではないため、注意してください。

レコード取得 API だけでは、特定のレコードの項目が未入力になっているだけなのか、それともその項目自体がフォーム上に存在しないのかを区別できません。テーブル上に存在するすべてのフォーム項目を確認するには、メタデータ API を使用してください。

項目値の形式

レコード取得 API で返される各フォーム項目の値は、項目の型に応じて以下の形式になります。

数値 - フォーム上で入力された数値
文字列 - フォーム上で入力された文字列
リッチテキスト - リッチテキストの HTML 表現
日付 - "YYYY/MM/DD" 形式の文字列
時刻 - "HH:MM" 形式の文字列
日付と時刻 - "YYYY/MM/DD HH:MM" 形式の文字列
添付ファイル - すべての添付ファイル名をカンマ区切りで連結した文字列
ラジオボタン - 選択された選択肢のラベル
チェックボックス - 選択された選択肢のラベルをカンマ区切りで連結した文字列
プルダウン - 選択された選択肢のラベル
計算式 - 計算結果を表す文字列、数値、または日付と時刻を表す文字列
ユーザー選択 - 選択されたユーザーの表示名。表示名が設定されていない場合はログイン ID
表組み - 表組み内の各行を JSON 文字列として表した JSON 配列
アプリ連携 - キー項目の値
レコード参照 - レコード参照内の各行を JSON 文字列として表した JSON 配列
グリッド参照 - グリッド参照内の各行を JSON 文字列として表した JSON 配列
組織選択 - 選択された組織名を、最上位の組織から "/" 区切りで連結した文字列
レコード番号 - 数値
作成者 - レコードの作成者であるユーザーのログイン ID
作成日時 - "YYYY/MM/DD HH:MM" 形式の文字列
更新者 - レコードの最終更新者であるユーザーのログイン ID
更新日時 - "YYYY/MM/DD HH:MM" 形式の文字列
作成者の組織 - レコードの作成者の所属組織名を、最上位の組織から "/" 区切りで連結した文字列
ステータス - ステータス名の文字列

ラベル項目、罫線項目、ボタン項目はレコード取得 API のレスポンスには含まれません。

リクエストヘッダーの形式

リクエストボディの形式

レスポンスボディの形式

未入力項目の値

項目値の形式

関連情報

関連記事