Toodledo/API/Task/情報フィールド - api_programming @ ウィキ

http://api.toodledo.com/3/

下位ページ

Content

Task（タスク）のデータフィールド

retrieve, setに共通して用いられるフィールド

GT	AD	ED	DN	DD	SR	フィールド	定義	フォーマット、制限
△					◯	added	タスクが追加された日。UNIX時間で表記。	タスクが追加された「時間」は記録されない。常に正午としてカウントされる。
△					◯	addedby	タスクを割り当てたユーザのId (※subscriptionユーザ限定).
◯					×	after	この時間以降に更新したタスクを探索	UNIX時間。
△					◯	attachment	添付アイテムの配列。各アイテムは３つのフィールドを含む。添付アイテムは読み取り専用。アウトラインを参照するidを使えます。リスト(list)、ノート(note)はこのAPIを通して取得可。ファイルは現在読めないが、機能追加準備中。
○	-	-	-	-	×	before	この時間以前に更新したタスクを探索	UNIX時間。
×					◯	checked	Whether the task is completed or not
△					◯	children	このタスクが持つサブタスク数	サブタスク自身や、サブタスクを持たないタスクは0
◯						comp	未完了、完了の選択。	0:未完のみ、1:完了のみ、無しor-1:両方
×		◯			◯	completed	いつタスクが完了したか	未完了の場合、0.UNIX時間。 Toodledoはタスクが完了した「時間」はトラッキングしない。そのため、タスクは正午に完了、として処理される。
△		◯			◯	context	コンテクストのID番号	コンテクスト割当なしの場合は省略（もしくは0）
△		◯			◯	duedate	タスクの期限（日）	UNIXタイムスタンプ（GMTの正午） タイムスタンプ＝1445172465 ↓ 日時（Tokyo）＝2015/10/18 21:47:45
△		◯			◯	duedatemod	期限（日）のタイプを示す整数	0 : Due By 1 : Due On (=) 2 : Due After (>) 3 : Optionally (?)
△		◯			◯	duetime	for when the task is due.	UNIX時間。設定しなければ0.duedateが設定されず、duetimeのみが設定されていると、1970年1月1日と判断。タイムゾーンにかかわらず、10amは10amと判断。You can convert this timestamp to a GMT string and display the time component without worrying about timezones.
		◯				duration
○						fields	レスポンスに付けて返してほしいフィールド	コンマ区切り。レスポンス向上のため、不用なら省略する。
△		◯			◯	folder	フォルダのID番号	フォルダ割当なしの場合は0もしくは省略。
△		◯			◯	goal	goalのID番号	goal割当なしの場合は省略（もしくは0）
△	-	●	-	-	×	id	タスクID	アカウントに対してユニークな番号（違うアカウントに対しては、同一のIDに対して異なるタスクがぶら下がる可能性あり。
△					◯	length	タスク達成までの予想時間（分、整数値）
△		◯			◯	location	場所のID番号	割当なしの場合は省略（もしくは0）
△		◯				meta	A text for storing metadata about the task. This is useful for syncing data that cannot otherwise be synced to Toodledo. Because of an implementation detail, using the meta field introduces extra latency to each API call, so you should only use this field when necessary.	1,024バイトまで。タスクごとにユニークなIDを持ち、AppIDに対してprivate。ユーザーもAppIDsも個々に入力した値は見られない。
-					◯	modified	for when the task was last modified.	UNIX時間。
△		◯				note	ノート	32,000 bytesまで。改行コードは\n
◯						num	取得するタスク数。複数ページで表示する場合などに使用	デフォルト値、最大値ともに1000
△					×	order	サブタスクの順番	読み取り専用
△					◯	parent	親タスクのID番号	デフォルト値はO
△					×	previous	If the task was repeated from another task, this will contain the id number of the previous version of this task.
△		◯			◯	priority	優先順位。整数値。	3 = Top 2 = High, 1 = Medium, 0 = Low, -1 = Negative,
△		◯			◯	remind	リマインダが送られる、タスクの期限までの時間（分）を表す整数値。	0:リマインダなし 値の制限：0, 1, 15, 30, 45, 60, 90, 120, 180, 240, 1440, 2880, 4320, 5760, 7200, 8640, 10080, 20160, 43200)。これ以外は近い値に丸め。 無料ユーザーは0か60。
△		◯			◯	repeat	どのようにタスクを繰り返すかを示す文字列	記録を残すため、リピートするタスクが完了した場合ははコピーされたタスクがリストに加えられ、完了タスクに対して、新しいID番号が付与される。繰り返しを中止するには、これに空文字列を設定。記法は※を参照。
△					◯	shared	that indicates if the task is shared as a joint task (Subscription required for user).	A boolean (0 or 1) 。読み取り専用
-					×	sharedowner	The user id of the person who owns the task that is being shared with the current user. If the current user is not the owner, then they cannot make changes to the collaboration settings for this task, although they can make other changes.	読み取り専用
-					×	sharedwith	An array of user ids for people that this task is shared with, other than myself and the owner. Read only.
△		◯			◯	star	スターの有無	0:スターあり 1:スターなし
◯						start	スキップするタスク数。複数ページで表示する場合などに使用	デフォルト値は0
△		◯			◯	startdate	タスクの開始（日）	A GMT unix timestamp
△		◯			◯	starttime	for when the task starts.	UNIX時間。
△		◯			◯	status	タスクのステータスを表す整数値	0 = None, 1 = Next Action, 2 = Active, 3 = Planning, 4 = Delegated, 5 = Waiting, 6 = Hold, 7 = Postponed, 8 = Someday, 9 = Canceled, 10 = Reference
×					◯	subtask
△		◯			◯	tag	タグ	複数の場合はコンマで区切る。64文字まで。
△	●	◯	-	-	◯	title	タスクタイトル	文字列。255文字まで。
△					◯	timer	The value in the timer field indicates the number of seconds that have elapsed for the timer not including the current session.
×					☓	timeron	（タイマーON時）タイマースタート時間のタイムスタンプ	Total Time=timer+(now-timeron). Where "now" is a unix timestamp for the current time.
△					◯	via	A read-only field that indicates how the task was added.	読み取り専用 -0: Main website -1: Email Import, -2: Firefox Addon -3: This API, -4: Widgets (Google Gadget, etc) -5: Not used, -6: Mobile Phone -7: iPhone App, -8: Import Tools -9: Twitter

※繰り返し(repeat)を表現する文字列は、iCal RRULEフォーマットに従う。

"FREQ=DAILY"
"FREQ=WEEKLY;BYDAY=TU"

但し、Toodledoで全てのiCal RRULEが解釈されるわけではない（鋭意対応中）。ので、ToodledoのFAQを参照のこと。ユーザーがGUIや人間が理解できる文字列（英語）で記入する。iCalのルールに変換される。

There are three enhancements to the iCal RRULE format that we have made to support some advanced Toodledo features.
Subtasks can repeat based on their parent's repeat value. There is not a comparable iCal RRULE for this, so we have a custom RRULE of "PARENT" to indicate this setting.
Tasks can be set to repeat from their due-date or their completion date. There is not a way to indicate this in a standard iCAL RRULE. To indicate this, we have a custom string of ";FROMCOMP" that we append to the RRULE if the task is set to repeat from the completion date. The absence of this string means that the task repeats from the due-date.
Normally, when a task is rescheduled it moves forwards by 1 occurrence. If the user has procrastinated, the new due-date could still be in the past. Toodledo will have the option to indicate that certain repeating tasks should be rescheduled to the next future occurance of the task. If this is the case, the custom ";FASTFORWARD" string will be appended to the RRULE.

タスクの取得（Retrieve Task）

• 上記の記号
  • ◯：リスエスト時に指定できる
  • △：fieldオプションの選択値（レスポンスに含めてほしい情報）として指定できる
  • ×：使用不可

Adding Tasks

http://api.toodledo.com/3/tasks/add.php

access_token=yourtoken
tasks=[{"title":"My Task"},{"title":"Another","star":"1","ref":"98765"},{"title":"","ref":"1234"}]
fields=folder,star

• METHOD : POST
• 一度に登録できるタスクは50個まで
• "tasks/add.php" API call with an array of tasks.
• 必須パラメータ : title field
• 任意パラメータ : folder, context, goal, location, priority, status,star, duration, remind, starttime, duetime, completed, duedatemod, repeat, tag, duedate, startdate, note, parent, meta (see above for possible values).

There is also a special field called "ref" that you can use to pass through an alphanumeric id number to aid in matching things up after a sync. The "ref" field is not saved into the task, it is only echoed back to you on this call.

Tasks are added by creating a JSON object (example below) and submitting a POST to the API. Please represent newline characters as \n. Be sure to encode the data properly for transfer via a URL (symbols replaced with their %XX equivalent and spaces encoded as +). Each element in the array will be a task object. You only need to set the fields that you want to set. For efficiency, you should try to send only the fields that you are setting.

If the action was successful the added tasks will be returned in the same order in which they were added. If there were any errors on individual tasks, they will be output inline with the returned tasks, so you can determine which action failed.

You can also specify xml as the output format for any API calls by attaching "f=xml" to the URL.

http://api.toodledo.com/3/tasks/add.php

access_token=yourtoken

Editing Tasks

You can edit up to 50 tasks at a time by making a POST to the "tasks/edit.php" API call. For each task, the id field is required, and the following fields are optional: title, folder, context, goal, location, priority, status,star, duration, remind, starttime, duetime, completed, duedatemod, repeat, tag, duedate, startdate, note, parent, meta (see above for possible values).

Additionally, you can set the "reschedule" variable to "1" if you want Toodledo to automatically reschedule the repeating task for you. This will only apply if you also set the completion date, and if the task has a due-date and repeating value. If you do not set this, then you are responsible for rescheduling repeating tasks yourself, as well as properly handling any subtasks that the task may have. It is recommended that you allow Toodledo to reschedule repeating tasks for you.

Tasks are added by creating a JSON object (example below) and submitting a POST to the API. Be sure to encode the data properly for transfer via a URL (symbols replaced with their %XX equivalent and spaces encoded as +). Please represent newline characters as \n. Each element in the array will be a task object. You only need to set the fields that you want to set. For efficiency, you should try to send only the fields that have changed.

http://api.toodledo.com/3/tasks/edit.php

access_token=yourtoken
tasks=[{"id"%3A"1234"%2C"title"%3A"My Task"}%2C{"id"%3A"1235"%2C"title"%3A"Another Task"%2C"star"%3A"1"}

%2C{"id"%3A"5678"%2C"title"%3A"Invalid"}]

fields=folder,star

If the action was successful the edit tasks will be returned. If there were any errors on individual tasks, they will be output inline with the returned tasks, so you can determine which action failed.

[{"id":1234,"title":"My Task","modified":1281990824,"completed":0,"folder":0,"star":0},
{"id":1235,"title":"Another","modified":1280877483,"completed":0,"folder":0,"star":1},
{"errorCode":605,"errorDesc":"Invalid task ID","ref":"5678"}]
You can also specify xml as the output format for any API calls.

http://api.toodledo.com/3/tasks/edit.php

access_token=yourtoken
tasks=[{"id"%3A"1234"%2C"title"%3A"My Task"}%2C{"id"%3A"1235"%2C"title"%3A"Another Task"%2C"priority"%3A"2"}

%2C{"id"%3A"5678"%2C"title"%3A"Invalid"}]

fields=folder,star&f=xml

<tasks>

<task>
	<id>1234</id>
	<title>My Task</title>
	<folder>0</folder>
	<modified>1234567890</modified>
	<completed></completed>
	<star>0</star>
</task>
<task>
	<id>1235</id>
	<title>Another Task</title>
	<folder>0</folder>
	<modified>1234567890</modified>
	<completed></completed>
	<star>1</star>
</task>
<error id="605" ref="5678">Invalid task ID</error>

</tasks>

Deleting Tasks

The "/tasks/delete.php" API call will allow you to permanently delete up to 50 tasks at a time. You can access this via POST. For tasks that the user wants available in the history section, or for tasks that continue to repeat, you should not use this method. Instead, you should edit the task and mark it as completed.

Tasks are deleted by submitting a JSON encoded array of id numbers to the API.

http://api.toodledo.com/3/tasks/delete.php

access_token=yourtoken
tasks=["1234"%2C"1235"%2C"5678"]

If the action was successful the deleted tasks's id numbers will be returned. If there were any errors on individual tasks, they will be output inline with the returned tasks, so you can determine which action failed.

[{"id":1234},{"id":1235},{"errorCode":605,"errorDesc":"Invalid ID number","ref":"5678"}]
You can also specify xml as the output format for any API calls.

http://api.toodledo.com/3/tasks/delete.php

access_token=yourtoken
tasks=["1234"%2C"1235"%2C"5678"]
f=xml

<deleted>

<id>1234</id>
<id>1235</id>
Invalid ID number

</deleted>

Get Deleted Tasks
The "/tasks/deleted.php" API call will enable you to detect when a task was deleted on Toodledo, so you can also delete the task from your application. You can access this via GET or POST.

after : A GMT unix timestamp. Used to find tasks with a deletion date and time after this date and time.

http://api.toodledo.com/3/tasks/deleted.php&access_token=yourtoken&after=1234567890
This returns a list of id numbers and datetime stamps.

[{"num":24},{"id":1234,"stamp":1234567891},{"id":1235,"stamp":1234567892}]
You can also specify xml as the output format for any API calls.

http://api.toodledo.com/3/tasks/deleted.php?access_token=yourtoken&after=1234567890&f=xml

<deleted num="2">

<task>
<id>12345</id>
<stamp>1234567891</stamp>
</task>
<task>
<id>67890</id>
<stamp>1234567892</stamp>
</task>

</deleted>

Error Codes

Any of the API calls can return error messages. Here is a list of the error messages that you may receive from the tasks API endpoints. If there was an error when editing or deleting a task, the id number that you attempted to edit will be included in the error's "ref" field for your reference.

601 : Your task must have a title.
602 : Only 50 tasks can be added/edited/deleted at a time.
603 : The maximum number of tasks allowed per account (20000) has been reached
604 : Empty id
605 : Invalid task
606 : Nothing was added/edited. You'll get this error if you attempt to edit a task but don't pass any parameters to edit.
607 : Invalid folder id
608 : Invalid context id
609 : Invalid goal id
610 : Invalid location id
611 : Malformed request
612 : Invalid parent id
613 : Incorrect field parameters
614 : Parent was deleted
615 : Invalid collaborator
616 : Unable to reassign or share task

Examples:
JSON:
{"errorCode":601,"errorDesc":"Your task must have a name","ref":1234}

XML:
<error id="601" ref="1234">Your task must have a name</error>

GT	AD	ED	DN	DD	SR	フィールド	定義	フォーマット、制限
△					◯	added	タスクが追加された日。UNIX時間で表記。	タスクが追加された「時間」は記録されない。常に正午としてカウントされる。
△					◯	addedby	タスクを割り当てたユーザのId (※subscriptionユーザ限定).
◯					×	after	この時間以降に更新したタスクを探索	UNIX時間。
△					◯	attachment	添付アイテムの配列。各アイテムは３つのフィールドを含む。添付アイテムは読み取り専用。アウトラインを参照するidを使えます。リスト(list)、ノート(note)はこのAPIを通して取得可。ファイルは現在読めないが、機能追加準備中。
○	-	-	-	-	×	before	この時間以前に更新したタスクを探索	UNIX時間。
×					◯	checked	Whether the task is completed or not
△					◯	children	このタスクが持つサブタスク数	サブタスク自身や、サブタスクを持たないタスクは0
◯						comp	未完了、完了の選択。	0:未完のみ、1:完了のみ、無しor-1:両方
×		◯			◯	completed	いつタスクが完了したか	未完了の場合、0.UNIX時間。 Toodledoはタスクが完了した「時間」はトラッキングしない。そのため、タスクは正午に完了、として処理される。
△		◯			◯	context	コンテクストのID番号	コンテクスト割当なしの場合は省略（もしくは0）
△		◯			◯	duedate	タスクの期限（日）	UNIXタイムスタンプ（GMTの正午） タイムスタンプ＝1445172465 ↓ 日時（Tokyo）＝2015/10/18 21:47:45
△		◯			◯	duedatemod	期限（日）のタイプを示す整数	0 : Due By 1 : Due On (=) 2 : Due After (>) 3 : Optionally (?)
△		◯			◯	duetime	for when the task is due.	UNIX時間。設定しなければ0.duedateが設定されず、duetimeのみが設定されていると、1970年1月1日と判断。タイムゾーンにかかわらず、10amは10amと判断。You can convert this timestamp to a GMT string and display the time component without worrying about timezones.
		◯				duration
○						fields	レスポンスに付けて返してほしいフィールド	コンマ区切り。レスポンス向上のため、不用なら省略する。
△		◯			◯	folder	フォルダのID番号	フォルダ割当なしの場合は0もしくは省略。
△		◯			◯	goal	goalのID番号	goal割当なしの場合は省略（もしくは0）
△	-	●	-	-	×	id	タスクID	アカウントに対してユニークな番号（違うアカウントに対しては、同一のIDに対して異なるタスクがぶら下がる可能性あり。
△					◯	length	タスク達成までの予想時間（分、整数値）
△		◯			◯	location	場所のID番号	割当なしの場合は省略（もしくは0）
△		◯				meta	A text for storing metadata about the task. This is useful for syncing data that cannot otherwise be synced to Toodledo. Because of an implementation detail, using the meta field introduces extra latency to each API call, so you should only use this field when necessary.	1,024バイトまで。タスクごとにユニークなIDを持ち、AppIDに対してprivate。ユーザーもAppIDsも個々に入力した値は見られない。
-					◯	modified	for when the task was last modified.	UNIX時間。
△		◯				note	ノート	32,000 bytesまで。改行コードは\n
◯						num	取得するタスク数。複数ページで表示する場合などに使用	デフォルト値、最大値ともに1000
△					×	order	サブタスクの順番	読み取り専用
△					◯	parent	親タスクのID番号	デフォルト値はO
△					×	previous	If the task was repeated from another task, this will contain the id number of the previous version of this task.
△		◯			◯	priority	優先順位。整数値。	3 = Top 2 = High, 1 = Medium, 0 = Low, -1 = Negative,
△		◯			◯	remind	リマインダが送られる、タスクの期限までの時間（分）を表す整数値。	0:リマインダなし 値の制限：0, 1, 15, 30, 45, 60, 90, 120, 180, 240, 1440, 2880, 4320, 5760, 7200, 8640, 10080, 20160, 43200)。これ以外は近い値に丸め。 無料ユーザーは0か60。
△		◯			◯	repeat	どのようにタスクを繰り返すかを示す文字列	記録を残すため、リピートするタスクが完了した場合ははコピーされたタスクがリストに加えられ、完了タスクに対して、新しいID番号が付与される。繰り返しを中止するには、これに空文字列を設定。記法は※を参照。
△					◯	shared	that indicates if the task is shared as a joint task (Subscription required for user).	A boolean (0 or 1) 。読み取り専用
-					×	sharedowner	The user id of the person who owns the task that is being shared with the current user. If the current user is not the owner, then they cannot make changes to the collaboration settings for this task, although they can make other changes.	読み取り専用
-					×	sharedwith	An array of user ids for people that this task is shared with, other than myself and the owner. Read only.
△		◯			◯	star	スターの有無	0:スターあり 1:スターなし
◯						start	スキップするタスク数。複数ページで表示する場合などに使用	デフォルト値は0
△		◯			◯	startdate	タスクの開始（日）	A GMT unix timestamp
△		◯			◯	starttime	for when the task starts.	UNIX時間。
△		◯			◯	status	タスクのステータスを表す整数値	0 = None, 1 = Next Action, 2 = Active, 3 = Planning, 4 = Delegated, 5 = Waiting, 6 = Hold, 7 = Postponed, 8 = Someday, 9 = Canceled, 10 = Reference
×					◯	subtask
△		◯			◯	tag	タグ	複数の場合はコンマで区切る。64文字まで。
△	●	◯	-	-	◯	title	タスクタイトル	文字列。255文字まで。
△					◯	timer	The value in the timer field indicates the number of seconds that have elapsed for the timer not including the current session.
×					☓	timeron	（タイマーON時）タイマースタート時間のタイムスタンプ	Total Time=timer+(now-timeron). Where "now" is a unix timestamp for the current time.
△					◯	via	A read-only field that indicates how the task was added.	読み取り専用 -0: Main website -1: Email Import, -2: Firefox Addon -3: This API, -4: Widgets (Google Gadget, etc) -5: Not used, -6: Mobile Phone -7: iPhone App, -8: Import Tools -9: Twitter