Garoon API ドキュメント

管理者権限で施設グループを登録する

目次

管理者権限で施設グループを登録する

施設グループの情報を登録します。
この API を実行するには、管理者権限が必要です。詳細は 必要なアクセス権 を参照してください。

URL

クラウド版

https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups

パッケージ版
Windows 環境
http://サーバーの IP アドレスまたはホスト名/scripts/インストール識別子/grn.exe/api/v1/schedule/admin/facilityGroups
Linux 環境
http://サーバーの IP アドレスまたはホスト名/cgi-bin/インストール識別子/grn.cgi/api/v1/schedule/admin/facilityGroups

HTTP メソッド

POST

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 5.15 以降

必要なアクセス権

次のいずれかの権限が必要です。

  • Garoon のシステム管理者権限
  • 予定のアプリケーション管理者権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
name 文字列 必須 施設グループ名
nameLocale.ja 文字列 省略可 日本語で表示したときの施設グループ名
nameLocale.en 文字列 省略可 英語で表示したときの施設グループ名
nameLocale.zh 文字列 省略可 簡体字で表示したときの施設グループ名
nameLocale.zh-tw 文字列 省略可 繁体字で表示したときの施設グループ名
code 文字列 必須 施設グループコード
notes 文字列 省略可 メモ
parentFacilityGroup 数値 省略可 親施設グループ ID
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups/

ヘッダー
1
2
3
4

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

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

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

{
  "name": "Tokyo",
  "nameLocale": {
    "ja": "東京",
    "en": "Tokyo",
    "zh": "東京",
    "zh-tw": "东京"
  },
  "code": "tokyo_office",
  "notes": "This is note",
  "parentFacilityGroup": 2
}
レスポンスの例
プロパティ
プロパティ名 型 説明
id 数値 施設グループ ID
name 文字列 施設グループ名
nameLocale オブジェクト 言語ごとに設定した施設グループの表示名
nameLocale.ja 文字列 日本語で表示したときの施設グループ名
nameLocale.en 文字列 英語で表示したときの施設グループ名
nameLocale.zh 文字列 簡体字で表示したときの施設グループ名
nameLocale.zh-tw 文字列 繁体字で表示したときの施設グループ名
code 文字列 施設コード
notes 文字列 メモ
parentFacilityGroup 数値 親施設グループ ID
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "id": 1,
  "name": "Tokyo",
  "nameLocale": {
    "ja": "東京",
    "en": "Tokyo",
    "zh": "東京",
    "zh-tw": "东京"
  },
  "code": "tokyo_office",
  "notes": "This is note",
  "parentFacilityGroup": 2
}

サンプルコード

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

curl -X POST 'https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Tokyo",
    "nameLocale": {
      "ja": "東京",
      "en": "Tokyo",
      "zh": "東京",
      "zh-tw": "东京"
    },
    "code": "tokyo_office",
    "notes": "This is note",
    "parentFacilityGroup": 2
  }
Garoon REST API リクエストを送信する API を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

const body = {
  name: 'Tokyo',
  nameLocale: {
    ja: '東京',
    en: 'Tokyo',
    zh: '東京',
    'zh-tw': '东京'
  },
  code: 'tokyo_office',
  notes: 'This is note',
  parentFacilityGroup: 2
};

await garoon.api('/api/v1/schedule/admin/facilityGroups', 'POST', body);