BigTime's task api provides access to all of the tasks assigned to any project in the system. Tasks cannot exist unless they are assigned to a project. The api will let you see tasks by staffer assigned as well (if assignments are filled out).

Getting a listing of Tasks by Project

try it

• BasicDetailed
• Submit

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /task/listByProject/{ProjectSid}?{showCompleted=True/False}
HTTP RESPONSE:  (array of Task objects ("basic" view -- see below for details)

By default, we return only tasks that are "in process", but you can pass ShowCompleted=True to see tasks that are archived as well.

Getting "budget status" data for a Project's Tasks

try it

• Submit

In addition to pulling a list of tasks from the system, you can also pull the current totals for time/expenses and invoice line item amounts on a per-task basis. That information is useful for budget reporting -- but it's not a part of the default view for task data.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /task/BudgetStatusByProject/{ProjectSid}
HTTP RESPONSE:  (array of TaskBudgetStatus objects (see below for details)

Getting a listing of Tasks by Staffer

try it

• BasicDetailed
• Submit

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /task/ListByStaffer/{StaffSid}?{showCompleted=True/False}
HTTP RESPONSE:  (array of Task objects ("basic" view -- see below for details)

By default, we return only tasks that are "in process", but you can pass ShowCompleted=True to see tasks that are archived as well.

Pulling the detail for a specific task.

try it

• BasicDetailed
• Get

You can use a simple GET request to pull the details associated with a single task. Note that the DETAIL view fields will be returned by default. You should also note that a user cannot pull data for an entity they are not permitted to view in the BigTime program. This can often become a problem when back-end services are using the api without system-wide permissions.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /task/detail/{TaskSid}?&View={Detailed/Basic}
HTTP RESPONSE:  (Task object -- see below for details)

Creating a NEW task.

try it

• {TaskSid: 0, ProjectSid:0, Tasknm:"Test New Task"}
• Post

Note that only the fields listed in the AddUpdate view (below) should be included in your post to this url. Any other data will be ignored. BigTime doesn't care about the order in which field data is posted, and none of the fields are case sensitive. Note that any validation errors will return a 400 error, and an invalid permission will return a 405 (eg - attempting to create a task withing a project you don't have rights to access).

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP Post:  /task/detail
POST CONTENT:  {TaskSid: 0, ProjectSid:0, Tasknm:"Test New Task"}
You can include ANY of the AddUpdate fields below, 
	but you MUST include the required (*) fields.

HTTP RESPONSE:  (new Task object -- see below for details)

Updating Existing Tasks.

try it

• Submit

Note that only the fields listed in the AddUpdate and Update views (below) should be included in your post to this url. Any other data will be ignored. Note again, validation errors will return a 400 error, and an invalid permission will return a 405 (eg - attempting to update tasks you don't have rights to access).

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP Post:  /task/detail/{taskSid}
POST CONTENT:  {TaskSid: 123, 
		notes: "this is an updated note..."}
		
** You can include ANY of the AddUpdate/Update fields below.  
		However - you cannot "zero-out" or remove any of the 
		required (*) fields.

HTTP RESPONSE:  (updated Task object -- see below for details)

Deleting a Task.

try it

• delete

As long as there is no time/expense data logged against a task, BigTime will allow you to delete it through the api.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP DELETE:  /task/detail/{sid}
HTTP RESPONSE:  200 is a successful delete.

Task: Field Details

For each of the operations listed above, you will post or "get" one or more task objects. The list below is a complete catalog of fields available through the api (including the views within which those fields are found). Take special note of the AddUpdate views. Required fields are flagged with an "*" character.

Task: Budget Data