Tasks

Tasks API

Scope: ZohoProjects.tasks.{Operation}

Operations: READ, CREATE, UPDATE, DELETE, ALL

Use the ALL operation to gain the scope for all the other operations like READ, CREATE, UPDATE, and DELETE at once.

All Tasks
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/
Tasks for a Tasklist
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasklists/[TASKLISTID]/tasks/
Task Details
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/
Create Task
POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/
Update Task
POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/
Reorder Task
POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/reorder
Delete Task
DELETE /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/
Create Subtask
POST /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/subtasks/
Get My Tasks
GET /portal/[PORTALID]/mytasks/
Get Subtasks
GET /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/subtasks/
Get Comments
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/
Add Comment
POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/
Update Comment
POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/[COMMENTID]/
Delete Comment
DELETE /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/[COMMENTID]/
Get Task Attachments
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/attachments/
Delete Task Attachments
DELETE  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/attachments/[ATTACHMENTID]/
Get All Task Layouts
GET  /portal/[PORTALID]/tasklayouts/
Get Task Layout Details
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasklayouts/
Get Task Custom Views
GET  /portal/[PORTALID]/projects/[PROJECTID]/tasklayouts/

 All Tasks

Gets all the tasks in the given project. It fetches only the main tasks and not the subtasks.

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/

Scope: ZohoProjects.tasks.READ

Request Parameters

indexintIndex number of the task.
rangeint

Range of the tasks.

ownerString or Long

Owner of the task must be provided as all or user ID.

(all - String, user ID - Long)

statusStringStatus of the task must be all or completed or notcompleted.
timeStringTime period of the task must be all or overdue or today or tomorrow.
priorityStringPriority of the task must be all or none or low or medium or high.
tasklist_idLongID of the tasklist.
custom_statusLongThe ID of the custom task status. Example : 932200000000277068.
sort_columnStringSort tasks using the last modified time or time of creation. (created_time / last_modified_time)
sort_orderStringSort in ascending or descending order.
last_modified_timeLongLast updated time of task in milliseconds.
milestone_idLongID of the milestone.
created_byString or LongPass the value as all or the user ID (all - String, user ID - Long).
custom_fieldsJSON ObjectValue of the custom field. Example: {"UDF_CHAR1":"Hello"}
view_idLongView ID of the Task. view_id is obtained from the Get Task Custom Views API.

Example of viewing a task with custom fields

Since custom field <display_name> is not unique, custom fields are referred by their respective < column_name>. The same custom field <display_name> will be referred with different < column_name>. The params that you need to pass for the task custom fields is the value in <column_name> in Get Task Layout Details API. 

You must first get all the custom fields, and then pass the <column_name> value of the custom field as a param to create a task with the custom fields.

Example: {“UDF_CHAR1”:”Hello”}

UDF_CHAR1 is the param that you need to pass while creating tasks.

Hello is the value of the custom field. 

Here is a sample response of a custom field:

{
"section_name": "New Section",
"customfield_details": [{
"column_name": "UDF_CHAR1",
"is_mandatory": false,
"is_default": false",
"display_name": "My_Field",
"column_type": "singleline" }]
}

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
  "tasks": [
    {
      "end_date": "05-09-2018",
      "milestone_id": "170876000004922038",
      "link": {
        "timesheet": {
          "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/170876000004921003/tasks/170876000004922138/logs/"
        },
        "self": {
          "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/170876000004921003/tasks/170876000004922138/"
        }
      },
      "description": "",
      "start_date_long": 1524251880000,
      "end_date_long": 1525893480000,
      "end_date_format": "05-09-2018 12:18:00 PM",
      "duration": "13",
      "last_updated_time_long": 1511331772071,
      "details": {
        "owners": [
          {
            "name": "Eduardo Vargas",
            "id": "2060557"
          },
          {
            "name": "Lin Brenn",
            "id": "639281665"
          }
        ]
      },
      "id": 170876000004922140,
      "key": "X9-T8",
      "start_date": "04-20-2018",
      "created_person": "Helen Collins",
      "created_time_long": 1511331772071,
      "created_time": "11-21-2017",
      "is_reminder_set": false,
      "is_recurrence_set": false,
      "created_time_format": "11-21-2017 10:22:52 PM",
      "subtasks": false,
      "dependency": {},
      "work": "208:00",
      "isparent": false,
      "start_date_format": "04-20-2018 12:18:00 PM",
      "work_type": "work_hrs_per_day",
      "completed": false,
      "priority": "None",
      "created_by": "639283127",
      "percent_complete": "0",
      "last_updated_time": "11-21-2017",
      "name": "Roofing paper installed",
      "id_string": "170876000004922138",
      "last_updated_time_format": "11-21-2017 10:22:52 PM",
      "tasklist": {
        "name": "Roofing- All tasks",
        "id": "170876000004922094"
      },
      "order_sequence": 1,
      "status": {
        "name": "Open",
        "id": "170876000004668068",
        "type": "open",
        "color_code": "#568dd5"
      }
   }
]}

Note:

  • The task custom field feature is available only in the Enterprise plan.

 Tasks for a Tasklist

Gets all the tasks in the given tasklist .

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasklists/[TASKLISTID]/tasks/

Scope: ZohoProjects.tasks.READ

Request Parameters

indexintIndex number of the task.
rangeintRange of the tasks.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "tasks": [{
        "id": 170876000001217298,
        "name": "Fix review comments by SME",
        "completed": true,
        "created_by": "2060758",
        "created_person": "Patricia Boyle",
        "priority": "None",
        "percent_complete": 100,
        "start_date": "09-30-2013 12:00 PM",
        "start_date_long": 1380551400000,
        "end_date": "10-04-2013 09:00 PM",
        "end_date_long": 1380929400000,
        "duration": "49",
        "details": {
            "owners": [{
                "name": "Unassigned"
            }]
        },
        "link": {
            "self": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000000147021/tasks/170876000001217298/"
            },
            "timesheet": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000000147021/tasks/170876000001217298/logs/"
            }
        }
    }]
}

 Task Details

Gets all the details for the task.

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/

Scope: ZohoProjects.tasks.READ

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
  "tasks": [
    {
      "milestone_id": "170876000004154071",
      "link": {
        "timesheet": {
          "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/170876000004921003/tasks/170876000004685009/logs/"
        },
        "self": {
          "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/170876000004921003/tasks/170876000004685009/"
        },
        "subtask": {
          "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/170876000004921003/tasks/170876000004685009/subtasks/"
        }
      },
      "last_updated_time_long": 1518530491135,
      "details": {
        "owners": [
          {
            "name": "Patricia Boyle",
            "id": "2060758"
          },
          {
            "work": "40:00",
            "name": "Helen Collins",
            "id": "639283127"
          }
        ]
      },
      "id": 170876000004685020,
      "key": "X9-T158",
      "created_person": "Helen Collins",
      "created_time_long": 1499061211693,
      "created_time": "07-02-2017",
      "is_reminder_set": false,
      "is_recurrence_set": false,
      "created_time_format": "07-02-2017 10:53:31 PM",
      "subtasks": true,
      "work": "40:00",
      "isparent": true,
      "work_type": "work_hours",
      "completed": false,
      "priority": "None",
      "created_by": "639283127",
      "percent_complete": "10",
      "last_updated_time": "02-13-2018",
      "name": "Roof trusses construction",
      "id_string": "170876000004685009",
      "last_updated_time_format": "02-13-2018 06:01:31 AM",
      "tasklist": {
        "name": "Finish coat",
        "id": "170876000004154537"
      },
      "order_sequence": 1,
      "status": {
        "name": "In Progress",
        "id": "170876000004771005",
        "type": "open",
        "color_code": "#878b8e"
      }
    }
  ]
}

 Create Task

POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/

Scope: ZohoProjects.tasks.CREATE

If you are uploading files in the task, you must additionally use this Scope: ZohoPC.files.CREATE

Request Parameters

person_responsibleLongOwner ID of the task. User ID for multiple owners must be separated by commas.
tasklist_idLongID of the tasklist.
name*StringName of the task.
start_dateString [MM-DD-YYYY]Start date of the task.
end_dateString [MM-DD-YYYY]End date of the task.
duration intDuration of the task.
duration_typeStringDuration of the task type in days or hrs.
priority (None or Low or Medium or High)StringPriority of the task must be None or Low or Medium or High.
descriptionStringDescription for the task.
uploaddocFileAdd file to a task.
start_timeStringStart time can be specified in either 12 hour or 24 hour format. Eg. 01:00 pm or 13:00
end_timeStringEnd time can be specified in either 12 hour or 24 hour format. Eg. 09:00 pm or 21:00
owner_workJSON Arrayuser_id and working_hours must be given in the array to assign work hours to task owners. [{"user_id":"xxxxxx","working_hours":"2"}]
work_typeStringAllocate work_hrs_per_day or work_in_percentage or work_hours.
custom_fieldsJSON ObjectValue of the custom field. Example: {“UDF_CHAR1”:”Hello”}
completed_onString [MM-DD-YYYY]Completed date of the task.
reminderStringTask reminder can be specified as On Same Day or daily or values between 1 to 30 (based on number of days). 
json_stringJSON Object

If you set a task as recurring task, it will automatically get recreated after the specified time period. Specify the recurring criteria values in the json_string. Separate multiple values using comma. 

Ex: { "recurrence" : { "recurring_frequency" : "daily", "time_span" : "15", "number_of_occurrences" : "30" } 

  • Set recurring_frequency value(String) as dailyweekly / monthly / yearly.
  • Set time_span value(int) based on which the task will recur again.
  • Set number_of_occurrences value(int) to mention how many times the task should recur. 

Example of creating a task with custom fields.

Sample Response

Status: 201 Created

Content Type: application/json;charset=utf-8
{
"tasks": [
{
"id": 170876000001849020,
"name": "Fix QA comments",
"completed": false,
"created_by": "2060758",
"created_person": "Patricia Boyle",
"priority": "None",
"percent_complete": 0,
"custom_fields": [{
            "column_name": "UDF_DATE1",
            "label_name": "My_date",
            "value": "11-11-2017 12:00:00 AM"
            }],
"recurrence": {
        "number_of_times": "30",
        "timespan": "15",
        "recurrence_frequency": "daily"
      },
"order_sequence": 11,
"details": {
"owners": [
{
"name": "Unassigned"
}
]
},
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/ 170876000000147021/tasks/170876000001849039/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/ 170876000000147021/tasks/170876000001849039/logs/"
}
},
"status": {
            "name": "Open",
            "id": "4000000000335",
            "type": "open",
            "color_code": "#eb5768"
            }
}
]
}

 Update Task

Updates the task in the given project

POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/

Scope: ZohoProjects.tasks.UPDATE

If you are uploading files in the task, you must additionally use this Scope: ZohoPC.files.CREATE

Request Parameters

person_responsibleLongOwner ID of the task. User ID for multiple owners must be separated by commas.
nameStringName of the task.
start_dateString [MM-DD-YYYY]Start date of the task.
end_dateString [MM-DD-YYYY]End date of the task. You must also provide the start_date value to update end_date. 
percent_completeintTask completed percentage must be provided in multiple of 10's. [10 to 100]
durationintDuration of the task.
duration_typeStringDuration of the task type in days or hrs.
priority (None or Low or Medium or High) StringPriority of the task must be None or Low or Medium or High.
descriptionStringDescription for the task.
start_timeStringStart time can be specified in either 12 hour or 24 hour format. Eg. 01:00 pm or 13:00
end_timeStringEnd time can be specified in either 12 hour or 24 hour format. Eg. 01:00 pm or 13:00
owner_workJSON Arrayuser_id and working_hours must be given in the array to assign work hours to task owners.
work_typeStringAllocate work_hrs_per_day or work_in_percentage or work_hours.
task_duration_as_workStringAllocates entire task duration as work hours for the task owners if value is true
uploaddocFileAdd a file to the task.
custom_fieldsJSON ObjectValue of the custom field. Example : {"UDF_CHAR1":"Hello"}
custom_statusLongThe ID of the custom task status. Example : 932200000000277068
clear_dateBooleanClears the start date and end date of the task. (true / false)
make_as_taskBooleanMake a sub_task as task. (true / false)
json_stringJSON Object

If you set a task as recurring task, it will automatically get recreated after the specified time period. Specify the recurring criteria values in the json_string. Separate multiple values using comma. 

Ex: { "recurrence" : { "recurring_frequency" : "daily", "time_span" : "15", "number_of_occurrences" : "30" } 

  • Set recurring_frequency value(String) as dailyweekly / monthly / yearly.
  • Set time_span value(int) based on which the task will recur again.
  • Set number_of_occurrences value(int) to mention how many times the task should recur. 

Example of updating task with custom fields.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
"tasks": [
{
"id": 170876000001849020,
"name": "Fix QA comments",
"completed": false,
"created_by": "2060758",
"created_person": "Patricia Boyle",
"priority": "None",
"percent_complete": 0,
"custom_fields": [{
            "column_name": "UDF_DATE1",
            "label_name": "My_date",
            "value": "11-11-2017 12:00:00 AM"
            }],
"recurrence": {
        "number_of_times": "30",
        "timespan": "15",
        "recurrence_frequency": "daily"
      },
"order_sequence": 11,
"details": {
"owners": [
{
"name": "Unassigned"
}
]
},
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/ 170876000000147021/tasks/170876000001849039/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/ 170876000000147021/tasks/170876000001849039/logs/"
}
},
"status": {
            "name": "Open",
            "id": "4000000000335",
            "type": "open",
            "color_code": "#eb5768"
            }
}
]
}

 Reorder Task

Reorders the tasks in the given project

POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/reorder

Scope: ZohoProjects.tasks.UPDATE

Request Parameters

json_stringjson object

Task will be reordered in-between two tasks based on the previous and next task IDs. Specify the previous_task_id and next_task_id values(Long) in json_string. Separate the values using comma.

Ex. { "task_order" : { "previous_task_id" : 4000000021037, "next_task_id" : 4000000029097 } }

If there is no previous task, you can specify only the next_task_id. The task will be reordered above the task with the next_task_id. 

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
  "message": "Tasks reordered..."
}

 Delete Task

Deletes the tasks in the given project.

DELETE /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/

Scope: ZohoProjects.tasks.DELETE

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "response": "Task Deleted Successfully"
}

 Create Subtask

POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/subtasks/

Scope: ZohoProjects.tasks.CREATE

Request Parameters

person_responsibleLongOwner ID of the task. User ID for multiple owners must be separated by commas.
name*StringName of the task.
start_dateString [MM-DD-YYYY]Start date of the task.
end_dateString [MM-DD-YYYY]End date of the task.
durationintDuration of the task.
duration_typeStringDuration of the task type in days or hrs.
priority (None or Low or Medium or High)StringPriority of the task must be None or Low or Medium or High.
descriptionStringDescription for the task.
custom_fieldsJSON ObjectValue of the custom field. Example: {“UDF_CHAR1”:”Hello”}

Example of creating a subtask with custom fields.

Sample Response

Status: 201 Created

Content Type: application/json;charset=utf-8
{
  "tasks": [{
  "created_by": "2060758",
  "created_time_long": 1451974141000,
  "subtasks": false,
  "link": {
  "self": {
  "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/
   170876000001865067/tasks/170876000002969005/"
  },
  "timesheet": {
  "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/
   170876000001865067/tasks/170876000002969005/logs/"
  }
  },
  "depth": 1,
  "last_updated_time_format": "01-04-2016 10:09:01 PM",
  "last_updated_time_long": 1451974141000,
  "id": 170876000002969005,
  "percent_complete": "0",
  "created_person": "Patricia Boyle",
  "last_updated_time": "01-04-2016",
  "details": {
  "owners": [{
  "name": "Unassigned"
  }]
  },
  "id_string": "170876000002969005",
  "priority": "None",
  "name": "Blog Image",
  "created_time_format": "01-04-2016 10:09:01 PM",
  "created_time": "01-04-2016",
  "completed": false
  }]
}

Note:

  • The task custom field feature is available only in the Enterprise plan.

Get My Tasks

Gets all your tasks in the portal.

GET  /portal/[PORTALID]/mytasks/

Scope: ZohoProjects.tasks.READ

Request Parameters

indexintIndex number of the task.
rangeint

Range of the tasks.

ownerString or Long

Owner of the task must be provided as all or user ID.

(all - String, user ID - Long)

statusStringStatus of the task must be all or open or closed.
timeStringTime period of the task must be all or overdue or today or tomorrow.
priorityStringPriority of the task must be low or medium or high or none.
sort_columnStringSort tasks using the last modified time or time of creation. (created_time / last_modified_time)
sort_orderStringSort in ascending or descending order.
last_modified_timeLongLast updated time of task in milliseconds.
created_byString or LongPass the value as all or the user ID (all - String, user ID - Long).
owner_emailStringEmail ID of the owner.
reverse_orderBooleanPass the value as true or false.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
Public
 {
  "tasks": [
    {
      "milestone_id": "170876000004154071",
      "project": {
        "name": "Donnelly Apartments Construction",
        "id": 170876000004154020
      },
      "last_updated_time_long": 1518530491135,
      "details": {
        "owners": [
          {
            "name": "Patricia Boyle",
            "id": "2060758"
          },
          {
            "work": "40:00",
            "name": "Helen Collins",
            "id": "639283127"
          }
        ]
      },
      "id": 170876000004685020,
      "key": "DC-T158",
      "created_person": "Helen Collins",
      "created_time_long": 1499061211693,
      "created_time": "07-02-2017",
      "is_reminder_set": false,
      "is_recurrence_set": false,
      "created_time_format": "07-02-2017 10:53:31 PM",
      "subtasks": true,
      "work": "40:00",
      "custom_fields": [],
      "isparent": true,
      "work_type": "work_hours",
      "completed": false,
      "priority": "None",
      "created_by": "639283127",
      "percent_complete": "10",
      "last_updated_time": "02-13-2018",
      "name": "Roof trusses construction",
      "id_string": "170876000004685009",
      "tasklist": {
        "name": "Finish coat",
        "id": 170876000004154530
      },
      "last_updated_time_format": "02-13-2018 06:01:31 AM",
      "order_sequence": 1,
      "status": {
        "name": "In Progress",
        "id": "170876000004771005",
        "type": "open",
        "color_code": "#878b8e"
      }
    },
    {
      "milestone_id": "170876000004521019",
      "project": {
        "name": "Pet Drive",
        "id": 170876000004521000
      },
      "last_updated_time_long": 1507111847000,
      "details": {
        "owners": [
          {
            "name": "Helen Collins",
            "id": "639283127"
          }
        ]
      },
      "id": 170876000004850020,
      "key": "KH-T17",
      "created_person": "Patricia Boyle",
      "created_time_long": 1507110576936,
      "created_time": "10-04-2017",
      "is_reminder_set": false,
      "is_recurrence_set": false,
      "created_time_format": "10-04-2017 02:49:36 AM",
      "subtasks": false,
      "work": "200:00",
      "custom_fields": [],
      "isparent": false,
      "parenttask_id": "170876000004521105",
      "work_type": "work_hrs_per_day",
      "completed": false,
      "priority": "None",
      "created_by": "2060758",
      "percent_complete": "0",
      "depth": 1,
      "last_updated_time": "10-04-2017",
      "name": "test",
      "id_string": "170876000004850031",
      "tasklist": {
        "name": "Place and venue",
        "id": 170876000004521020
      },
      "last_updated_time_format": "10-04-2017 03:10:47 AM",
      "order_sequence": 4,
      "status": {
        "name": "Open",
        "id": "170876000004668068",
        "type": "open",
        "color_code": "#568dd5"
      }
]}

 Get Subtasks

Get all the subtasks of the given task.

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/subtasks/

Scope: ZohoProjects.tasks.READ

Request Parameters

indexintIndex number of the subtask.
rangeintRange of the subtasks.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "tasks": [{
        "created_by": "2060758",
        "subtasks": false,
        "start_date_long": 1408365000000,
        "link": {
            "self": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000001865067/tasks/170876000001868770/"
            },
            "timesheet": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000001865067/tasks/170876000001868770/logs/"
            }
        },
        "tasklist": {
            "id": 170876000001868599,
            "name": "ERP Phase III"
        },
        "depth": 1,
        "end_date_format": "08-19-2014 06:30 AM",
        "id": 170876000001868770,
        "percent_complete": "60",
        "duration": "2",
        "created_person": "Boyle Patricia",
        "end_date": "08-19-2014",
        "details": {
            "owners": [{
                "id": "2060556",
                "name": "Hiyoshi Nakano"
            }, {
                "id": "2060755",
                "name": "Manish Patel"
            }]
        },
        "priority": "None",
        "name": "Work on Finance Budget for this month",
        "end_date_long": 1408483800000,
        "start_date_format": "08-17-2014 09:30 PM",
        "start_date": "08-17-2014",
        "completed": false
    }]
}

 Get Comments

Get all the task comments. 

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/

Scope: ZohoProjects.tasks.READ

Request Parameters

indexintIndex number of the task comment.
rangeintRange of the task comments.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "comments": [{
        "content": "Projects",
        "id": 57000001124005,
        "created_time_long": 1408625664048,
        "added_by": "2060758",
        "added_person": "Boyle Patricia",
        "created_time_format": "08-20-2014 09:54 PM",
        "created_time": "08-20-2014"
    }, {
        "content": "Check with Sales team",
        "id": 57000001153001,
        "created_time_long": 1411755818829,
        "added_by": "2060758",
        "added_person": "Boyle Patricia",
        "created_time_format": "09-26-2014 03:23 AM",
        "created_time": "09-26-2014"
    }]
}

 Add Comment

Adds a task comment.

POST  /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/

Scope: ZohoProjects.tasks.CREATE

If you are uploading files in the task comment, you must additionally use this Scope: ZohoPC.files.CREATE

Request Parameters

content*StringComment for the task.
uploaddocFileAdd file in the task comment.

Sample Response

Status: 201 Created

Content Type: application/json;charset=utf-8
{
    "comments": [{
        "content": "Setup Demo Video",
        "id": 57000001149011,
        "created_time_long": 1411756962722,
        "added_by": "2060758",
        "added_person": "Boyle Patricia",
        "created_time_format": "09-26-2014 03:42 AM",
        "created_time": "09-26-2014"
    }]
}

 Update Comment

Updates the description of task comment.

GET  POST /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/[COMMENTID]/

Scope: ZohoProjects.tasks.UPDATE

Request Parameters

content*StringComment for the task.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "comments": [{
        "content": "Setup Demo Video",
        "id": 57000001149011,
        "created_time_long": 1411756962722,
        "added_by": "2060758",
        "added_person": "Boyle Patricia",
        "created_time_format": "09-26-2014 03:42 AM",
        "created_time": "09-26-2014"
    }]
}

 Delete Comment

Deletes the task comment.

DELETE /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/comments/[COMMENTID]/

Scope: ZohoProjects.tasks.DELETE

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "response": "Comment Deleted Successfully"
}

 Get Task Attachments

Retrieve details of attachments associated to the task.

GET /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/attachments/

Scope: ZohoProjects.tasks.READ

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
[{
    "CONTENT_TYPE": "pdf",
    "AUTHOR_ID": "565296969",
    "THUMBNAIL_URL": "https://download.zoho.com/paramdownloadservlet?x-service=EX&x-encoding=gzip&x-mode=2&x-resource_id=033zqca7d98669ef541348a5d2ded5d44ff3d&event-id=033zqca7d98669ef541348a5d2ded5d44ff3d_350x262&x-w=350&x-h=262",
    "FILENAME": "mybook.pdf",
    "UPLOADED_TIME": 1476939840136,
    "DOWNLOAD_URL": "https://download.zoho.com/paramdownloadservlet?x-service=EX&event-id=033zqca7d98669ef541348a5d2ded5d44ff3d_1476939885220&x-encoding=gzip&x-resource_id=033zqca7d98669ef541348a5d2ded5d44ff3d",
    "RESOURCE_ID": "033zqca7d98669ef541348a5d2ded5d44ff3d",
    "OWNER": "Boyle Patricia"
}]

 Delete Task Attachments

Delete attachments associated with the task.

DELETE /portal/[PORTALID]/projects/[PROJECTID]/tasks/[TASKID]/attachments/[ATTACHMENTID]/

Scope: ZohoProjects.tasks.DELETE

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
     "response": "Task Document Deleted Successfully"
}

Get All Task Layouts

View the list of all the task layouts available in your portal.

GET  /portal/[PORTALID]/tasklayouts

Scope: ZohoProjects.projects.READ

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "layouts": [{
        "layout_name": "CustomizedLayout",
        "layout_id": "932200000000304001",
        "is_default": false
    }, {
        "layout_name": "Standard Layout",
        "layout_id": "932200000000277011",
        "is_default": true
    }]
}
    }]
}

Get Task Layout Details

Fetch the details of a task layout as necessary.

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasklayouts

Scope: ZohoProjects.projects.READ

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "layout_id": "932200000000304001",
    "section_details": [{
        "section_name": "Task Information",
        "customfield_details": [{
            "column_name": "LOGINNAME",
            "is_mandatory": false,
            "is_default": true,
            "display_name": "Owner",
            "column_type": "userpicklist"
        }, {
            "column_name": "CUSTOM_STATUSID",
            "is_mandatory": false,
            "is_default": true,
            "display_name": "Status",
            "column_type": "picklist"
        }, {
            "column_name": "PRIORITY",
            "is_mandatory": false,
            "is_default": true,
            "display_name": "Priority",
            "column_type": "picklist"
        }, {
            "column_name": "PERCENTCOMPLETE",
            "is_mandatory": false,
            "is_default": true,
            "display_name": "Percentcomplete",
            "column_type": "singleline"
        }],
        "is_default": false
    }, {
        "section_name": "New Section",
        "customfield_details": [{
            "column_name": "UDF_CHAR1",
            "is_mandatory": false,
            "is_default": false,
            "display_name": "My_Field",
            "column_type": "singleline"
        }, {
            "column_name": "UDF_DATE1",
            "is_mandatory": false,
            "is_default": false,
            "display_name": "My_Date",
            "column_type": "date"
        }],
        "is_default": false
    }],
    "status_details": [{
        "is_start": true,
        "color": "#eb5768",
        "name": "Open",
        "id": "932200000000277068",
        "is_default": true,
        "type": "open"
    }, {
        "is_start": false,
        "color": "#8eb15a",
        "name": "Closed",
        "id": "932200000000277071",
        "is_default": true,
        "type": "closed"
    }, {
        "is_start": false,
        "color": "#935b1a",
        "name": "To be Tested",
        "id": "932200000000345019",
        "is_default": false,
        "type": "open"
    }]
}
    }]
}

Get Task Custom Views

Gets all the task custom views.

GET  /portal/[PORTALID]/projects/[PROJECTID]/tasks/views

Scope: ZohoProjects.tasks.READ

Request Parameters

indexintIndex number of the task view.
rangeintRange of the task view.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
  "views": [
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "All Tasks",
      "id": "0",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "All Open",
      "id": "6",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "All Closed",
      "id": "7",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "All Overdue & Open",
      "id": "38",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "Not Assigned",
      "id": "21",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "Unscheduled Tasks",
      "id": "10",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "My Open",
      "id": "19",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "My Closed",
      "id": "20",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "My Overdue & Open",
      "id": "37",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "Today Tasks",
      "id": "23",
      "is_default": true
    },
    {
      "edit_permission": false,
      "is_favorite": false,
      "name": "Tasks I Follow",
      "id": "25",
      "is_default": true
    }
  ]
}

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohoprojects.com