組織を登録する

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

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

URL

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

HTTP メソッド

POST

必要なアクセス権

• cybozu.com 共通管理者

リクエスト

パラメーター

パラメーター名	型	必須	説明
organizations	配列	必須	組織情報の一覧
organizations[].code	文字列	必須	組織コード 128 文字以下で指定します。 空文字または空白文字のみは指定できません。
organizations[].name	文字列	必須	組織名 128 文字以下で指定します。 空文字または空白文字のみは指定できません。
organizations[].localName	文字列	省略可	別言語での表示名 128 文字以下で指定します。
organizations[].localNameLocale	文字列	省略可	別言語での表示名（言語） 次の値を指定できます。 ja：日本語 en：英語 zh：中国語（簡体字） zh-TW：中国語（繁体字） 省略、または空文字や null を指定すると、 システムの初期値 が設定されます。
organizations[].parentCode	文字列	省略可	親組織のコード 親組織がルートの組織の場合には null を指定します。
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 での操作を並行して行うことを推奨していません。
• 親となる組織の情報と子となる組織の情報を、同時に登録できます。
  ただし、リクエストボディには、先に親となる組織の情報を指定してください。
• 組織の事前設定 が有効な場合には API を実行できません。