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

組織コードを更新する

目次

組織コードを更新する

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

組織コードを更新します。
1 度に更新できる組織は、100 件までです。

CSV ファイルをインポートする API の詳細は、 組織情報をインポートする を参照してください。

URL

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

https://sample.cybozu.com/v1/organizations/codes.json

HTTP メソッド

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

PUT

必要なアクセス権

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

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
codes 配列 必須 組織コードの一覧
codes[].currentCode 文字列 必須
 現在の組織コード
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
codes[].newCode 文字列 必須 更新後の組織コード
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4
5
6
7
8

{
  "codes": [
    {
      "currentCode": "Sales03",
      "newCode": "Sales05"
    }
  ]
}

レスポンス

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

1

{}

サンプルコード

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

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

curl -X PUT 'https://sample.cybozu.com/v1/organizations/codes.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "codes": [
          {
            "currentCode": "Sales03",
            "newCode": "Sales05"
          }
        ]
      }'

制限事項

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

  • 組織の事前設定 (External link) で予約データが作成されている場合は、API を実行できません。
  • cybozu.com 共通管理における次の操作と、API の実行を並行して行うことは推奨しません。
    • 組織とユーザーの設定画面における、組織に対する各操作
    • ファイルからの読み込み