検索¶
指定した条件で検索したレポートの検索結果を取得します。
リクエストボディ¶
リクエストボディ情報の説明です。
プロパティ名 論理名 型 設定 デフォルト値 説明 reportId レポートID string 必須 なし ReportBuilderのレポートIDを指定します。 queryId クエリーID string 任意 なし json JSON object 任意 なし レポートの検索条件をJSON形式で指定します。 json/selectionList 表示項目設定 array<string> 任意 ReportBuilderの一覧設定 ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。 json/searchOptions 検索条件設定 object 任意 なし json/sortKey ソート項目設定 array<object> 任意 ReportBuilderの一覧設定に指定したソート順 json/paging ページング情報設定 object 任意 各項目を参照してください。 json/paging/pageNo ページNo number 任意 1 取得するページNoを指定します。(1始まり) json/paging/pageSize 最大件数 number 任意 50 1ページ当たりの最大件数を指定します。 リクエストボディのjsonの設定例{ "selectionList":[ "companyCd", "id", "name" ] "searchOptions":{ "companyCd":"xxx", "id":"XXX" }, "sortKey":[ {"companyCd":"asc"}, {"id":"desc"} ], "paging":{ "pageNo":1, "pageSize":50 } }
レスポンスデータ¶
レスポンスデータはJSON情報を返却します。レスポンスデータ例{ "statusCode":"200", "error":"false", "message":"XXX", "errorMessage":"XXX", "pageInfo":{ "pageNo":"1", "totalPageNo":"3" }, "data":[ {"companyCd":"xxx", "id":"XXX", "name":"XXX"}, {"companyCd":"www", "id":"WWW", "name":"WWW"} ] }解説
プロパティ名 論理名 型 説明 statusCode 処理ステータス string error 処理結果 boolean message メッセージ string 処理結果が正常終了で、検索結果が0件の場合、設定されます。 errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。 pageInfo ページ情報 object ページ情報 pageInfo/pageNo ページNo string 返却対象の検索結果のページNo pageInfo/totalPageNo 合計ページ数 string 検索結果の合計ページ数 data 検索結果 array<object> リクエストボディの表示項目設定に従い、検索結果が「{“項目名”:”値”,”項目名”:”値”…},」の形式で設定されます。