イベント(グループ)

グループのイベントを取得するための API です。更新操作はブラウザでサイトに直接アクセスしてください。

リクエスト

エンドポイント

  • https://api.cybozulive.com/api/gwSchedule/V2

利用可能な HTTP メソッド

GET

リクエスト制限

  • アプリケーションがイベント情報にアクセスする権限を持っていなくてはなりません。
  • アクセスを許可されていないフィールドの情報は取得できません。

予定を取得する

グループの ID と期間を指定して予定を取得します。

必須パラメータ

  • group - グループの ID を指定します。

オプションパラメータ

  • term-start - イベントを取得する期間の最小値を指定します。指定しない場合はリクエストを処理する日時になります。

  • term-end - イベントを取得する期間の最大値を指定します。指定しない場合は term-start から1ヶ月後になります。
    • term-startterm-end は共に 1900年1月1日から 2100年12月31日の間でなければなりません。

    • term-endterm-start より未来の日付でなければなりません。

    • term-endterm-start より365日より未来の日付にすることはできません。

    • フォーマットは RFC 3339 の日時表現でなければなりません。

    • 日付範囲は次のように決定されます。
      • 予定の開始日時 <= term-start < 予定の終了日時
      • 予定の開始日時 < term-end < 予定の終了日時
  • embed-comment - “true” の場合にコメントも取得します。コメントへのアクセス権が必要です。

  • single-events - “true” の場合に繰り返し予定や期間予定を1日1つに展開して取得します。

  • start-index - コレクションを取得する場合のインデクスを指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “0” です。

  • max-results - コレクションを取得する場合の最大件数を指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。

term-startterm-end での日時は日本時間のみをサポートしています。日本時間での日単位のみの指定が可能で、時刻部分は無視されます。

レスポンス

要素 説明
/feed/entry/cbl:comments/cbl:feedLink イベントに対するコメントです。
/feed/entry/cbl:group グループ情報です。グループイベントの場合のみ存在します。
/feed/entry/cbl:when 開始時間、終了時間です。繰り返し予定の場合は最初の予定です。
/feed/entry/cblSch:banner 予定の種類が期間予定であることを表します。
/feed/entry/cblSch:recurrence 繰り返し条件です。該当期間内の予定日時を含みます。
/feed/entry/cblSch:targetDate 1日1つに展開して取得した場合の該当イベントの対象日です。

/feed/entry/link 要素はいくつかの操作へのリンクを含んでいます。 ブラウザでサイトにアクセスする場合は、操作に合わせて entryDatescopeDate パラメータを付与してください。

これらのパラメータには、その予定の日付を与えます。 例えば、10月の毎日繰り返し予定の10月10日の分を変更するには entryDate=2010-10-10 を付け、削除するには scopeDate=2010-10-10 を付けます。

注釈

リンクに付与するパラメータの仕様は変更の可能性があります。

Examples

リクエストの例:

GET /api/gwSchedule/V2?group=1:1&term-start=2010-09-16T15:00:00Z&term-end=2010-09-22T15:00:00Z

通常予定の例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblSch="http://schemas.cybozulive.com/schedule/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-03T02:54:33Z</updated>
  <dc:date>2010-08-03T02:54:33Z</dc:date>
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:4</uri>
  </author>
  <entry>
    <title>朝の進捗確認</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwSchedule/view?eid=1%3A3909" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwSchedule/modify?eid=1%3A3909" />
    <link rel="mobile" href="https://cybozulive.com/m/1_1/gwSchedule/view?eid=1%3A3909" />
    <link rel="mobile-edit" href="https://cybozulive.com/m/1_1/gwSchedule/modify?eid=1%3A3909" />
    <link rel="mobile-delete" href="https://cybozulive.com/m/1_1/gwSchedule/delete?eid=1%3A3909" />
    <link rel="reuse" href="https://cybozulive.com/1_1/gwSchedule/add?eid=1%3A3909#scheduleEntryNormal" />
    <link rel="mobile-reuse" href="https://cybozulive.com/m/1_1/gwSchedule/normalAdd?eid=1%3A3909" />
    <category term="GROUP" />
    <category term="GW_SCHEDULE" />
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,1:1,GW_SCHEDULE,1:3909</id>
    <updated>2010-09-13T06:37:13Z</updated>
    <summary type="text">今日やることを3つ挙げる</summary>
    <cbl:when startTime="2010-09-23T00:00:00Z" endTime="2010-09-23T01:00:00Z" />
    <cbl:group valueString="グループウェア1" id="1:1" />
  </entry>
</feed>

期間予定の例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblSch="http://schemas.cybozulive.com/schedule/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-03T02:54:33Z</updated>
  <dc:date>2010-08-03T02:54:33Z</dc:date>
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:4</uri>
  </author>
  <entry>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwSchedule/view?eid=1%3A2" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwSchedule/modify?eid=1%3A2" />
    <link rel="mobile" href="https://cybozulive.com/m/1_1/gwSchedule/view?eid=1%3A2" />
    <link rel="mobile-edit" href="https://cybozulive.com/m/1_1/gwSchedule/modify?eid=1%3A2" />
    <link rel="mobile-delete" href="https://cybozulive.com/m/1_1/gwSchedule/delete?eid=1%3A2" />
    <link rel="reuse" href="https://cybozulive.com/1_1/gwSchedule/add?eid=1%3A2#scheduleEntryBanner" />
    <link rel="mobile-reuse" href="https://cybozulive.com/m/1_1/gwSchedule/bannerAdd?eid=1%3A2" />
    <title>バナースケジュール</title>
    <category term="GROUP" />
    <category term="GW_SCHEDULE" />
    <updated>2010-08-01T02:54:33Z</updated>
    <author>
      <name>松田環奈</name>
      <uri>1:777</uri>
    </author>
    <id>GROUP,1:1,GW_SCHEDULE,1:777</id>
    <cbl:when startTime="2010-08-22" endTime="2010-08-25" />
    <cblSch:banner />
    <cbl:group valueString="グループウェア1" id="1:1" />
  </entry>
</feed>

繰り返し予定の例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblSch="http://schemas.cybozulive.com/schedule/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-03T02:54:33Z</updated>
  <dc:date>2010-08-03T02:54:33Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwSchedule/view?eid=1%3A2" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwSchedule/modify?eid=1%3A2" />
    <link rel="mobile" href="https://cybozulive.com/m/1_1/gwSchedule/view?eid=1%3A2" />
    <link rel="mobile-edit" href="https://cybozulive.com/m/1_1/gwSchedule/modify?eid=1%3A2" />
    <link rel="mobile-delete" href="https://cybozulive.com/m/1_1/gwSchedule/delete?eid=1%3A2" />
    <link rel="reuse" href="https://cybozulive.com/1_1/gwSchedule/add?eid=1%3A2#scheduleEntryRepeat" />
    <link rel="mobile-reuse" href="https://cybozulive.com/m/1_1/gwSchedule/repeatAdd?eid=1%3A2" />
    <title>公開スケジュール</title>
    <category term="GROUP" />
    <category term="GW_SCHEDULE" />
    <updated>2010-08-01T02:54:33Z</updated>
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,1:1,GW_SCHEDULE,1:2</id>
    <cblSch:recurrence type="MONTHLY">
      <cbl:when startTime="2010-09-05T15:00:00Z" endTime="2010-09-05T18:00:00Z" />
      <cblSch:byMonth>5</cblSch:byMonth>
      <cblSch:exception startTime="2010-10-05T15:00:00Z" endTime="2010-10-05T18:00:00Z"/>
      <cblSch:until>2011-03-31</cblSch:until>
    </cblSch:recurrence>
    <cbl:group valueString="グループウェア1" id="1:1" />
  </entry>
</feed>

注釈

コメント用のサブフィードには <summary> 要素と <content> 要素に同じ値を含みます。 将来的な コメント API との互換性のため、できるだけ <summary> 要素を使用してください。

特定のイベントを取得する

ID を指定して、イベントを取得します。

必須パラメータ

  • entry - トピック ID を指定します

オプションパラメータ

  • embed-comment - “true” の場合にコメントも取得します。コメントへのアクセス権が必要です。

レスポンス

グループ ID を指定した場合と同様の形式のレスポンスを返します。

Examples

リクエストの例:

GET /api/gwSchedule/V2?entry=GROUP,1:1,GW_SCHEDULE,1:5

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2015"
      xmlns:cblSch="http://schemas.cybozulive.com/schedule/2015"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2015-08-03T02:54:33Z</updated>
  <dc:date>2015-08-03T02:54:33Z</dc:date>
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:4</uri>
  </author>
  <entry>
    <title>朝の進捗確認</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwSchedule/view?eid=1%3A5" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwSchedule/modify?eid=1%3A5" />
    <link rel="mobile" href="https://cybozulive.com/m/1_1/gwSchedule/view?eid=1%3A5" />
    <link rel="mobile-edit" href="https://cybozulive.com/m/1_1/gwSchedule/modify?eid=1%3A5" />
    <link rel="mobile-delete" href="https://cybozulive.com/m/1_1/gwSchedule/delete?eid=1%3A5" />
    <link rel="reuse" href="https://cybozulive.com/1_1/gwSchedule/add?eid=1%3A5#scheduleEntryNormal" />
    <link rel="mobile-reuse" href="https://cybozulive.com/m/1_1/gwSchedule/normalAdd?eid=1%3A5" />
    <category term="GROUP" />
    <category term="GW_SCHEDULE" />
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,1:1,GW_SCHEDULE,1:5</id>
    <updated>2015-09-13T06:37:13Z</updated>
    <summary type="text">今日やることを3つ挙げる</summary>
    <cbl:when startTime="2015-09-23T00:00:00Z" endTime="2015-09-23T01:00:00Z" />
    <cbl:group valueString="グループウェア1" id="1:1" />
  </entry>
</feed>

エラーコード

ありません。