🌐
従業員情報インポート API（YESOD API v21.07 ）
エンドポイント
インポートと同時に承認しない場合
従業員情報のインポート:
組織・会社・事業所・プロジェクトのインポート:
インポートと同時に承認する場合
従業員情報のインポート:
組織・会社・事業所・プロジェクトのインポート:
クエリパラメータ
必要なし
リクエストヘッダ
APIリクエストヘッダ を参照
リクエストボディ
| データ | 説明 |
| csv | インポートするCSVデータをセットします。 |
| options | インポート時の設定を指定します。 |
詳細
| オプション | 必須 | 型・型式 | 指定しなかった場合の値 | 値の例 | 説明 |
| mapping | はい | string | - | CSVの項目とYESODの属性とのマッピングを の形式で指定します。 を区切り文字として使用可能。 | |
| optionMapping | いいえ | string | null | YESODのSELECT型の項目の値と、CSVファイルの値の変換が必要な場合にマッピングを指定します。マッピングは の形式で表現します。 を区切り文字として使用可能。 | |
| applicationName | いいえ | string | null | インポートによって作成される変更の管理名を指定します。 | |
| changeDate | いいえ | YYYY-MM-DD 形式の string | null | 変更日付。指定がない場合、APIリクエストした当日日付になります。 | |
| tierSeparator | いいえ | string | null | 一つのセルの中で階層を表現する際に使用する区切り文字 | |
| referenceSeparator | いいえ | string | null | 一つのセルの中で、複数の所属またはその所属に紐づく値を指定する場合に、どの所属に対しての値なのかを区別するための区切り文字 | |
| companyEntityId | いいえ | エンティティIDを表すstring | null | インポートデータのメンバーを所属させる会社を指定します。指定方法についてはお問い合わせください。 | |
| rootCompanyEntityId | いいえ | エンティティIDを表すstring | null | 従業員の会社に紐づく属性情報の更新範囲を制限することができます。指定方法についてはお問い合わせください。 | |
| rootOrganizationEntityId | いいえ | エンティティIDを表すstring | null | 従業員の組織に紐づく属性情報の更新範囲を制限することができます。指定方法についてはお問い合わせください。 | |
| rootOfficeEntityId | いいえ | エンティティIDを表すstring | null | 従業員の事業所に紐づく属性情報の更新範囲を制限することができます。指定方法についてはお問い合わせください。 | |
| rootProjectEntityId | いいえ | エンティティIDを表すstring | null | 従業員のプロジェクトに紐づく属性情報の更新範囲を制限することができます。指定方法についてはお問い合わせください。 | |
| retireUnlisted | いいえ | boolean | false | インポートデータに存在しないレコードを退職/削除する場合に true を指定 | |
| avoidUnlistedEmails | いいえ | メールアドレス形式のstringの配列 | null | オプションの対象外とするメンバーのメールアドレスを指定します。 と を区切り文字として使用可能（併用可）。 |
全てのoptionsをリクエストボディへ指定した例:
詳細
- オプションのmappingで、CSVの1行目の項目名と、YESODの属性とをマッピングを指定します。
- 指定方法は 🌐マッピングファイルの記載方法 を参照
インポート時の名寄キー項目について
以下の項目の一致を順に確認し、一致すれば情報の更新を行います。一致しない場合新規登録が行われます。
- 社員ID（会社横断の固有のID）：identificationNumber
- 社員番号：employeeNumber
- メールアドレス：email
入社日および変更日、退社日について
- 未入社の従業員が、YESOD上に登録されていなければ、指定された入社日で情報が取り込まれます。
- 既に従業員が登録されている場合は、changeDateが指定されていればその日付で、指定されていなければAPIが実行された日付を基準にして、属性情報の更新を行います。
- 退社日が設定されている場合は、その日付で退職予約が行われ、それ以降の属性情報の更新は行われなくなります。
更新される情報について
承認申請には、CSVに記載された情報とYESODのデータベース上の差分のみ含まれます。変更がない項目については無視されます。