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

6.1. REST API

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

6.1.1. REST APIについて

MasterBuilderが提供するREST APIは、HTTPプロトコルを使用し、MasterBuilderに関する様々な処理を呼び出すことが可能です。
また、REST APIは全ての呼び出し先に対し認可リソースを持ちます。
REST APIとして利用可能な機能は以下のとおりです。
  • 汎用検索
  • 汎用検索結果件数取得
  • 検索
  • 検索結果件数取得
  • 新規登録
  • 更新
  • 削除
  • 期間分割
  • 期間変更
  • 有効化
  • 無効化
  • インポート
  • エクスポート

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

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

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

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

  • 仕様に沿わない構造やプロパティ名の情報が含まれる場合、予期せぬ動作になる可能性があります。
  • 各マスタのマスタID、ガジェットバリエーションを確認する場合、「マスタ一覧」を参照してください。
  • ガジェットバリエーションを保持するマスタの場合、ガジェットクラスは「master」を保持しており、マスタの定義ファイル名は「master_%ガジェットバリエーション%」です。

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

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