🌐
項目管理、オプション管理について
この記事では、項目管理・オプション管理画面で設定した項目・オプションが、APIやクエリでどのように扱われるかを説明します。
📋 関連記事 画面上での実際の設定手順は「項目管理でカスタム項目を追加・編集・削除する」「標準項目の上書きを設定する」「オプション管理でセレクト項目の選択肢を管理する」を参照してください。
項目管理・オプション管理とはカスタム項目・標準項目カスタムオプション・標準オプションとoptionId画面設定とAPIフィールドの対応レスポンス例（抜粋）属性一覧取得API項目オプションAPIクエリAPI（参考）API利用時に知っておきたい注意点関連記事
カスタム項目・標準項目
YESODで扱う項目には、大きく分けて次の2種類があります。
| 種別 | 位置付け・機能 | attributeIdの扱い |
|---|---|---|
| カスタム項目 | テナント独自の項目を新規に追加したものです | 新しいattributeIdが発行されます |
| 標準項目 | YESODがあらかじめ用意している項目です。上書きしていない状態（標準項目）と、名称・英語名称・入力チェックのみを変更した状態（標準項目の上書き）があります（データタイプはどちらの状態でも変更できません） | 上書きの有無にかかわらず、元のattributeIdがそのまま使われます（新規発行されません） |
📋 関連記事 標準項目は、上書きするまでは項目管理画面には一覧表示されません。ただし、画面に表示されていない状態でも、attributeIdは既に割り当てられており、API・クエリからは上書き前の状態のまま参照・利用できます。項目管理画面で「標準項目の上書き」を行うと、初めてこの画面上に表示されるようになります。
💡 ポイント 標準項目を「上書き」しても、attributeIdは変わりません。そのため、連携設定やクエリの条件で参照しているattributeIdを変更する必要はありません。
⚠️ 注意 データタイプ（テキスト・数字・日付・セレクト・画像・ファイル）は、カスタム項目・標準項目のどちらも変更できません。API経由で取得・登録する値の型も、このデータタイプに固定されます。
⚠️ 注意 項目の名称（attributeLabel）は一意ではありません。たとえば「性別」という名称の項目は、メンバー本体・扶養家族・在留資格関連など、異なるで複数存在します。API連携やクエリの条件では、名称ではなく必ずで項目を特定してください。
カスタムオプション・標準オプションとoptionId
オプション管理画面で扱える選択肢（オプション）にも、大きく分けて次の2種類があります。
| 種別 | 位置付け・機能 | optionIdの扱い |
|---|---|---|
| カスタム | セレクト項目（カスタム項目・標準項目のどちらでも可）に、新しく追加した選択肢です | 新しいoptionIdが発行されます |
| 標準 | YESODがあらかじめ用意しているオプションです。上書きしていない状態（標準）と、名称・英語名称・順序のみを変更した状態（標準上書き）があります | 上書きの有無にかかわらず、元のoptionIdがそのまま使われます（新規発行されません） |
📋 関連記事 標準オプションは、上書きするまではオプション管理画面には一覧表示されません。ただし、画面に表示されていない状態でも、optionIdは既に割り当てられており、API・クエリからは上書き前の状態のまま参照・利用できます。オプション管理画面で「標準項目のオプションを上書き」を行うと、初めてこの画面上に表示されるようになります。
💡 ポイント オプションを「上書き」しても、optionIdは変わりません。
⚠️ 注意 オプションは無効化のみが可能で、完全に削除することはできません。無効化した後も、すでに登録済みのデータはAPI・クエリから参照できますが、新規登録の選択肢としては使用できなくなります（がになります）。
画面設定とAPIフィールドの対応
項目管理・オプション管理画面の表示項目のうち、次のものは属性一覧取得API・項目オプションAPIのレスポンスから取得できます。
| 画面上の表示 | 属性一覧取得API | 項目オプションAPI |
|---|---|---|
| 項目・属性の名称 | attributeId, attributeLabel | attributeId, attributeLabel |
| データタイプ | dataType | - |
| 関連項目の種別 | referenceType | - |
| オプションのID・名称 | - | optionId, labels |
| 順序 | - | order |
| 有効化／無効化 | - | selectable |
⚠️ 注意 「種別（カスタム / 標準上書き）」と「入力チェック（rules）」は、属性一覧取得API・項目オプションAPIのどちらのレスポンスにも含まれません。API経由でこれらの値を判定することはできないため、必要な場合は画面（項目管理・オプション管理）で確認してください。
⚠️ 注意 属性一覧取得APIのには、項目管理でカスタム項目に選べる6種類（テキスト・数字・日付・セレクト・画像・ファイル）以外にも、・・・など、システム内部（ロール・権限セット・業務アセットなど）で使われる値が含まれます。
📋 関連記事 各APIが実際に返すレスポンス形式は「属性一覧取得API」「項目オプションAPI」を参照してください。
レスポンス例（抜粋）
項目管理・オプション管理で設定した内容が、実際のAPIレスポンスでどう見えるかを抜粋で紹介します。
属性一覧取得API
json
項目オプションAPI
json
⚠️ 注意は、属性一覧取得APIではのオブジェクト、項目オプションAPIでは単一の文字列という異なる形式で返ります。同じフィールド名でも型が異なるため、両方のAPIを併用する場合は注意してください。
💡 ポイントが空（）のオプションも存在します（内部的な選択肢や、まだ日本語・英語名称が設定されていない選択肢など）。表示処理では、名称が空の場合を考慮してください。
クエリAPI（参考）
クエリAPIのレスポンスでも、属性一覧取得API・項目オプションAPIと同じ（例：雇用形態＝）が一貫して使われます。
json
📋 関連記事 クエリAPIレスポンスの詳しい構造（所属グループの階層、兼務時の複数値、期間指定での差分取得など）は「クエリAPIで入社、退職情報を取得するケースについて」を参照してください。
API利用時に知っておきたい注意点
項目管理・オプション管理でカスタム項目を扱う際、API連携の観点では次の点に注意してください。
| 項目 | 注意点 |
|---|---|
| データタイプ | 項目作成後に変更できないため、API経由で扱う値の型も固定されます |
| リピート項目グループ | 項目自体（定義）はCSVインポートで一括登録できますが、実際の値（データ）の入力については、CSVインポート・APIに「どの1件を更新するか」を一意に指定する仕組みがありません。同じ項目セットに複数件のデータがすでに存在する場合、意図した1件だけを更新することはできないため、複数件のデータを扱う場合は対象の詳細画面から直接登録・更新する必要があります |
| オプションの無効化 | 完全に削除されるわけではないため、無効化後も過去に登録済みの値はAPI・クエリから参照できます |