Changes and Differences in Task-related API Operations
The task-related V3 API operations have been revised. To avoid interruption and failures, the changes and differences listed here should be incorporated into your environment.
Prerequisites
Update your HTTP Accept Header to the following value: application/vnd.manageengine.sdp.v3+json
Note: This is mandatory for format changes to be accepted.
The changes and differences are categorized into various sections as listed below:
- Field Name Changes
- Removed Fields
- New Fields
- Field Behavior Changes
- Format Differences
- Field Restrictions
- URL Differences
- New Operations
Field Name Changes
|
Old |
New |
Difference |
|
estimated_effort_hours |
estimated_effort: { hours: 0, minutes: 0, days: 0 } |
Changed the format. Input is required as JSON objects. |
|
estimated_effort_minutes |
||
|
estimated_effort_days |
||
|
created_date |
created_time |
Changed the name |
|
task_type |
type |
Changed the name |
Removed Fields
|
Old |
New |
Difference |
|
comment |
- |
Deprecated. The new format no longer supports adding a comment along with the task. |
New Fields
|
Old |
New |
Difference |
|
- |
template |
In the new format, the option to add tasks from the template is included. |
|
- |
index (read-only) |
In the new format, the index field (Order) is included to display the order of the task which is under request/change/problem and milestone. |
|
- |
due_by_time(read-only) |
In the new format, this field will have the same value as that of the scheduled_end_time. |
|
- |
attachments |
In the new format, the option to add attachments along with the task. All attachments will be displayed in the response. |
Field Behavior Changes
|
Old |
New |
Difference |
|
group |
group |
In the new format, these fields will be displayed for tasks under request/problem/change modules. |
|
marked_group |
marked_group |
Format Differences
|
Old Input / Output |
New Input/Output |
Difference |
|
"estimated_effort_hours": 2, "estimated_effort_days": 2, "estimated_effort_minutes": 2 |
"estimated_effort": { "hours": "2", "minutes": "2", "days": "2" } |
estimated_effort
|
|
"estimated_effort_hours": "2 Hrs", "estimated_effort_minutes": "2 Mins", "estimated_effort_days": "2 Days " |
"estimated_effort": { "display_value": "2 Days 2 Hrs 2 Mins", "hours": "2", "minutes": "2", "days": "2" } |
|
|
- |
"template": { "id": "11" } |
template
Newly added field. Requires input as a JSON Object. |
|
|
"template": { "id": "11", "name": "test" } |
|
|
- |
- |
index New read-only field, -1 for project and general. Positive increments for the rest of the modules. |
|
|
"index": "-1" --------------------------- "index": "3" |
|
|
- |
"attachments": [ { "id": 53 } ] |
attachments In the new format, attachments can be added along with the task addition and all the attachments will be displayed in the response. |
|
|
"attachments": [ { "content_type": "image/png", "size": { "display_value": "170.88KB", "value": 174990 }, "module": "task", "name": "filename.png", "content_url": "/api/v3/requests/101/tasks/5564/attachments/53/download", "id": "53" } ] |
|
|
"account" : "Sample Account"
|
"account":{ "name":" Sample Account" } |
The format has been changed. Input for account is required as a JSON object in the new format. |
Field Restrictions
|
Old |
New |
Difference |
|
request (editable) |
request(read-only)
|
In the new format, the parent JSON is not allowed to be provided in the input data, but it is mandatory to be included in the URL.
|
|
problem (editable) |
problem(read-only) |
|
|
change(editable) |
change (read-only) |
|
|
project (editable) |
project (read-only) |
URL Differences
|
Old |
New |
Difference |
|
/api/v3/tasks |
/api/v3/tasks |
In the new format, the direct task URL is to access only the general task (To access other module tasks, the parent module and its ID need to be mentioned in the URL) |
New Operations
|
Operation |
New API URL |
Input |
|
assign (operation: put) |
/api/v3/requests/{id}/tasks/{id}/assign |
{ "task": { "owner": { "id": 6 }, "group": { "id": 1 } } } |
|
mark and (operation: put) |
/api/v3/requests/{id}/tasks/{id}/mark |
{ "task": { "marked_owner": { "id": 6 }, "marked_group": { "id": 1 } } } |
|
trigger (operation: put) |
/api/v3/requests/{id}/tasks/{id}/trigger |
- |
|
close (operation: put) |
/api/v3/requests/{id}/tasks/{id}/close |
- |
|
/api/v3/requests/{id}/tasks/organize?ids={id},{id} |
- |
|
Major Difference: To access a task that has a parent entity, the respective parent module name and its ID need to be provided in the URL.