ToDoリスト(グループ)

グループの ToDo リストを取得するための API です。状態の更新などはブラウザでサイトに直接アクセスしてください。

ToDo リストの個々のデータを「タスク」と表します。

この API では特定のグループ内のすべてのタスクが対象となります。 ログインユーザーが担当者となっているタスクを対象としたい場合は ToDoリスト を使用してください。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET

リクエスト制限

ありません。

指定グループのToDoリストを取得する

グループの ID を指定して、ToDoリストを取得します。

必須パラメータ

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

オプションパラメータ

  • term-start - タスク期日の最小値を指定します。指定しない場合はリクエストを処理する日時になります。
    • term-startterm-end を共に指定しなかった場合は、すべてのタスクを取得します。
  • term-end - タスク期日の最大値を指定します。指定しない場合は term-start から1ヶ月後になります。
    • term-startterm-end は共に 1900年1月1日から 2100年12月31日の間でなければなりません。
    • term-endterm-start より未来の日付でなければなりません。
    • term-endterm-start より365日より未来の日付にすることはできません。
    • フォーマットは RFC 3339 の日時表現でなければなりません。
    • タイムゾーンは標準時 Z のみをサポートしています。
  • embed-comment - “true” の場合にコメントも取得します。コメントへのアクセス権が必要です。

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

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

  • status - タスクの状態を指定します。完了していない状態を表す “NOT_COMPLETED” のみ指定可能です。

  • task-folder - 絞り込むカテゴリを指定します。値はID文字列を指定するか、”UNCLASSIFIED” で未分類、”TRASH” でごみ箱を指定します。

レスポンス

要素 説明
/feed/entry/cbl:task タスク固有の情報。ステータスと番号など。
/feed/entry/cbl:when 期日。
/feed/entry/cbl:who 担当者。
/feed/entry/cbl:group グループ。
/feed/entry/cbl:comments/cbl:feedLink コメント。

Examples

リクエストの例:

GET /api/gwTask/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:cblTsk="http://schemas.cybozulive.com/task/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-07-29T02:39:46Z</updated>
  <dc:date>2010-07-29T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>Mashup Award 6 締め切り</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwTask/view?tid=1%3A1" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwTask/modify?tid=1%3A1" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwTask/view?tid=1%3A1" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwTask/modify?tid=1%3A1" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwTask/delete?tid=1%3A1" />
    <category term="GROUP" />
    <category term="TASK" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,TASK,1:1</id>
    <cbl:task sequence="1" valueString="保留"/>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="佐藤 昇" id="1:1"/>
    <cbl:when allday="true" endTime="2010-11-09"/>
    <cblTsk:folder valueString="お知らせ" id="1:5" />
    <cblTsk:priority>S</cblTsk:priority>
    <cbl:confirmed>true</cbl:confirmed>
  </entry>
  <entry>
    <title>年賀状</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwTask/view?tid=1%3A10" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwTask/modify?tid=1%3A10" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwTask/view?tid=1%3A10" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwTask/modify?tid=1%3A10" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwTask/delete?tid=1%3A10" />
    <category term="GROUP" />
    <category term="TASK" />
    <author>
      <name>brown</name>
      <uri>2:8</uri>
    </author>
    <id>GROUP,1:1,TASK,1:10</id>
    <cbl:task sequence="100" valueString="完了"/>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="佐藤 昇" id="1:1"/>
    <cbl:when endTime="2010-12-20T04:30:00Z"/>
    <cblTsk:priority>A</cblTsk:priority>
    <cbl:confirmed>false</cbl:confirmed>
  </entry>
</feed>

特定のToDoリストを取得する

ID を指定して、ToDoリストを取得します。

必須パラメータ

  • entry - ToDoリスト ID を指定します

オプションパラメータ

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

レスポンス

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

Examples

リクエストの例:

GET /api/gwTask/V2?entry=GROUP,1:1,TASK,1:5

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblTsk="http://schemas.cybozulive.com/task/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2015-07-29T02:39:46Z</updated>
  <dc:date>2015-07-29T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>花火大会の場所取り</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwTask/view?tid=1%3A5" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwTask/modify?tid=1%3A5" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwTask/view?tid=1%3A5" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwTask/modify?tid=1%3A5" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwTask/delete?tid=1%3A5" />
    <category term="GROUP" />
    <category term="TASK" />
    <author>
      <name>brown</name>
      <uri>2:8</uri>
    </author>
    <id>GROUP,1:1,TASK,1:5</id>
    <cbl:task sequence="100" valueString="完了"/>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="佐藤 昇" id="1:1"/>
    <cbl:when endTime="2015-08-01T09:00:00Z"/>
    <cblTsk:priority>S</cblTsk:priority>
    <cbl:confirmed>false</cbl:confirmed>
  </entry>
</feed>

未完了のタスクを取得する

Examples

リクエストの例:

GET /api/gwTask/V2?group=1:1&status=NOT_COMPLETED&embed-comment=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:cblTsk="http://schemas.cybozulive.com/task/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-07-29T02:39:46Z</updated>
  <dc:date>2010-07-29T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>Mashup Award 締め切り</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwTask/view?tid=1%3A1" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwTask/modify?tid=1%3A1" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwTask/view?tid=1%3A1" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwTask/modify?tid=1%3A1" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwTask/delete?tid=1%3A1" />
    <category term="GROUP" />
    <category term="TASK" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,TASK,1:1</id>
    <cbl:task sequence="1" valueString="未着手"/>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="佐藤 昇" id="1:1"/>
    <cbl:when allday="true" endTime="2010-11-09"/>
    <cblTsk:folder valueString="お知らせ" id="1:5" />
    <cblTsk:priority>S</cblTsk:priority>
    <cbl:confirmed>true</cbl:confirmed>
  </entry>
  <entry>
    <title>年賀状</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwTask/view?tid=1%3A10" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwTask/modify?tid=1%3A10" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwTask/view?tid=1%3A10" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwTask/modify?tid=1%3A10" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwTask/delete?tid=1%3A10" />
    <category term="GROUP" />
    <category term="TASK" />
    <author>
      <name>brown</name>
      <uri>2:8</uri>
    </author>
    <id>GROUP,1:1,TASK,1:10</id>
    <cbl:task sequence="100" valueString="未着手"/>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="佐藤 昇" id="1:1"/>
    <cbl:when endTime="2010-12-20T04:30:00Z"/>
    <cblTsk:priority>A</cblTsk:priority>
    <cbl:confirmed>false</cbl:confirmed>
    <cbl:comments>
      <cbl:feedLink>
        <feed>
          <entry cbl:sequence="1">
            <link rel="alternate" href="https://cybozulive.com/1_1/gwTask/view?tid=1%3A10&amp;fid=7&amp;focusOn=follow"/>
            <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwTask/view?tid=1%3A10&amp;fid=7#follow"/>
            <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwTask/followDelete?tid=1%3A10&amp;fid=7"/>
            <updated>2010-08-03T12:54:33Z</updated>
            <author>
              <name>すずき</name>
              <uri>1:2</uri>
            </author>
            <content type="text">来年の干支は?</content>
            <summary type="text">来年の干支は?</summary>
          </entry>
        </feed>
      </cbl:feedLink>
    </cbl:comments>
  </entry>
</feed>

注釈

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

エラーコード

ありません。