<service domain|custom domain>/app/<portal>//api/v3/tasks
Task
A piece of work done by a member of a team.
Attributes
id (long)
Unique identifier of the task.
title (string)
Title of the task.
template (task_template)
Task template from which Task is to be created.
status (status)
Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.
owner (technician)
User to whom the task is assigned. Object has the “id” and “name” of the owner.
scheduled_start_time (datetime)
Date and time at which the task is scheduled to start. Object has the “value” in milliseconds and “display_value” in the standard date format.
More Attributes Expand all
scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish.Object has the “value” in milliseconds and “display_value” in the standard date format.
due_by_time (datetime)read only
Date and time at which the task is to set as the due.Object has the “value” in milliseconds and “display_value” in the standard date format.
actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.
actual_end_time (datetime)
Date and time at which the task actually got finished.Object has the “value” in milliseconds and “display_value” in the standard date format.
type (task_type)
Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.
created_time (datetime)read only
Date and time at which the task is created. This object has the “value” in milliseconds and “display_value” in the standard date format.
priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority.
created_by (user)read only
Name and Id of the Technician who created the task is present in JSON format.
marked_owner (technician)
Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner
estimated_effort (JSONObject)
Estimated effort given in terms of days hours and minutes.
show attribute
Add Task
This operation helps you add a new task.
Mandatory Fields :- title
Url
Attributes
id (long)
Unique identifier of the task.
title (string)
Title of the task.
template (task_template)
Task template from which Task is to be created.
status (status)
Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.
owner (technician)
User to whom the task is assigned. Object has the “id” and “name” of the owner.
scheduled_start_time (datetime)
Date and time at which the task is scheduled to start. Object has the “value” in milliseconds and “display_value” in the standard date format.
More Attributes Expand all
scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish.Object has the “value” in milliseconds and “display_value” in the standard date format.
due_by_time (datetime)read only
Date and time at which the task is to set as the due.Object has the “value” in milliseconds and “display_value” in the standard date format.
actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.
actual_end_time (datetime)
Date and time at which the task actually got finished.Object has the “value” in milliseconds and “display_value” in the standard date format.
type (task_type)
Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.
created_time (datetime)read only
Date and time at which the task is created. This object has the “value” in milliseconds and “display_value” in the standard date format.
priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority.
created_by (user)read only
Name and Id of the Technician who created the task is present in JSON format.
marked_owner (technician)
Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner
estimated_effort (JSONObject)
Estimated effort given in terms of days hours and minutes.
show attribute
$ curl <service domain|custom domain>/app/<portal>//api/v3/tasks\
-X POST\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"task": {
"percentage_completion": 6,
"email_before": 50,
"description": "Hello description",
"title": "General Task adding through API doctool",
"additional_cost": "2.20",
"actual_end_time": {
"value": 1583814450059
},
"actual_start_time": {
"value": 1483814450059
},
"owner": {
"id": 6
},
"priority": {
"name": "Low"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "2",
"minutes": "33",
"days": "4"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"id": "1",
"name": "open"
}
}
}'
// 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": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"task": {
"percentage_completion": 6,
"email_before": 50,
"description": "Hello description",
"title": "General Task adding through API doctool",
"additional_cost": "2.20",
"actual_end_time": {
"value": 1583814450059
},
"actual_start_time": {
"value": 1483814450059
},
"owner": {
"id": 6
},
"priority": {
"name": "Low"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "2",
"minutes": "33",
"days": "4"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"id": "1",
"name": "open"
}
}
};
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" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"task": {
"percentage_completion": 6,
"email_before": 50,
"description": "Hello description",
"title": "General Task adding through API doctool",
"additional_cost": "2.20",
"actual_end_time": {
"value": 1583814450059
},
"actual_start_time": {
"value": 1483814450059
},
"owner": {
"id": 6
},
"priority": {
"name": "Low"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "2",
"minutes": "33",
"days": "4"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"id": "1",
"name": "open"
}
}
}
'@
$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" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"task": {
"percentage_completion": 6,
"email_before": 50,
"description": "Hello description",
"title": "General Task adding through API doctool",
"additional_cost": "2.20",
"actual_end_time": {
"value": 1583814450059
},
"actual_start_time": {
"value": 1483814450059
},
"owner": {
"id": 6
},
"priority": {
"name": "Low"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "2",
"minutes": "33",
"days": "4"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"id": "1",
"name": "open"
}
}
}'''
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": null,
"percentage_completion": 6,
"attachments": [],
"email_before": "50",
"description": "Hello description",
"title": "General Task adding through API doctool",
"overdue": false,
"additional_cost": "2.20",
"actual_end_time": {
"display_value": "Mar 10, 2020 09:57 AM",
"value": "1583814450059"
},
"id": "5",
"actual_start_time": {
"display_value": "Jan 8, 2017 12:10 AM",
"value": "1483814450059"
},
"owner": {
"email_id": "guest@zylker.com",
"name": "Heather Graham",
"is_vipuser": false,
"id": "6",
"department": null
},
"created_time": {
"display_value": "Apr 27, 2020 06:45 PM",
"value": "1587993358625"
},
"associated_entity": "general",
"priority": {
"color": "#666666",
"name": "Low",
"id": "1"
},
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": {
"display_value": "May 11, 2023 07:44 PM",
"value": "1683814450059"
},
"scheduled_end_time": {
"display_value": "May 11, 2023 07:44 PM",
"value": "1683814450059"
},
"marked_owner": null,
"site": null,
"estimated_effort": {
"display_value": "4 Days 2 Hrs 33 Mins",
"hours": "2",
"minutes": "33",
"days": "4"
},
"created_date": {
"display_value": "Apr 27, 2020 06:45 PM",
"value": "1587993358625"
},
"type": null,
"scheduled_start_time": {
"display_value": "Mar 10, 2020 09:57 AM",
"value": "1583814450059"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Edit Task
This operation helps you update an existing task
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}
Attributes
id (long)
Unique identifier of the task.
title (string)
Title of the task.
template (task_template)
Task template from which Task is to be created.
status (status)
Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.
owner (technician)
User to whom the task is assigned. Object has the “id” and “name” of the owner.
scheduled_start_time (datetime)
Date and time at which the task is scheduled to start. Object has the “value” in milliseconds and “display_value” in the standard date format.
More Attributes Expand all
scheduled_end_time (datetime)
Date and time at which the task is scheduled to finish.Object has the “value” in milliseconds and “display_value” in the standard date format.
due_by_time (datetime)read only
Date and time at which the task is to set as the due.Object has the “value” in milliseconds and “display_value” in the standard date format.
actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.
actual_end_time (datetime)
Date and time at which the task actually got finished.Object has the “value” in milliseconds and “display_value” in the standard date format.
type (task_type)
Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.
created_time (datetime)read only
Date and time at which the task is created. This object has the “value” in milliseconds and “display_value” in the standard date format.
priority (priority)
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority.
created_by (user)read only
Name and Id of the Technician who created the task is present in JSON format.
marked_owner (technician)
Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner
estimated_effort (JSONObject)
Estimated effort given in terms of days hours and minutes.
show attribute
$ curl <service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"task": {
"title": "General Task edited through API doctool",
"marked_owner": {
"name": "Jeniffer Doe"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "11",
"minutes": "45",
"days": "0"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"name": "Closed"
}
}
}'
// 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": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"task": {
"title": "General Task edited through API doctool",
"marked_owner": {
"name": "Jeniffer Doe"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "11",
"minutes": "45",
"days": "0"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"name": "Closed"
}
}
};
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" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"task": {
"title": "General Task edited through API doctool",
"marked_owner": {
"name": "Jeniffer Doe"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "11",
"minutes": "45",
"days": "0"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"name": "Closed"
}
}
}
'@
$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" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"task": {
"title": "General Task edited through API doctool",
"marked_owner": {
"name": "Jeniffer Doe"
},
"scheduled_end_time": {
"value": 1683814450059
},
"estimated_effort": {
"hours": "11",
"minutes": "45",
"days": "0"
},
"scheduled_start_time": {
"value": 1583814450059
},
"status": {
"name": "Closed"
}
}
}'''
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": null,
"percentage_completion": 100,
"attachments": [],
"email_before": "0",
"description": null,
"title": "General Task edited through API doctool",
"overdue": false,
"additional_cost": "0.00",
"actual_end_time": {
"display_value": "Apr 27, 2020 06:53 PM",
"value": "1587993831561"
},
"id": "4",
"actual_start_time": null,
"owner": null,
"created_time": {
"display_value": "Apr 27, 2020 06:31 PM",
"value": "1587992470814"
},
"associated_entity": "general",
"priority": null,
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": {
"display_value": "May 11, 2023 07:44 PM",
"value": "1683814450059"
},
"scheduled_end_time": {
"display_value": "May 11, 2023 07:44 PM",
"value": "1683814450059"
},
"marked_owner": {
"email_id": "guest@zylker.com",
"name": "Jeniffer Doe",
"is_vipuser": false,
"id": "9",
"department": {
"site": null,
"name": "IT Services",
"id": 5
}
},
"site": null,
"estimated_effort": {
"display_value": "11 Hrs 45 Mins",
"hours": "11",
"minutes": "45",
"days": "0"
},
"created_date": {
"display_value": "Apr 27, 2020 06:31 PM",
"value": "1587992470814"
},
"type": null,
"scheduled_start_time": {
"display_value": "Mar 10, 2020 09:57 AM",
"value": "1583814450059"
},
"status": {
"color": "#006600",
"name": "Closed",
"id": "3"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Task
This operation helps you view an existing task by ID
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}
Attributes
$ 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: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-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": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
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" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"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" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"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": null,
"percentage_completion": 0,
"attachments": [],
"email_before": "0",
"description": "<div>sample description of gen task...<br /></div>",
"title": "General task view",
"overdue": true,
"additional_cost": "33.00",
"actual_end_time": null,
"id": "6",
"actual_start_time": {
"display_value": "Apr 10, 2020 12:00 AM",
"value": "1586457000000"
},
"owner": null,
"created_time": {
"display_value": "Apr 27, 2020 07:01 PM",
"value": "1587994312041"
},
"associated_entity": "general",
"priority": null,
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": {
"display_value": "Apr 24, 2020 11:59 PM",
"value": "1587752940000"
},
"scheduled_end_time": {
"display_value": "Apr 24, 2020 11:59 PM",
"value": "1587752940000"
},
"marked_owner": {
"email_id": null,
"name": "Howard Stern",
"is_vipuser": false,
"id": "8",
"department": null
},
"site": null,
"estimated_effort": {
"display_value": "3 Hrs",
"hours": "3",
"minutes": "0",
"days": "0"
},
"created_date": {
"display_value": "Apr 27, 2020 07:01 PM",
"value": "1587994312041"
},
"type": {
"color": "#999900",
"name": "Implementation",
"id": "2"
},
"scheduled_start_time": null,
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get List Task
This operation lets you view the details of all tasks under all permissible modules
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks
Attributes
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/tasks\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
--data-urlencode input_data='{
"list_info": {
"row_count": "12",
"start_index": "2",
"sort_fields": [
{
"field": "title",
"order": "asc"
},
{
"field": "created_time",
"order": "desc"
}
],
"filter_by": {
"id": "7"
},
"search_criteria": {
"field": "priority",
"condition": "is not",
"values": [
{
"id": "1"
}
],
"children": [
{
"field": "additional_cost",
"condition": "lte",
"values": [
100
],
"logical_operator": "AND"
},
{
"field": "marked_owner.name",
"condition": "like",
"values": [
"Howard Stern"
],
"logical_operator": "OR"
}
]
},
"fields_required": [
"id",
"status",
"additional_cost",
"created_time"
]
}
}'
// 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": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"list_info": {
"row_count": "12",
"start_index": "2",
"sort_fields": [
{
"field": "title",
"order": "asc"
},
{
"field": "created_time",
"order": "desc"
}
],
"filter_by": {
"id": "7"
},
"search_criteria": {
"field": "priority",
"condition": "is not",
"values": [
{
"id": "1"
}
],
"children": [
{
"field": "additional_cost",
"condition": "lte",
"values": [
100
],
"logical_operator": "AND"
},
{
"field": "marked_owner.name",
"condition": "like",
"values": [
"Howard Stern"
],
"logical_operator": "OR"
}
]
},
"fields_required": [
"id",
"status",
"additional_cost",
"created_time"
]
}
};
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" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{
"list_info": {
"row_count": "12",
"start_index": "2",
"sort_fields": [
{
"field": "title",
"order": "asc"
},
{
"field": "created_time",
"order": "desc"
}
],
"filter_by": {
"id": "7"
},
"search_criteria": {
"field": "priority",
"condition": "is not",
"values": [
{
"id": "1"
}
],
"children": [
{
"field": "additional_cost",
"condition": "lte",
"values": [
100
],
"logical_operator": "AND"
},
{
"field": "marked_owner.name",
"condition": "like",
"values": [
"Howard Stern"
],
"logical_operator": "OR"
}
]
},
"fields_required": [
"id",
"status",
"additional_cost",
"created_time"
]
}
}'@
$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" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"list_info": {
"row_count": "12",
"start_index": "2",
"sort_fields": [
{
"field": "title",
"order": "asc"
},
{
"field": "created_time",
"order": "desc"
}
],
"filter_by": {
"id": "7"
},
"search_criteria": {
"field": "priority",
"condition": "is not",
"values": [
{
"id": "1"
}
],
"children": [
{
"field": "additional_cost",
"condition": "lte",
"values": [
100
],
"logical_operator": "AND"
},
{
"field": "marked_owner.name",
"condition": "like",
"values": [
"Howard Stern"
],
"logical_operator": "OR"
}
]
},
"fields_required": [
"id",
"status",
"additional_cost",
"created_time"
]
}
}'''
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": {
"sort_fields": [
{
"field": "title",
"order": "asc"
},
{
"field": "created_time",
"order": "desc"
}
],
"has_more_rows": true,
"start_index": 2,
"fields_required": [
"id",
"status",
"additional_cost",
"created_time"
],
"filter_by": {
"id": 7
},
"search_criteria": {
"condition": "is not",
"field": "priority",
"children": [
{
"condition": "lte",
"field": "additional_cost",
"logical_operator": "AND",
"values": [
"100"
]
},
{
"condition": "like",
"field": "marked_owner.name",
"logical_operator": "OR",
"values": [
"Howard Stern"
]
}
],
"values": [
"{\"id\":\"1\"}"
]
},
"row_count": 12
},
"tasks": [
{
"created_time": {
"display_value": "Apr 27, 2020 05:45 PM",
"value": "1587989701660"
},
"additional_cost": "0.00",
"id": "2",
"created_date": {
"display_value": "Apr 27, 2020 05:45 PM",
"value": "1587989701660"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994813791"
},
"additional_cost": "0.00",
"id": "8",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994813791"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 08:20 PM",
"value": "1587999024605"
},
"additional_cost": "0.00",
"id": "17",
"created_date": {
"display_value": "Apr 27, 2020 08:20 PM",
"value": "1587999024605"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:01 PM",
"value": "1587994312041"
},
"additional_cost": "33.00",
"id": "6",
"created_date": {
"display_value": "Apr 27, 2020 07:01 PM",
"value": "1587994312041"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994828044"
},
"additional_cost": "0.00",
"id": "10",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994828044"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994808154"
},
"additional_cost": "0.00",
"id": "7",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994808154"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994840184"
},
"additional_cost": "0.00",
"id": "12",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994840184"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 06:26 PM",
"value": "1587992206421"
},
"additional_cost": "0.00",
"id": "3",
"created_date": {
"display_value": "Apr 27, 2020 06:26 PM",
"value": "1587992206421"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994821662"
},
"additional_cost": "0.00",
"id": "9",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994821662"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994833893"
},
"additional_cost": "0.00",
"id": "11",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994833893"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994846168"
},
"additional_cost": "0.00",
"id": "13",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994846168"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
{
"created_time": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994857807"
},
"additional_cost": "0.00",
"id": "15",
"created_date": {
"display_value": "Apr 27, 2020 07:10 PM",
"value": "1587994857807"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
}
]
}
Delete Task
This operation helps you delete an existing task by ID
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: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-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": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
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" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"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" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"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"
}
}
Trigger A Task
This operation helps you trigger an existing task.
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/trigger
$ curl <service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/trigger\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data=''
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/trigger";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = ;
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}/trigger"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
'@
$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}/trigger"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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": null,
"percentage_completion": 0,
"attachments": [],
"email_before": "0",
"description": null,
"title": "General task",
"overdue": false,
"additional_cost": "0.00",
"actual_end_time": null,
"id": "17",
"actual_start_time": null,
"owner": {
"email_id": "guest@zylker.com",
"name": "Heather Graham",
"is_vipuser": false,
"id": "6",
"department": null
},
"created_time": {
"display_value": "Apr 27, 2020 08:20 PM",
"value": "1587999024605"
},
"associated_entity": "general",
"priority": null,
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": null,
"scheduled_end_time": null,
"marked_owner": null,
"site": null,
"estimated_effort": {
"display_value": "-",
"hours": "0",
"minutes": "0",
"days": "0"
},
"created_date": {
"display_value": "Apr 27, 2020 08:20 PM",
"value": "1587999024605"
},
"type": null,
"scheduled_start_time": {
"display_value": "Apr 27, 2020 08:38 PM",
"value": "1588000134117"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Close A Task
This operation helps to close an existing task.
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/close
$ curl <service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/close\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data=''
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/close";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = ;
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}/close"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
'@
$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}/close"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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": null,
"percentage_completion": 100,
"attachments": [],
"email_before": "0",
"description": null,
"title": "gen task doctool",
"overdue": false,
"additional_cost": "0.00",
"actual_end_time": {
"display_value": "Apr 27, 2020 10:44 PM",
"value": "1588007678344"
},
"id": "19",
"actual_start_time": null,
"owner": null,
"created_time": {
"display_value": "Apr 27, 2020 10:40 PM",
"value": "1588007440570"
},
"associated_entity": "general",
"priority": null,
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": null,
"scheduled_end_time": null,
"marked_owner": {
"email_id": "guest@zylker.com",
"name": "Jeniffer Doe",
"is_vipuser": false,
"id": "9",
"department": {
"site": null,
"name": "IT Services",
"id": 5
}
},
"site": null,
"estimated_effort": {
"display_value": "-",
"hours": "0",
"minutes": "0",
"days": "0"
},
"created_date": {
"display_value": "Apr 27, 2020 10:40 PM",
"value": "1588007440570"
},
"type": null,
"scheduled_start_time": null,
"status": {
"color": "#006600",
"name": "Closed",
"id": "3"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Assign Task Owner
This operation helps to assign owner for an existing task
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/assign
$ curl <service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/assign\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"task": {
"owner": {
"name": "Jeniffer Doe"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/assign";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"task": {
"owner": {
"name": "Jeniffer Doe"
}
}
};
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}/assign"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"task": {
"owner": {
"name": "Jeniffer Doe"
}
}
}
'@
$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}/assign"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"task": {
"owner": {
"name": "Jeniffer Doe"
}
}
}'''
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": null,
"percentage_completion": 0,
"attachments": [],
"email_before": "0",
"description": null,
"title": "General task",
"overdue": false,
"additional_cost": "0.00",
"actual_end_time": null,
"id": "17",
"actual_start_time": null,
"owner": {
"email_id": "guest@zylker.com",
"name": "Jeniffer Doe",
"is_vipuser": false,
"id": "9",
"department": {
"site": null,
"name": "IT Services",
"id": 5
}
},
"created_time": {
"display_value": "Apr 27, 2020 08:20 PM",
"value": "1587999024605"
},
"associated_entity": "general",
"priority": null,
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": null,
"scheduled_end_time": null,
"marked_owner": null,
"site": null,
"estimated_effort": {
"display_value": "-",
"hours": "0",
"minutes": "0",
"days": "0"
},
"created_date": {
"display_value": "Apr 27, 2020 08:20 PM",
"value": "1587999024605"
},
"type": null,
"scheduled_start_time": {
"display_value": "Apr 27, 2020 08:38 PM",
"value": "1588000134117"
},
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Mark Task Owner
This operation helps to mark owner for an existing task
Url
<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/mark
$ curl <service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/mark\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"task": {
"marked_owner": {
"name": "Jeniffer Doe"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/tasks/{task_id}/mark";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"task": {
"marked_owner": {
"name": "Jeniffer Doe"
}
}
};
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}/mark"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"task": {
"marked_owner": {
"name": "Jeniffer Doe"
}
}
}
'@
$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}/mark"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"task": {
"marked_owner": {
"name": "Jeniffer Doe"
}
}
}'''
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": null,
"percentage_completion": 0,
"attachments": [],
"email_before": "0",
"description": null,
"title": "gen task doctool",
"overdue": false,
"additional_cost": "0.00",
"actual_end_time": null,
"id": "19",
"actual_start_time": null,
"owner": null,
"created_time": {
"display_value": "Apr 27, 2020 10:40 PM",
"value": "1588007440570"
},
"associated_entity": "general",
"priority": null,
"created_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"due_by_time": null,
"scheduled_end_time": null,
"marked_owner": {
"email_id": "guest@zylker.com",
"name": "Jeniffer Doe",
"is_vipuser": false,
"id": "9",
"department": {
"site": null,
"name": "IT Services",
"id": 5
}
},
"site": null,
"estimated_effort": {
"display_value": "-",
"hours": "0",
"minutes": "0",
"days": "0"
},
"created_date": {
"display_value": "Apr 27, 2020 10:40 PM",
"value": "1588007440570"
},
"type": null,
"scheduled_start_time": null,
"status": {
"color": "#0066ff",
"name": "Open",
"id": "1"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}