Skip to content

Change Task

A piece of work done by a member of a team.

Attributes

id (long)
Unique identifier of the task

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

Example 

234759602834500

title (string)
Title of the task.

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

Example 

Sample Content

description (html)
Has 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. Object has the “value” in milliseconds and “display_value” in the standard date format.

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.Object has the “value” in milliseconds and “display_value” in the standard date format.

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

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

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

actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

More Attributes Expand all

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.

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)

Time set to trigger notification to owner.

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

status (status)

Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.

status (status)

owner (technician)

User to whom the task is assigned. Object has the “id” and “name” of the owner.

owner (technician)

marked_owner (technician)

Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner.

marked_owner (technician)

priority (priority)

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

priority (priority)

type (task_type)

Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.

type (task_type)

template (task_template)

Task template from which Task is to be created.

template (task_template)

estimated_effort (JSONObject)

Estimated effort given in terms of days hours and minutes.

estimated_effort (JSONObject)

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.

created_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.

created_by (user)read only

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

created_by (user)

index (long)read only

Index of the task

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

Example 

234759602834500

overdue (boolean)read only

OverDue of the Task.

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

associated_entity (string)read only

Module to which the task is associated to.

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

Example 

Sample Content

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.

due_by_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.

Remove Task Dependency

This operation helps to remove dependency between two tasks.

Url

/api/v3/changes/{change_id}/task_dependencies/{task_dependency_id}


$ curl /api/v3/changes/{change_id}/task_dependencies/{task_dependency_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 = "/api/v3/changes/{change_id}/task_dependencies/{task_dependency_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 = "/api/v3/changes/{change_id}/task_dependencies/{task_dependency_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 = "/api/v3/changes/{change_id}/task_dependencies/{task_dependency_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"
  }
}

View more

Add Task Dependency

This operation helps to add dependency between two tasks.

Url

/api/v3/changes/{change_id}/task_dependencies


$ curl /api/v3/changes/{change_id}/task_dependencies
      -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_dependency": {
        "parent_task": {
            "id": "1"
        },
        "child_task": {
            "id": "3"
        }
    }
}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/task_dependencies";
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_dependency": {
        "parent_task": {
            "id": "1"
        },
        "child_task": {
            "id": "3"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/task_dependencies"
$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_dependency": {
        "parent_task": {
            "id": "1"
        },
        "child_task": {
            "id": "3"
        }
    }
}
'@
$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 = "/api/v3/changes/{change_id}/task_dependencies"
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_dependency": {
        "parent_task": {
            "id": "1"
        },
        "child_task": {
            "id": "3"
        }
    }
}'''
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())

{
    "response_status": {
        "status": "success",
        "status_code": 2000
    },
    "task_dependency": {
        "child_task": {
            "id": "3",
            "title": "task 3"
        },
        "id": "2",
        "parent_task": {
            "id": "1",
            "title": "task 1"
        }
    }
}

View more

Get Task Dependencies

This operation helps to view all task dependencies under a change.

Url

/api/v3/changes/{change_id}/task_dependencies


$ curl -G /api/v3/changes/{change_id}/task_dependencies
      -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 = '{}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/task_dependencies";
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: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/task_dependencies"
$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 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 = "/api/v3/changes/{change_id}/task_dependencies"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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,
        "start_index": 1,
        "row_count": 2
    },
    "task_dependencies": [
        {
            "parent_task": {
                "id": "1",
                "title": "task 1"
            },
            "id": "1",
            "child_task": {
                "id": "2",
                "title": "task 2"
            }
        },
        {
            "parent_task": {
                "id": "1",
                "title": "task 1"
            },
            "id": "2",
            "child_task": {
                "id": "3",
                "title": "task 3"
            }
        }
    ]
}

View more

Mark Task Owner

This operation helps to mark owner for an existing task.

Url

/api/v3/changes/{change_id}/tasks/{task_id}/mark


$ curl /api/v3/changes/{change_id}/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": {
            "id": "9"
        }
    }
}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/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": {
            "id": "9"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/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": {
            "id": "9"
        }
    }
}
'@
$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 = "/api/v3/changes/{change_id}/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": {
            "id": "9"
        }
    }
}'''
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": "<div>To include new joinee details in Active directory.<br /></div><div><br /></div><div>First name :<br /></div><div>Last name :<br /></div><div>Employee Title :<br /></div><div>Date of Birth:<br /></div><div>Email Id :<br /></div><div>Department :<br /></div><div>Entension : <br /></div><div>Account login name :<br /></div><div>Account password :<br /></div>",
        "title": "Entry in Active directory",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": true,
        "additional_cost": "0.00",
        "actual_end_time": null,
        "id": "42",
        "actual_start_time": null,
        "group": null,
        "owner": null,
        "created_time": {
            "display_value": "Apr 28, 2020 03:14 PM",
            "value": "1588067057651"
        },
        "associated_entity": "change",
        "index": "5",
        "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": "zzz@zzz.com",
            "name": "Jeniffer Doe",
            "is_vipuser": false,
            "id": "9",
            "department": {
                "site": null,
                "name": "IT Services",
                "id": 5
            }
        },
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 03:14 PM",
            "value": "1588067057651"
        },
        "type": {
            "color": "#666666",
            "name": "Install/UnInstall",
            "id": "8"
        },
        "scheduled_start_time": {
            "display_value": "Apr 16, 2020 12:00 AM",
            "value": "1586975400000"
        },
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "1"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

View more

Assign Task Owner

This operation helps to assign owner for an existing task

Url

/api/v3/changes/{change_id}/tasks/{task_id}/assign


$ curl /api/v3/changes/{change_id}/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": {
            "id": "7"
        }
    }
}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/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": {
            "id": "7"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/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": {
            "id": "7"
        }
    }
}
'@
$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 = "/api/v3/changes/{change_id}/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": {
            "id": "7"
        }
    }
}'''
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": "To change the printer Toner<br /><br />Printer name :<br />Printer Location :<br />",
        "title": "Change the Printer Toner",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": false,
        "additional_cost": "0.00",
        "actual_end_time": null,
        "id": "43",
        "actual_start_time": null,
        "group": null,
        "owner": {
            "email_id": null,
            "name": "John Roberts",
            "is_vipuser": false,
            "id": "7",
            "department": null
        },
        "created_time": {
            "display_value": "Apr 28, 2020 03:14 PM",
            "value": "1588067069745"
        },
        "associated_entity": "change",
        "index": "6",
        "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,
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 03:14 PM",
            "value": "1588067069745"
        },
        "type": null,
        "scheduled_start_time": null,
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "1"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

View more

Close A Task

This operation helps to close an existing task.

Url

/api/v3/changes/{change_id}/tasks/{task_id}/close


$ curl /api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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": "change rr",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": false,
        "additional_cost": "0.00",
        "actual_end_time": {
            "display_value": "Apr 28, 2020 03:12 PM",
            "value": "1588066925690"
        },
        "id": "41",
        "actual_start_time": null,
        "group": {
            "site": null,
            "name": "Network",
            "id": "2"
        },
        "owner": {
            "email_id": "aaa@zzz.com",
            "name": "Heather Graham",
            "is_vipuser": false,
            "id": "6",
            "department": null
        },
        "created_time": {
            "display_value": "Apr 28, 2020 03:10 PM",
            "value": "1588066840094"
        },
        "associated_entity": "change",
        "index": "4",
        "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,
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 03:10 PM",
            "value": "1588066840094"
        },
        "type": null,
        "scheduled_start_time": {
            "display_value": "Apr 28, 2020 03:10 PM",
            "value": "1588066858020"
        },
        "status": {
            "color": "#006600",
            "name": "Closed",
            "id": "3"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

View more

Trigger A Task

This operation helps you trigger an existing task.

Url

/api/v3/changes/{change_id}/tasks/{task_id}/trigger


$ curl /api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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": "change rr",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": false,
        "additional_cost": "0.00",
        "actual_end_time": null,
        "id": "41",
        "actual_start_time": null,
        "group": {
            "site": null,
            "name": "Network",
            "id": "2"
        },
        "owner": {
            "email_id": "aaa@zzz.com",
            "name": "Heather Graham",
            "is_vipuser": false,
            "id": "6",
            "department": null
        },
        "created_time": {
            "display_value": "Apr 28, 2020 03:10 PM",
            "value": "1588066840094"
        },
        "associated_entity": "change",
        "index": "4",
        "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,
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 03:10 PM",
            "value": "1588066840094"
        },
        "type": null,
        "scheduled_start_time": {
            "display_value": "Apr 28, 2020 03:10 PM",
            "value": "1588066858020"
        },
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "1"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

View more

Get List Change Task

This operation lets you view the details of all tasks under a change

Url

/api/v3/changes/{change_id}/tasks

Attributes

id (long)
Unique identifier of the task

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

Example 

234759602834500

title (string)
Title of the task.

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

Example 

Sample Content

description (html)
Has 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. Object has the “value” in milliseconds and “display_value” in the standard date format.

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.Object has the “value” in milliseconds and “display_value” in the standard date format.

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

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

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

actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

More Attributes Expand all

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.

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)

Time set to trigger notification to owner.

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

status (status)

Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.

status (status)

owner (technician)

User to whom the task is assigned. Object has the “id” and “name” of the owner.

owner (technician)

marked_owner (technician)

Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner.

marked_owner (technician)

priority (priority)

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

priority (priority)

type (task_type)

Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.

type (task_type)

template (task_template)

Task template from which Task is to be created.

template (task_template)

estimated_effort (JSONObject)

Estimated effort given in terms of days hours and minutes.

estimated_effort (JSONObject)

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.

created_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.

created_by (user)read only

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

created_by (user)

index (long)read only

Index of the task

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

Example 

234759602834500

overdue (boolean)read only

OverDue of the Task.

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

associated_entity (string)read only

Module to which the task is associated to.

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

Example 

Sample Content

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.

due_by_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.

$ curl -G /api/v3/changes/{change_id}/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": {
        "sort_field": "title",
        "get_total_count": "true",
        "sort_order": "desc",
        "fields_required": [
            "id",
            "title"
        ]
    }
}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/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": {
        "sort_field": "title",
        "get_total_count": "true",
        "sort_order": "desc",
        "fields_required": [
            "id",
            "title"
        ]
    }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/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": {
        "sort_field": "title",
        "get_total_count": "true",
        "sort_order": "desc",
        "fields_required": [
            "id",
            "title"
        ]
    }
}
'@
$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 = "/api/v3/changes/{change_id}/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": {
        "sort_field": "title",
        "get_total_count": "true",
        "sort_order": "desc",
        "fields_required": [
            "id",
            "title"
        ]
    }
}'''       
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,
        "sort_field": "title",
        "fields_required": [
            "id",
            "title"
        ],
        "start_index": 1,
        "total_count": 3,
        "sort_order": "desc",
        "get_total_count": "true",
        "row_count": 3
    },
    "tasks": [
        {
            "id": "38",
            "title": "Task adding through API"
        },
        {
            "id": "39",
            "title": "Setting up user computer"
        },
        {
            "id": "40",
            "title": "change task"
        }
    ]
}

Get Change Task

This operation helps you view an existing task by ID

Url

/api/v3/changes/{change_id}/tasks/{task_id}

Attributes

id (long)
Unique identifier of the task

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

Example 

234759602834500

title (string)
Title of the task.

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

Example 

Sample Content

description (html)
Has 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. Object has the “value” in milliseconds and “display_value” in the standard date format.

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.Object has the “value” in milliseconds and “display_value” in the standard date format.

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

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

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

actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

More Attributes Expand all

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.

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)

Time set to trigger notification to owner.

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

status (status)

Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.

status (status)

owner (technician)

User to whom the task is assigned. Object has the “id” and “name” of the owner.

owner (technician)

marked_owner (technician)

Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner.

marked_owner (technician)

priority (priority)

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

priority (priority)

type (task_type)

Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.

type (task_type)

template (task_template)

Task template from which Task is to be created.

template (task_template)

estimated_effort (JSONObject)

Estimated effort given in terms of days hours and minutes.

estimated_effort (JSONObject)

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.

created_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.

created_by (user)read only

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

created_by (user)

index (long)read only

Index of the task

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

Example 

234759602834500

overdue (boolean)read only

OverDue of the Task.

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

associated_entity (string)read only

Module to which the task is associated to.

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

Example 

Sample Content

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.

due_by_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.

$ curl -G /api/v3/changes/{change_id}/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"
      --data-urlencode input_data = '{}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/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 = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/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 = @'
{}
'@
$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 = "/api/v3/changes/{change_id}/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 = '''{}'''       
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())

{
    "task": {
        "template": {
            "id": "3",
            "title": "Setting up user computer"
        },
        "percentage_completion": 0,
        "attachments": [],
        "email_before": null,
        "description": "To set up computer for the new joinee.<br /><br />Laptop / Desktop :<br />Additional software :<br />Additional hardware :",
        "title": "Setting up user computer",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": false,
        "additional_cost": "0.00",
        "actual_end_time": null,
        "id": "39",
        "actual_start_time": null,
        "group": null,
        "owner": null,
        "created_time": {
            "display_value": "Apr 28, 2020 02:57 PM",
            "value": "1588066035760"
        },
        "associated_entity": "change",
        "index": "2",
        "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,
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 02:57 PM",
            "value": "1588066035760"
        },
        "type": null,
        "scheduled_start_time": null,
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "1"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Delete Change Task

This operation helps you delete an existing task by ID

Url

/api/v3/changes/{change_id}/tasks/{task_id}


$ curl /api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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 = "/api/v3/changes/{change_id}/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"
  }
}

Edit Change Task

This operation helps you update an existing task

Url

/api/v3/changes/{change_id}/tasks/{task_id}

Attributes

id (long)
Unique identifier of the task

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

Example 

234759602834500

title (string)
Title of the task.

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

Example 

Sample Content

description (html)
Has 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. Object has the “value” in milliseconds and “display_value” in the standard date format.

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.Object has the “value” in milliseconds and “display_value” in the standard date format.

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

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

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

actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

More Attributes Expand all

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.

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)

Time set to trigger notification to owner.

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

status (status)

Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.

status (status)

owner (technician)

User to whom the task is assigned. Object has the “id” and “name” of the owner.

owner (technician)

marked_owner (technician)

Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner.

marked_owner (technician)

priority (priority)

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

priority (priority)

type (task_type)

Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.

type (task_type)

template (task_template)

Task template from which Task is to be created.

template (task_template)

estimated_effort (JSONObject)

Estimated effort given in terms of days hours and minutes.

estimated_effort (JSONObject)

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.

created_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.

created_by (user)read only

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

created_by (user)

index (long)read only

Index of the task

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

Example 

234759602834500

overdue (boolean)read only

OverDue of the Task.

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

associated_entity (string)read only

Module to which the task is associated to.

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

Example 

Sample Content

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.

due_by_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.

$ curl /api/v3/changes/{change_id}/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": {
        "status": {
            "id": 3
        },
        "owner": {
            "id": "9"
        },
        "additional_cost": 9000
    }
}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/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": {
        "status": {
            "id": 3
        },
        "owner": {
            "id": "9"
        },
        "additional_cost": 9000
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/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": {
        "status": {
            "id": 3
        },
        "owner": {
            "id": "9"
        },
        "additional_cost": 9000
    }
}
'@
$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 = "/api/v3/changes/{change_id}/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": {
        "status": {
            "id": 3
        },
        "owner": {
            "id": "9"
        },
        "additional_cost": 9000
    }
}'''
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": "change task",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": false,
        "additional_cost": "9000.00",
        "actual_end_time": {
            "display_value": "Apr 28, 2020 03:02 PM",
            "value": "1588066353533"
        },
        "id": "40",
        "actual_start_time": null,
        "group": null,
        "owner": {
            "email_id": "zzz@zzz.com",
            "name": "Jeniffer Doe",
            "is_vipuser": false,
            "id": "9",
            "department": {
                "site": null,
                "name": "IT Services",
                "id": 5
            }
        },
        "created_time": {
            "display_value": "Apr 28, 2020 03:01 PM",
            "value": "1588066289964"
        },
        "associated_entity": "change",
        "index": "3",
        "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,
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 03:01 PM",
            "value": "1588066289964"
        },
        "type": null,
        "scheduled_start_time": null,
        "status": {
            "color": "#006600",
            "name": "Closed",
            "id": "3"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Add Change Task

This operation helps you add a new task.

Mandatory Fields :- title

Url

/api/v3/changes/{change_id}/tasks

Attributes

id (long)
Unique identifier of the task

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

Example 

234759602834500

title (string)
Title of the task.

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

Example 

Sample Content

description (html)
Has 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. Object has the “value” in milliseconds and “display_value” in the standard date format.

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.Object has the “value” in milliseconds and “display_value” in the standard date format.

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

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

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

actual_start_time (datetime)
Date and time at which the task has actually started.Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

More Attributes Expand all

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.

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)

Time set to trigger notification to owner.

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

status (status)

Indicates the level of progress of the task. The Object has “id” and/or “name” of the status.

status (status)

owner (technician)

User to whom the task is assigned. Object has the “id” and “name” of the owner.

owner (technician)

marked_owner (technician)

Represents the Technician who is marked to do the task. Object has the “id” and “name” of the owner.

marked_owner (technician)

priority (priority)

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

priority (priority)

type (task_type)

Used to categorize the tasks of similar cases. Object has “id” and/or “name” of the task type.

type (task_type)

template (task_template)

Task template from which Task is to be created.

template (task_template)

estimated_effort (JSONObject)

Estimated effort given in terms of days hours and minutes.

estimated_effort (JSONObject)

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.

created_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.

created_by (user)read only

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

created_by (user)

index (long)read only

Index of the task

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

Example 

234759602834500

overdue (boolean)read only

OverDue of the Task.

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

associated_entity (string)read only

Module to which the task is associated to.

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

Example 

Sample Content

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.

due_by_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.

$ curl /api/v3/changes/{change_id}/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": {
        "title": "Task adding through API"
    }
}'

// Deluge Sample script
url = "/api/v3/changes/{change_id}/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": {
        "title": "Task adding through API"
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/changes/{change_id}/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": {
        "title": "Task adding through API"
    }
}
'@
$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 = "/api/v3/changes/{change_id}/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": {
        "title": "Task adding through API"
    }
}'''
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": 0,
        "attachments": [],
        "email_before": null,
        "description": null,
        "title": "Task adding through API",
        "change": {
            "id": "1",
            "title": "change 1"
        },
        "overdue": false,
        "additional_cost": "0.00",
        "actual_end_time": null,
        "id": "38",
        "actual_start_time": null,
        "group": null,
        "owner": null,
        "created_time": {
            "display_value": "Apr 28, 2020 02:55 PM",
            "value": "1588065956455"
        },
        "associated_entity": "change",
        "index": "1",
        "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,
        "marked_group": null,
        "site": null,
        "estimated_effort": {
            "display_value": "-",
            "hours": "0",
            "minutes": "0",
            "days": "0"
        },
        "created_date": {
            "display_value": "Apr 28, 2020 02:55 PM",
            "value": "1588065956455"
        },
        "type": null,
        "scheduled_start_time": null,
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "1"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}