Garoon API ドキュメント

予定のカスタム項目（Schedule datastore）を登録する

目次

予定のカスタム項目（Schedule datastore）を登録する

固定リンクがコピーされました

予定 ID とカスタマイズ名を指定して、予定のカスタム項目（Schedule datastore）を登録します。

URL

固定リンクがコピーされました

クラウド版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME：Garoon のインストール先の IP アドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoon のインストール識別子

https://sample.cybozu.com/g/api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_NAME

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME：Garoon のインストール先の IP アドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoon のインストール識別子
Windows 環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_NAME
Linux 環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/events/SCHEDULE_ID/datastore/CUSTOMIZE_NAME
パスパラメーター
パラメーター名 説明
SCHEDULE_ID カスタム項目を登録する予定の予定 ID
CUSTOMIZE_NAME 登録するカスタム項目のカスタマイズ名
カスタマイズ名の命名規則は、 カスタム項目(Schedule datastore) の命名規則 を確認してください。

HTTP メソッド

固定リンクがコピーされました

POST

利用できるバージョン

固定リンクがコピーされました

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

必要なアクセス権

固定リンクがコピーされました

  • 予定の変更権限

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
value オブジェクト 必須 カスタム項目の設定内容
キーと値を対にしたオブジェクトの形式で指定します。
キー名は 128 文字以下、値は 80,000 文字以下で指定します。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample

ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4
5
6
7

{
  "value": {
    "key1": "value1",
    "key2": { "key2.1": "value2.1" },
    "key3": ["value3"]
  }
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
value オブジェクト 登録したカスタム項目の設定
キーと値を対にしたオブジェクトの形式です。
レスポンスの例
1
2
3
4
5
6
7

{
  "value": {
    "key1": "value1",
    "key2": { "key2.1": "value2.1" },
    "key3": ["value3"]
  }
}

サンプルコード

固定リンクがコピーされました

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

curl -X POST 'https://sample.cybozu.com/g/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": {
      "key1": "value1",
      "key2": {"key2.1": "value2.1"},
      "key3": ["value3"]
    }
  }
Garoon REST API リクエストを送信する API を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

const body = {
  value: {
    key1: 'value1',
    key2: {
      'key2.1': 'value2.1'
    },
    key3: ['value3']
  }
};

await garoon.api('/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample', 'POST', body);

制限事項

固定リンクがコピーされました

  • 1 つの予定に登録できるカスタマイズ名は 10 個までです。