新着情報

サイボウズLive で更新があった情報をユーザーごとにまとめて管理します。 掲示板にコメントが追加された場合や、新規にイベントが追加された場合などです。 新着情報には「確認済み」のマークがあり、未確認の新着情報だけを取得することや、取得した新着情報を確認済みにマークすることができます。

リクエスト

エンドポイント

https://api.cybozulive.com/api/notification/V2

利用可能な HTTP メソッド

GET, POST

リクエスト制限

  • 1回のリクエストで確認済みにマークできるのは100件までです。

必須パラメータ

ありません。

オプションパラメータ

  • start-index - コレクションを取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • unconfirmed - 未確認の新着情報のみ取得する場合に使います。値は “true” のみ可能です。
  • include-rule-out - “true” の場合に個人設定の参加グループで「通知しない」設定をしたグループの新着情報を含めます。デフォルトは “false” です。
  • embed-attachment - 添付ファイル情報を含める場合に使います。値は “true” のみ可能です。
  • category - サイボウズLive内のアプリケーションを絞り込む場合に使います。ひとつだけ指定できます。
  • group - グループの ID を指定します。
category パラメータで有効なアプリケーション名
パラメータ名 アプリケーション
M_SCHEDULE マイスケジュール
G_SCHEDULE グループイベント
M_CHAT チャット
TASK ToDoリスト
BOARD 掲示板
CABINET 共有フォルダ
MEMBER_LIST グループへの入退会

レスポンス

要素 説明
/feed/entry/cbl:summaryUpdated 本文更新日時。
/feed/entry/cbl:summaryUpdator 本文更新者。
/feed/entry/cbl:unconfirmedCommentCount 未読コメント数。
/feed/entry/cbl:attachment 添付ファイル情報。
/feed/entry/cblNtf:commentId コメントID。コメントによる通知の場合のみ。
/feed/entry/cblNtf:commentDeleted コメント削除による通知かどうか。コメントによる通知の場合のみ。

すべての新着情報を取得する

確認済み、未確認を問わず、全ての新着情報を取得します。データ量を制御するためには max-results パラメータを指定してください。

Examples

リクエストの例:

GET /api/notification/V2

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblNtf="http://schemas.cybozulive.com/notification/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <subtitle>サイボウズLiveの新着情報です</subtitle>
  <updated>2010-07-29T02:39:45Z</updated>
  <dc:date>2010-07-29T02:39:45Z</dc:date>
  <author>
    <name>佐藤 昇</name>
    <email>sato@example.com</email>
    <uri>1:1</uri>
  </author>
  <entry>
    <title>公開スケジュール</title>
    <link rel="alternate" href="https://cybozulive.com/mpSchedule/view?viewDate=2010-07-22&amp;eid=1%3A10" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?viewDate=2010-07-22&amp;eid=1%3A10" />
    <category term="MYPAGE" />
    <category term="MP_SCHEDULE" />
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>MYPAGE,1:1,MP_SCHEDULE,1:10</id>
    <updated>2010-07-22T02:23:49Z</updated>
    <summary type="text">[登録] 2010年7月22日(木)</summary>
    <cblNtf:lastAccess>2010-07-22T02:23:49Z</cblNtf:lastAccess>
  </entry>
  <entry>
    <title>こんにちは</title>
    <link rel="alternate" href="https://cybozulive.com/mpMessage/view?mid=1%3A1&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpMessage/modify?mid=1%3A1#follow" />
    <category term="MYPAGE" />
    <category term="MESSAGE" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>MYPAGE,2:1,MESSAGE,1:1</id>
    <summary type="text">明日はβ9!</summary>
  </entry>
  <entry>
    <title>こんにちは</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A4&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A4#follow" />
    <category term="GROUP" />
    <category term="BOARD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:4</id>
    <summary type="text">こんにちはー</summary>
    <cblNtf:icon>DEFAULT</cblNtf:icon>
  </entry>
  <entry>
    <title>てすと</title>
    <link rel="alternate" href="https://cybozulive.com/2_1/gwSchedule/view?viewDate=2010-07-22&amp;eid=1%3A7" />
    <link rel="mobile" href="https://m.cybozulive.com/m/2_1/gwSchedule/modify?viewDate=2010-07-22&amp;eid=1%3A7" />
    <category term="GROUP" />
    <category term="GW_SCHEDULE" />
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,2:1,GW_SCHEDULE,1:7</id>
    <updated>2010-07-22T02:22:24Z</updated>
    <summary type="text">[変更] 2010年7月22日(木)</summary>
    <cblNtf:lastAccess>2010-07-22T04:44:24Z</cblNtf:lastAccess>
  </entry>
  <entry>
    <title>ようこそ!</title>
    <link rel="alternate" href="https://cybozulive.com/2_2/gwBoard/view?bid=1%3A11" />
    <link rel="mobile" href="https://m.cybozulive.com/m/2_2/gwBoard/modify?bid=1%3A11" />
    <category term="GROUP" />
    <category term="BOARD" />
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,2:2,BOARD,1:11</id>
    <updated>2010-07-26T00:59:09Z</updated>
    <summary type="text">グループにメンバーを招待して情報共有しましょう。
グループの情報を閲覧できるのは、グループメンバーとして追加されたユーザーだけです。

■グループの主な機能
・イベント
   カレンダー形式でイベントやマイルストーンを共有できます。
・ToDoリスト
   担当と期日を決めてToDoをメンバー間で共有できます。
・掲示板
   テーマごとにトピックを作成してディスカッションできます。
・共有フォルダ
   フォルダを作ってファイルを整理できます。</summary>
    <cblNtf:lastAccess>2010-07-28T10:11:37Z</cblNtf:lastAccess>
  </entry>
</feed>

ユーザーが確認していない情報を取得する

GET リクエストで unconfirmed パラメータに true を指定します。

Examples

リクエストの例:

GET /api/notification/V2?unconfirmed=true

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblNtf="http://schemas.cybozulive.com/notification/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <subtitle>サイボウズLiveの新着情報です</subtitle>
  <updated>2010-08-29T02:39:46Z</updated>
  <dc:date>2010-08-29T02:39:46Z</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/mpMessage/view?mid=1%3A2&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpMessage/view?mid=1%3A2#follow" />
    <category term="MYPAGE" />
    <category term="MESSAGE" />
    <updated>2010-08-28T02:54:33Z</updated>
    <author>
      <name>田中 美子</name>
      <uri>1:11</uri>
    </author>
    <id>MYPAGE,1:1,MESSAGE,1:2</id>
    <summary type="text">明日は晴れ!</summary>
  </entry>
  <entry>
    <title>添付ファイルのテストです</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A3&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A3#follow" />
    <category term="GROUP" />
    <category term="BOARD" />
    <updated>2010-08-27T21:54:02Z</updated>
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:3</id>
    <summary type="text">こんにちは</summary>
    <cblNtf:icon>DEFAULT</cblNtf:icon>
  </entry>
</feed>

特定のグループのみの情報を取得する

GET リクエストで group パラメータを指定します。

Examples

リクエストの例:

GET /api/notification/V2?group=1:1

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblNtf="http://schemas.cybozulive.com/notification/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <subtitle>サイボウズLiveの新着情報です</subtitle>
  <updated>2010-07-29T02:39:45Z</updated>
  <dc:date>2010-07-29T02:39:45Z</dc:date>
  <author>
    <name>佐藤 昇</name>
    <email>sato@example.com</email>
    <uri>1:1</uri>
  </author>
  <entry>
    <title>こんにちは</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A4&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A4#follow" />
    <category term="GROUP" />
    <category term="BOARD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:4</id>
    <summary type="text">こんにちはー</summary>
    <cblNtf:icon>DEFAULT</cblNtf:icon>
  </entry>
</feed>

新着情報を確認済みにする

取得した新着情報の ID を指定して確認済みにできます。確認済みになったエントリが返されます。 存在しない ID を指定した場合、そのエントリは無視されます。エラーにはなりません。 既に確認済みの新着情報を指定した場合も、そのエントリは無視されます。

リクエスト

Atom 名前空間 (http://www.w3.org/2005/Atom) の feedentry を使います。

要素 説明
/feed/entry/id 確認済みにマークする新着情報の ID。

Examples

リクエストの例:

POST /api/notification/V2
Content-Type: application/atom+xml
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <entry>
    <id>MYPAGE,1:1,MESSAGE,1:2</id>
  </entry>
  <entry>
    <id>GROUP,1:1,BOARD,1:3</id>
  </entry>
  <entry>
    <id>UNKNOWN-IDENTIFIER</id>
  </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:cblNtf="http://schemas.cybozulive.com/notification/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <subtitle>サイボウズLiveの新着情報です</subtitle>
  <updated>2010-08-29T02:39:46Z</updated>
  <dc:date>2010-08-29T02:39:46Z</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/mpMessage/view?mid=1%3A2&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpMessage/view?mid=1%3A2#follow" />
    <category term="MYPAGE" />
    <category term="MESSAGE" />
    <updated>2010-08-28T02:54:33Z</updated>
    <author>
      <name>田中 美子</name>
      <uri>1:11</uri>
    </author>
    <id>MYPAGE,1:1,MESSAGE,1:2</id>
    <summary type="text">明日は晴れ!</summary>
  </entry>
  <entry>
    <title>添付ファイルのテストです</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A3&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A3#follow" />
    <category term="GROUP" />
    <category term="BOARD" />
    <updated>2010-08-27T21:54:02Z</updated>
    <author>
      <name>佐藤 昇</name>
      <uri>1:1</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:3</id>
    <summary type="text">こんにちは</summary>
    <cblNtf:icon>DEFAULT</cblNtf:icon>
  </entry>
</feed>

エラーコード

ありません。