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

組織を追加する

目次

組織を追加する

組織を追加します。
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 文字列 省略可 別言語での表示名（言語）
次の値を指定できます。
  • ja：日本語
  • en：英語
  • zh：中国語（簡体字）
  • zh-TW：中国語（繁体字）
省略、または空文字や null を指定すると、 システムの初期値 (External link) が設定されます。
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": "Sales03",
      "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 POST '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"
          }
        ]
      }'

制限事項

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