お気に入り

アイテムにお気に入りを設定する機能です。 グループおよびアプリケーションに関わらず、お気に入りを設定することができます。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET, POST

必須パラメータ

ありません。

オプションパラメータ

  • start-index - コレクションを取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • id - 取得対象の ID を指定します。ID を指定した場合はインデクスなどの絞込み条件は無視されます。

お気に入りの一覧を取得する

Examples

リクエストの例:

GET /api/star/V2

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2011-03-05T02:54:33Z</updated>
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:4</uri>
  </author>
  <entry>
    <link rel="alternate" href="https://cybozulive.com/1_2/gwBoard/view?bid=1%3A3"/>
    <link rel="mobile" href="https://m.cybozulive.com/m/1_2/gwBoard/view?bid=1%3A3"/>
    <updated>2011-03-03T12:54:33Z</updated>
    <category term="GROUP"/>
    <category term="BOARD"/>
    <category term="STAR"/>
    <id>GROUP,1:2,BOARD,1:3</id>
    <title>ようこそ!</title>
    <summary type="text">グループにメンバーを招待して情報共有しましょう。
      グループの情報を閲覧できるのは、グループメンバーとして追加されたユーザーだけです。

      ■グループの主な機能
      ・イベント
      カレンダー形式でイベントやマイルストーンを共有できます。
      ・ToDoリスト
      担当と期日を決めてToDoをメンバー間で共有できます。
      ・掲示板
      テーマごとにトピックを作成してディスカッションできます。
      ・共有フォルダ
      フォルダを作ってファイルを整理できます。</summary>
    <cbl:group valueString="グループウェア2" id="1:2" />
  </entry>
  <entry>
    <link rel="alternate" href="https://cybozulive.com/1_2/gwBoard/view?bid=1%3A3&amp;fid=1&amp;focusOn=follow"/>
    <link rel="mobile" href="https://m.cybozulive.com/m/1_2/gwBoard/view?bid=1%3A3#follow"/>
    <updated>2011-03-03T14:02:32Z</updated>
    <category term="GROUP"/>
    <category term="BOARD"/>
    <category term="STAR"/>
    <id>GROUP,1:2,BOARD,1:3,COMMENT,1</id>
    <title>ようこそ!</title>
    <summary type="text">よろしくお願いします。</summary>
    <cbl:group valueString="グループウェア2" id="1:2" />
  </entry>
</feed>
NOTE:
実際の <entry> 要素には空の <author> 要素が含まれますが、当面は無視してください。 Atom のスキーマとの整合性のために出力しています。

アイテムをお気に入りに登録する

アイテムの ID を指定して、そのアイテムをお気に入りに登録することができます。 アイテムはひとつずつしか指定できません。

要素 説明
/feed/cbl:operation type 属性に insert を指定します。
/feed/entry/id お気に入りを登録するアイテムの ID (必須項目)

Examples

リクエストの例:

POST /api/star/V2
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <cbl:operation type="insert"/>
  <entry>
    <id>GROUP,1:1,BOARD,1:1,COMMENT,42</id>
  </entry>
</feed>

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <entry>
    <id>GROUP,1:1,BOARD,1:1,COMMENT,42</id>
  </entry>
</feed>

アイテムからお気に入りを削除する

アイテムの ID を指定して、そのアイテムからお気に入りを削除することができます。 アイテムはひとつずつしか指定できません。

要素 説明
/feed/cbl:operation type 属性に delete を指定します。(必須項目)
/feed/entry/id お気に入りを削除するアイテムの ID (必須項目)

Examples

リクエストの例:

POST /api/star/V2
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <cbl:operation type="delete"/>
  <entry>
    <id>GROUP,1:1,BOARD,1:1,COMMENT,42</id>
  </entry>
</feed>

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <entry>
    <id>GROUP,1:1,BOARD,1:1,COMMENT,42</id>
  </entry>
</feed>

エラーコード

書き込み用のデータが不正な場合にはエラーの XML が返ります。 <error> 要素の中身を確認してください。

  • お気に入りを登録する/削除する対象となるアイテムが存在しない場合
  • ふたつ以上のアイテムに対して操作を試みた場合