This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Tasks in Zoho Books

Owned by Former user (Deleted)
Last updated: Apr 22, 2015
2 min read

Overview

The following operations allow you to work with tasks. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with tasks, see Sample configuration. 

OperationDescription

createTask

Creates a task.

getTaskRetrieves details of a task.
listTasksRetrieves a list of tasks.

Operation details

This section provides further details on the operations related to tasks.

Creating a task

The createTask operation creates a new task.

createTask
<zohobooks.createTask>
    <budgetHours>{$ctx:budgetHours}</budgetHours>
    <rate>{$ctx:rate}</rate>
    <description>{$ctx:description}</description>
    <projectId>{$ctx:projectId}</projectId>
	<taskName>{$ctx:taskName}</taskName>
</zohobooks.createTask>
Properties
  • budgetHours: The task budget hours.
  • rate: The hourly rate for a task.
  • description: Project description.
  • projectId: The project ID.
  • taskName: The name of the task.
Sample request

Following is a sample REST/JSON request that can be handled by the createTask operation.

Sample Request for createTask 
{
	"apiUrl": "https://books.zoho.com",
	"authToken": "57e6fad184585333a76eab2906ad9dd1",
	"organizationId": "48996196",
	"budgetHours":"10",
	"rate":"56",
	"description":"this is cooooool",
	"projectId":"122825000000041001",
	"taskName":"taskCC123"
}
Related Zoho Books documentation
https://www.zoho.com/books/api/v3/projects/tasks/#add-task

Retrieving details of a task

The getTask operation retrieves details of a task.

getTask 
<zohobooks.getTask>
    <taskId>{$ctx:taskId}</taskId>
	<projectId>{$ctx:projectId}</projectId>
</zohobooks.getTask>
Properties
  • taskId: The ID of the task to be retrieved.
  • projectId: The project ID to retrieve the task.
Sample request

Following is a sample REST/JSON request that can be handled by the getTask operation.

Sample Request for getTask 
{
	"apiUrl":"https://books.zoho.com",
	"authToken":"45bf59aede45cbd3e4248af901efa39a",
	"organizationId":"48848129",
	"projectId":"128419000000069011",
	"taskId":"128419000000069015"
}
Related Zoho Books documentation

https://www.zoho.com/books/api/v3/projects/tasks/#get-a-task

Retrieving a list of tasks

The listTasks operation retrieves a list of tasks.

listTasks 
<zohobooks.listTasks>
    <sortColumn>{$ctx:sortColumn}</sortColumn>
    <page>{$ctx:page}</page>
    <perPage>{$ctx:perPage}</perPage>
	<projectId>{$ctx:projectId}</projectId>
</zohobooks.listTasks>
Properties
  • sortColumn: Sort tasks. Allowed Values: task_name, billed_hours, log_time and un_billed_hours
  • page: Number of the page to be returned - Pagination value.
  • perPage: Specifies how many entries should be returned in the response.
  • projectId: The project ID to retrieve tasks.
Sample request

Following is a sample REST/JSON request that can be handled by the listTasks operation.

Sample Request for listTasks 
{
	"apiUrl":"https://books.zoho.com",
	"authToken":"45bf59aede45cbd3e4248af901efa39a",
	"organizationId":"48848129",
	"projectId":"128419000000069011",
	"sortColumn":"task_name",
	"page":"2",
	"perPage":"1"
}
Related Zoho Books documentation

https://www.zoho.com/books/api/v3/projects/tasks/#list-tasks

Sample configuration

Following is a sample proxy service that illustrates how to connect to Zoho Books with the init operation and use the createTask operation. The sample request for this proxy can be found in the createTask sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
	<proxy xmlns="http://ws.apache.org/ns/synapse" name="zohobooks_createTask" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
	 <target>
	 <inSequence>
      <property name="authToken" expression="json-eval($.authToken)"/>
      <property name="apiUrl" expression="json-eval($.apiUrl)"/>
      <property name="organizationId" expression="json-eval($.organizationId)"/>
      <property name="budgetHours" expression="json-eval($.budgetHours)"/>
      <property name="rate" expression="json-eval($.rate)"/>
      <property name="description" expression="json-eval($.description)"/>
      <property name="projectId" expression="json-eval($.projectId)"/>
      <property name="taskName" expression="json-eval($.taskName)"/>
      <zohobooks.init>
         <authToken>{$ctx:authToken}</authToken>
         <apiUrl>{$ctx:apiUrl}</apiUrl>
         <organizationId>{$ctx:organizationId}</organizationId>
      </zohobooks.init>
      <zohobooks.createTask>
         <budgetHours>{$ctx:budgetHours}</budgetHours>
         <rate>{$ctx:rate}</rate>
         <description>{$ctx:description}</description>
         <projectId>{$ctx:projectId}</projectId>
         <taskName>{$ctx:taskName}</taskName>
      </zohobooks.createTask>
	   <respond/>
	 </inSequence>
	  <outSequence>
	   <send/>
	  </outSequence>
	 </target>
   <description/>
  </proxy>