FlexDB 一覧データの取得

FlexDBで作成した各テーブルのデータ一覧を取得します。

フォーマット

エンドポイント(URL) https://flex-crm.com/<site_id>/api/v1/flexdb/<table_id>
※専用サーバでご契約いただいている場合はサブドメインとなります。
 https://<site_id>.flex-crm.com/api/v1/flexdb/<table_id>
HTTPメソッド GET
リクエストヘッダ(APIキー) 認証用のAPIキー
  • <site_id> は ワークスペース申込み時 に登録されている “ワークスペースID” です。
  • <table_id> は FlexDB に登録されているテーブルの “テーブルID” です。各FlexDBの設定画面の基本設定よりご確認ください。

↑ ページの先頭へ

取得できるデータ項目

status ステータス
limit 取得時のデータ制限数

※limitを未指定の場合:最大100件を取得します。

※limitを指定した場合:最大1000件まで取得が可能です。

offset 取得時のデータ取得位置
count 取得データ数
maxCount 総データ数
data

※フィールド固定項目

id:<データのレコードID>
create_user_id:<作成者ユーザのレコードID>
update_user_id:<更新者ユーザのレコードID>
update_date_for_user:<更新日付(ユーザによる最終操作時刻)>
update_date:<更新日付(システム更新時刻含む)>
create_date:<作成日付>

※以下、フィールド指定項目

<フィールドID>:<データの値>

↑ ページの先頭へ

リクエスト例

https://flex-crm.com/flex/api/v1/flexdb/tbl_customer/

X-FlexCRM-API-KEY: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

↑ ページの先頭へ

レスポンス例

GET https://flex-crm.com/flex/api/v1/flexdb/tbl_customer/

{
status: “success”,
limit: 100,
offset: 0,
count: 100,
maxCount: 1000,
data: [
{
id: “1”,
create_user_id: “1”,
update_user_id: “1”,
update_date_for_user: “2019-01-01 15:00:00”,
update_date: “2019-01-01 15:00:00”,
create_date: “2019-01-01 12:00:00”,
code: “1001”,
title: “顧客太郎”,
text: “こきゃくたろう”,
number: “100”,
tel: “03-0000-0000”,
mail: flexcrm@neu.co.jp,
date: “2019-01-01 18:00:00”,
select: “1”,
address_zip: “100-0005”,
address_state: “東京都”,
address_city: “千代田区丸の内”,
address_address: “東京駅ビル”,
user: “14”,
category: “カテゴリー1”,
data2: “,2,”
},
{
id: “2”,
create_user_id: “1”,
update_user_id: “1”,

↑ ページの先頭へ

レスポンス例(limit=5,offset=10を指定した場合)

GET https://flex-crm.com/flex/api/v1/flexdb/tbl_customer/?limit=5&offset=10

{
status: “success”,
limit: 5,
offset: 10,
count: 5,
maxCount: 1000,
data: [
{
id: “1”,
create_user_id: “1”,
update_user_id: “1”,
update_date_for_user: “2019-01-01 15:00:00”,
update_date: “2019-01-01 15:00:00”,
create_date: “2019-01-01 12:00:00”,
code: “1001”,
title: “顧客太郎”,
text: “こきゃくたろう”,
number: “100”,
tel: “03-0000-0000”,
mail: flexcrm@neu.co.jp,
date: “2019-01-01 18:00:00”,
select: “1”,
address_zip: “100-0005”,
address_state: “東京都”,
address_city: “千代田区丸の内”,
address_address: “東京駅ビル”,
user: “14”,
category: “カテゴリー1”,
data2: “,2,”

↑ ページの先頭へ

レスポンス例(更新日付が2019/01/01以降のデータ)

GET https://flex-crm.com/flex/api/v1/flexdb/tbl_customer/?update_date%3E%3D=2019-01-01%2000%3A00%3A00

  • 検索値にはURLエンコードが必要となります。
  • 数値型または日付型のフィールドには、比較演算子(>、>=、<、<=)を用いて範囲検索を行うことができます。また、比較演算子においてもURLエンコードが必要となります。

{
status: “success”,
limit: 100,
offset: 0,
count: 80,
maxCount: 80,
data: [
{
id: “1”,
create_user_id: “1”,
update_user_id: “1”,
update_date_for_user: “2019-01-01 15:00:00”,
update_date: “2019-01-01 15:00:00”,
create_date: “2019-01-01 12:00:00”,
code: “1001”,
title: “顧客太郎”,
text: “こきゃくたろう”,
number: “100”,
tel: “03-0000-0000”,
mail: flexcrm@neu.co.jp,
date: “2019-01-01 18:00:00”,
select: “1”,
address_zip: “100-0005”,
address_state: “東京都”,
address_city: “千代田区丸の内”,
address_address: “東京駅ビル”,
user: “14”,
category: “カテゴリー1”,
data2: “,2,”

より良いサポート情報提供のために、アンケートへのご協力をお願いします。
この情報は役に立ちましたか?

はい いいえ

0人中0人がこの情報が役に立ったと言っています。

より良いサポート情報提供のために、アンケートへのご協力をお願いします。
この情報は役に立ちましたか?

はい いいえ

0人中0人がこの情報が役に立ったと言っています。