組織・会社・事務所・プロジェクトの追加・削除
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| POST | /api/v21.07/organizationTransactions/import | 組織の追加・削除 | ー |
| POST | /api/v21.07/organizationTransactions/importAndApply | 組織の追加・削除と承認 | ー |
| POST | /api/v21.07/companyTransactions/import | 会社の追加・削除 | 〇 |
| POST | /api/v21.07/companyTransactions/importAndApply | 会社の追加・削除と承認 | 〇 |
| POST | /api/v21.07/officeTransactions/import | 事務所の追加・削除 | 〇 |
| POST | /api/v21.07/officeTransactions/importAndApply | 事務所の追加・削除と承認 | 〇 |
| POST | /api/v21.07/projectTransactions/import | プロジェクトの追加・削除 | ー |
| POST | /api/v21.07/projectTransactions/importAndApply | プロジェクトの追加・削除と承認 | ー |
クエリパラメータ
不要
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| csv | 〇 | 文字列 | ー | インポートするCSVデータ 本APIを利用する場合はCSVデータ上に「transactionType」に対応する項目が必須 |
| options | 〇 | optionsオブジェクト ※項目は、「optionsオブジェクト」をご覧ください | ー | インポート時の設定値 |
optionsオブジェクト
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| mapping | 〇 | 文字列 | ー | 区切り文字としては「\n」を利用する ※記載内容について詳しくは、「属性マッピング設定」をご覧ください 本APIを利用する場合はCSVデータ上に「transactionType」に対応する項目が必要となるため、以下のような設定が必須 transactionType: [CSVデータ内の「transactionType」に対応する項目] |
| optionMapping | ー | 文字列 | null | 本サービスのSELECT型項目の値とCSVファイルの値で変換が必要な場合にマッピングを指定する マッピングは以下の形式で指定し、区切り文字としては「\n」を利用する [CSVデータ内の値]: [本サービスのSELECT型の値] |
| changeDate | ー | 文字列（「YYYY-MM-DD」形式） | API実行日を示す文字列 | 作成する変更の日付を指定する |
| valueForDelete | ー | 文字列 | null | CSVデータ内で値を削除する際に指定する文字列 |
| tierSeparator | ー | 文字列 | null | CSVデータの一つのセル内で、階層を表現する際に利用する区切り文字 ※設定例は、「属性マッピング設定」をご覧ください |
| referenceSeparator | ー | 文字列 | null | CSVデータの一つのセル内で、複数の設定値を表現する際に利用する区切り文字 ※設定例は、「属性マッピング設定」をご覧ください |
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| 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": "操作,組織\nretireEntity,親組織/削除対象組織",
"options": {
"mapping": "transactionType: 操作\norganization: 組織",
"changeDate": "2025/04/01",
"tierSeparator": "/"
}
}
exampleテナントに対するcurlコマンドでの実行
// APIトークンを $API_TOKEN 変数に登録した状態で実行
curl \
-X POST 'https://example.igms.iij.jp/api/v21.07/organizationTransactions/import' \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $API_TOKEN" \
-d @request.json | jq .
レスポンスボディ例
{
"diffIds": [
"AOSDktUcSsi4epACLdI8gw"
],
"changing": [
{
"changeDate": 1743465600000,
"changingEntities": [
{
"entityId": "s3BCw5M_Rsic9gbJw79CaA",
"count": 1
}
]
}
],
"changingCSVPositions": [
{
"lineNumber": 0,
"columnNumbers": [
0
]
}
]
}
備考
transactionType属性設定値
| 設定値 | 操作内容 |
|---|---|
| addEntity | 新規組織・会社・事業所・プロジェクトを登録する |
| retireEntity | 組織・会社・事業所・プロジェクトを削除する |
インポート時の名寄せキー
組織・会社・事業所・プロジェクトをインポートする際、以下の項目が一致している場合は、情報の更新を行います。
一致する項目がない場合は、新規登録処理が実行されます。
| 優先順位 | 項目名 | 属性ID |
|---|---|---|
| 1 | 最上位オブジェクトからのフルパス表記 | ー |