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

組織を更新する

目次

組織を更新する

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

組織を更新します。
一度に更新できる組織は、100件までです。

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

URL

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

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

HTTPメソッド

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

PUT

必要なアクセス権

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

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

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
organizations 配列 必須 組織情報の一覧
organizations[].code 文字列 必須 組織コード
128文字以下で指定します。
organizations[].name 文字列 省略可 組織名
128文字以下で指定します。
省略すると、値は更新されません。
organizations[].localName 文字列 省略可 別言語での表示名
128文字以下で指定します。
省略すると、値は更新されません。
organizations[].localNameLocale 文字列 省略可 別言語での表示名（言語）
次の値を指定できます。
  • ja：日本語
  • en：英語
  • zh：中国語（簡体字）
  • zh-TW：中国語（繁体字）
  • es：スペイン語
省略、または空文字やnullを指定すると、値は更新されません。
organizations[].parentCode 文字列 省略可 親組織の組織コード
128文字以下で指定します。
省略すると、値は更新されません。
空文字を指定すると、組織のルートに移動します。
organizations[].description 文字列 省略可 説明
1,000文字以下で指定します。
省略すると、空文字が設定されます。
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "organizations": [
    {
      "code": "Sales02",
      "name": "北米営業部",
      "localName": "North America Sales Department",
      "localNameLocale": "en",
      "description": "北米営業部",
      "parentCode": "Sales00"
    }
  ]
}

レスポンス

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

1

{}

サンプルコード

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

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

curl -X PUT 'https://sample.cybozu.com/v1/organizations.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "organizations": [
          {
            "code": "Sales03",
            "name": "北米営業部",
            "localName": "North America Sales Department",
            "localNameLocale": "en",
            "description": "北米営業部",
            "parentCode": "Sales00"
          }
        ]
      }'

制限事項

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

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