スケジュール

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

このドキュメントでは、自分の個人的な予定および他のユーザーと共有しているスケジュールデータを「個人予定」、 グループで登録したスケジュールデータを「グループイベント」と表記します。また、これらを合わせて「予定」と表記します。 個人予定は参加者と設備を指定でき、参加者のみ閲覧できます。グループイベントはグループ内の全メンバーが閲覧できます。 グループイベントに参加者および設備を設定することはできません。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET

リクエスト制限

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

必須パラメータ

ありません。

オプションパラメータ

  • 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 の日時表現でなければなりません。

    • タイムゾーンは標準時 Z のみをサポートしています。

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

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

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

  • ignore-aggregated - サイボウズLiveシンクで同期された予定を含めるかを指定します。デフォルトは “false” です。

  • id - 取得対象の ID を指定します。ID を指定した場合は期間などの絞込み条件は無視されます。

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

レスポンス

要素 説明
/feed/entry/cbl:comments/cbl:feedLink イベントに対するコメントです。
/feed/entry/cbl:facility 設備です。個人予定の場合のみ存在することがあります。
/feed/entry/cbl:group グループ情報です。グループイベントの場合のみ存在します。
/feed/entry/cbl:when 開始時間、終了時間です。繰り返し予定の場合は最初の予定です。
/feed/entry/cbl:who 参加者です。個人予定の場合のみ存在します。
/feed/entry/cblSch:allowEdit 編集許可のフラグです。
/feed/entry/cblSch:banner 予定の種類が期間予定であることを表します。
/feed/entry/cblSch:recurrence 繰り返し条件です。該当期間内の予定日時を含みます。
/feed/entry/cblSch:syncEvent サイボウズ Live シンクで同期されている場合の同期元です。

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

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

注釈

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

予定を取得する

期間を指定して予定を取得します。

Examples

リクエストの例:

GET /api/schedule/V2?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>
    <link rel="alternate" href="https://cybozulive.com/mpSchedule/view?eid=1%3A2" />
    <link rel="edit" href="https://cybozulive.com/mpSchedule/modify?eid=1%3A2" />
    <link rel="reuse" href="https://cybozulive.com/mpSchedule/add?eid=1%3A2#scheduleEntryNormal" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/mpSchedule/modify?eid=1%3A2" />
    <link rel="mobile-reuse" href="https://m.cybozulive.com/m/mpSchedule/normalAdd?eid=1%3A2" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/mpSchedule/delete?eid=1%3A2" />
    <link rel="mobile-leave" href="https://m.cybozulive.com/m/mpSchedule/leave?eid=1%3A2" />
    <title>公開スケジュール</title>
    <category term="MYPAGE" />
    <category term="MP_SCHEDULE" />
    <updated>2010-09-01T02:54:33Z</updated>
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <contributor>
      <name>田中 美子</name>
    </contributor>
    <contributor>
      <name>高橋 健太</name>
    </contributor>
    <id>MYPAGE,1:1,MP_SCHEDULE,1:2</id>
    <summary type="text">予定のメモを記入できます。書式は削ぎ落されて出力されます。</summary>
    <cbl:when startTime="2010-09-22T06:00:00Z" endTime="2010-09-22T09:00:00Z" />
    <cbl:who valueString="やまだ">
      <cbl:attendeeType value="REQUIRED"/>
    </cbl:who>
    <cbl:who valueString="たなか">
      <cbl:attendeeType value="NON"/>
    </cbl:who>
    <cbl:who valueString="さとう">
      <cbl:attendeeType value="REQUIRED"/>
    </cbl:who>
    <cbl:facility valueString="大会議室1" id="1:1" group="1:1" groupName="グループ1" />
    <cbl:facility valueString="プロジェクター" id="1:3" group="1:2" groupName="グループ2" />
    <cbl:facility valueString="テレビ会議システム" id="1:5" group="1:3" groupName="グループ3" />
    <cbl:comments>
      <cbl:feedLink>
        <feed>
          <entry cbl:sequence="1">
            <link rel="alternate" href="https://cybozulive.com/mpSchedule/view?eid=1%3A2&amp;fid=7&amp;focusOn=follow"/>
            <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2&amp;fid=7#follow"/>
            <link rel="mobile-delete" href="https://m.cybozulive.com/m/mpSchedule/followDelete?eid=1%3A2&amp;fid=7"/>
            <updated>2010-09-03T12:54:33Z</updated>
            <cbl:who valueString="すずき"/>
            <content type="text">あいうえお、これはテストのコメントです。</content>
            <summary type="text">あいうえお、これはテストのコメントです。</summary>
          </entry>
          <entry cbl:sequence="3">
            <link rel="alternate" href="https://cybozulive.com/mpSchedule/view?eid=1%3A2&amp;fid=20&amp;focusOn=follow"/>
            <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2&amp;fid=20#follow"/>
            <link rel="mobile-delete" href="https://m.cybozulive.com/m/mpSchedule/followDelete?eid=1%3A2&amp;fid=20"/>
            <updated>2010-09-03T02:54:33Z</updated>
            <author>
              <name>クレモンティーヌ</name>
            </author>
            <content type="text">こんにちはこんにちは</content>
            <summary type="text">こんにちはこんにちは</summary>
          </entry>
        </feed>
      </cbl:feedLink>
    </cbl:comments>
    <cblSch:syncEvent sourceId="128" sourceName="Google Calendar" />
    <cblSch:allowEdit/>
  </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/mpSchedule/view?eid=1%3A2" />
    <link rel="edit" href="https://cybozulive.com/mpSchedule/modify?eid=1%3A2" />
    <link rel="reuse" href="https://cybozulive.com/mpSchedule/add?eid=1%3A2#scheduleEntryBanner" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/mpSchedule/modify?eid=1%3A2" />
    <link rel="mobile-reuse" href="https://m.cybozulive.com/m/mpSchedule/bannerAdd?eid=1%3A2" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/mpSchedule/delete?eid=1%3A2" />
    <link rel="mobile-leave" href="https://m.cybozulive.com/m/mpSchedule/leave?eid=1%3A2" />
    <title>バナースケジュール</title>
    <category term="MYPAGE" />
    <category term="MP_SCHEDULE" />
    <updated>2010-08-01T02:54:33Z</updated>
    <author>
      <name>松田環奈</name>
      <uri>1:777</uri>
    </author>
    <id>MYPAGE,1:1,MP_SCHEDULE,1:2</id>
    <cbl:when startTime="2010-08-22" endTime="2010-08-25" />
    <cbl:who valueString="松田 環奈" id="1:123">
      <cbl:attendeeType value="REQUIRED"/>
    </cbl:who>
    <cbl:who valueString="高橋 健太" id="1:4">
      <cbl:attendeeType value="NON"/>
    </cbl:who>
    <cblSch:banner />
  </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/mpSchedule/view?eid=1%3A2" />
    <link rel="edit" href="https://cybozulive.com/mpSchedule/modify?eid=1%3A2" />
    <link rel="reuse" href="https://cybozulive.com/mpSchedule/add?eid=1%3A2#scheduleEntryRepeat" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/mpSchedule/scopeSet?eid=1%3A2" />
    <link rel="mobile-reuse" href="https://m.cybozulive.com/m/mpSchedule/repeatAdd?eid=1%3A2" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/mpSchedule/delete?eid=1%3A2" />
    <link rel="mobile-leave" href="https://m.cybozulive.com/m/mpSchedule/leave?eid=1%3A2" />
    <title>公開スケジュール</title>
    <category term="MYPAGE" />
    <category term="MP_SCHEDULE" />
    <updated>2010-08-01T02:54:33Z</updated>
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>MYPAGE,1:1,MP_SCHEDULE,1:2</id>
    <cbl:who valueString="佐藤 昇" id="1:1">
      <cbl:attendeeType value="REQUIRED"/>
    </cbl:who>
    <cbl:who valueString="田中 美子" id="1:11">
      <cbl:attendeeType value="REQUIRED"/>
    </cbl:who>
    <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>
  </entry>
</feed>

注釈

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

エラーコード

ありません。