API Guide > Convenience Methods > Updating Estimates and Tracking Time
|
Developer Forum - Ask the LiquidPlanner development team questions. Note that the LP iPhone app uses this same API. |
|
API Sample Code – See the API in action then give it a try. |
Enter a search term or try the Dev Forums for more answers.
LiquidPlanner uses a RESTful web service API. You can download the API Guide (PDF) for offline reference. Most actions that you can perform within the application can be automated using the API -- for example, you can create a task, comment on the task, track time against it, and then mark it done.
NEED HELP? Please post API questions in the API forums
You can update your estimate, track hours worked, and add a comment with a single POST using the track_time method on tasks.
The following request tracks four hours of work on the task, and sets the remaining estimate to a low of 1.5 days and a high of 3 days.
% curl https://app.liquidplanner.com/api/workspaces/:id/tasks/:id/track_time \
-d '{ work: 4, low: "1.5d", high: "3d" }'Parameters include:
- member_id
- id of the member to track work against and comment as; optional, defaults to you (the current user), and limited to full or restricted workspace members (not portal guests or virtual members)
- work
- hours worked; optional
- activity_id
- id of the activity for the work; required if you are using timesheets and provide a value for work
- low
- low estimate for remaining work, hours (or a string such as “4h”, “0.5d”); usually optional, must be provided if you provide high, and omitted or set to ‘0’ when setting is_done
- high
- high estimate for remaining work, hours (or a string such as “4h”, “0.5d”); usually optional, must be provided if you provide low, and omitted or set to ‘0’ when setting is_done
- is_done
- if true, marks task as done; low and high must each be omitted or explicitly zero
- done_on
- datetime on which the task was done; valid only when is_done=true, defaults to now
- work_performed_on
- datetime on which the work was performed, default now
- comment
- comment to add to the task, optional
