<service domain|custom domain>/app/<portal>/api/v3/requests
Request
The numerous help desk tickets raised in your organization are organized and tracked in the Requests module. The Requests module enables you to handle tickets promptly, assign tickets to technicians, merge similar requests and so on.
Attributes
subject (string)
Subject of this request[Max-length : 250]
description (html)
Description of this request
impact_details (string)
Description about the impact of this request[Max-length : 250]
email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request
delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted
More Attributes Expand all
first_response_due_by_time (datetime)
Indicates the time at which the first response for this request is schedule
on_behalf_of (user)
Requesters can raise request on behalf of other users. This field denotes the user, on behalf of who the request has been raised
resolution (JSONObject)
A solution for the request, provided by the technician
show attribute
service_approvers (JSONObject)
The configured users will be added to the first stage of approval for the service request. It can be added only by Requesters.
show attribute
onhold_scheduler (JSONObject)
Contains the scheduling details for the request, when the request is in Onhold status
show attribute
scheduled_time (datetime)
Denotes the scheduled time for the onhold scheduler to change the Request’s status
change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed.
held_by (technician)
The technician who stopped the timer/who changed the status to OnHold of the Request
closure_info (JSONObject)
Contains the closure information when the request is in Closed status
show attribute
requester_ack_resolution (boolean)
Denotes if the requester has acknowledged the resolution he/she has been given.
requester_ack_comments (string)
Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]
closure_comments (string)
Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.
closure_code (closure_code)
Closure Codes are codes that denote the reason for closing a request(ticket)/change request, whether the request/change was closed due to completion, rejection, and so on
linked_to_request (JSONObject)
Holds linked request details
show attribute
request (request)
End user can raise a request when he find disruption of existing service offered to him or he can raise a request for a new service.
email_cc (string)read only
List of e-mail addresses(cc addresses) which receives the request through e-mail.
completed_by_denial (boolean)read only
Boolean which denotes whether the request is completed, when the request was denied
cancellation_requested (boolean)read only
Boolean which indicates whether the request is raised for cancelation by the requester
cancel_flag_comments (action_comment)read only
Information provided by the requester to cancel a request to the technician
total_cost (double)read only
Total Cost is the cumulative value of service cost and the cost of the individual resources selected
is_service_request (boolean)read only
Boolean value indicating whether this request is a service request or not
is_first_response_overdue (boolean)read only
Boolean value indicating whether this request is in overdue to make first response
is_escalated (boolean)read only
A boolean value which represents whether the request is escalated or not
notification_status (string)read only
Shows the current status of request’s replies, whether last one from requester or technician
approval_status (approval_status)read only
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)
assigned_time (datetime)read only
Indicates the time at which this request is assigned to a technician
has_attachments (boolean)read only
Boolean value indicating whether this request has any attachments or not
has_linked_requests (boolean)read only
Boolean value indicating whether this request has any linked requests or not
has_project (boolean)read only
Boolean value indicating whether this request is associated to a project or not
has_problem (boolean)read only
Boolean value indicating whether this request is associated to a problem or not
has_request_initiated_change (boolean)read only
Boolean value indicating whether this request is initiated a change or not
has_change_initiated_request (boolean)read only
Boolean to show whether there are requests which are initated by the change
has_purchase_orders (boolean)read only
Boolean value indicating whether this request is associated to Purchase Order(s)
Add Request
This operation is used to add a new request. Please note that is a mandatory filed.
Mandatory Fields :- subject
Url
Attributes
subject (string)
Subject of this request[Max-length : 250]
description (html)
Description of this request
impact_details (string)
Description about the impact of this request[Max-length : 250]
email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request
delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted
More Attributes Expand all
first_response_due_by_time (datetime)
Indicates the time at which the first response for this request is schedule
on_behalf_of (user)
Requesters can raise request on behalf of other users. This field denotes the user, on behalf of who the request has been raised
resolution (JSONObject)
A solution for the request, provided by the technician
show attribute
service_approvers (JSONObject)
The configured users will be added to the first stage of approval for the service request. It can be added only by Requesters.
show attribute
onhold_scheduler (JSONObject)
Contains the scheduling details for the request, when the request is in Onhold status
show attribute
scheduled_time (datetime)
Denotes the scheduled time for the onhold scheduler to change the Request’s status
change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed.
held_by (technician)
The technician who stopped the timer/who changed the status to OnHold of the Request
closure_info (JSONObject)
Contains the closure information when the request is in Closed status
show attribute
requester_ack_resolution (boolean)
Denotes if the requester has acknowledged the resolution he/she has been given.
requester_ack_comments (string)
Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]
closure_comments (string)
Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.
closure_code (closure_code)
Closure Codes are codes that denote the reason for closing a request(ticket)/change request, whether the request/change was closed due to completion, rejection, and so on
linked_to_request (JSONObject)
Holds linked request details
show attribute
request (request)
End user can raise a request when he find disruption of existing service offered to him or he can raise a request for a new service.
email_cc (string)read only
List of e-mail addresses(cc addresses) which receives the request through e-mail.
completed_by_denial (boolean)read only
Boolean which denotes whether the request is completed, when the request was denied
cancellation_requested (boolean)read only
Boolean which indicates whether the request is raised for cancelation by the requester
cancel_flag_comments (action_comment)read only
Information provided by the requester to cancel a request to the technician
total_cost (double)read only
Total Cost is the cumulative value of service cost and the cost of the individual resources selected
is_service_request (boolean)read only
Boolean value indicating whether this request is a service request or not
is_first_response_overdue (boolean)read only
Boolean value indicating whether this request is in overdue to make first response
is_escalated (boolean)read only
A boolean value which represents whether the request is escalated or not
notification_status (string)read only
Shows the current status of request’s replies, whether last one from requester or technician
approval_status (approval_status)read only
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)
assigned_time (datetime)read only
Indicates the time at which this request is assigned to a technician
has_attachments (boolean)read only
Boolean value indicating whether this request has any attachments or not
has_linked_requests (boolean)read only
Boolean value indicating whether this request has any linked requests or not
has_project (boolean)read only
Boolean value indicating whether this request is associated to a project or not
has_problem (boolean)read only
Boolean value indicating whether this request is associated to a problem or not
has_request_initiated_change (boolean)read only
Boolean value indicating whether this request is initiated a change or not
has_change_initiated_request (boolean)read only
Boolean to show whether there are requests which are initated by the change
has_purchase_orders (boolean)read only
Boolean value indicating whether this request is associated to Purchase Order(s)
$ curl <service domain|custom domain>/app/<portal>/api/v3/requests\
-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='{
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"editor": {
"email_id": "lincoln@zmail.com"
},
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"editor": {
"email_id": "lincoln@zmail.com"
},
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
}
}
};
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"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"editor": {
"email_id": "lincoln@zmail.com"
},
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
}
}
}
'@
$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"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"editor": {
"email_id": "lincoln@zmail.com"
},
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
}
}
}'''
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())
{
"request": {
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "1948726349434187"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "2044673193715195"
},
"assets": [
{
"name": "192.0.2.1",
"id": "2476215879232669",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "2045488344070845",
"name": "test-name",
"id": "1611839137508603"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "2290537481381500",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1646275022585519"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2374730939861945",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "2372339936802225"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1859958322770061"
},
"level": {
"name": "Tier 1",
"id": "2018182121337715"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1532347302595840",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"approval_status": {
"name": "Approved",
"id": "2383059912529037"
},
"impact": {
"name": "Affects Business",
"id": "1765848093928449"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "2329032013178322",
"sort_index": 7
},
"sla": {
"name": "High",
"duebyminutes": 21,
"id": "2267633716896305",
"duebyhours": false,
"duebydays": 41
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "1967268183361012"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2070790206912927",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2470322684475602"
},
"udf_boolean1": false,
"udf_long1": "2136851967326526",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1975292840863883"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "2204017819975726"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "2434907668683558"
},
"template": {
"is_service_template": false,
"name": "Raise a New Monitor Request",
"id": "2174353095375675"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Incident",
"id": "2147014131875404"
},
"display_id": "39",
"time_elapsed": "2371520029466911",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2104949385602485"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "2174353095375675",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "2190218995208715"
},
"is_reopened": false,
"editor_status": 27,
"editor": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2458320955274024",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "charles@zmail.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "2276596244154377",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "2222857346042280"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "4",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "test-path",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "1939084650493601",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "2411765802963298"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Edit Request
This operation is used to edit and update a request.
Url
<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}
Attributes
subject (string)
Subject of this request[Max-length : 250]
description (html)
Description of this request
impact_details (string)
Description about the impact of this request[Max-length : 250]
email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request
delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted
More Attributes Expand all
first_response_due_by_time (datetime)
Indicates the time at which the first response for this request is schedule
on_behalf_of (user)
Requesters can raise request on behalf of other users. This field denotes the user, on behalf of who the request has been raised
resolution (JSONObject)
A solution for the request, provided by the technician
show attribute
service_approvers (JSONObject)
The configured users will be added to the first stage of approval for the service request. It can be added only by Requesters.
show attribute
onhold_scheduler (JSONObject)
Contains the scheduling details for the request, when the request is in Onhold status
show attribute
scheduled_time (datetime)
Denotes the scheduled time for the onhold scheduler to change the Request’s status
change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed.
held_by (technician)
The technician who stopped the timer/who changed the status to OnHold of the Request
closure_info (JSONObject)
Contains the closure information when the request is in Closed status
show attribute
requester_ack_resolution (boolean)
Denotes if the requester has acknowledged the resolution he/she has been given.
requester_ack_comments (string)
Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]
closure_comments (string)
Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.
closure_code (closure_code)
Closure Codes are codes that denote the reason for closing a request(ticket)/change request, whether the request/change was closed due to completion, rejection, and so on
linked_to_request (JSONObject)
Holds linked request details
show attribute
request (request)
End user can raise a request when he find disruption of existing service offered to him or he can raise a request for a new service.
email_cc (string)read only
List of e-mail addresses(cc addresses) which receives the request through e-mail.
completed_by_denial (boolean)read only
Boolean which denotes whether the request is completed, when the request was denied
cancellation_requested (boolean)read only
Boolean which indicates whether the request is raised for cancelation by the requester
cancel_flag_comments (action_comment)read only
Information provided by the requester to cancel a request to the technician
total_cost (double)read only
Total Cost is the cumulative value of service cost and the cost of the individual resources selected
is_service_request (boolean)read only
Boolean value indicating whether this request is a service request or not
is_first_response_overdue (boolean)read only
Boolean value indicating whether this request is in overdue to make first response
is_escalated (boolean)read only
A boolean value which represents whether the request is escalated or not
notification_status (string)read only
Shows the current status of request’s replies, whether last one from requester or technician
approval_status (approval_status)read only
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)
assigned_time (datetime)read only
Indicates the time at which this request is assigned to a technician
has_attachments (boolean)read only
Boolean value indicating whether this request has any attachments or not
has_linked_requests (boolean)read only
Boolean value indicating whether this request has any linked requests or not
has_project (boolean)read only
Boolean value indicating whether this request is associated to a project or not
has_problem (boolean)read only
Boolean value indicating whether this request is associated to a problem or not
has_request_initiated_change (boolean)read only
Boolean value indicating whether this request is initiated a change or not
has_change_initiated_request (boolean)read only
Boolean to show whether there are requests which are initated by the change
has_purchase_orders (boolean)read only
Boolean value indicating whether this request is associated to Purchase Order(s)
$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_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='{
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
},
"update_reason": "The request is updated for this reason"
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
},
"update_reason": "The request is updated for this reason"
}
};
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}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
},
"update_reason": "The request is updated for this reason"
}
}
'@
$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}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"request": {
"subject": "Need an External Monitor",
"resolution": {
"content": "The following is the resolution to the above request"
},
"mode": {
"name": "E-Mail"
},
"assets": [
{
"name": "192.0.2.1"
}
],
"configuration_items": [
{
"name": "test-name"
}
],
"group": {
"name": "Hardware Problems"
},
"requester": {
"email_id": "lincoln@zmail.com"
},
"created_time": {
"value": "1478758440000"
},
"item": {
"name": "Install"
},
"level": {
"name": "Tier 1"
},
"impact": {
"name": "Affects Business"
},
"priority": {
"name": "High"
},
"first_response_due_by_time": {
"value": "1478758440000"
},
"udf_fields": {
"udf_ref1": {
"id": "100000000000036517"
},
"udf_boolean1": true,
"udf_long1": "100000",
"udf_date1": {
"value": "1478758440000"
},
"udf_double1": "1000.99",
"udf_char1": "test-udf_char1"
},
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader"
},
"status": {
"name": "Open"
},
"template": {
"name": "Raise a New Monitor Request"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"request_type": {
"name": "Service Request"
},
"description": "Provide me an External Monitor",
"urgency": {
"name": "Urgent"
},
"request_template_task_ids": [
{
"id": "2174353095375675"
}
],
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"technician": {
"email_id": "charles@zmail.com"
},
"due_by_time": {
"value": "1478758440000"
},
"site": {
"name": "Custom Site"
},
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3"
}
}
],
"users": [
{
"id": "100000000000036517"
}
]
},
"category": {
"name": "Software"
},
"update_reason": "The request is updated for this reason"
}
}'''
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())
{
"request": {
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "1514128723865219"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "1785800795078801"
},
"assets": [
{
"name": "192.0.2.1",
"id": "1579769602046877",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "1896705322349033",
"name": "test-name",
"id": "1817168032728604"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "1670208611727359",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "2032360473619919"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1603000856585323",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "2343864003562140"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1952646101420942"
},
"level": {
"name": "Tier 1",
"id": "2018427819162646"
},
"approval_status": {
"name": "Approved",
"id": "2002953393788937"
},
"impact": {
"name": "Affects Business",
"id": "2353086283418210"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "1802964913784450",
"sort_index": 32
},
"sla": {
"name": "High",
"duebyminutes": 39,
"id": "1913531130645398",
"duebyhours": false,
"duebydays": 23
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "1762189736746819"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1657374833669151",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2453311655210411"
},
"udf_boolean1": false,
"udf_long1": "1761306217498546",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1506122445145915"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "2013714640655749"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "1529533040741304"
},
"template": {
"is_service_template": false,
"name": "Raise a New Monitor Request",
"id": "1713884005690428"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Service Request",
"id": "1610739987445006"
},
"display_id": "39",
"time_elapsed": "2361304194073745",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2186221343430947"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "1790443846902208",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "2324165742600380"
},
"is_reopened": false,
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "charles@zmail.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "1506813999497311",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "1756317513872024"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "1",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "orgroles.udf_ref3",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "1687819002163120",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "1499545717195057"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Request
This operation is used to get information on a request
Url
<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}
Attributes
subject (string)
Subject of this request[Max-length : 250]
description (html)
Description of this request
impact_details (string)
Description about the impact of this request[Max-length : 250]
email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request
delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted
More Attributes Expand all
first_response_due_by_time (datetime)
Indicates the time at which the first response for this request is schedule
on_behalf_of (user)
Requesters can raise request on behalf of other users. This field denotes the user, on behalf of who the request has been raised
resolution (JSONObject)
A solution for the request, provided by the technician
show attribute
service_approvers (JSONObject)
The configured users will be added to the first stage of approval for the service request. It can be added only by Requesters.
show attribute
onhold_scheduler (JSONObject)
Contains the scheduling details for the request, when the request is in Onhold status
show attribute
scheduled_time (datetime)
Denotes the scheduled time for the onhold scheduler to change the Request’s status
change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed.
held_by (technician)
The technician who stopped the timer/who changed the status to OnHold of the Request
closure_info (JSONObject)
Contains the closure information when the request is in Closed status
show attribute
requester_ack_resolution (boolean)
Denotes if the requester has acknowledged the resolution he/she has been given.
requester_ack_comments (string)
Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]
closure_comments (string)
Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.
closure_code (closure_code)
Closure Codes are codes that denote the reason for closing a request(ticket)/change request, whether the request/change was closed due to completion, rejection, and so on
linked_to_request (JSONObject)
Holds linked request details
show attribute
request (request)
End user can raise a request when he find disruption of existing service offered to him or he can raise a request for a new service.
email_cc (string)read only
List of e-mail addresses(cc addresses) which receives the request through e-mail.
completed_by_denial (boolean)read only
Boolean which denotes whether the request is completed, when the request was denied
cancellation_requested (boolean)read only
Boolean which indicates whether the request is raised for cancelation by the requester
cancel_flag_comments (action_comment)read only
Information provided by the requester to cancel a request to the technician
total_cost (double)read only
Total Cost is the cumulative value of service cost and the cost of the individual resources selected
is_service_request (boolean)read only
Boolean value indicating whether this request is a service request or not
is_first_response_overdue (boolean)read only
Boolean value indicating whether this request is in overdue to make first response
is_escalated (boolean)read only
A boolean value which represents whether the request is escalated or not
notification_status (string)read only
Shows the current status of request’s replies, whether last one from requester or technician
approval_status (approval_status)read only
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)
assigned_time (datetime)read only
Indicates the time at which this request is assigned to a technician
has_attachments (boolean)read only
Boolean value indicating whether this request has any attachments or not
has_linked_requests (boolean)read only
Boolean value indicating whether this request has any linked requests or not
has_project (boolean)read only
Boolean value indicating whether this request is associated to a project or not
has_problem (boolean)read only
Boolean value indicating whether this request is associated to a problem or not
has_request_initiated_change (boolean)read only
Boolean value indicating whether this request is initiated a change or not
has_change_initiated_request (boolean)read only
Boolean to show whether there are requests which are initated by the change
has_purchase_orders (boolean)read only
Boolean value indicating whether this request is associated to Purchase Order(s)
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_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}";
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}"
$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}"
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())
{
"request": {
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "2443600536133958"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "1743175316536973"
},
"assets": [
{
"name": "192.0.2.1",
"id": "2306179315535136",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "2111060118891071",
"name": "test-name",
"id": "1612693499061190"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "1609986682753632",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1746894398691272"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1668875968147459",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "1606171185407131"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1592819115556702"
},
"level": {
"name": "Tier 1",
"id": "1712745572986935"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1643011318597068",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"approval_status": {
"name": "Approved",
"id": "1858180902915481"
},
"impact": {
"name": "Affects Business",
"id": "2380793715077504"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "2221187392556437",
"sort_index": 4
},
"sla": {
"name": "High",
"duebyminutes": 7,
"id": "2271209243231168",
"duebyhours": false,
"duebydays": 7
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "2122091410549622"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1702301804752558",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2077733248417746"
},
"udf_boolean1": false,
"udf_long1": "1669611083673063",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1707129139370826"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "1682460040207791"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "1963213494293406"
},
"template": {
"is_service_template": false,
"name": "Default Template",
"id": "1680069048077101"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Incident",
"id": "2365492162670803"
},
"display_id": "39",
"time_elapsed": "1705254959507821",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2092810721686973"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "2079888365956172",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "1598513718012730"
},
"is_reopened": false,
"editor_status": 11,
"editor": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1860301843414371",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_[\\d]+": {
"qstn_check_[\\d]+": [
{
"name": "test-name",
"id": "2040998211548801"
}
],
"qstn_text_[\\d]+": {
"value": "1478758440000"
},
"qstn_simple_[\\d]+": {
"name": "test-name",
"id": "2250224515939879"
},
"qstn_select_[\\d]+": {
"name": "test-name",
"id": "1522645667649958"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "test@test.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "1908721420032067",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "1883391796931265"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "2",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "test-path",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "2426105250004218",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "1657009934955796"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get List Request
This operation helps you to get all requests.
Url
<service domain|custom domain>/app/<portal>/api/v3/requests
Attributes
subject (string)
Subject of this request[Max-length : 250]
created_time (datetime)
Indicates the time at which this request is created
due_by_time (datetime)
Indicates the time at which this request is scheduled to be completed
scheduled_start_time (datetime)
Date and time at which the request is scheduled to start
scheduled_end_time (datetime)
Date and time at which the request is scheduled to end
More Attributes Expand all
on_behalf_of (user)
Requesters can raise request on behalf of other users. This field denotes the user, on behalf of who the request has been raised
cancellation_requested (boolean)read only
Boolean which indicates whether the request is raised for cancelation by the requester
cancel_flag_comments (action_comment)read only
Information provided by the requester to cancel a request to the technician
total_cost (double)read only
Total Cost is the cumulative value of service cost and the cost of the individual resources selected
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests\
-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";
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"
$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"
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,
"start_index":1,
"sort_field":"created_time",
"page":1,
"sort_order":"desc",
"row_count":3
},
"requests": [
{
"total_cost": "250",
"subject": "Need an External Monitor",
"cancellation_requested": false,
"id": "2079997951635005",
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1991067324577676"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2042966008743323",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "2242543726819414"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1902656482944435",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_notes": false,
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "2458124360347390"
},
"template": {
"is_service_template": false,
"name": "Default Template",
"id": "1859130656844078"
},
"display_id": "39",
"is_service_request": false,
"technician": {
"email_id": "test@test.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "1725613767796307",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"service_cost": "100"
}
]
}
Delete Request
This operation is used to delete a request which is no longer required.
Url
<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}
$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_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}";
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}"
$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}"
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"
}
}
Add Attachment To A Request
This operation helps you to Add attachment to a request. Here, the input must be given as multipart - form data.
Mandatory Fields :- filename
Url
<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads
Attributes
filename (FILE)
The path of the file to be uploaded must be given with ’@’ at the beginning of the path.
addtoattachment (BOOLEAN)
Denotes whether to add the file as an attachment to the associated entity.
files (FILES)
The details of the file is contained here.
show attribute
size (LONG)
The size of the file that is uploaded.
content_type (STRING)
The type of the content of the file.
file_id (LONG)
The file_id is used to add that file as an attachment to the entity
$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads\
-X POST\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: multipart/form-data"\
-F "filename=@local_file_path" -F "addtoattachment=true"\
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "multipart/form-data",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
file_list = List();
param1 = {"paramName":"filename", "content":"local_file_path"};
file_list.add(param1);
response = invokeurl
[
url: url
type: POST
headers: headers
files: file_list
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads"
$filePath = "local_file_path"
$addtoattachment = "true"
$boundary = [System.Guid]::NewGuid().ToString()
$headers = @{
"Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "multipart/form-data; boundary=`"$boundary`""
}
$content = [System.Text.Encoding]::GetEncoding('iso-8859-1').GetString([System.IO.File]::ReadAllBytes($filePath))
$body = (
"--$boundary",
"Content-Disposition: form-data; name=`"addtoattachment`"`r`n",
"$addtoattachment",
"--$boundary",
"Content-Disposition: form-data; name=`"filename`"; filename=`"$(Split-Path $filePath -Leaf)`"",
"Content-Type: $([System.Web.MimeMapping]::GetMimeMapping($filePath))`r`n",
$content,
"--$boundary--`r`n"
) -join "`r`n"
$response = Invoke-RestMethod -Uri $url -Method post -Headers $headers -Body $body
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import Request,urlopen
import mimetypes
import ntpath
import uuid
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads"
file_path = "local_file_path"
add_to_attachments = "true"
boundary = uuid.uuid4()
headers = {
"Content-Type": f"multipart/form-data; boundary={boundary}",
"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
}
with open(file_path, "rb") as f:
content = f.read()
body = (
bytes(f'--{boundary}\r\nContent-Disposition: form-data; name="addtoattachment"\r\n\r\n{add_to_attachments}\r\n', "utf-8")
+ bytes(f'--{boundary}\r\nContent-Disposition: form-data; name="filename"; filename="{ntpath.basename(file_path)}"\r\nContent-Type: {mimetypes.guess_type(file_path)[0] or "application/octet-stream"}\r\n\r\n', "utf-8")
+ content
+ bytes(f"\r\n--{boundary}--", "utf-8")
)
httprequest = Request(url, data=body, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode("utf-8"))
except HTTPError as e:
print(e.read().decode())
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"files": [
{
"content_type": "application/zip",
"size": "36171",
"file_id": "4001",
"name": "test_file.txt",
"content_url": "/requests/1234233323423432/_uploads/4001"
}
]
}