レコード一覧 API を使用することで、レコード一覧の情報を取得することが可能です。
1. APIの基本形式
{
① "tenant_id": "test",
② "app_id": "aaaaaaaaaaaaaaa",
③ "api_key": "bbbbbbb",
④ "api_secret": "ccccccccccccccccc",
"property": [
{
"System_Create_User": "admin",
"Text": "レコード追加テスト",
"Number": "1234",
}
]
}
①. Canbus. のテナントID を入力します。（必須）
②. 各テーブルで発行される [API権限] の [アプリID] を入力します。（必須）
③. 各テーブルで発行される [API権限] の [APIキー] を入力します。（必須）
④. 各テーブルで発行される [API権限] の [APIシークレット] を入力します。（必須）
2. レコード一覧 API
| HTTP | URL |
| GET | https://aaa.canbus.com/api/records |
※URL "aaa" は、お客様毎の テナントID を入力してください。
3. HTTP Request header
ご使用いただいている外部ツールに、下記のヘッダーを設定します。
| ヘッダー | 値 |
| Content-Type | "application/json" |
4. Request body
例としまして、レコードNO,1から開始して100レコード分のレコード情報を取得します。
レコード作成 API のリクエストボディは下記の通りとなります。
{
※"tenant_id": "test",
※"app_id": "aaaaaaaaaaaaaaa",
※"api_key": "bbbbbbb",
※"api_secret": "ccccccccccccccccc",
①"record_list":
{
②"start": 0,
③"number": 100,
④"filter": "000000000000000000000000"
}
}
[※] は入力必須です。
① record_list
必須。レコード一覧 API ではpropertyを "record_list" と入力します。
② start
レコードの取得を開始する位置を指定する値となり、レコード一覧画面で表示した際の上から
何番目のレコードから取得を開始するか決めるものとなります。 ※値は「"1"」ではなく「"0"」から始まるため、一番上を指定する場合は「”0”」としてください。
③ number
「start」 から何レコード取得するかの数値を指定するために
「start」で指定したレコードから何レコード取得するかの数値を指定します。
※レコード【一覧取得】 API は一度に取得できる上限が1000レコードとなっております。
そのため、「"number"」の最大値は1000としてください。
※レコードの情報量によっては、使用しているツール側でタイムアウトが発生する可能性が
ございますので、必要に応じて取得するレコード数を制限してください。
④ filter
レコード一覧画面で使用しているテーブルフィルターを指定する値となります。
こちらは24桁の値となり、デフォルトの「すべてのレコード」は「"000000000000000000000000"」と
なります。
その他のフィルターIDにつきましては、対象のテーブルのレコード一覧画面にて下記手順を行い、
取得してください。
【「filter」の取得方法】 1.APIを使用する対象テーブルのレコード一覧画面にて、適用させたいフィルターを
設定します。
2.フィルターが適用されていることを確認した後、右クリック > [ページのソースを表示]
（または ctrl + U）をクリックします。
3.ctrl + F で検索キーを表示していただき、「window.GLOBAL.FILTER_ID」で検索をします。
4.「’ ’(シングルコーテーション)」で囲われている24桁の値が「filter」のIDとなります。
| コード | 判定 | 意味 |
| 201 Created | "authen": "OK" | 成功 |
| 400 Bad Request | "authen": "NG" | JSON形式不正 or API_ID不正 |
| 401 Unauthorized | "authen": "NG" | 認証失敗 |
| 403 Forbidden | "authen": "NG" | 接続元IP制限 |
| 404 Not Found | - | /api 以下の URL が不正 |
| 405 Method Not Allowed | "authen": "NG" | 無効な HTTP メソッドでアクセス |
| 413 Payload Too Large | "authen": "NG" | サイズ超過 |
| 429 Too Many Requests | "authen": "NG" | APIアクセス数制限 |
| 500 Internal Server Error | - | 予期せぬエラー |
5. Response
・HTTP ステータスコード 一覧
・body data
※下記は例となります。
{
① "authen":"OK"
② "results": [
{
③ "result": 100,
④ "count": 100,
⑤ "lenght": 100,
⑥ "records":[
{
⑦"_id":"1111111111",
⑧"field_id":"aaaaaaaaaa"
},
{
"_id":"2222222222",
"field_id":"bbbbbbbbbb"
],
}
]
}
① authen
API 認証が成功した場合には "OK" が返されます。そうでない場合は "NG" が返されます。
② results
レコード作成の結果を表す情報が配列で返されます。
③ result
レコード作成の結果を表すコード番号が返されます。
※ Result code をご参照ください。
④ count
フィルター条件で絞り込まれたレコード数が返されます。
⑤ length
返されたオブジェクトの配列の長さを返します。
⑥ records
オブジェクト配列を返します。
⑦ _id
取得したレコードIDを返します。
⑧ field_id
情報を取得した項目ID を返します。
・Result code
| コード | 意味 |
| 0 | 成功 |
6.query
query を使用することで、レコードの項目を選択して取得することが可能となります。
※下記は例となります。
{
"record_list": {
"query": {
※"filter": {
①<filter-conditions>
},
※"items": [
②<output-items-id>
],
※"sort": [
③<sort-orders>
]
},
"start": 0,
"number": 1000
}
}
[※] は入力必須のため①～③の値を入力しない場合でも値を空で入力してください。
① <filter-conditions>
レコードの条件を記載する箇所となります。
フィルターを指定しない場合は、下記のように値を空で入力します。
例）
"filter": {
},
②<output-items-id>
取得する項目を指定する箇所となるため取得したい項目IDを指定してください。
例）
"items": [
"Text", "Number", "Text_2", "Text_1"
],
③<sort-orders>
ソートを指定する箇所となります。
値を空欄で入力することも可能ですが、必要に応じてソートをかける項目IDを指定してください。
例）最終更新日時の降順でソート
"filter": {
"~System_Update_Time"
},
※昇順の場合は項目IDのみ、降順の場合は項目 ID の先頭に "~" （チルダ）をつけてください。