検索結果件数取得¶

指定した条件で検索したレポートの検索結果件数を取得します。

HTTPリクエスト
リクエストボディ
レスポンスデータ

HTTPリクエスト ¶

POST /kaiden/v2/api/generic/report/count

リクエストボディ ¶

リクエストボディ情報の説明です。

プロパティ名論理名型設定デフォルト値説明

reportId レポートID string 必須なし ReportBuilderのレポートIDを指定します。

queryId クエリーID string 任意なし

各レポートに保存されるクエリーIDを指定します。

指定した場合、「json」の値は無視します。

json JSON object 任意なしレポートの検索条件をJSON形式で指定します。

json/selectionList 表示項目設定 array<string> 任意 ReportBuilderの一覧設定 ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。

json/searchOptions 検索条件設定 object 任意なし

「”項目名”:”検索条件”,”項目名”:”検索条件”…」の形式で指定します。

項目名には、ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。

リクエストボディのjsonの設定例
{
    "selectionList":[
        "companyCd",
        "id",
        "name"
    ]
    "searchOptions":{
        "companyCd":"xxx",
        "id":"XXX"
    }
}

レスポンスデータ ¶

レスポンスデータはJSON情報を返却します。

レスポンスデータ例
{
    "statusCode":"200",
    "error":"false",
    "message":"検索対象データ件数:5件",
    "errorMessage":"XXX",
    "data":"5"
}
解説

プロパティ名論理名型説明

statusCode 処理ステータス string

200：正常終了

401：エラー終了（認可によりアクセスが拒否）

500：エラー終了（認可以外のエラーが発生）

error 処理結果 boolean

true：エラー終了

false：正常終了

message メッセージ string 処理結果が正常終了の場合、「検索対象データ件数:%検索結果件数%件」が設定されます。

errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。

data 検索結果件数 string

目次

検索結果件数取得¶

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶

目次

プロパティ名	論理名	型	設定	デフォルト値	説明
reportId	レポートID	string	必須	なし	ReportBuilderのレポートIDを指定します。
queryId	クエリーID	string	任意	なし	各レポートに保存されるクエリーIDを指定します。指定した場合、「json」の値は無視します。
json	JSON	object	任意	なし	レポートの検索条件をJSON形式で指定します。
json/selectionList	表示項目設定	array<string>	任意	ReportBuilderの一覧設定	ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。
json/searchOptions	検索条件設定	object	任意	なし	「”項目名”:”検索条件”,”項目名”:”検索条件”…」の形式で指定します。項目名には、ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。

プロパティ名	論理名	型	説明
statusCode	処理ステータス	string	200：正常終了 401：エラー終了（認可によりアクセスが拒否） 500：エラー終了（認可以外のエラーが発生）
error	処理結果	boolean	true：エラー終了 false：正常終了
message	メッセージ	string	処理結果が正常終了の場合、「検索対象データ件数:%検索結果件数%件」が設定されます。
errorMessage	エラーメッセージ	string	処理結果がエラー終了の場合、設定されます。
data	検索結果件数	string

目次

検索結果件数取得¶

HTTPリクエスト¶

リクエストボディ¶

レスポンスデータ¶

目次

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶