Skip to content

Change Worklog

This API helps you to track and record the work done by a team member. 

Attributes

id (long)
Indicates the unique ID of the Worklog

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

Example 

234759602834500

owner (user)
Indicates the owner for the worklog

owner (user)
Indicates the owner for the worklog

Example 

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

description (html)
Contains the 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)
Contains start date and time of the worklog as a JSON Object and 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)
Contains the end date and time of the worklog as a JSON Object and 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)
Contains the date and time of creation of the Worklog as a JSON Object and 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)

Indicates the extra charges other than the technician charges

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

Example 

23.08

tech_charge (double)

Indicates 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 mark response 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)

Indicates the different modes of technician’s work

worklog_type (worklog_type)
Indicates the different modes of technician’s work

Example 

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

created_by (user)read only

Indicates the user who created the worklog

created_by (user)
Indicates 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

Indicates the total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

Indicates the total time spent in the worklog in terms of hours, minutes and seconds

time_spent (timediff)

Add Change Worklog

This operation helps you to add a change worklog.

Mandatory Fields :- owner

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs

Attributes

id (long)
Indicates the unique ID of the Worklog

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

Example 

234759602834500

owner (user)
Indicates the owner for the worklog

owner (user)
Indicates the owner for the worklog

Example 

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

description (html)
Contains the 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)
Contains start date and time of the worklog as a JSON Object and 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)
Contains the end date and time of the worklog as a JSON Object and 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)
Contains the date and time of creation of the Worklog as a JSON Object and 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)

Indicates the extra charges other than the technician charges

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

Example 

23.08

tech_charge (double)

Indicates 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 mark response 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)

Indicates the different modes of technician’s work

worklog_type (worklog_type)
Indicates the different modes of technician’s work

Example 

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

created_by (user)read only

Indicates the user who created the worklog

created_by (user)
Indicates 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

Indicates the total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

Indicates the total time spent in the worklog in terms of hours, minutes and seconds

time_spent (timediff)

$ curl <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629877380000"
    },
    "end_time": {
      "value": "1629963827755"
    },
    "time_spent": {
      "hours": "24",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629877380000"
    },
    "end_time": {
      "value": "1629963827755"
    },
    "time_spent": {
      "hours": "24",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
};
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/changes/2000000033487/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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629877380000"
    },
    "end_time": {
      "value": "1629963827755"
    },
    "time_spent": {
      "hours": "24",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
}
'@
$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/changes/2000000033487/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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629877380000"
    },
    "end_time": {
      "value": "1629963827755"
    },
    "time_spent": {
      "hours": "24",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
}'''
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": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "cost_per_hour": "0.0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=13&ID=152&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "include_nonoperational_hours": true,
    "change_stage": null,
    "end_time": {
      "display_value": "Aug 26, 2021 01:13 PM",
      "value": "1629963780000"
    },
    "description": "",
    "other_charge": "0",
    "total_charge": "0",
    "created_by": {
      "email_id": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=1&ID=19&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "recorded_time": {
      "display_value": "Aug 26, 2021 01:14 PM",
      "value": "1629963847070"
    },
    "time_spent": {
      "hours": "24",
      "minutes": "00",
      "value": "86400000"
    },
    "tech_charge": "0",
    "start_time": {
      "display_value": "Aug 25, 2021 01:13 PM",
      "value": "1629877380000"
    },
    "worklog_type": null,
    "id": "2000000033570"
  }
}

Edit Change Worklog

This operation helps you to update a change worklog.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570

Attributes

id (long)
Indicates the unique ID of the Worklog

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

Example 

234759602834500

owner (user)
Indicates the owner for the worklog

owner (user)
Indicates the owner for the worklog

Example 

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

description (html)
Contains the 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)
Contains start date and time of the worklog as a JSON Object and 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)
Contains the end date and time of the worklog as a JSON Object and 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)
Contains the date and time of creation of the Worklog as a JSON Object and 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)

Indicates the extra charges other than the technician charges

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

Example 

23.08

tech_charge (double)

Indicates 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 mark response 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)

Indicates the different modes of technician’s work

worklog_type (worklog_type)
Indicates the different modes of technician’s work

Example 

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

created_by (user)read only

Indicates the user who created the worklog

created_by (user)
Indicates 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

Indicates the total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

Indicates the total time spent in the worklog in terms of hours, minutes and seconds

time_spent (timediff)

$ curl <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570\
      -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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629790980000"
    },
    "end_time": {
      "value": "1629963780000"
    },
    "time_spent": {
      "hours": "48",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570";
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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629790980000"
    },
    "end_time": {
      "value": "1629963780000"
    },
    "time_spent": {
      "hours": "48",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
};
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/changes/2000000033487/worklogs/2000000033570"
$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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629790980000"
    },
    "end_time": {
      "value": "1629963780000"
    },
    "time_spent": {
      "hours": "48",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
}
'@
$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/changes/2000000033487/worklogs/2000000033570"
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": {
      "id": "2000000033133"
    },
    "description": "",
    "start_time": {
      "value": "1629790980000"
    },
    "end_time": {
      "value": "1629963780000"
    },
    "time_spent": {
      "hours": "48",
      "minutes": "0"
    },
    "tech_charge": "0.00",
    "other_charge": "0",
    "worklog_type": null,
    "include_nonoperational_hours": true,
    "mark_first_response": false
  }
}'''
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": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "cost_per_hour": "0.0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=18&ID=7512&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "include_nonoperational_hours": true,
    "change_stage": null,
    "end_time": {
      "display_value": "Aug 26, 2021 01:13 PM",
      "value": "1629963780000"
    },
    "description": "",
    "other_charge": "0",
    "total_charge": "0",
    "created_by": {
      "email_id": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=14&ID=112&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "recorded_time": {
      "display_value": "Aug 26, 2021 01:14 PM",
      "value": "1629963847070"
    },
    "time_spent": {
      "hours": "48",
      "minutes": "00",
      "value": "172800000"
    },
    "tech_charge": "0",
    "start_time": {
      "display_value": "Aug 24, 2021 01:13 PM",
      "value": "1629790980000"
    },
    "worklog_type": null,
    "id": "2000000033570"
  }
}

Get Change Worklog

This operation helps you to get a change worklog.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570

Attributes

id (long)
Indicates the unique ID of the Worklog

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

Example 

234759602834500

owner (user)
Indicates the owner for the worklog

owner (user)
Indicates the owner for the worklog

Example 

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

description (html)
Contains the 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)
Contains start date and time of the worklog as a JSON Object and 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)
Contains the end date and time of the worklog as a JSON Object and 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)
Contains the date and time of creation of the Worklog as a JSON Object and 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)

Indicates the extra charges other than the technician charges

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

Example 

23.08

tech_charge (double)

Indicates 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 mark response 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)

Indicates the different modes of technician’s work

worklog_type (worklog_type)
Indicates the different modes of technician’s work

Example 

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

created_by (user)read only

Indicates the user who created the worklog

created_by (user)
Indicates 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

Indicates the total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

Indicates the total time spent in the worklog in terms of hours, minutes and seconds

time_spent (timediff)

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570\
      -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/changes/2000000033487/worklogs/2000000033570";
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/changes/2000000033487/worklogs/2000000033570"
$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/changes/2000000033487/worklogs/2000000033570"
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": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "cost_per_hour": "0.0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=10&ID=1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "include_nonoperational_hours": true,
    "change_stage": null,
    "end_time": {
      "display_value": "Aug 26, 2021 01:13 PM",
      "value": "1629963780000"
    },
    "description": "",
    "other_charge": "0",
    "total_charge": "0",
    "created_by": {
      "email_id": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=10&ID=12&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "recorded_time": {
      "display_value": "Aug 26, 2021 01:14 PM",
      "value": "1629963847070"
    },
    "time_spent": {
      "hours": "24",
      "minutes": "00",
      "value": "86400000"
    },
    "tech_charge": "0",
    "start_time": {
      "display_value": "Aug 25, 2021 01:13 PM",
      "value": "1629877380000"
    },
    "worklog_type": null,
    "id": "2000000033570"
  }
}

Get List Change Worklog

This operation helps you to Get all change worklogs.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs

Attributes

id (long)
Indicates the unique ID of the Worklog

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

Example 

234759602834500

owner (user)
Indicates the owner for the worklog

owner (user)
Indicates the owner for the worklog

Example 

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

description (html)
Contains the 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)
Contains start date and time of the worklog as a JSON Object and 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)
Contains the end date and time of the worklog as a JSON Object and 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)
Contains the date and time of creation of the Worklog as a JSON Object and 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)

Indicates the extra charges other than the technician charges

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

Example 

23.08

tech_charge (double)

Indicates 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 mark response 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)

Indicates the different modes of technician’s work

worklog_type (worklog_type)
Indicates the different modes of technician’s work

Example 

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

created_by (user)read only

Indicates the user who created the worklog

created_by (user)
Indicates 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

Indicates the total charges related to the worklog

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

Example 

23.08

time_spent (timediff)

Indicates the total time spent in the worklog in terms of hours, minutes and seconds

time_spent (timediff)

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/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='{}'

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

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

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

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

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 2
  },
  "worklogs": [
    {
      "owner": {
        "email_id": "ad-360@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "",
        "user_scope": "0",
        "phone": null,
        "name": "Bruce",
        "id": "2000000033133",
        "photo_url": "https://contacts.zykler.com/file?exp=10&ID=1512&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "Bruce",
        "job_title": null
      },
      "include_nonoperational_hours": true,
      "change_stage": {
        "internal_name": "submission",
        "stage_index": 1,
        "name": "Submission",
        "id": "2000000026641"
      },
      "end_time": {
        "display_value": "Aug 26, 2021 01:38 PM",
        "value": "1629965308847"
      },
      "description": "",
      "other_charge": "0",
      "total_charge": "0",
      "created_by": {
        "email_id": "ad-360@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "",
        "user_scope": "0",
        "phone": null,
        "name": "Bruce",
        "id": "2000000033133",
        "photo_url": "https://contacts.zylker.com/file?exp=10&ID=1512&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "Bruce",
        "job_title": null
      },
      "recorded_time": {
        "display_value": "Aug 26, 2021 01:38 PM",
        "value": "1629965313798"
      },
      "time_spent": {
        "hours": "06",
        "minutes": "00",
        "value": "21600000"
      },
      "tech_charge": "0",
      "start_time": {
        "display_value": "Aug 26, 2021 07:38 AM",
        "value": "1629943708847"
      },
      "worklog_type": null,
      "id": "2000000033649"
    },
    {
      "owner": {
        "email_id": "ad-360@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "",
        "user_scope": "0",
        "phone": null,
        "name": "Bruce",
        "id": "2000000033133",
        "photo_url": "https://contacts.zylker.com/file?exp=10&ID=7512&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "Bruce",
        "job_title": null
      },
      "include_nonoperational_hours": true,
      "change_stage": null,
      "end_time": {
        "display_value": "Aug 26, 2021 01:39 PM",
        "value": "1629965349110"
      },
      "description": "",
      "other_charge": "0",
      "total_charge": "0",
      "created_by": {
        "email_id": "ad-360@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "",
        "user_scope": "0",
        "phone": null,
        "name": "Bruce",
        "id": "2000000033133",
        "photo_url": "https://contacts.zylker.com/file?exp=10&ID=112&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "Bruce",
        "job_title": null
      },
      "recorded_time": {
        "display_value": "Aug 26, 2021 01:39 PM",
        "value": "1629965354733"
      },
      "time_spent": {
        "hours": "04",
        "minutes": "00",
        "value": "14400000"
      },
      "tech_charge": "0",
      "start_time": {
        "display_value": "Aug 26, 2021 09:39 AM",
        "value": "1629950949110"
      },
      "worklog_type": null,
      "id": "2000000033661"
    }
  ]
}

Delete Change Worklog

This operation helps you to delete a change worklog.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570


$ curl <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/worklogs/2000000033570\
      -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/changes/2000000033487/worklogs/2000000033570";
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/changes/2000000033487/worklogs/2000000033570"
$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/changes/2000000033487/worklogs/2000000033570"
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"
  }
}