API Guide > RESTful Resources > The Resource Parameter
|
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
When creating or updating a resource, the API requires a request parameter with the same name as the resource (in the singular form), whose value is a hash of the resource’s attributes.
Putting together the HTTP methods, resource nesting, and the resource parameter, we have the following:
| If you want to… | Then you should… | To… | With a parameter… |
|---|---|---|---|
| create a task | POST | /api/workspaces/:workspace_id/tasks | task = …hash… |
| create a comment on a task | POST | /api/workspaces/:workspace_id/tasks/:task_id/comments | comment = …hash… |
| update a folder | PUT | /api/workspaces/:workspace_id/folders/:folder_id | folder = …hash… |
