Skip to content

Task

A task is an activity or piece of work which you have to do, usually as part of a larger request/change/project/milestone/problem/release or general.

Attributes

id (long)
Unique Identifier to identify the task

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

title (string)
Title of the task

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

scheduled_start_time (datetime)
Date and time at which the task is scheduled to start

scheduled_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish

scheduled_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_start_time (datetime)
Date and time at which the task has actually started

actual_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_end_time (datetime)
Date and time at which the task actually got finished

actual_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

More Attributes Expand all

email_before (long)

Indicates when to send an notification before schedule start in ms.

email_before (long)
The allowed values  are 0 , 900000 , 1800000 , 2700000 , 3600000 , 7200000 , 21600000 , 43200000 , 86400000 , 172800000 , 604800000

Example 

234759602834500

percentage_completion (int)

Indicates the progress of the task in percentage of completion

percentage_completion (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

additional_cost (double)

Cost spent other than the actual cost of the task

additional_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_effort_days (long)

Estimated number of days to finish the task

estimated_effort_days (long)
Numerical digits which are considered to have larger values.

Example 

2347

estimated_effort_hours (long)

Estimated number of hours to finish the task

estimated_effort_hours (long)
Numerical digits which are considered to have larger values.

Example 

239

estimated_effort_minutes (long)

Estimated number of minutes to finish the task

estimated_effort_minutes (long)
Numerical digits which are considered to have larger values.

Example 

457

description (html)

Contains description about the task

description (html)
HTML is a text area where html elements can be used.

Example 

<b>The content to be displayed</b>

status (status)

Indicates the level of progress of the task

status (status)
Indicates the level of progress of the task

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority

Example 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

attachments (attachment)

Files that are attached to the task. Maximum of 10 files can be attached to a task

attachments (attachment)
Files that are attached to the task. A maximum of only 50 attachments can be added

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

group (group)

The group associated to the task

group (group)

marked_group (group)

The group to be assigned when the task is triggered

marked_group (group)

owner (user)

The User assigned to the task

owner (user)
The User to whom the task is assigned

Example 

{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

marked_technician (user)

The user to be assigned when the task is triggered

marked_technician (user)
The user to be assigned when the task is triggered

Example 

{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Indicates the type of the task

Example 

{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

created_by (user)read only

Name and Id of the user who created the task is present in JSON format

created_by (user)
Indicates the Technician who created the task is present in JSON format

Example 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

associated_entity (string)read only

Entity associated to the task

associated_entity (string)
Associated_entity has regex “request | problem | change | project | milestone | request_template | project_template | milestone_template | release | change_template | release_template”

Example 

Sample Content

module (string)read only

The module to which the task belongs to

module (string)
Module has regex “General | Project | Milestone | Request | Change | Problem | Release | RequestTemplate | ProjectTemplate |  milestoneTemplate | ChangeTemplate | ReleaseTemplate”

Example 

Sample Content

created_date (datetime)read only

Date and time at which the task is created

created_date (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

estimated_effort (long)read only

The estimated effort needed to finish the task

estimated_effort (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

deleted (boolean)read only

Indicates whether the task is deleted or not

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

overdue (boolean)read only

Indicates whether the task is overdue or not

overdue (boolean)
Boolean value which can have two possible values. The values are true and false.

Add Task

This operation helps you to add tasks.

Mandatory Fields :- title

Url

<service domain|custom domain>/app/<portal>/api/v3/tasks

Attributes

id (long)
Unique Identifier to identify the task

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

title (string)
Title of the task

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

scheduled_start_time (datetime)
Date and time at which the task is scheduled to start

scheduled_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish

scheduled_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_start_time (datetime)
Date and time at which the task has actually started

actual_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_end_time (datetime)
Date and time at which the task actually got finished

actual_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

More Attributes Expand all

email_before (long)

Indicates when to send an notification before schedule start in ms.

email_before (long)
The allowed values  are 0 , 900000 , 1800000 , 2700000 , 3600000 , 7200000 , 21600000 , 43200000 , 86400000 , 172800000 , 604800000

Example 

234759602834500

percentage_completion (int)

Indicates the progress of the task in percentage of completion

percentage_completion (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

additional_cost (double)

Cost spent other than the actual cost of the task

additional_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_effort_days (long)

Estimated number of days to finish the task

estimated_effort_days (long)
Numerical digits which are considered to have larger values.

Example 

2347

estimated_effort_hours (long)

Estimated number of hours to finish the task

estimated_effort_hours (long)
Numerical digits which are considered to have larger values.

Example 

239

estimated_effort_minutes (long)

Estimated number of minutes to finish the task

estimated_effort_minutes (long)
Numerical digits which are considered to have larger values.

Example 

457

description (html)

Contains description about the task

description (html)
HTML is a text area where html elements can be used.

Example 

<b>The content to be displayed</b>

status (status)

Indicates the level of progress of the task

status (status)
Indicates the level of progress of the task

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority

Example 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

attachments (attachment)

Files that are attached to the task. Maximum of 10 files can be attached to a task

attachments (attachment)
Files that are attached to the task. A maximum of only 50 attachments can be added

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

group (group)

The group associated to the task

group (group)

marked_group (group)

The group to be assigned when the task is triggered

marked_group (group)

owner (user)

The User assigned to the task

owner (user)
The User to whom the task is assigned

Example 

{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

marked_technician (user)

The user to be assigned when the task is triggered

marked_technician (user)
The user to be assigned when the task is triggered

Example 

{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Indicates the type of the task

Example 

{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

created_by (user)read only

Name and Id of the user who created the task is present in JSON format

created_by (user)
Indicates the Technician who created the task is present in JSON format

Example 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

associated_entity (string)read only

Entity associated to the task

associated_entity (string)
Associated_entity has regex “request | problem | change | project | milestone | request_template | project_template | milestone_template | release | change_template | release_template”

Example 

Sample Content

module (string)read only

The module to which the task belongs to

module (string)
Module has regex “General | Project | Milestone | Request | Change | Problem | Release | RequestTemplate | ProjectTemplate |  milestoneTemplate | ChangeTemplate | ReleaseTemplate”

Example 

Sample Content

created_date (datetime)read only

Date and time at which the task is created

created_date (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

estimated_effort (long)read only

The estimated effort needed to finish the task

estimated_effort (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

deleted (boolean)read only

Indicates whether the task is deleted or not

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

overdue (boolean)read only

Indicates whether the task is overdue or not

overdue (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl <service domain|custom domain>/app/<portal>/api/v3/tasks\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "task": {
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "1871812265827162"
    },
    "priority": {
      "name": "High",
      "id": "2474460469828007"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1898428065971893"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1822002620862973"
    }
  }
}''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/tasks";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "task": {
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "1871812265827162"
    },
    "priority": {
      "name": "High",
      "id": "2474460469828007"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1898428065971893"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1822002620862973"
    }
  }
}';
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/tasks"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "task": {
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "1871812265827162"
    },
    "priority": {
      "name": "High",
      "id": "2474460469828007"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1898428065971893"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1822002620862973"
    }
  }
}'
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/tasks"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "task": {
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "1871812265827162"
    },
    "priority": {
      "name": "High",
      "id": "2474460469828007"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1898428065971893"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1822002620862973"
    }
  }
}''''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "task": {
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "marked_technician": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2443319112022586",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "overdue": false,
    "additional_cost": "100",
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "1504379411346066",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "owner": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1871812265827162",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "module": "General",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2474460469828007"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1577080616582153",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort": "22845",
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Implementation",
      "id": "1898428065971893"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "stop_timer": false,
      "color": "#ffffff",
      "name": "Open",
      "id": "1822002620862973"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Edit Task

This operation helps you to edit tasks.

Url

<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}

Attributes

id (long)
Unique Identifier to identify the task

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

title (string)
Title of the task

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

scheduled_start_time (datetime)
Date and time at which the task is scheduled to start

scheduled_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish

scheduled_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_start_time (datetime)
Date and time at which the task has actually started

actual_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_end_time (datetime)
Date and time at which the task actually got finished

actual_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

More Attributes Expand all

email_before (long)

Indicates when to send an notification before schedule start in ms.

email_before (long)
The allowed values  are 0 , 900000 , 1800000 , 2700000 , 3600000 , 7200000 , 21600000 , 43200000 , 86400000 , 172800000 , 604800000

Example 

234759602834500

percentage_completion (int)

Indicates the progress of the task in percentage of completion

percentage_completion (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

additional_cost (double)

Cost spent other than the actual cost of the task

additional_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_effort_days (long)

Estimated number of days to finish the task

estimated_effort_days (long)
Numerical digits which are considered to have larger values.

Example 

2347

estimated_effort_hours (long)

Estimated number of hours to finish the task

estimated_effort_hours (long)
Numerical digits which are considered to have larger values.

Example 

239

estimated_effort_minutes (long)

Estimated number of minutes to finish the task

estimated_effort_minutes (long)
Numerical digits which are considered to have larger values.

Example 

457

description (html)

Contains description about the task

description (html)
HTML is a text area where html elements can be used.

Example 

<b>The content to be displayed</b>

status (status)

Indicates the level of progress of the task

status (status)
Indicates the level of progress of the task

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority

Example 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

attachments (attachment)

Files that are attached to the task. Maximum of 10 files can be attached to a task

attachments (attachment)
Files that are attached to the task. A maximum of only 50 attachments can be added

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

group (group)

The group associated to the task

group (group)

marked_group (group)

The group to be assigned when the task is triggered

marked_group (group)

owner (user)

The User assigned to the task

owner (user)
The User to whom the task is assigned

Example 

{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

marked_technician (user)

The user to be assigned when the task is triggered

marked_technician (user)
The user to be assigned when the task is triggered

Example 

{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Indicates the type of the task

Example 

{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

created_by (user)read only

Name and Id of the user who created the task is present in JSON format

created_by (user)
Indicates the Technician who created the task is present in JSON format

Example 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

associated_entity (string)read only

Entity associated to the task

associated_entity (string)
Associated_entity has regex “request | problem | change | project | milestone | request_template | project_template | milestone_template | release | change_template | release_template”

Example 

Sample Content

module (string)read only

The module to which the task belongs to

module (string)
Module has regex “General | Project | Milestone | Request | Change | Problem | Release | RequestTemplate | ProjectTemplate |  milestoneTemplate | ChangeTemplate | ReleaseTemplate”

Example 

Sample Content

created_date (datetime)read only

Date and time at which the task is created

created_date (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

estimated_effort (long)read only

The estimated effort needed to finish the task

estimated_effort (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

deleted (boolean)read only

Indicates whether the task is deleted or not

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

overdue (boolean)read only

Indicates whether the task is overdue or not

overdue (boolean)
Boolean value which can have two possible values. The values are true and false.

index (int)read only

No Description

index (int)
Numerical digits which are considered to have smaller numbers.

Example 

39


$ curl <service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "2301935913214789"
    },
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "2328502781662753"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1904788127933512"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2028758908906679"
    }
  }
}''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "2301935913214789"
    },
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "2328502781662753"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1904788127933512"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2028758908906679"
    }
  }
}';
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "2301935913214789"
    },
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "2328502781662753"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1904788127933512"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2028758908906679"
    }
  }
}'
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "2301935913214789"
    },
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "2328502781662753"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": "100",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Implementation",
      "id": "1904788127933512"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2028758908906679"
    }
  }
}''''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "task": {
    "percentage_completion": "30",   
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "marked_technician": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2020729935683450",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "overdue": false,
    "additional_cost": "100",
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "1850904131920933",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "owner": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2301935913214789",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "module": "General",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2328502781662753"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2035980242195913",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Implementation",
      "id": "1904788127933512"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "stop_timer": false,
      "color": "#ffffff",
      "name": "Open",
      "id": "2028758908906679"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Get Task

This operation helps you to get a task

Url

<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}

Attributes

id (long)
Unique Identifier to identify the task

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

title (string)
Title of the task

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

scheduled_start_time (datetime)
Date and time at which the task is scheduled to start

scheduled_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish

scheduled_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_start_time (datetime)
Date and time at which the task has actually started

actual_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_end_time (datetime)
Date and time at which the task actually got finished

actual_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

More Attributes Expand all

email_before (long)

Indicates when to send an notification before schedule start in ms.

email_before (long)
The allowed values  are 0 , 900000 , 1800000 , 2700000 , 3600000 , 7200000 , 21600000 , 43200000 , 86400000 , 172800000 , 604800000

Example 

234759602834500

percentage_completion (int)

Indicates the progress of the task in percentage of completion

percentage_completion (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

additional_cost (double)

Cost spent other than the actual cost of the task

additional_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_effort_days (long)

Estimated number of days to finish the task

estimated_effort_days (long)
Numerical digits which are considered to have larger values.

Example 

2347

estimated_effort_hours (long)

Estimated number of hours to finish the task

estimated_effort_hours (long)
Numerical digits which are considered to have larger values.

Example 

239

estimated_effort_minutes (long)

Estimated number of minutes to finish the task

estimated_effort_minutes (long)
Numerical digits which are considered to have larger values.

Example 

457

description (html)

Contains description about the task

description (html)
HTML is a text area where html elements can be used.

Example 

<b>The content to be displayed</b>

status (status)

Indicates the level of progress of the task

status (status)
Indicates the level of progress of the task

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority

Example 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

attachments (attachment)

Files that are attached to the task. Maximum of 10 files can be attached to a task

attachments (attachment)
Files that are attached to the task. A maximum of only 50 attachments can be added

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

group (group)

The group associated to the task

group (group)

marked_group (group)

The group to be assigned when the task is triggered

marked_group (group)

owner (user)

The User assigned to the task

owner (user)
The User to whom the task is assigned

Example 

{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

marked_technician (user)

The user to be assigned when the task is triggered

marked_technician (user)
The user to be assigned when the task is triggered

Example 

{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Indicates the type of the task

Example 

{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

created_by (user)read only

Name and Id of the user who created the task is present in JSON format

created_by (user)
Indicates the Technician who created the task is present in JSON format

Example 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

associated_entity (string)read only

Entity associated to the task

associated_entity (string)
Associated_entity has regex “request | problem | change | project | milestone | request_template | project_template | milestone_template | release | change_template | release_template”

Example 

Sample Content

module (string)read only

The module to which the task belongs to

module (string)
Module has regex “General | Project | Milestone | Request | Change | Problem | Release | RequestTemplate | ProjectTemplate |  milestoneTemplate | ChangeTemplate | ReleaseTemplate”

Example 

Sample Content

created_date (datetime)read only

Date and time at which the task is created

created_date (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

estimated_effort (long)read only

The estimated effort needed to finish the task

estimated_effort (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

deleted (boolean)read only

Indicates whether the task is deleted or not

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

overdue (boolean)read only

Indicates whether the task is overdue or not

overdue (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "task": {
    "percentage_completion": "30",
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "3600000",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "marked_technician": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1535323003932447",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "overdue": false,
    "additional_cost": "100",
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "1812392449864730",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "owner": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1769738715543843",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "module": "General",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1609361103967137"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2277660139615760",
      "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
      "is_vip_user": false,
      "department": null
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort": "22845",
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Implementation",
      "id": "2193248305423023"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "stop_timer": false,
      "color": "#ffffff",
      "name": "Open",
      "id": "1857239324475714"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Get List Task

This operation helps you Get list tasks.

Url

<service domain|custom domain>/app/<portal>/GET api/v3/tasks

Attributes

id (long)
Unique Identifier to identify the task

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

title (string)
Title of the task

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

scheduled_start_time (datetime)
Date and time at which the task is scheduled to start

scheduled_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish

scheduled_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_start_time (datetime)
Date and time at which the task has actually started

actual_start_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

actual_end_time (datetime)
Date and time at which the task actually got finished

actual_end_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

More Attributes Expand all

email_before (long)

Indicates when to send an notification before schedule start in ms.

email_before (long)
The allowed values  are 0 , 900000 , 1800000 , 2700000 , 3600000 , 7200000 , 21600000 , 43200000 , 86400000 , 172800000 , 604800000

Example 

234759602834500

percentage_completion (int)

Indicates the progress of the task in percentage of completion

percentage_completion (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

additional_cost (double)

Cost spent other than the actual cost of the task

additional_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_effort_days (long)

Estimated number of days to finish the task

estimated_effort_days (long)
Numerical digits which are considered to have larger values.

Example 

2347

estimated_effort_hours (long)

Estimated number of hours to finish the task

estimated_effort_hours (long)
Numerical digits which are considered to have larger values.

Example 

239

estimated_effort_minutes (long)

Estimated number of minutes to finish the task

estimated_effort_minutes (long)
Numerical digits which are considered to have larger values.

Example 

457

description (html)

Contains description about the task

description (html)
HTML is a text area where html elements can be used.

Example 

<b>The content to be displayed</b>

status (status)

Indicates the level of progress of the task

status (status)
Indicates the level of progress of the task

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority

Example 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

attachments (attachment)

Files that are attached to the task. Maximum of 10 files can be attached to a task

attachments (attachment)
Files that are attached to the task. A maximum of only 50 attachments can be added

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

group (group)

The group associated to the task

group (group)

marked_group (group)

The group to be assigned when the task is triggered

marked_group (group)

owner (user)

The User assigned to the task

owner (user)
The User to whom the task is assigned

Example 

{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

marked_technician (user)

The user to be assigned when the task is triggered

marked_technician (user)
The user to be assigned when the task is triggered

Example 

{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Indicates the type of the task

Example 

{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

created_by (user)read only

Name and Id of the user who created the task is present in JSON format

created_by (user)
Indicates the Technician who created the task is present in JSON format

Example 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

associated_entity (string)read only

Entity associated to the task

associated_entity (string)
Associated_entity has regex “request | problem | change | project | milestone | request_template | project_template | milestone_template | release | change_template | release_template”

Example 

Sample Content

module (string)read only

The module to which the task belongs to

module (string)
Module has regex “General | Project | Milestone | Request | Change | Problem | Release | RequestTemplate | ProjectTemplate |  milestoneTemplate | ChangeTemplate | ReleaseTemplate”

Example 

Sample Content

created_date (datetime)read only

Date and time at which the task is created

created_date (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

estimated_effort (long)read only

The estimated effort needed to finish the task

estimated_effort (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

deleted (boolean)read only

Indicates whether the task is deleted or not

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

overdue (boolean)read only

Indicates whether the task is overdue or not

overdue (boolean)
Boolean value which can have two possible values. The values are true and false.

project (project)read only

Project Entity to which the task is going to be associated. The project information will be provided only if the task is associated to that project.

project (project)

Example 

{
  "project": {
    "display_id": {
      "display_value": "PJT-131",
      "value": "131"
    },
    "project_code": "test-project_code",
    "id": "2037672456177497",
    "title": "test-title"
  }
}

request (request)read only

Request Entity to which the task is going to be associated. The request information will be provided only if the task is associated to that request.

request (request)
The request to which the task is associated.

Example 

{
  "request": {
    "id": "234567890123456"
  }
}

change (change)read only

Change Entity to which the task is going to be associated. The change information will be provided only if the task is associated to that change.

change (change)
The change to which the task is associated.

Example 

{
  "change": {
    "id": "234567890123456"
  }
}

problem (problem)read only

Problem Entity to which the task is going to be associated. The problem information will be provided only if the task is associated to that problem.

problem (problem)
The problem to which the task is associated.

Example 

{
  "problem": {
    "id": "234567890123456"
  }
}

release (release)read only

The release to which the task is associated.

release (release)
The release to which the task is associated.

Example 

{
  "release": {
    "id": "234567890123456"
  }
}

milestone (milestone)read only

Milestone Entity to which the task is going to be associated. The milestone information will be provided only if the task is associated to that milestone.

milestone (milestone)

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/tasks\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/tasks";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/tasks"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/tasks"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 2
  },
  "tasks": [
    {
      "percentage_completion": "30",
      "estimated_effort_hours": "20",
      "email_before": "3600000",
      "description": "The SRS must contain all the requirements for the feature",
      "title": "Create SRS",
      "marked_technician": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2076667701496890",
        "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
        "is_vip_user": false,
        "department": null
      },
      "overdue": false,
      "additional_cost": "100",
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "id": "2145983913783948",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "owner": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2419092744655162",
        "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
        "is_vip_user": false,
        "department": null
      },
      "module": "General",
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1481689150742475"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2334112382067270",
        "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
        "is_vip_user": false,
        "department": null
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_effort_minutes": "45",
      "estimated_effort": "22845",
      "created_date": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "estimated_effort_days": "15",
      "task_type": {
        "color": "#ffffff",
        "name": "Implementation",
        "id": "2069098922455543"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "stop_timer": false,
        "color": "#ffffff",
        "name": "Open",
        "id": "2372589271608930"
      }
    },
    {
      "percentage_completion": "30",
      "estimated_effort_hours": "20",
      "email_before": "3600000",
      "project": {
        "id": "2000000030575"
      },
      "description": "The SRS must contain all the requirements for the feature",
      "title": "Create SRS",
      "marked_technician": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2076667701496890",
        "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
        "is_vip_user": false,
        "department": null
      },
      "overdue": false,
      "additional_cost": "100",
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "id": "2145983913783948",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "owner": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2419092744655162",
        "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
        "is_vip_user": false,
        "department": null
      },
      "associated_entity": "project",
      "module": "Project",
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1481689150742475"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2334112382067270",
        "photo_url": "https://contacts.zoho.com/file?exp\u003d10\u0026ID\u003d123\u0026t\u003duser\u0026height\u003d60\u0026width\u003d60",
        "is_vip_user": false,
        "department": null
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_effort_minutes": "45",
      "estimated_effort": "22845",
      "created_date": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "estimated_effort_days": "15",
      "task_type": {
        "color": "#ffffff",
        "name": "Implementation",
        "id": "2069098922455543"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "stop_timer": false,
        "color": "#ffffff",
        "name": "Open",
        "id": "2372589271608930"
      }
    }
  ]
}

Delete Task

This operation helps you to delete tasks.

Url

<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}


$ curl <service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/tasks/{task_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}