一覧取得API共通仕様

  • フォーマット
エンドポイント(URL) 例)  https://flex-crm.com/flex/api/flexdb/v1/tbl_customer
HTTPメソッド GET
リクエストヘッダ(APIキー) 認証用のAPIキー
  • 一覧取得では、limit, offsetにより取得データ数を操作出来ます
limit 取得データ数(指定の無い場合、該当する100件を取得します)
offset データ取得開始位置(指定の無い場合、該当するデータの1行目から取得します)

例:10件取得、データ取得位置は5行目から

?limit=10&offset=5

  • 一覧取得データを “フィールドID” と検索値によりフィルターをかけて取得することが出来ます
    ※フィールドIDは FlexDBのフィールドの設定画面からご確認ください。
    ※フィールドIDの一覧情報は、 データフィールドの取得API からもご確認いただけます。
  • 検索値は部分一致で、各フィールドの検索条件はANDになります
    ※検索パラメータにはURLエンコードが必要となります。

例:titleに”顧客太郎”を含み、尚且つtelに”030000″を含む検索

?title=顧客太郎&tel=030000

例:回答A(select)が選択肢型のデータ型の場合
選択肢 BBB(2:BBB)を含む検索

?select=2
?select=BBB

  • 一覧取得結果にはデータ以外に以下の情報を返却します
status ステータス
limit 取得時のデータ制限数
offset 取得時のデータ取得位置
count 取得データ数
maxCount 総データ数
data 取得データ

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

はい いいえ

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

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

はい いいえ

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