複数の予定を取得する
複数の予定を取得する
クエリで条件を指定して、複数の予定を取得します。
- 繰り返し予定を含む場合は、すべての日の予定が返ります。
- 仮予定を含む場合は、すべての候補の予定が返ります。
- クエリで
target
を指定しない場合は、APIを実行したユーザーが参加する予定だけを取得します。 - 画面で「予定あり」と表示されていても、APIを実行したユーザーが閲覧できない予定(非公開の予定)は取得できません。
非公開の予定を含む予定の有無を調べる場合は、 空き予定を検索するAPIを利用してください。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/schedule/events
パッケージ版
環境に合わせてそれぞれ以下を置き換えてください。
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 - Linux環境
- http://
IP_ADDRESS_OR_HOST_NAME
/cgi-bin/INSTALL_IDENTIFER
/grn.cgi/api/v1/schedule/events
HTTPメソッド
GET
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 4.10以降
必要なアクセス権
- 予定の閲覧権限
リクエスト
パラメーター
リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、
Garoon REST APIリクエストを送信するAPIを使って実行する場合は、リクエストボディとして指定できます。
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
fields | 文字列 | 省略可 | 取得するプロパティ スケジュールオブジェクトのプロパティを指定できます。 複数のプロパティを指定するには、半角カンマで区切ります。 |
orderBy | 文字列 | 省略可 | ソート条件 プロパティ名と並び順の間に半角スペースを入れて指定します。 たとえば、 createdAt を降順で並べ替える場合には、「orderBy=createdAt desc」を指定します。指定できるプロパティ名および並び順は次のとおりです。
updatedAt の昇順で並べ替えられます。 |
rangeStart | 文字列 | 省略可 | 予定の開始日時の取得期間(開始日時)rangeStart で指定した日時より後に開始する予定に絞り込みます。RFC 3339形式で指定します。 たとえば、日本時間の2022年10月19日9時10分30秒を指定したい場合には、次のように指定します。
rangeEnd を指定する場合には、rangeEnd より前の値を指定してください。 |
rangeEnd | 文字列 | 省略可 | 予定の終了日時の取得期間(終了日時)rangeEnd で指定した日時より前に終了した予定に絞り込みます。RFC 3339形式で指定します。 rangeStart を指定する場合には、rangeStart より後の値を指定してください。 |
target | 文字列 | 条件必須 | 絞り込みに使用するID 次のいずれかの値を指定します。
targetType を指定した場合は必須です。target とtargetType のどちらも省略した場合、次のいずれかの値を指定します。
|
targetType | 文字列 | 条件必須 | 絞り込みに使用するIDのタイプ 次のいずれかの値を指定します。
target を指定した場合は必須です。 |
keyword | 文字列 | 条件必須 | 予定検索のキーワード 次のいずれかの項目にキーワードを含む予定に絞り込みます。
excludeFromSearch を指定した場合は必須です。 |
excludeFromSearch | 文字列 | 省略可 | キーワード検索から除外する項目 次のいずれかの値を指定します。
|
showPrivate | 真偽値 | 省略可 | 次にいずれかに該当する、閲覧権限のない予定も含めて取得するかどうかを指定します。 取得できるスケジュールオブジェクトのプロパティには制限があります。詳細は、 閲覧権限がない予定で取得できるプロパティを参照してください。
次のいずれかの値を指定します。
非公開の予定を完全に隠す設定 をしている場合、 targetType に「user」または「organization」を指定していると、非公開の予定を取得できません。 |
limit | 数値 | 省略可 | 取得する予定の件数 1から1,000まで指定できます。省略すると100が設定されます。 指定された条件に一致する予定がさらにある場合でも、指定した値より取得できる予定の数は少なくなる可能性があります。 リクエストパラメーターで指定された条件に一致するレコードの中で、閲覧権限がないレコードは除外されます。 |
offset | 数値 | 省略可 | 取得する予定の先頭からスキップする数 省略すると、0が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/schedule/events?limit=100&orderBy=updatedAt%20asc
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。
ボディ
|
|
レスポンス
処理が成功すると、予定の内容がJSON形式で返ります。
形式の詳細は
スケジュールオブジェクトを確認してください。
レスポンスの例
|
|
additionalItems
は、パッケージ版Garoon 6.0より前のバージョンでのみ利用できます。
予定に関する付加情報を保存する場合は、カスタマイズ項目(Schedule Datastore)を利用してください。
詳細は、次のページを参照してください。
カスタム項目(additionalItems)の廃止について
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|