Skip to content

Release Task

A task is an activity or piece of work which you have to do, usually as part of a larger 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 

CodeReviewTask

template (task_template)
Indicates the template which is used to create this task

template (task_template)
Indicates the template which is used to create this task

Example 

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

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>

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.

More Attributes Expand all

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.

email_before (long)

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

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

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 

234759602834500

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 

234759602834500

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 

234759602834500

status (status)

Indicates the level of progress of the task

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

Example 

{
  "status": {
    "name": "test_status",
    "id": "133333300000042011"
  }
}

group (group)

Indicates the assigned group of the release task

group (group)
Indicates the assigned group of the release task

Example 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

owner (user)

The User assigned to the task

owner (user)
The User assigned to the task

Example 

{
  "owner": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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_techncian": {
    "email_id": "test@test.com",
    "name": "test_technician",
    "id": "100000000000042013"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task

Example 

{
  "priority": {
    "name": "test_priority",
    "id": "1001100000042011"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Used to categorize the tasks of similar cases

Example 

{
  "task_type": {
    "name": "test-task_type",
    "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. Maximum of 10 files can be attached to a task

Example 

{
  "attachments": {
    "name": "test_attachment_1",
    "id": "133333300000042011"
  }
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the task

udf_fields (udf_fields)
Holds user defined fields’ values associated with the task

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

module (string)read only

The module to which the task belongs to

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

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.

created_by (user)read only

Name and Id of the user who created the task

created_by (user)
Name and Id of the user who created the task

Example 

{
  "created_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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

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.

associated_entity (string)read only

Entity associated to the task

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

Example 

Sample Content

release (release)read only

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

release (release)
Release Entity to which the task is going to be associated. The release information will be provided only if the task is associated to that release

Example 

{
  "release": {
    "id": "100000000000042013"
  }
}

Add Release Task

This operation helps to add a new release task.

Mandatory Fields :- title, template

Url

<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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 

CodeReviewTask

template (task_template)
Indicates the template which is used to create this task

template (task_template)
Indicates the template which is used to create this task

Example 

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

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>

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.

More Attributes Expand all

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.

email_before (long)

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

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

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 

234759602834500

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 

234759602834500

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 

234759602834500

status (status)

Indicates the level of progress of the task

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

Example 

{
  "status": {
    "name": "test_status",
    "id": "133333300000042011"
  }
}

group (group)

Indicates the assigned group of the release task

group (group)
Indicates the assigned group of the release task

Example 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

owner (user)

The User assigned to the task

owner (user)
The User assigned to the task

Example 

{
  "owner": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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_techncian": {
    "email_id": "test@test.com",
    "name": "test_technician",
    "id": "100000000000042013"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task

Example 

{
  "priority": {
    "name": "test_priority",
    "id": "1001100000042011"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Used to categorize the tasks of similar cases

Example 

{
  "task_type": {
    "name": "test-task_type",
    "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. Maximum of 10 files can be attached to a task

Example 

{
  "attachments": {
    "name": "test_attachment_1",
    "id": "133333300000042011"
  }
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the task

udf_fields (udf_fields)
Holds user defined fields’ values associated with the task

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

module (string)read only

The module to which the task belongs to

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

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.

created_by (user)read only

Name and Id of the user who created the task

created_by (user)
Name and Id of the user who created the task

Example 

{
  "created_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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

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.

associated_entity (string)read only

Entity associated to the task

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

Example 

Sample Content

release (release)read only

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

release (release)
Release Entity to which the task is going to be associated. The release information will be provided only if the task is associated to that release

Example 

{
  "release": {
    "id": "100000000000042013"
  }
}


$ curl <service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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": {
        "template": {
      "name": "Default Task",
      "id": "1822002620872075"
    },
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": {
            "id": "100000000000033531"
        },
        "marked_technician": null,
        "group": null,
        "marked_group": null,
        "task_type": null,
        "priority": null,
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": null,
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>SRS must contain all the requirements for the feature<br></div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        },
        "udf_fields": {
                "udf_long1": "1563389026964443",
                "udf_date1": {
                "value": "1478758440000"
                },
                "udf_char1": "test-udf_char1"
            }
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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": {
        "template": {
              "name": "Default Task",
              "id": "1822002620872075"
         },
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": {
            "id": "100000000000033531"
        },
        "marked_technician": null,
        "group": null,
        "marked_group": null,
        "task_type": null,
        "priority": null,
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": null,
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>SRS must contain all the requirements for the feature<br></div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        },
        "udf_fields": {
              "udf_long1": "1563389026964443",
              "udf_date1": {
            "value": "1478758440000"
              },
              "udf_char1": "test-udf_char1"
            }
    }
};
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/releases/{release_id}/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": {
        "template": {
              "name": "Default Task",
              "id": "1822002620872075"
            },
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": {
            "id": "100000000000033531"
        },
        "marked_technician": null,
        "group": null,
        "marked_group": null,
        "task_type": null,
        "priority": null,
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": null,
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>SRS must contain all the requirements for the feature<br></div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        },
        "udf_fields": {
              "udf_long1": "1563389026964443",
              "udf_date1": {
            "value": "1478758440000"
              },
              "udf_char1": "test-udf_char1"
            }
    }
}
'@
$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/releases/{release_id}/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": {
        "template": {
              "name": "Default Task",
              "id": "1822002620872075"
            },
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": {
            "id": "100000000000033531"
        },
        "marked_technician": null,
        "group": null,
        "marked_group": null,
        "task_type": null,
        "priority": null,
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": null,
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>SRS must contain all the requirements for the feature<br></div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        },
        "udf_fields": {
              "udf_long1": "1563389026964443",
              "udf_date1": {
            "value": "1478758440000"
              },
              "udf_char1": "test-udf_char1"
            }
    }
}'''
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": {
        "template": {
              "inactive": false,
              "name": "Default Task",
              "id": "1822002620872075"
            },
        "percentage_completion": null,
        "estimated_effort_hours": null,
        "attachments": [],
        "email_before": "0",
        "release": {
            "display_id": {
                "display_value": "RL-1",
                "value": "1"
            },
            "id": "100000000000034001",
            "title": "Demo Release"
        },
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"> <div>SRS must contain all the requirements for the feature<br /><\/div> <\/div>",
        "title": "Feature SRS",
        "marked_technician": null,
        "overdue": false,
        "additional_cost": null,
        "actual_end_time": null,
        "id": "100000000000040029",
        "actual_start_time": null,
        "group": null,
        "owner": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "associated_entity": "release",
        "module": "Release",
        "index": 1,
        "priority": null,
        "created_by": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "scheduled_end_time": null,
        "marked_group": null,
        "estimated_effort_minutes": null,
        "udf_fields": {
              "udf_long1": "1563389026964443",
              "udf_date1": {
            "display_value": "Nov 10, 2016 11:44 AM",
            "value": "1478758440000"
              },
              "udf_char1": "test-udf_char1"
            },
        "site": "null",
        "release_stage": {
            "internal_name": "submission",
            "inactive": false,
            "stage_index": 1,
            "name": "Submission",
            "id": "100000000000029003"
        },
        "deleted": false,
        "estimated_effort": null,
        "created_date": {
            "display_value": "Jan 27, 2022 12:31 PM",
            "value": "1643266899411"
        },
        "estimated_effort_days": null,
        "task_type": null,
        "scheduled_start_time": null,
        "status": {
            "in_progress": true,
            "internal_name": "Open",
            "stop_timer": false,
            "color": "#0066ff",
            "name": "Open",
            "id": "100000000000005126"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Edit Release Task

This operation helps to edit or update a release task.

Url

<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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 

CodeReviewTask

template (task_template)
Indicates the template which is used to create this task

template (task_template)
Indicates the template which is used to create this task

Example 

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

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>

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.

More Attributes Expand all

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.

email_before (long)

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

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

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 

234759602834500

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 

234759602834500

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 

234759602834500

status (status)

Indicates the level of progress of the task

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

Example 

{
  "status": {
    "name": "test_status",
    "id": "133333300000042011"
  }
}

group (group)

Indicates the assigned group of the release task

group (group)
Indicates the assigned group of the release task

Example 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

owner (user)

The User assigned to the task

owner (user)
The User assigned to the task

Example 

{
  "owner": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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_techncian": {
    "email_id": "test@test.com",
    "name": "test_technician",
    "id": "100000000000042013"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task

Example 

{
  "priority": {
    "name": "test_priority",
    "id": "1001100000042011"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Used to categorize the tasks of similar cases

Example 

{
  "task_type": {
    "name": "test-task_type",
    "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. Maximum of 10 files can be attached to a task

Example 

{
  "attachments": {
    "name": "test_attachment_1",
    "id": "133333300000042011"
  }
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the task

udf_fields (udf_fields)
Holds user defined fields’ values associated with the task

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

module (string)read only

The module to which the task belongs to

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

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.

created_by (user)read only

Name and Id of the user who created the task

created_by (user)
Name and Id of the user who created the task

Example 

{
  "created_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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

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.

associated_entity (string)read only

Entity associated to the task

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

Example 

Sample Content

release (release)read only

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

release (release)
Release Entity to which the task is going to be associated. The release information will be provided only if the task is associated to that release

Example 

{
  "release": {
    "id": "100000000000042013"
  }
}


$ curl <service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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": {
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": null,
        "marked_technician": null,
        "group": {
            "id": "100000000000005176"
        },
        "marked_group": null,
        "task_type": {
            "id": "100000000000005405"
        },
        "priority": {
            "id": "100000000000005157"
        },
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": {
            "value": "1643353740000"
        },
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>SRS must contain all the requirements for the feature<br></div></div>"
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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": {
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": null,
        "marked_technician": null,
        "group": {
            "id": "100000000000005176"
        },
        "marked_group": null,
        "task_type": {
            "id": "100000000000005405"
        },
        "priority": {
            "id": "100000000000005157"
        },
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": {
            "value": "1643353740000"
        },
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>SRS must contain all the requirements for the feature<br></div></div>"
    }
};
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/releases/{release_id}/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": {
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": null,
        "marked_technician": null,
        "group": {
            "id": "100000000000005176"
        },
        "marked_group": null,
        "task_type": {
            "id": "100000000000005405"
        },
        "priority": {
            "id": "100000000000005157"
        },
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": {
            "value": "1643353740000"
        },
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>SRS must contain all the requirements for the feature<br></div></div>"
    }
}
'@
$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/releases/{release_id}/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": {
        "title": "Feature SRS",
        "estimated_effort_days": "",
        "estimated_effort_hours": "",
        "estimated_effort_minutes": "",
        "owner": null,
        "marked_technician": null,
        "group": {
            "id": "100000000000005176"
        },
        "marked_group": null,
        "task_type": {
            "id": "100000000000005405"
        },
        "priority": {
            "id": "100000000000005157"
        },
        "status": {
            "id": "100000000000005126"
        },
        "scheduled_start_time": {
            "value": "1643353740000"
        },
        "scheduled_end_time": null,
        "actual_start_time": null,
        "actual_end_time": null,
        "email_before": "0",
        "percentage_completion": "",
        "attachments": [],
        "additional_cost": "",
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>SRS must contain all the requirements for the feature<br></div></div>"
    }
}'''
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": {
        "template": {
              "inactive": false,
              "name": "Default Task",
              "id": "1822002620872075"
            },
        "percentage_completion": null,
        "estimated_effort_hours": null,
        "attachments": [],
        "email_before": "0",
        "release": {
            "display_id": {
                "display_value": "RL-1",
                "value": "1"
            },
            "id": "100000000000034001",
            "title": "Demo Release"
        },
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>SRS must contain all the requirements for the feature<br /><\/div><\/div>",
        "title": "Feature SRS",
        "marked_technician": null,
        "overdue": false,
        "additional_cost": null,
        "actual_end_time": null,
        "id": "100000000000040029",
        "actual_start_time": null,
        "group": {
            "site": null,
            "deleted": false,
            "name": "Printer Problems",
            "id": "100000000000005176"
        },
        "owner": null,
        "associated_entity": "release",
        "module": "Release",
        "index": 1,
        "priority": {
            "color": "#ff6600",
            "name": "Medium",
            "id": "100000000000005157"
        },
        "created_by": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "scheduled_end_time": null,
        "marked_group": null,
        "estimated_effort_minutes": null,
        "site": "null",
        "release_stage": {
            "internal_name": "submission",
            "inactive": false,
            "stage_index": 1,
            "name": "Submission",
            "id": "100000000000029003"
        },
        "deleted": false,
        "estimated_effort": null,
        "created_date": {
            "display_value": "Jan 27, 2022 12:31 PM",
            "value": "1643266899411"
        },
        "estimated_effort_days": null,
        "udf_fields": {
              "udf_long1": "1563389026964443",
              "udf_date1": {
            "display_value": "Nov 10, 2016 11:44 AM",
            "value": "1478758440000"
              },
              "udf_char1": "test-udf_char1"
            },
        "task_type": {
            "color": "#ff6600",
            "name": "Maintenance",
            "id": "100000000000005405"
        },
        "scheduled_start_time": {
            "display_value": "Jan 28, 2022 12:39 PM",
            "value": "1643353740000"
        },
        "status": {
            "in_progress": true,
            "internal_name": "Open",
            "stop_timer": false,
            "color": "#0066ff",
            "name": "Open",
            "id": "100000000000005126"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Release Task

This operation helps to get a release task.

Url

<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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 

CodeReviewTask

template (task_template)
Indicates the template which is used to create this task

template (task_template)
Indicates the template which is used to create this task

Example 

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

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>

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.

More Attributes Expand all

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.

email_before (long)

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

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

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 

234759602834500

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 

234759602834500

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 

234759602834500

status (status)

Indicates the level of progress of the task

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

Example 

{
  "status": {
    "name": "test_status",
    "id": "133333300000042011"
  }
}

group (group)

Indicates the assigned group of the release task

group (group)
Indicates the assigned group of the release task

Example 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

owner (user)

The User assigned to the task

owner (user)
The User assigned to the task

Example 

{
  "owner": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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_techncian": {
    "email_id": "test@test.com",
    "name": "test_technician",
    "id": "100000000000042013"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task

Example 

{
  "priority": {
    "name": "test_priority",
    "id": "1001100000042011"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Used to categorize the tasks of similar cases

Example 

{
  "task_type": {
    "name": "test-task_type",
    "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. Maximum of 10 files can be attached to a task

Example 

{
  "attachments": {
    "name": "test_attachment_1",
    "id": "133333300000042011"
  }
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the task

udf_fields (udf_fields)
Holds user defined fields’ values associated with the task

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

module (string)read only

The module to which the task belongs to

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

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.

created_by (user)read only

Name and Id of the user who created the task

created_by (user)
Name and Id of the user who created the task

Example 

{
  "created_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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

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.

associated_entity (string)read only

Entity associated to the task

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

Example 

Sample Content

release (release)read only

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

release (release)
Release Entity to which the task is going to be associated. The release information will be provided only if the task is associated to that release

Example 

{
  "release": {
    "id": "100000000000042013"
  }
}


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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/releases/{release_id}/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/releases/{release_id}/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/releases/{release_id}/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": {
        "template": {
              "inactive": false,
              "name": "Default Task",
              "id": "1822002620872075"
            },
        "percentage_completion": null,
        "estimated_effort_hours": null,
        "attachments": [],
        "email_before": "0",
        "release": {
            "display_id": {
                "display_value": "RL-1",
                "value": "1"
            },
            "id": "100000000000034001",
            "title": "Demo Release"
        },
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>SRS must contain all the requirements for the feature<br /></div></div>",
        "title": "Feature SRS",
        "marked_technician": null,
        "overdue": false,
        "additional_cost": null,
        "actual_end_time": null,
        "id": "100000000000040029",
        "actual_start_time": null,
        "group": {
            "site": null,
            "deleted": false,
            "name": "Printer Problems",
            "id": "100000000000005176"
        },
        "owner": null,
        "associated_entity": "release",
        "module": "Release",
        "index": 1,
        "priority": {
            "color": "#ff6600",
            "name": "Medium",
            "id": "100000000000005157"
        },
        "created_by": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "scheduled_end_time": null,
        "marked_group": null,
        "estimated_effort_minutes": null,
        "udf_fields": {
              "udf_long1": "1563389026964443",
              "udf_date1": {
            "display_value": "Nov 10, 2016 11:44 AM",
            "value": "1478758440000"
              },
              "udf_char1": "test-udf_char1"
            },
        "site": "null",
        "release_stage": {
            "internal_name": "submission",
            "inactive": false,
            "stage_index": 1,
            "name": "Submission",
            "id": "100000000000029003"
        },
        "deleted": false,
        "estimated_effort": null,
        "created_date": {
            "display_value": "Jan 27, 2022 12:31 PM",
            "value": "1643266899411"
        },
        "estimated_effort_days": null,
        "task_type": {
            "color": "#ff6600",
            "name": "Maintenance",
            "id": "100000000000005405"
        },
        "scheduled_start_time": {
            "display_value": "Jan 28, 2022 12:39 PM",
            "value": "1643353740000"
        },
        "status": {
            "in_progress": true,
            "internal_name": "Open",
            "stop_timer": false,
            "color": "#0066ff",
            "name": "Open",
            "id": "100000000000005126"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get List Release Task

This operation helps to get a list of all release tasks

Url

<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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 

CodeReviewTask

template (task_template)
Indicates the template which is used to create this task

template (task_template)
Indicates the template which is used to create this task

Example 

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

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>

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.

More Attributes Expand all

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.

email_before (long)

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

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

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 

234759602834500

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 

234759602834500

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 

234759602834500

status (status)

Indicates the level of progress of the task

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

Example 

{
  "status": {
    "name": "test_status",
    "id": "133333300000042011"
  }
}

group (group)

Indicates the assigned group of the release task

group (group)
Indicates the assigned group of the release task

Example 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

owner (user)

The User assigned to the task

owner (user)
The User assigned to the task

Example 

{
  "owner": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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_techncian": {
    "email_id": "test@test.com",
    "name": "test_technician",
    "id": "100000000000042013"
  }
}

priority (priority)

Defines the intensity or importance of a task

priority (priority)
Defines the intensity or importance of a task

Example 

{
  "priority": {
    "name": "test_priority",
    "id": "1001100000042011"
  }
}

task_type (task_type)

Used to categorize the tasks of similar cases

task_type (task_type)
Used to categorize the tasks of similar cases

Example 

{
  "task_type": {
    "name": "test-task_type",
    "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. Maximum of 10 files can be attached to a task

Example 

{
  "attachments": {
    "name": "test_attachment_1",
    "id": "133333300000042011"
  }
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the task

udf_fields (udf_fields)
Holds user defined fields’ values associated with the task

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

module (string)read only

The module to which the task belongs to

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

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.

created_by (user)read only

Name and Id of the user who created the task

created_by (user)
Name and Id of the user who created the task

Example 

{
  "created_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

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

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.

associated_entity (string)read only

Entity associated to the task

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

Example 

Sample Content

release (release)read only

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

release (release)
Release Entity to which the task is going to be associated. The release information will be provided only if the task is associated to that release

Example 

{
  "release": {
    "id": "100000000000042013"
  }
}


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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/releases/{release_id}/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/releases/{release_id}/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/releases/{release_id}/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": [{
        "template": {
          "inactive": false,
          "name": "Default Task",
          "id": "1822002620872075"
        },
            "percentage_completion": null,
            "estimated_effort_hours": null,
            "email_before": "0",
            "release": {
                "display_id": {
                    "display_value": "RL-1",
                    "value": "1"
                },
                "id": "100000000000034001",
                "title": "Demo Release"
            },
            "description": "SRS must contain all the requirements for the feature",
            "title": "Feature SRS",
            "marked_technician": null,
            "overdue": false,
            "additional_cost": null,
            "actual_end_time": null,
            "id": "100000000000040029",
            "actual_start_time": null,
            "group": {
                "site": null,
                "deleted": false,
                "name": "Printer Problems",
                "id": "100000000000005176"
            },
            "owner": null,
            "associated_entity": "release",
            "module": "Release",
            "index": 1,
            "priority": {
                "color": "#ff6600",
                "name": "Medium",
                "id": "100000000000005157"
            },
            "created_by": {
                "email_id": "pratiush.narayan@zohotest.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "",
                "user_scope": "0",
                "phone": null,
                "name": "Pratiush",
                "id": "100000000000033531",
                "photo_url": "https://contacts.zoho.com/file?sample",
                "is_vip_user": false,
                "department": null,
                "first_name": "Pratiush",
                "job_title": null
            },
            "scheduled_end_time": null,
            "marked_group": null,
            "estimated_effort_minutes": null,
            "site": "null",
            "release_stage": {
                "internal_name": "submission",
                "inactive": false,
                "stage_index": 1,
                "name": "Submission",
                "id": "100000000000029003"
            },
            "deleted": false,
            "estimated_effort": null,
            "created_date": {
                "display_value": "Jan 27, 2022 12:31 PM",
                "value": "1643266899411"
            },
            "estimated_effort_days": null,
            "udf_fields": {
                  "udf_long1": "1563389026964443",
                  "udf_date1": {
                "display_value": "Nov 10, 2016 11:44 AM",
                "value": "1478758440000"
                  },
                  "udf_char1": "test-udf_char1"
                },
            "task_type": {
                "color": "#ff6600",
                "name": "Maintenance",
                "id": "100000000000005405"
            },
            "scheduled_start_time": {
                "display_value": "Jan 28, 2022 12:39 PM",
                "value": "1643353740000"
            },
            "status": {
                "in_progress": true,
                "internal_name": "Open",
                "stop_timer": false,
                "color": "#0066ff",
                "name": "Open",
                "id": "100000000000005126"
            }
        },
        {
            "template": {
                  "inactive": false,
                  "name": "Default Task",
                  "id": "1822002620872075"
                },
            "percentage_completion": null,
            "estimated_effort_hours": null,
            "email_before": "0",
            "release": {
                "display_id": {
                    "display_value": "RL-1",
                    "value": "1"
                },
                "id": "100000000000034001",
                "title": "Demo Release"
            },
            "description": "Task to create validation plans",
            "title": "Validation plan",
            "marked_technician": null,
            "overdue": false,
            "additional_cost": null,
            "actual_end_time": null,
            "id": "100000000000040064",
            "actual_start_time": null,
            "group": null,
            "owner": null,
            "associated_entity": "release",
            "module": "Release",
            "index": 1,
            "priority": {
                "color": "#ff0000",
                "name": "High",
                "id": "100000000000005139"
            },
            "created_by": {
                "email_id": "pratiush.narayan@zohotest.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "",
                "user_scope": "0",
                "phone": null,
                "name": "Pratiush",
                "id": "100000000000033531",
                "photo_url": "https://contacts.zoho.com/file?sample",
                "is_vip_user": false,
                "department": null,
                "first_name": "Pratiush",
                "job_title": null
            },
            "scheduled_end_time": null,
            "marked_group": null,
            "estimated_effort_minutes": null,
            "udf_fields": {
                  "udf_long1": "1563389026964443",
                  "udf_date1": {
                "display_value": "Nov 10, 2016 11:44 AM",
                "value": "1478758440000"
                  },
                  "udf_char1": "test-udf_char1"
                },
            "site": "null",
            "release_stage": {
                "internal_name": "planning",
                "inactive": false,
                "stage_index": 2,
                "name": "Planning",
                "id": "100000000000029042"
            },
            "deleted": false,
            "estimated_effort": null,
            "created_date": {
                "display_value": "Jan 27, 2022 12:52 PM",
                "value": "1643268162007"
            },
            "estimated_effort_days": null,
            "task_type": null,
            "scheduled_start_time": null,
            "status": {
                "in_progress": true,
                "internal_name": "Open",
                "stop_timer": false,
                "color": "#0066ff",
                "name": "Open",
                "id": "100000000000005126"
            }
        }
    ]
}

Delete Release Task

This operation helps to delete a release task.

Url

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


$ curl <service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}/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/releases/{release_id}/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/releases/{release_id}/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/releases/{release_id}/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"
  }
}