項目オプションマスターの取得
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| GET | /api/v25.04/options | 項目オプションマスターの取得 | 〇 |
パスパラメータ
不要
クエリパラメータ
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| attributeId | ー | 文字列（項目のID） | ー | オプション値を取得する項目のIDを指定。未設定の場合、全ての項目のオプション値が出力される |
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
不要
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| ー | attributeOptionオブジェクトの配列。各要素の属性は、「attributeOptionオブジェクト 」をご覧ください | 取得した項目オプション情報の配列 |
attributeOptionオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| attributeId | 文字列 | 項目のID |
| attributeLabel | 文字列 | 項目の名前 |
| optionId | 文字列 | 項目オプションのID |
| labels | labelオブジェクト。項目は「labelオブジェクト 」をご覧ください | 項目オプションの表示名 |
| order | 整数 | 項目オプションの順番。数値が小さいほど上に表示される |
| selectable | boolean | 項目オプションが選択できるかどうかを示す値 |
labelオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| ja_JP | 文字列 | 日本語の項目オプション名 |
| en_UN | 文字列 | 英語の項目オプション名 |