組織を登録する
組織を登録します。
1 度に登録できる組織は、100 件までです。
CSV ファイルをインポートする API の詳細は、 組織情報をインポートする を参照してください。
URL
https://sample.cybozu.com/v1/organizations.json
HTTP メソッド
POST
必要なアクセス権
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
organizations | 配列 | 必須 | 組織情報の一覧 |
organizations[].code | 文字列 | 必須 | 組織コード 128 文字以下で指定します。 空文字または空白文字のみは指定できません。 |
organizations[].name | 文字列 | 必須 | 組織名 128 文字以下で指定します。 空文字または空白文字のみは指定できません。 |
organizations[].localName | 文字列 | 省略可 | 別言語での表示名 128 文字以下で指定します。 |
organizations[].localNameLocale | 文字列 | 省略可 | 別言語での表示名(言語) 次の値を指定できます。
null を指定すると、
システムの初期値
|
organizations[].parentCode | 文字列 | 省略可 | 親組織のコード 親組織がルートの組織の場合には null を指定します。 |
organizations[].description | 文字列 | 省略可 | 説明 1,000 文字以下で指定します。 |
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は User API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
|
|
制限事項
- API の実行と同時に、画面から登録/編集したり CSV ファイルをインポートしたりした場合には、書き込まれた順に処理されます。
- この API では、処理のロックを行っていません。
そのため、画面からの登録/編集、CSV ファイルのインポート、API での操作を並行して行うことを推奨していません。 - 親となる組織の情報と子となる組織の情報を、同時に登録できます。
ただし、リクエストボディには、先に親となる組織の情報を指定してください。 -
組織の事前設定
が有効な場合には API を実行できません。