予定のカスタム項目(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
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
value | オブジェクト | 登録したカスタム項目の設定 キーと値を対にしたオブジェクトの形式です。 |
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|
制限事項
- 1つの予定に登録できるカスタマイズ名は10個までです。