intra-mart Accel Kaiden! ReportBuilder 設定ガイド 第10版 2024-04-01

クエリー情報取得

指定したレポートに保存されているクエリー情報を取得します。

HTTPリクエスト

POST /kaiden/v2/api/generic/report/query

リクエストボディ

リクエストボディ情報の説明です。
プロパティ名 論理名 設定 デフォルト値 説明
reportId レポートID string 必須 なし ReportBuilderのレポートIDを指定します。

レスポンスデータ

レスポンスデータはJSON情報を返却します。
レスポンスデータ例
{
    "statusCode":"200",
    "error":"false",
    "message":"XXX",
    "errorMessage":"XXX",
    "public":[
        {"queryId":"xxx", "queryName":"XXX"},
        {"queryId":"yyy", "queryName":"YYY"}
    ],
    "private":[
        {"queryId":"zzz", "queryName":"ZZZ"},
        {"queryId":"qqq", "queryName":"QQQ"}
    ]
}
解説
プロパティ名 論理名 説明
statusCode 処理ステータス string
200:正常終了(取得結果あり)
204:正常終了(取得結果なし)
401:エラー終了(認可によりアクセスが拒否)
500:エラー終了(認可以外のエラーが発生)
error 処理結果 boolean
true:エラー終了
false:正常終了
message メッセージ string 処理結果が正常終了で、取得結果が0件の場合、設定されます。
errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。
public パブリッククエリー情報 array<object> パブリッククエリーが保存されている場合、設定されます。
public/queryId クエリーID string  
public/queryName クエリー名 string  
private プライベートクエリー情報 array<object> プライベートクエリーが保存されている場合、設定されます。
private/queryId クエリーID string  
private/queryName クエリー名 string