Garoon APIドキュメント

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

目次

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

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

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

URL

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

クラウド版

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 取得するカスタム項目のカスタマイズ名

HTTPメソッド

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

GET

利用できるバージョン

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

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

必要なアクセス権

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

  • 予定の閲覧権限

リクエスト

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

リクエストの例
URL

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

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

レスポンス

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

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

{
  "value": {
    "key": "value",
    "key1": {
      "key1.1": "value1.1",
      "key1.2": "123"
    },
    "key2": ["value2"]
  }
}

サンプルコード

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

curlを使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1

await garoon.api('/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample', 'GET', {});