カテゴリー内の他の記事

予定のカスタム項目(Schedule datastore)の取得(GET)

予定のカスタム項目(Schedule datastore)の取得

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

HTTP メソッド

GET

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 文字列 必須

取得するカスタム項目のカスタマイズ名を指定します。

リクエストの例 

GET /g/api/v1/schedule/events/1/datastore/jp.co.cybozu.schedule.sample HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Type ヘッダは不要です。

レスポンスの例

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

JavaScript サンプル

Garoon REST API

XMLHttpRequest

関連情報

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Avatar
Megumi Kawano

REST APIで予定一覧を取得しそれぞれのカスタム項目(datastore)を取得する処理を行う際、そもそも該当のスケジュールに指定のカスタム項目(datastore)が設定されているかどうかの確認をする方法はありますでしょうか?(単純にGETすると404となります)

Avatar
cybozu Development team

Kawano Megumi  様

お世話になっております。cybozu developer network  事務局です。

そもそも該当のスケジュールに指定のカスタム項目(datastore)が設定されているかどうかを確認する方法ですが、
リクエストパラメータの customizeName にあたる部分がわからないと GET できないようになっております。

それ以外の方法ではできないかと存じます。

よろしくお願いいたします。

Avatar
Megumi Kawano

cybozu developer network  事務局ご担当者さま

ご返答ありがとうございます。
(customizeNameはわかっているのでGETするURIは生成可能な状況です)

こちらからの質問がよくなかったのですが、処理が失敗した時のレスポンスの例、データがない場合の(valueが空)の場合のレスポンスの例を教えていただ苦こと可能でしょうか。

よろしくお願いいたします。

Avatar
cybozu Development team

Kawano Megumi  様

お世話になっております。cybozu developer network  事務局です。

>処理が失敗した時のレスポンスの例

処理のパターンによってエラーが違ってくるので、まとめに言えません。

 

>データがない場合の(valueが空)の場合のレスポンスの例

1.そもそもValue:{}でcustomizeName の値を登録することができません。

2.実行対象のスケジュールに対して指定した customizeName の値が登録されなかったら、404エラーが返ります。

よろしくお願いします。

cybozu Development teamにより編集されました
サインインしてコメントを残してください。