Skip to content

Request Task Worklog

Helps you track and capture the work done by a team member.

Attributes

id (long)
Unique id of the Worklog

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

Example 

234759602834500

owner (user)
Owner of the worklog

owner (user)
The technician who works on the worklog

Example 

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

description (html)
Description about the worklog.

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

Example 

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

start_time (datetime)
Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

end_time (datetime)
Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

recorded_time (datetime)
Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_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

other_charge (double)

Extra charges other than the Technician related to the worklog.

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

Example 

23.08

tech_charge (double)

The technician charges related to the worklog

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

Example 

23.08

include_nonoperational_hours (boolean)

Indicates whether to include non-operational hours or not.

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

mark_first_response (boolean)

Indicates whether to set responded date of a Request/ticket while adding worklog for that request/ticket

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

worklog_type (worklog_type)

Worklog type allows you to record the different modes of technician’s work

worklog_type (worklog_type)
Worklog type allows you to record the different modes of technician’s work.

Example 

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

created_by (user)read only

The user who created the worklog

created_by (user)
The User who created the worklog

Example 

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

total_charge (double)read only

The total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

The time spent in terms of hours, minutes and seconds.

time_spent (timediff)
Contains the Time spent in hours, minutes and seconds

Example 

{
  "time_spent": {
    "hours": "1895",
    "minutes": 20
  }
}

Add Request Task Worklog

This operation helps you Add worklog for request task.

Mandatory Fields :- owner

Url

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

Attributes

id (long)
Unique id of the Worklog

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

Example 

234759602834500

owner (user)
Owner of the worklog

owner (user)
The technician who works on the worklog

Example 

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

description (html)
Description about the worklog.

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

Example 

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

start_time (datetime)
Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

end_time (datetime)
Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

recorded_time (datetime)
Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_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

other_charge (double)

Extra charges other than the Technician related to the worklog.

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

Example 

23.08

tech_charge (double)

The technician charges related to the worklog

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

Example 

23.08

include_nonoperational_hours (boolean)

Indicates whether to include non-operational hours or not.

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

mark_first_response (boolean)

Indicates whether to set responded date of a Request/ticket while adding worklog for that request/ticket

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

worklog_type (worklog_type)

Worklog type allows you to record the different modes of technician’s work

worklog_type (worklog_type)
Worklog type allows you to record the different modes of technician’s work.

Example 

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

created_by (user)read only

The user who created the worklog

created_by (user)
The User who created the worklog

Example 

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

total_charge (double)read only

The total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

The time spent in terms of hours, minutes and seconds.

time_spent (timediff)
Contains the Time spent in hours, minutes and seconds

Example 

{
  "time_spent": {
    "hours": "1895",
    "minutes": 20
  }
}


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name"
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name"
    }
  }
};
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/requests/{request_id}/tasks/{task_id}/worklogs"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name"
    }
  }
}
'@
$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/requests/{request_id}/tasks/{task_id}/worklogs"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name"
    }
  }
}'''
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_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "mobile": "test-mobile",
      "id": "1856265534885993",
      "photo_url": "test-photo_url",
      "is_vip_user": false
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "mobile": "test-mobile",
      "id": "2119952679762012",
      "photo_url": "test-photo_url",
      "is_vip_user": false
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    },
    "mark_first_response": false,
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name",
      "id": "2170586614301410"
    },
    "id": "2469549357974301"
  }
}

Edit Request Task Worklog

This operation helps you Update worklog for request task.

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}

Attributes

id (long)
Unique id of the Worklog

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

Example 

234759602834500

owner (user)
Owner of the worklog

owner (user)
The technician who works on the worklog

Example 

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

description (html)
Description about the worklog.

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

Example 

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

start_time (datetime)
Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

end_time (datetime)
Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

recorded_time (datetime)
Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_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

other_charge (double)

Extra charges other than the Technician related to the worklog.

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

Example 

23.08

tech_charge (double)

The technician charges related to the worklog

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

Example 

23.08

include_nonoperational_hours (boolean)

Indicates whether to include non-operational hours or not.

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

mark_first_response (boolean)

Indicates whether to set responded date of a Request/ticket while adding worklog for that request/ticket

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

worklog_type (worklog_type)

Worklog type allows you to record the different modes of technician’s work

worklog_type (worklog_type)
Worklog type allows you to record the different modes of technician’s work.

Example 

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

created_by (user)read only

The user who created the worklog

created_by (user)
The User who created the worklog

Example 

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

total_charge (double)read only

The total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

The time spent in terms of hours, minutes and seconds.

time_spent (timediff)
Contains the Time spent in hours, minutes and seconds

Example 

{
  "time_spent": {
    "hours": "1895",
    "minutes": 20
  }
}


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "include_nonoperational_hours": false,
    "worklog_type": {
      "name": "test-name"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "include_nonoperational_hours": false,
    "worklog_type": {
      "name": "test-name"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
};
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/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "include_nonoperational_hours": false,
    "worklog_type": {
      "name": "test-name"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}
'@
$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/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com"
    },
    "mark_first_response": false,
    "start_time": {
      "value": "1421988300000"
    },
    "include_nonoperational_hours": false,
    "worklog_type": {
      "name": "test-name"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}'''
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())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "mobile": "test-mobile",
      "id": "1509662054134177",
      "photo_url": "test-photo_url",
      "is_vip_user": false
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "mobile": "test-mobile",
      "id": "2246857526128709",
      "photo_url": "test-photo_url",
      "is_vip_user": false
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    },
    "mark_first_response": false,
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name",
      "id": "1665563197087693"
    },
    "id": "1778953679609145"
  }
}

Get Request Task Worklog

This operation helps you Get worklog for request task.

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}

Attributes

id (long)
Unique id of the Worklog

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

Example 

234759602834500

owner (user)
Owner of the worklog

owner (user)
The technician who works on the worklog

Example 

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

description (html)
Description about the worklog.

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

Example 

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

start_time (datetime)
Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

end_time (datetime)
Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

recorded_time (datetime)
Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_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

other_charge (double)

Extra charges other than the Technician related to the worklog.

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

Example 

23.08

tech_charge (double)

The technician charges related to the worklog

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

Example 

23.08

include_nonoperational_hours (boolean)

Indicates whether to include non-operational hours or not.

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

mark_first_response (boolean)

Indicates whether to set responded date of a Request/ticket while adding worklog for that request/ticket

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

worklog_type (worklog_type)

Worklog type allows you to record the different modes of technician’s work

worklog_type (worklog_type)
Worklog type allows you to record the different modes of technician’s work.

Example 

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

created_by (user)read only

The user who created the worklog

created_by (user)
The User who created the worklog

Example 

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

total_charge (double)read only

The total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

The time spent in terms of hours, minutes and seconds.

time_spent (timediff)
Contains the Time spent in hours, minutes and seconds

Example 

{
  "time_spent": {
    "hours": "1895",
    "minutes": 20
  }
}


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

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

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

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

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

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "mobile": "test-mobile",
      "id": "2309879366386186",
      "photo_url": "test-photo_url",
      "is_vip_user": false
    },
    "include_nonoperational_hours": false,
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "mobile": "test-mobile",
      "id": "2253467407133239",
      "photo_url": "test-photo_url",
      "is_vip_user": false
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    },
    "mark_first_response": false,
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "worklog_type": {
      "name": "test-name",
      "id": "2234750506915010"
    },
    "id": "1962124438644868"
  }
}

Get List Request Task Worklog

This operation helps you Get all worklogs for request task.

Url

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

Attributes

id (long)
Unique id of the Worklog

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

Example 

234759602834500

owner (user)
Owner of the worklog

owner (user)
The technician who works on the worklog

Example 

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

description (html)
Description about the worklog.

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

Example 

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

start_time (datetime)
Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

end_time (datetime)
Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

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.

recorded_time (datetime)
Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_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

other_charge (double)

Extra charges other than the Technician related to the worklog.

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

Example 

23.08

tech_charge (double)

The technician charges related to the worklog

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

Example 

23.08

include_nonoperational_hours (boolean)

Indicates whether to include non-operational hours or not.

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

mark_first_response (boolean)

Indicates whether to set responded date of a Request/ticket while adding worklog for that request/ticket

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

worklog_type (worklog_type)

Worklog type allows you to record the different modes of technician’s work

worklog_type (worklog_type)
Worklog type allows you to record the different modes of technician’s work.

Example 

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

created_by (user)read only

The user who created the worklog

created_by (user)
The User who created the worklog

Example 

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

total_charge (double)read only

The total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

The time spent in terms of hours, minutes and seconds.

time_spent (timediff)
Contains the Time spent in hours, minutes and seconds

Example 

{
  "time_spent": {
    "hours": "1895",
    "minutes": 20
  }
}


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}};
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/requests/{request_id}/tasks/{task_id}/worklogs"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}}'@
$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/requests/{request_id}/tasks/{task_id}/worklogs"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "worklogs": [
    {
      "owner": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "mobile": "test-mobile",
        "id": "1712486082040001",
        "photo_url": "test-photo_url",
        "is_vip_user": false
      },
      "include_nonoperational_hours": false,
      "end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "description": "test-description",
      "other_charge": 1343434.4333,
      "total_charge": 1343434.4333,
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "mobile": "test-mobile",
        "id": "2194826265892475",
        "photo_url": "test-photo_url",
        "is_vip_user": false
      },
      "recorded_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "tech_charge": 1343434.4333,
      "time_spent": {
        "hours": 16800,
        "minutes": 54
      },
      "mark_first_response": false,
      "start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "worklog_type": {
        "name": "test-name",
        "id": "1510346242283071"
      },
      "id": "1647468155796426"
    }
  ]
}

Delete Request Task Worklog

This operation helps you Delete worklog for request task.

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/tasks/{task_id}/worklogs/{worklog_id}


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

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

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

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

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

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