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

組織を更新する

目次

組織を更新する

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

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

URL

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

HTTP メソッド

PUT

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
organizations 配列 必須 組織情報の一覧
organizations[].code 文字列 必須 組織コード
128 文字以下で指定します。
organizations[].name 文字列 省略可 組織名
128 文字以下で指定します。
省略すると、値は更新されません。
organizations[].localName 文字列 省略可 別言語での表示名
128 文字以下で指定します。
省略すると、値は更新されません。
organizations[].localNameLocale 文字列 省略可 別言語での表示名（言語）
次の値を指定できます。
  • ja：日本語
  • en：英語
  • zh：中国語（簡体字）
  • zh-TW：中国語（繁体字）
省略、または空文字や 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": "organization-1",
      "name": "組織-1",
      "localName": "Organization 1",
      "localNameLocale": "en",
      "description": "組織1のメモ",
      "parentCode": null
    }
  ]
}

レスポンス

1

{}

制限事項

  • API の実行と同時に、画面から登録／編集したり CSV ファイルをインポートしたりした場合には、書き込まれた順に処理されます。
  • この API では、処理のロックを行っていません。
    そのため、画面からの登録／編集、CSV ファイルのインポート、API での操作を並行して行うことを推奨していません。
  • リクエストボディに同じ organizations[].code の組織情報を指定すると、後の組織情報で更新されます。
  • 組織の事前設定 (External link) が有効な場合には API を実行できません。