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

ユーザー情報をインポートする

目次

ユーザー情報をインポートする

固定リンクがコピーされました

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

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

URL

固定リンクがコピーされました

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

HTTPメソッド

固定リンクがコピーされました

POST

必要なアクセス権

固定リンクがコピーされました

cybozu.com共通管理者 (External link)

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
fileKey 文字列 必須 CSVファイルをアップロードするAPIで取得したファイルキー
CSVファイルをアップロードするAPI
variableCustomItemLength 真偽値 省略可 カスタマイズ項目値に過不足があってもインポートを成功させるかどうか
  • true：成功させる
  • false：失敗させる
省略すると「false」が設定されます。
「false」を設定している場合に、CSVにカスタマイズ項目に相当する列が足りないと、カスタマイズ項目の順番どおりにインポートされます。
カスタマイズ項目に相当する列が足りずに値が指定されていない項目は、元のデータが維持されます。
カスタマイズ項目に相当する列が多すぎると、超過した列は無視されてインポートされます。
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4

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

レスポンス

固定リンクがコピーされました

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

{
  "id": 1
}

サンプルコード

固定リンクがコピーされました

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

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