オプション	必須	型・型式	指定しなかった場合の値	値の例	説明
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		オプションの対象外とするメンバーのメールアドレスを指定します。とを区切り文字として使用可能（併用可）。
identifiedBy	いいえ	string	default		グループのインポートを行う際に、どの項目を使って名寄せするかを指定します。指定できる値は以下のとおりです。・・・オプション値にを指定した場合では、グループコードとフルパスの両方による名寄せが行われます。これまでのグループインポートと同じ仕様でインポートが行われます。オプション値にを指定した場合では、フルパスを正とした名寄せが行われます。この際、フルパスが重複したレコードが存在した状態でリクエストした場合には、エラーが返却されます。オプション値にを指定した場合では、グループコードを正とした名寄せが行われます。この際、グループコードが存在しないレコードが存在した状態でリクエストした場合にはエラーが返却されます。オプション値が未指定の場合には、グループコードとフルパスによる名寄せが行われます。
waitForLock	いいえ	boolean	false		インポート時にデータベースへのロックが行われている場合に、ロックが解除されるまで待機します。

メンバーインポートで全てのoptionsをリクエストボディへ指定した例:

詳細

オプションのmappingで、CSVの1行目の項目名と、YESODの属性とをマッピングを指定します。

指定方法は 🌐マッピングファイルの記載方法 を参照

メンバーインポート時の名寄キー項目について

以下の項目の一致を順に確認し、一致すれば情報の更新を行います。一致しない場合新規登録が行われます。

社員ID（会社横断の固有のID）：identificationNumber

社員番号：employeeNumber

メールアドレス：email

入社日および変更日、退社日について

未入社の従業員が、YESOD上に登録されていなければ、指定された入社日で情報が取り込まれます。

既に従業員が登録されている場合は、changeDateが指定されていればその日付で、指定されていなければAPIが実行された日付を基準にして、属性情報の更新を行います。

退社日が設定されている場合は、その日付で退職予約が行われ、それ以降の属性情報の更新は行われなくなります。

入社日の変更について

トランザクションインポートAPIをご利用ください。 🌐トランザクションインポート API

更新される情報について

承認申請には、CSVに記載された情報とYESODのデータベース上の差分のみ含まれます。変更がない項目については無視されます。

Node.jsで、APIからメンバーをインポートする例

組織・会社・事業所・プロジェクトのインポート

CSVファイルからグループ（組織・会社・事業所・プロジェクト）をインポートします。

OpenAPIドキュメントは下記を参照ください。

組織・会社・事業所・プロジェクトのインポート

組織・会社・事業所・プロジェクトのインポート（インポートと同時に承認）

リクエスト

エンドポイント

インポートと同時に承認しない場合

インポートと同時に承認しない場合：

組織・会社・事業所・プロジェクトのインポート:

インポートと同時に承認する場合：

組織・会社・事業所・プロジェクトのインポート:

クエリパラメータ

必要なし

リクエストヘッダ

APIリクエストヘッダ

リクエストボディ

データ	説明
csv	インポートするCSVデータをセットします。
options	インポート時の設定を指定します。

options 詳細

オプション	必須	型	デフォルト	説明
mapping	はい	string	-	CSVの項目とYESODの属性とのマッピングを指定します。
optionMapping	いいえ	string	null	SELECT型の項目の値変換が必要な場合にマッピングを指定します。
applicationName	いいえ	string	null	インポートによって作成される変更の管理名を指定します。
changeDate	いいえ	YYYY-MM-DD 形式の string	null	変更日付。指定がない場合、APIリクエストした当日の日付になります。
tierSeparator	いいえ	string	null	1つのセルの中で階層を表現する際に使用する区切り文字。
referenceSeparator	いいえ	string	null	1つのセルの中で複数のグループを区別するための区切り文字。
identifiedBy	いいえ	string	default	グループの名寄せ方法を指定します。（コードとフルパスの両方）/ （フルパスのみ）/ （グループコードのみ）。指定時はコード列が必須です。
retireUnlisted	いいえ	boolean	false	にするとCSVに存在しないグループを削除します。
companyEntityId	いいえ	string	null	インポート対象を特定の会社に限定するエンティティID。
rootOrganizationEntityId	いいえ	string	null	更新対象の組織ツリーのルートを制限するエンティティID。
rootOfficeEntityId	いいえ	string	null	更新対象の事業所ツリーのルートを制限するエンティティID。
rootProjectEntityId	いいえ	string	null	更新対象のプロジェクトツリーのルートを制限するエンティティID。
waitForLock	いいえ	boolean	false	インポート時にDBロック中の場合、解除されるまで待機します。

options/mapping 詳細

CSVの1行目の項目名とYESODの属性をマッピングします。記載方法はマッピングファイルの記載方法を参照してください。

グループ種別ごとに使用できる属性IDは以下のとおりです。

グループ種別	名前の属性ID	コードの属性ID
組織	organization	organizationCode
会社	company	companyCode
事業所	office	officeCode
プロジェクト	project	projectCode

CSVの列が階層を表す場合は、mapping内でを指定します。

csv

この場合、が第1階層、が第2階層、が第3階層として読み込まれます。

グループインポート時の名寄せキー項目について

の指定値により、既存グループとの突合方法が変わります。

default（省略時）：グループコードとフルパスの両方で名寄せを行います。

fullPath：フルパスのみで名寄せを行います。フルパスが重複するレコードがある場合はエラーになります。

groupCode：グループコードのみで名寄せを行います。コード列がないレコードがある場合はエラーになります。

一致するグループが見つかった場合は更新、見つからない場合は新規作成が行われます。

更新される情報について

承認申請には、CSVに記載された情報とYESODのデータベース上の差分のみ含まれます。変更がない項目については無視されます。

グループの表示順について

グループの表示順はCSVの行順に従います。ただし、表示順を固定できるのは （洗い替え）の場合のみです。（差分更新）の場合、新規追加されたグループは末尾に追加されるため、表示順を意図した順序に保つには全件を含むCSVでを指定してください。

Node.jsで、APIからグループをインポートする例

組織のインポート（階層構造あり）：

プロジェクトのインポート：

🐘YESOD ヘルプ/🌐インポート API