予定のカスタム項目（Schedule datastore）の登録（POST）

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

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

HTTP メソッド

POST

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/schedule/events/{id}/datastore/{customizeName}

パッケージ版（Windows環境）

以下は、ヘルプに記載している Windows のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/schedule/events/{id}/datastore/{customizeName}

パッケージ版（Linux環境）

以下は、ヘルプに記載している Linux のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/schedule/events/{id}/datastore/{customizeName}

使用可能なガルーンのバージョン

クラウド版 Garoon
パッケージ版 Garoon バージョン 5.9.0以降

必要なアクセス権

予定の変更権限

リクエストパラメータ

パラメータ名	指定する値	必須	説明
id	数値	必須	カスタム項目を登録するスケジュール ID を指定します。
customizeName	文字列	必須	登録するカスタム項目のカスタマイズ名を指定します。命名規則については、「カスタム項目(Schedule datastore) の命名規則」をご確認ください。

リクエストの例　

リクエストヘッダ

POST /g/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

Content-Type に application/json を指定して下さい。指定しない場合は JSON が解釈できないため、実行時エラーとなります。

リクエストボディ

パラメータ名

指定する値

必須

説明

value

オブジェクト

必須

キーと値を対にしたオブジェクトの形式で、カスタム項目に保存する設定を指定します。
例：

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

レスポンスの例

処理が成功すると、カスタム項目の内容が JSON 形式で返されます。

JavaScript サンプル

Garoon REST API

XMLHttpRequest

制限事項

1 つの予定に登録できる customizeName は 10 個までです。

cybozu developer network