開発者向けサポート

/extra/{table_name}

追加テーブルのレコード一覧情報です。クエリを使用して検索をすることができます。

必要権限

  • system

提供メソッド

GET

サンプル
リクエスト
GET /extra/EXAMPLE.json?select=EXAMPLE_ID,EXAMPLE_NAME
レスポンス
200 OK

[
	{"EXAMPLE_ID": "1", "EXAMPLE_NAME": "サンプルデータ1"},
	{"EXAMPLE_ID": "2", "EXAMPLE_NAME": "サンプルデータ2"},
	{"EXAMPLE_ID": "3", "EXAMPLE_NAME": "サンプルデータ3"}
]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は全カラムを取得します。
"count(*)"のみを指定した時は、条件にマッチする件数を返します。このとき結果は次の形式になります。[{"count(*)": 件数数値}]
query
検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。
search_order
検索結果の順序を指定します。
未指定の場合ソートはされません。
また、sort_orderに指定された値がある場合search_orderは呼ばれませんのでご注意ください。
search_group
GROUPBY句で指定するカラムを指定します。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。
sort_order
ソートする列名をソート順にカンマ区切りで指定します。降順の場合、「列名:DESC」と指定してください。

応答値説明
ボディー文字列

情報を格納したJSON値を返します。

POST

サンプル
リクエスト
POST /extra/EXAMPLE.json

{"EXAMPLE_ID":4,"EXAMPLE_NAME":"サンプルデータ4"}
レスポンス
200 OK

{"result": 1}
リクエスト文説明
クエリーパラメータ

data_type
multi_upsert:複数データの登録・更新を行う場合に指定します。指定されたキー値が存在する場合は更新、存在しない場合は登録を行います。一度に指定可能な件数は100件までになります。

ボディー文字列

登録・更新する情報を格納したJSON文字列

応答値説明
ボディー文字列

data_typeを指定していない場合は、登録したExtra情報のID、 data_typeにmulti_upsertを指定した場合は登録・更新結果が返却されます

DELETE

サンプル
リクエスト
DELETE /extra/EXAMPLE.json?all=true
レスポンス
200 OK

{"result": 4}
リクエスト文説明
クエリーパラメータ

all
all=trueを指定すると全レコード削除します（現在、all=trueが指定されていない場合、エラーとなります）。
query
削除条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。

応答値説明
ボディー文字列

削除件数

ここを見た方は他にもこんなページを見ています。