dataset/search
アプリのデータを検索します。
APIを使用するには、WebAPIオプション が必要です。
POST
http://example.com/RakWDB/webapi/v1/dataset/search
リクエスト
ヘッダー
content-type
application/x-www-form-urlencoded
もしくは multipart/form-data
パラメータ
- appcode
-
アプリコードを設定します。
- appkey
-
アプリの認証キーを設定します。
- execuserid
-
APIを実行するユーザーを設定します。
アプリの認証キーに紐づくユーザーがアプリの管理者の場合に使用します。
アプリの認証キーに紐づくユーザーがアプリの管理者でない場合、このパラメータの値は使用しません。 - lang
-
アプリを動作させる言語の言語区分を設定します。
- tablecode
-
フォームに表が存在するアプリのときに、検索結果に含める表の「表コード」を設定します。 省略した場合は、検索結果に表を表示しません。
- param
-
検索条件をJSON形式で設定します。
「アプリ編集 - 検索設定」で非表示にした項目は、検索条件として使用できません。書式{ "項目ID": "キーワード", …他の項目の設定…, "表コード": { "項目ID": "キーワード", …他の項目の設定…, } }
- 項目ID
-
検索条件を設定します。
検索設定で指定した検索方法ごとに書式が異なります。- 部分一致、 完全一致、 前方一致、 後方一致
-
例「A」と一致する。
{ "rakwdb_app1234_main_0": "A" }
- いずれかを含む
-
例「A」もしくは「B」を含む。
{ "rakwdb_app1234_main_0": "A,B" }
- 範囲検索
-
例1000以上。
{ "rakwdb_app1234_main_0": "1000" }
例1000以下。{ "rakwdb_app1234_main_0_to": "1000" }
例1000以上、2000以下。{ "rakwdb_app1234_main_0": "1000", "rakwdb_app1234_main_0_to": "2000" }
- 表コード
-
表のデータの検索条件を設定します。表コードは「アプリ編集 - フォーム編集」の表のプロパティから取得します。
例{ "rakwdb_app1234_main_0": "u101", "TABLE_1": { "rakwdb_app1234_dtl_3": "A", } }
レスポンス
ヘッダー
content-type
application/json;charset=UTF-8
レスポンス例
該当データが存在する場合
{
"rkwa_status": "OK",
"rkwa_errorcount": 0,
"rkwa_errmsg": null,
"TABLE_1": [
{
"rakwdb_app1234_main_primarykey": {
"type": "id",
"value": "1000"
},
"rakwdb_app1234_main_0": {
"type": "text",
"value": "u101"
},
"rakwdb_app1234_main_1": {
"type": "date",
"value": "2021-06-01"
},
"rakwdb_app1234_main_2": {
"type": "text_area",
"value": "以下のシートをご参照ください。\r\n「表A」\r\n「表B」"
},
"rakwdb_app1234_main_3": {
"type": "file",
"value": "1011",
"filename": "サンプル.xlsx",
"filesize": "51200"
},
"pms_i_usr": {
"type": "pms_i_usr",
"value": {
"id": "admin",
"name": "admin"
}
},
"pms_i_ymd": {
"type": "pms_i_ymd",
"value": "2021-06-25 17:00:00"
},
"pms_u_usr": {
"type": "pms_u_usr",
"value": {
"id": "admin",
"name": "admin"
}
},
"pms_u_ymd": {
"type": "pms_u_ymd",
"value": "2021-06-25 17:10:00"
}
}
]
}
該当データが存在しない場合
{
"rkwa_status": "OK",
"rkwa_errorcount": 1,
"rkwa_errmsg": [
"該当データがありません。"
],
"rakwdb_app1234_main_0": "u101",
"rakwdb_app1234_main_1": "",
"rakwdb_app1234_dtl_3": "A",
"rakwdb_app1234_dtl_4": ""
}
注意事項
「アプリの編集 - 一覧設定」で非表示にした項目は、レスポンスに含みません。