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

リクエスト
エンドポイント

実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。

HTTPメソッド APIパス 用途 マスタ管理プラスオプション必須
POST /api/v21.07/groups/import 組織・会社・事業所・プロジェクトのインポート
POST /api/v21.07/groups/importAndApply 組織・会社・事業所・プロジェクトのインポートと承認
クエリパラメータ

不要

リクエストヘッダ

APIリクエストヘッダ」をご覧ください。

リクエストボディ
項目名 必須 データ形式 デフォルト値 説明
csv 文字列 インポートするCSVデータ
options optionsオブジェクト。項目は、「optionsオブジェクト 」をご覧ください

インポート時の設定値


optionsオブジェクト

項目名 必須 データ形式 デフォルト値 説明
mapping 文字列

区切り文字としては「\n」を利用する※1

optionMapping 文字列 null

本サービスのSELECT型項目の値とCSVファイルの値で変換が必要な場合にマッピングを指定する。マッピングは以下の形式で指定し、区切り文字としては「\n」を利用する

[CSVデータ内の値]: [本サービスのSELECT型の値]
applicationName 文字列 null インポートによって作成される変更名を指定する
changeDate 文字列 (「YYYY-MM-DD」形式) API実行日を示す文字列

作成する変更の日付を指定する

tierSeparator 文字列 null

CSVデータの一つのセル内で、階層を表現する際に利用する区切り文字※1

referenceSeparator 文字列 null

CSVデータの一つのセル内で、複数の設定値を表現する際に利用する区切り文字※1

companyEntityId 文字列

rootCompanyEntityId 文字列

rootOrganizationEntityId 文字列

rootOfficeEntityId 文字列

rootProjectEntityId 文字列

retireUnlisted boolean(true / false) false インポートデータに存在しないレコードを退職、削除する場合に「true」とする
identifiedBy

下記いずれかの文字列

  • default
  • fullPath
  • groupCode
default

インポートを行う際、名寄せに利用する属性を指定する

  • default: グループコードとフルパスの両方で名寄せを実施
  • fullPath: フルパスのみを利用して名寄せを実施
  • groupCode: グループコードのみを利用して名寄せを実施

※1:記載内容及び設定例について詳しくは、「属性マッピング設定」をご覧ください。

レスポンス
レスポンスボディ
項目名 データ形式 説明
diffIds 文字列の配列 インポートによって発生した変更に割り当てられたID
changing changingオブジェクトの配列。各要素の属性は、「changingオブジェクト 」をご覧ください

変更内容の詳細

changingCSVPositions changingCSVPositionsオブジェクトの配列。各要素の属性は、「changingCSVPositionsオブジェクト 」をご覧ください

変更内容を規定しているCSVデータの場所


changingオブジェクト

項目名

データ形式

説明

changeDate 整数値 変更日(0:00時点のUNIX時間 / 末尾3桁は小数点以下の数字)
changingEntities changingEntitiesオブジェクトの配列。各要素の属性は、「changingEntitiesオブジェクト 」をご覧ください 変更した属性の情報


changingEntitiesオブジェクト

項目名

データ形式

説明

entityId 文字列 変更された従業員・組織・会社・事業所・プロジェクトのID
count 整数値 変更された属性の数


changingCSVPositionsオブジェクト

項目名

データ形式

説明

lineNumber 整数値 変更に利用された行数(最初の行を0として起算)
columnNumbers 整数値の配列 変更に利用された列数(一番左の列を0として起算)
実行例
親子構成のプロジェクトを作成する際のリクエストボディ例 (request.json)
{
  "csv": "プロジェクト,プロジェクトコード\nテストプロジェクト,Test project,test-project\nテストプロジェクト/サブプロジェクト,sub-project",
  "options": {
    "mapping": "project: プロジェクト\nprojectCode: プロジェクトコード",
    "tierSeparator": "/"
   }
}
exampleテナントに対するcurlコマンドでの実行
// APIトークンを $API_TOKEN 変数に登録した状態で実行
curl \
    -X POST 'https://example.igms.iij.jp/api/v21.07/groups/import' \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $API_TOKEN" \
    -d @request.json | jq .
レスポンスボディ例
{
  "diffIds": [
    "XFQhEX3JSlWrQL-ri31ARg"
  ],
  "changing": [
    {
      "changeDate": 1745193600000,
      "changingEntities": [
        {
          "entityId": "0y7Fx-ZlST2WfuHVBflPew",
          "count": 3
        },
        {
          "entityId": "hgXjUOp9TEONN41VrdIYcA",
          "count": 3
        }
      ]
    }
  ],
  "changingCSVPositions": []
}
備考
更新される情報について

管理コンソールの「変更予定」で確認できる変更内容は、CSVに記載された情報と本サービスのデータベース上の差分のみです。変更がない項目は表示されません。