選択項目の選択肢一覧を取得する
単一選択項目や複数選択項目などの、選択肢の一覧を取得します。
get_member_table_element_config
API仕様
| 項目 | 内容 |
|---|---|
| エンドポイント | /api/v1/get_member_table_element_config |
| HTTPメソッド | POST |
| 必要権限 | 全てのアクセス権 または 操作のみ |
リクエスト
{
"element_id": 270
}
| キー | 型 | 必須 | 説明 |
|---|---|---|---|
element_id | Integer | 〇 | 選択肢を取得したいデータベース項目のID。 |
レスポンス
成功すると、項目の詳細設定情報が返されます。選択肢は options の中に連想配列として格納されています。
{
"options": {
"1": "選択肢_1",
"2": "選択肢_2",
"3": "選択肢_3",
"4": "選択肢_4",
"5": "選択肢_5"
}
}
備考
optionsは、キーが選択肢 ID、値が選択肢のラベルとなっています。- 選択肢を持たない項目(テキスト項目など)に対してこの API を呼び出した場合、空の配列が返されます。
サンプルコード
- PHP
<?php
$environmentId = getenv("ENV_ID");
$apiUrl = "https://krs.bz/$environmentId/api/v1/get_member_table_element_config";
$apiToken = getenv("API_TOKEN");
$elementId = 270; // 選択肢を取得したい項目 ID
$headers = [
'Authorization: Bearer ' . $apiToken,
'Content-Type: application/json',
];
$data = json_encode(['element_id' => $elementId]);
$ch = curl_init($apiUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($httpCode === 200) {
$result = json_decode($response, true);
if (isset($result['options']) && is_array($result['options']) && count($result['options']) > 0) {
foreach ($result['options'] as $id => $label) {
echo "選択肢 ID: {$id}\t選択肢名: {$label}", PHP_EOL;
}
} else {
echo "指定した項目には選択肢データがありません。", PHP_EOL;
}
} else {
echo "API リクエストに失敗しました。 HTTP ステータスコード: ", $httpCode, PHP_EOL;
$error = json_decode($response, true);
echo "エラーコード: {$error['error_code']}, 詳細: {$error['error_desc']}", PHP_EOL;
}
実行結果例
選択肢ID: 1 選択肢名: 選択肢_1
選択肢ID: 2 選択肢名: 選択肢_2
選択肢ID: 3 選択肢名: 選択肢_3
選択肢ID: 4 選択肢名: 選択肢_4
選択肢ID: 5 選択肢名: 選択肢_5