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

5.1. REST API

REST APIについて説明します。

5.1.1. REST APIについて

ReportBuilderが提供するREST APIは、HTTPプロトコルを使用し、ReportBuilderに関する様々な処理を呼び出すことが可能です。
また、REST APIは全ての呼び出し先に対し認可リソースを持ちます。
REST APIとして利用可能な機能は以下のとおりです。
  • 検索
  • 検索結果件数取得
  • エクスポート
  • クエリー情報取得

5.1.2. エンドポイントプレフィックス

REST APIは以下の通り呼び出してください。
プロトコル、ホスト名、ポート番号、コンテキストパスは環境にあわせて置き換えてください。

http(s)://{HOST}:{PORT}/{CONTEXT_PATH}/kaiden/v2/api/generic/report/....

5.1.3. リクエストパラメータ共通仕様

  • 仕様に沿わない構造やプロパティ名の情報が含まれる場合、予期せぬ動作になる可能性があります。
  • 各レポートのレポートIDを確認する場合、『intra-mart Accel Kaiden! レポート操作ガイド』-「リファレンス」-「レポート一覧」を参照してください。

5.1.4. レスポンスデータ共通仕様

  • 値が存在しない場合(ブランク文字列やnull)、プロパティそのものが含まれません。