cybozu.com 共通 API ドキュメント

組織情報をインポートする

目次

組織情報をインポートする

CSV ファイルを使って、組織情報をインポートします。
インポートするユーザー情報の CSV ファイルのフォーマットは、 組織情報 CSV を参照してください。

JSON 形式で更新する API の詳細は、次のページを参照してください。

URL

https://sample.cybozu.com/v1/csv/organization.json

HTTP メソッド

POST

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
fileKey 文字列 必須 CSV ファイルをアップロードする API で取得したファイルキー
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は User API の共通仕様 を参照してください。

ボディ
1
2
3

{
  "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}

レスポンス

プロパティ
プロパティ名 型 説明
id 数値 実行結果の ID
処理内容を確認するには、 インポートの結果を確認する API を実行します。
レスポンスの例
1
2
3

{
  "id": 1
}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6

curl -X POST 'https://sample.cybozu.com/v1/csv/organization.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
      }'

注意事項

  • CSV ファイルには、既存の組織情報も含めてください。
    CSV に存在しない組織コードの組織は、削除されます。
  • 親組織を削除すると、子組織も削除されます。
    組織を削除する場合の注意事項 (External link)