🌐
インポート API
Open APIドキュメントは下記を参照ください。
- 従業員情報のインポート
- 従業員情報のインポート(インポートと同時に承認)
- 組織・会社・事業所・プロジェクトのインポート
- 組織・会社・事業所・プロジェクトのインポート(インポートと同時に承認)
リクエストエンドポイントインポートと同時に承認しない場合インポートと同時に承認する場合クエリパラメータリクエストヘッダリクエストボディoptions 詳細options/mapping 詳細メンバーインポート時の名寄キー項目について入社日および変更日、退社日について更新される情報についてNode.jsで、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 | オプションの対象外とするメンバーのメールアドレスを指定します。 と を区切り文字として使用可能（併用可）。 | |
| identifiedBy | いいえ | string | default | グループのインポートを行う際に、どの項目を使って名寄せするかを指定します。指定できる値は以下のとおりです。・・・ オプション値に を指定した場合では、グループコードとフルパスの両方による名寄せが行われます。これまでのグループインポートと同じ仕様でインポートが行われます。オプション値に を指定した場合では、フルパスを正とした名寄せが行われます。この際、フルパスが重複したレコードが存在した状態でリクエストした場合には、エラーが返却されます。オプション値に を指定した場合では、グループコードを正とした名寄せが行われます。この際、グループコードが存在しないレコードが存在した状態でリクエストした場合にはエラーが返却されます。オプション値が未指定の場合には、グループコードとフルパスによる名寄せが行われます。 | |
| waitForLock | いいえ | boolean | false | インポート時にデータベースへのロックが行われている場合に、ロックが解除されるまで待機します。 |
メンバーインポートで全てのoptionsをリクエストボディへ指定した例:
詳細
- オプションのmappingで、CSVの1行目の項目名と、YESODの属性とをマッピングを指定します。
- 指定方法は 🌐マッピングファイルの記載方法 を参照