Skip to content

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

id (long)
Id of this request

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

Example 

234759602834500

subject (string)
Subject of this request[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this request

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

Example 

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

impact_details (string)
Description about the impact of this request[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request

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

Example 

abc.gmail.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

update_reason (string)

Reason to update the request[Max characters: 250]

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

Example 

Sample Content

created_time (datetime)

Indicates the time at which this request is created

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

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

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

due_by_time (datetime)

Indicates the time at which this request is scheduled to be completed

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

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

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is schedule

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

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

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

is_fcr (boolean)

Boolean value indicating if the request has been marked as First Call Resolution

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

status_change_comments (string)

The reason why the status is changed

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

Example 

Sample Content

scheduled_start_time (datetime)

Date and time at which the request is scheduled to start

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

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

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

scheduled_end_time (datetime)

Date and time at which the request is scheduled to end

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

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

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

impact (impact)

Impact of this request

impact (impact)
Indicates the impact of the request

Example 

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

status (status)

Indicates the current status of this request

status (status)
Indicates the current status of the request

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

Indicates the requester of this request

requester (user)
Indicates the requester of the request

Example 

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

mode (mode)

The mode in which this request is created

mode (mode)
The Mode in which the request is created.

Example 

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

site (site)

Denotes the site to which this request belongs

site (site)
Denotes the site to which this request belongs

Example 

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

template (request_template)

Indicates the template which is used to create this request

template (request_template)
Indicates the template which is used to create the request

Example 

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

sla (sla)

SLA details associated with this request

sla (sla)
Denotes SLA details associated with the request

Example 

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

service_category (service_category)

Service category to which this request belongs

service_category (service_category)
Service category to which this request belongs

Example 

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

group (group)

The group to which the request is assigned to

group (group)
Denotes the group to which the request belongs

Example 

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

technician (technician)

Technician assigned to this request

technician (technician)
Indicates the technician assigned to the request

Example 

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

priority (priority)

Priority of the request

priority (priority)
Indicates the priority of the request

Example 

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

level (level)

Level of the request

level (level)
Indicates the level of the request

Example 

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

category (category)

Category to which the request belongs

category (category)
Indicates the category to which the request belongs

Example 

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

subcategory (subcategory)

Subcategory to which the request belongs

subcategory (subcategory)
Subcategory to which the request belongs

Example 

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

item (item)

Item of the request

item (item)
Item of the request.

Example 

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

urgency (urgency)

Urgency of the request

urgency (urgency)
Denotes the urgency of the request

Example 

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

request_type (request_type)

Type of the request

request_type (request_type)
Indicates the type of the request

Example 

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

assets (asset)

Array of asset objects associated to this request

assets (asset)
Array of asset objects associated to the request.

Example 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the request

udf_fields (udf_fields)
Holds user defined fields’ values associated with the request

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

attachments (request_attachment)

Files that are attached to the request.

attachments (request_attachment)
Files that are attached to the request. Maximum of 50 attachments can be attached to a request.

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

Holds the resource data mapped to the request

resources (resources)
Denotes the resource data that is mapped to the request.

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "Dell Latitude E7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBook Air",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

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

on_behalf_of (user)
 This field denotes the user, on whose behalf the request is raised

Example 

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

configuration_items (configuration_item)

Critical Items for which the request has been raised

configuration_items (configuration_item)

Example 

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

editor (user)

The user who is configured as the Editor of the request

editor (user)
Indicates the editor of the request

Example 

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

resolution (JSONObject)

A solution for the request, provided by the technician
show attribute

resolution (JSONObject)
Contains the resolution details of the request.

Example 

{
  "resolution": {
    "content": "Resolution content"
  }
}

content (html)

Resolution content provided by the technician to resolve this request.

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

Example 

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

submitted_by (user)

No Description

submitted_by (user)

Example 

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

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

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

Example 

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

users (user)

The users who are configured as service approvers for the request

users (user)

Example 

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

onhold_scheduler (JSONObject)

Contains the scheduling details for the request, when the request is in Onhold status
show attribute

onhold_scheduler (JSONObject)
Contains onhold scheduling details.

Example 

{
  "onhold_scheduler": {
    "comments": "Reasons for Onhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan 5, 2018 01:16 PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time (datetime)

Denotes the scheduled time for the onhold scheduler to change the Request’s status

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

comments (string)

Comments added for linking requests[Max-length : 250]

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

Example 

Sample Content

change_to_status (status)

Status object to which the request is scheduled to move to, after the onhold scheduler is completed.

change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed

Example 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

The technician who stopped the timer/who changed the status to OnHold of the Request

held_by (technician)
User object of the user who put the request onhold.

Example 

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

closure_info (JSONObject)

Contains the closure information when the request is in Closed status
show attribute

closure_info (JSONObject)
Contains closure info of the request.

Example 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledged comments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution (boolean)

Denotes if the requester has acknowledged the resolution he/she has been given.

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]

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

Example 

Sample Content

closure_comments (string)

Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.

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

Example 

Sample Content

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

closure_code (closure_code)
Closure Code denotes the reason for closing a request.

Example 

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

linked_to_request (JSONObject)

Holds linked request details
show attribute

linked_to_request (JSONObject)

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.

request (request)
Holds linked request details.

Example 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed (long)read only

Indicates the time spent on this request

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

Example 

234759602834500

email_cc (string)read only

List of e-mail addresses(cc addresses) which receives the request through e-mail.

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

Example 

abc.gmail.com

email_to (string)read only

List of email addresses(to addresses) while receiving the request

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

Example 

abc.gmail.com

email_bcc (string)read only

List of email addresses(bcc addresses) which receives the request

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

Example 

abc.gmail.com

completed_by_denial (boolean)read only

Boolean which denotes whether the request is completed, when the request was denied

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

cancellation_requested (boolean)read only

Boolean which indicates whether the request is raised for cancelation by the requester

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

cancel_flag_comments (action_comment)read only

Information provided by the requester to cancel a request to the technician

cancel_flag_comments (action_comment)
Information provided by the requester to cancel a request to the technician

Example 

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

display_id (long)read only

Display id of this request

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

Example 

234759602834500

created_by (user)read only

Indicates the requester who created this request

created_by (user)
Indicates the user who created this request

Example 

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

responded_time (datetime)read only

Indicates the time at which this request is responded

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

completed_time (datetime)read only

Indicates the time at which this request is completed

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

department (department)read only

Department to which this requester belongs

department (department)
Department to which this requester belongs

Example 

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

deleted_time (datetime)read only

Denotes the time at which the request will be deleted

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

service_cost (double)read only

Basic cost for the service which we are requesting

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

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

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

Example 

23.08

lifecycle (lifecycle)read only

Lifecycle associated with this request

lifecycle (lifecycle)

Example 

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

is_service_request (boolean)read only

Boolean value indicating whether this request is a service request or not

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

resolved_time (datetime)read only

Indicates the time at which this request is resolved

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

last_updated_time (datetime)read only

Indicates the time when this request is last updated

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

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue

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

is_first_response_overdue (boolean)read only

Boolean value indicating whether this request is in overdue to make first response

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

is_escalated (boolean)read only

A boolean value which represents whether the request is escalated or not

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

is_read (boolean)read only

Boolean value indicating whether this request’s replies are read or not

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

notification_status (string)read only

Shows the current status of request’s replies, whether last one from requester or technician

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

Example 

Sample Content

approval_status (approval_status)read only

Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

approval_status (approval_status)
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

Example 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time (datetime)read only

Indicates the time at which this request is assigned to a technician

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

deleted_assets (string)read only

The assets that are disassociated from this request

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

Example 

Sample Content

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not

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

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not

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

has_linked_requests (boolean)read only

Boolean value indicating whether this request has any linked requests or not

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

has_project (boolean)read only

Boolean value indicating whether this request is associated to a project or not

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

has_problem (boolean)read only

Boolean value indicating whether this request is associated to a problem or not

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

has_request_initiated_change (boolean)read only

Boolean value indicating whether this request is initiated a change or not

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

has_change_initiated_request (boolean)read only

Boolean to show whether there are requests which are initated by the change

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

has_purchase_orders (boolean)read only

Boolean value indicating whether this request is associated to Purchase Order(s)

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not

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

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not

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

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash

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

unreplied_count (long)read only

The number of requester replies for which the technician haven’t replied yet

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

Example 

234759602834500

editor_status (int)read only

The status of the Editor’s review/update

editor_status (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

Add Request

This operation is used to add a new request. Please note that is a mandatory filed.

Mandatory Fields :- subject

Url

<service domain|custom domain>/app/<portal>/api/v3/requests

Attributes

id (long)
Id of this request

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

Example 

234759602834500

subject (string)
Subject of this request[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this request

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

Example 

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

impact_details (string)
Description about the impact of this request[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request

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

Example 

abc.gmail.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

created_time (datetime)

Indicates the time at which this request is created

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

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

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

due_by_time (datetime)

Indicates the time at which this request is scheduled to be completed

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

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

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is schedule

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

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

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

is_fcr (boolean)

Boolean value indicating if the request has been marked as First Call Resolution

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

status_change_comments (string)

The reason why the status is changed

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

Example 

Sample Content

scheduled_start_time (datetime)

Date and time at which the request is scheduled to start

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

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

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

scheduled_end_time (datetime)

Date and time at which the request is scheduled to end

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

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

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

impact (impact)

Impact of this request

impact (impact)
Indicates the impact of the request

Example 

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

status (status)

Indicates the current status of this request

status (status)
Indicates the current status of the request

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

Indicates the requester of this request

requester (user)
Indicates the requester of the request

Example 

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

mode (mode)

The mode in which this request is created

mode (mode)
The Mode in which the request is created.

Example 

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

site (site)

Denotes the site to which this request belongs

site (site)
Denotes the site to which this request belongs

Example 

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

template (request_template)

Indicates the template which is used to create this request

template (request_template)
Indicates the template which is used to create the request

Example 

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

sla (sla)

SLA details associated with this request

sla (sla)
Denotes SLA details associated with the request

Example 

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

service_category (service_category)

Service category to which this request belongs

service_category (service_category)
Service category to which this request belongs

Example 

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

group (group)

The group to which the request is assigned to

group (group)
Denotes the group to which the request belongs

Example 

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

technician (technician)

Technician assigned to this request

technician (technician)
Indicates the technician assigned to the request

Example 

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

priority (priority)

Priority of the request

priority (priority)
Indicates the priority of the request

Example 

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

level (level)

Level of the request

level (level)
Indicates the level of the request

Example 

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

category (category)

Category to which the request belongs

category (category)
Indicates the category to which the request belongs

Example 

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

subcategory (subcategory)

Subcategory to which the request belongs

subcategory (subcategory)
Subcategory to which the request belongs

Example 

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

item (item)

Item of the request

item (item)
Item of the request.

Example 

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

urgency (urgency)

Urgency of the request

urgency (urgency)
Denotes the urgency of the request

Example 

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

request_type (request_type)

Type of the request

request_type (request_type)
Indicates the type of the request

Example 

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

assets (asset)

Array of asset objects associated to this request

assets (asset)
Array of asset objects associated to the request.

Example 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the request

udf_fields (udf_fields)
Holds user defined fields’ values associated with the request

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

attachments (request_attachment)

Files that are attached to the request.

attachments (request_attachment)
Files that are attached to the request. Maximum of 50 attachments can be attached to a request.

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

Holds the resource data mapped to the request

resources (resources)
Denotes the resource data that is mapped to the request.

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "Dell Latitude E7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBook Air",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

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

on_behalf_of (user)
 This field denotes the user, on whose behalf the request is raised

Example 

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

configuration_items (configuration_item)

Critical Items for which the request has been raised

configuration_items (configuration_item)

Example 

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

editor (user)

The user who is configured as the Editor of the request

editor (user)
Indicates the editor of the request

Example 

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

resolution (JSONObject)

A solution for the request, provided by the technician
show attribute

resolution (JSONObject)
Contains the resolution details of the request.

Example 

{
  "resolution": {
    "content": "Resolution content"
  }
}

content (html)

Resolution content provided by the technician to resolve this request.

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

Example 

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

submitted_by (user)

No Description

submitted_by (user)

Example 

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

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

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

Example 

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

users (user)

The users who are configured as service approvers for the request

users (user)

Example 

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

onhold_scheduler (JSONObject)

Contains the scheduling details for the request, when the request is in Onhold status
show attribute

onhold_scheduler (JSONObject)
Contains onhold scheduling details.

Example 

{
  "onhold_scheduler": {
    "comments": "Reasons for Onhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan 5, 2018 01:16 PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time (datetime)

Denotes the scheduled time for the onhold scheduler to change the Request’s status

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

comments (string)

Comments added for linking requests[Max-length : 250]

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

Example 

Sample Content

change_to_status (status)

Status object to which the request is scheduled to move to, after the onhold scheduler is completed.

change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed

Example 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

The technician who stopped the timer/who changed the status to OnHold of the Request

held_by (technician)
User object of the user who put the request onhold.

Example 

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

closure_info (JSONObject)

Contains the closure information when the request is in Closed status
show attribute

closure_info (JSONObject)
Contains closure info of the request.

Example 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledged comments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution (boolean)

Denotes if the requester has acknowledged the resolution he/she has been given.

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]

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

Example 

Sample Content

closure_comments (string)

Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.

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

Example 

Sample Content

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

closure_code (closure_code)
Closure Code denotes the reason for closing a request.

Example 

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

linked_to_request (JSONObject)

Holds linked request details
show attribute

linked_to_request (JSONObject)

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.

request (request)
Holds linked request details.

Example 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed (long)read only

Indicates the time spent on this request

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

Example 

234759602834500

email_cc (string)read only

List of e-mail addresses(cc addresses) which receives the request through e-mail.

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

Example 

abc.gmail.com

email_to (string)read only

List of email addresses(to addresses) while receiving the request

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

Example 

abc.gmail.com

email_bcc (string)read only

List of email addresses(bcc addresses) which receives the request

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

Example 

abc.gmail.com

completed_by_denial (boolean)read only

Boolean which denotes whether the request is completed, when the request was denied

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

cancellation_requested (boolean)read only

Boolean which indicates whether the request is raised for cancelation by the requester

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

cancel_flag_comments (action_comment)read only

Information provided by the requester to cancel a request to the technician

cancel_flag_comments (action_comment)
Information provided by the requester to cancel a request to the technician

Example 

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

display_id (long)read only

Display id of this request

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

Example 

234759602834500

created_by (user)read only

Indicates the requester who created this request

created_by (user)
Indicates the user who created this request

Example 

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

responded_time (datetime)read only

Indicates the time at which this request is responded

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

completed_time (datetime)read only

Indicates the time at which this request is completed

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

department (department)read only

Department to which this requester belongs

department (department)
Department to which this requester belongs

Example 

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

deleted_time (datetime)read only

Denotes the time at which the request will be deleted

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

service_cost (double)read only

Basic cost for the service which we are requesting

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

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

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

Example 

23.08

lifecycle (lifecycle)read only

Lifecycle associated with this request

lifecycle (lifecycle)

Example 

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

is_service_request (boolean)read only

Boolean value indicating whether this request is a service request or not

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

resolved_time (datetime)read only

Indicates the time at which this request is resolved

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

last_updated_time (datetime)read only

Indicates the time when this request is last updated

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

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue

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

is_first_response_overdue (boolean)read only

Boolean value indicating whether this request is in overdue to make first response

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

is_escalated (boolean)read only

A boolean value which represents whether the request is escalated or not

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

is_read (boolean)read only

Boolean value indicating whether this request’s replies are read or not

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

notification_status (string)read only

Shows the current status of request’s replies, whether last one from requester or technician

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

Example 

Sample Content

approval_status (approval_status)read only

Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

approval_status (approval_status)
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

Example 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time (datetime)read only

Indicates the time at which this request is assigned to a technician

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

deleted_assets (string)read only

The assets that are disassociated from this request

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

Example 

Sample Content

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not

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

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not

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

has_linked_requests (boolean)read only

Boolean value indicating whether this request has any linked requests or not

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

has_project (boolean)read only

Boolean value indicating whether this request is associated to a project or not

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

has_problem (boolean)read only

Boolean value indicating whether this request is associated to a problem or not

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

has_request_initiated_change (boolean)read only

Boolean value indicating whether this request is initiated a change or not

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

has_change_initiated_request (boolean)read only

Boolean to show whether there are requests which are initated by the change

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

has_purchase_orders (boolean)read only

Boolean value indicating whether this request is associated to Purchase Order(s)

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not

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

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not

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

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash

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

unreplied_count (long)read only

The number of requester replies for which the technician haven’t replied yet

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

Example 

234759602834500

editor_status (int)read only

The status of the Editor’s review/update

editor_status (int)
Numerical digits which are considered to have smaller numbers.

Example 

39


$ 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

id (long)
Id of this request

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

Example 

234759602834500

subject (string)
Subject of this request[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this request

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

Example 

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

impact_details (string)
Description about the impact of this request[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request

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

Example 

abc.gmail.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

update_reason (string)

Reason to update the request[Max characters: 250]

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

Example 

Sample Content

created_time (datetime)

Indicates the time at which this request is created

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

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

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

due_by_time (datetime)

Indicates the time at which this request is scheduled to be completed

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

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

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is schedule

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

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

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

is_fcr (boolean)

Boolean value indicating if the request has been marked as First Call Resolution

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

status_change_comments (string)

The reason why the status is changed

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

Example 

Sample Content

scheduled_start_time (datetime)

Date and time at which the request is scheduled to start

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

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

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

scheduled_end_time (datetime)

Date and time at which the request is scheduled to end

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

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

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

impact (impact)

Impact of this request

impact (impact)
Indicates the impact of the request

Example 

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

status (status)

Indicates the current status of this request

status (status)
Indicates the current status of the request

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

Indicates the requester of this request

requester (user)
Indicates the requester of the request

Example 

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

mode (mode)

The mode in which this request is created

mode (mode)
The Mode in which the request is created.

Example 

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

site (site)

Denotes the site to which this request belongs

site (site)
Denotes the site to which this request belongs

Example 

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

template (request_template)

Indicates the template which is used to create this request

template (request_template)
Indicates the template which is used to create the request

Example 

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

sla (sla)

SLA details associated with this request

sla (sla)
Denotes SLA details associated with the request

Example 

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

service_category (service_category)

Service category to which this request belongs

service_category (service_category)
Service category to which this request belongs

Example 

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

group (group)

The group to which the request is assigned to

group (group)
Denotes the group to which the request belongs

Example 

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

technician (technician)

Technician assigned to this request

technician (technician)
Indicates the technician assigned to the request

Example 

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

priority (priority)

Priority of the request

priority (priority)
Indicates the priority of the request

Example 

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

level (level)

Level of the request

level (level)
Indicates the level of the request

Example 

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

category (category)

Category to which the request belongs

category (category)
Indicates the category to which the request belongs

Example 

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

subcategory (subcategory)

Subcategory to which the request belongs

subcategory (subcategory)
Subcategory to which the request belongs

Example 

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

item (item)

Item of the request

item (item)
Item of the request.

Example 

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

urgency (urgency)

Urgency of the request

urgency (urgency)
Denotes the urgency of the request

Example 

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

request_type (request_type)

Type of the request

request_type (request_type)
Indicates the type of the request

Example 

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

assets (asset)

Array of asset objects associated to this request

assets (asset)
Array of asset objects associated to the request.

Example 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the request

udf_fields (udf_fields)
Holds user defined fields’ values associated with the request

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

attachments (request_attachment)

Files that are attached to the request.

attachments (request_attachment)
Files that are attached to the request. Maximum of 50 attachments can be attached to a request.

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

Holds the resource data mapped to the request

resources (resources)
Denotes the resource data that is mapped to the request.

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "Dell Latitude E7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBook Air",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

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

on_behalf_of (user)
 This field denotes the user, on whose behalf the request is raised

Example 

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

configuration_items (configuration_item)

Critical Items for which the request has been raised

configuration_items (configuration_item)

Example 

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

editor (user)

The user who is configured as the Editor of the request

editor (user)
Indicates the editor of the request

Example 

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

resolution (JSONObject)

A solution for the request, provided by the technician
show attribute

resolution (JSONObject)
Contains the resolution details of the request.

Example 

{
  "resolution": {
    "content": "Resolution content"
  }
}

content (html)

Resolution content provided by the technician to resolve this request.

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

Example 

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

submitted_by (user)

No Description

submitted_by (user)

Example 

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

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

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

Example 

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

users (user)

The users who are configured as service approvers for the request

users (user)

Example 

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

onhold_scheduler (JSONObject)

Contains the scheduling details for the request, when the request is in Onhold status
show attribute

onhold_scheduler (JSONObject)
Contains onhold scheduling details.

Example 

{
  "onhold_scheduler": {
    "comments": "Reasons for Onhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan 5, 2018 01:16 PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time (datetime)

Denotes the scheduled time for the onhold scheduler to change the Request’s status

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

comments (string)

Comments added for linking requests[Max-length : 250]

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

Example 

Sample Content

change_to_status (status)

Status object to which the request is scheduled to move to, after the onhold scheduler is completed.

change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed

Example 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

The technician who stopped the timer/who changed the status to OnHold of the Request

held_by (technician)
User object of the user who put the request onhold.

Example 

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

closure_info (JSONObject)

Contains the closure information when the request is in Closed status
show attribute

closure_info (JSONObject)
Contains closure info of the request.

Example 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledged comments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution (boolean)

Denotes if the requester has acknowledged the resolution he/she has been given.

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]

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

Example 

Sample Content

closure_comments (string)

Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.

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

Example 

Sample Content

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

closure_code (closure_code)
Closure Code denotes the reason for closing a request.

Example 

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

linked_to_request (JSONObject)

Holds linked request details
show attribute

linked_to_request (JSONObject)

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.

request (request)
Holds linked request details.

Example 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed (long)read only

Indicates the time spent on this request

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

Example 

234759602834500

email_cc (string)read only

List of e-mail addresses(cc addresses) which receives the request through e-mail.

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

Example 

abc.gmail.com

email_to (string)read only

List of email addresses(to addresses) while receiving the request

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

Example 

abc.gmail.com

email_bcc (string)read only

List of email addresses(bcc addresses) which receives the request

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

Example 

abc.gmail.com

completed_by_denial (boolean)read only

Boolean which denotes whether the request is completed, when the request was denied

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

cancellation_requested (boolean)read only

Boolean which indicates whether the request is raised for cancelation by the requester

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

cancel_flag_comments (action_comment)read only

Information provided by the requester to cancel a request to the technician

cancel_flag_comments (action_comment)
Information provided by the requester to cancel a request to the technician

Example 

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

display_id (long)read only

Display id of this request

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

Example 

234759602834500

created_by (user)read only

Indicates the requester who created this request

created_by (user)
Indicates the user who created this request

Example 

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

responded_time (datetime)read only

Indicates the time at which this request is responded

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

completed_time (datetime)read only

Indicates the time at which this request is completed

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

department (department)read only

Department to which this requester belongs

department (department)
Department to which this requester belongs

Example 

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

deleted_time (datetime)read only

Denotes the time at which the request will be deleted

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

service_cost (double)read only

Basic cost for the service which we are requesting

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

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

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

Example 

23.08

lifecycle (lifecycle)read only

Lifecycle associated with this request

lifecycle (lifecycle)

Example 

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

is_service_request (boolean)read only

Boolean value indicating whether this request is a service request or not

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

resolved_time (datetime)read only

Indicates the time at which this request is resolved

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

last_updated_time (datetime)read only

Indicates the time when this request is last updated

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

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue

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

is_first_response_overdue (boolean)read only

Boolean value indicating whether this request is in overdue to make first response

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

is_escalated (boolean)read only

A boolean value which represents whether the request is escalated or not

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

is_read (boolean)read only

Boolean value indicating whether this request’s replies are read or not

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

notification_status (string)read only

Shows the current status of request’s replies, whether last one from requester or technician

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

Example 

Sample Content

approval_status (approval_status)read only

Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

approval_status (approval_status)
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

Example 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time (datetime)read only

Indicates the time at which this request is assigned to a technician

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

deleted_assets (string)read only

The assets that are disassociated from this request

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

Example 

Sample Content

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not

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

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not

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

has_linked_requests (boolean)read only

Boolean value indicating whether this request has any linked requests or not

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

has_project (boolean)read only

Boolean value indicating whether this request is associated to a project or not

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

has_problem (boolean)read only

Boolean value indicating whether this request is associated to a problem or not

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

has_request_initiated_change (boolean)read only

Boolean value indicating whether this request is initiated a change or not

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

has_change_initiated_request (boolean)read only

Boolean to show whether there are requests which are initated by the change

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

has_purchase_orders (boolean)read only

Boolean value indicating whether this request is associated to Purchase Order(s)

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not

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

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not

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

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash

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

unreplied_count (long)read only

The number of requester replies for which the technician haven’t replied yet

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

Example 

234759602834500

editor_status (int)read only

The status of the Editor’s review/update

editor_status (int)
Numerical digits which are considered to have smaller numbers.

Example 

39


$ 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

id (long)
Id of this request

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

Example 

234759602834500

subject (string)
Subject of this request[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this request

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

Example 

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

impact_details (string)
Description about the impact of this request[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be notified about the happenings of this request

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

Example 

abc.gmail.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

created_time (datetime)

Indicates the time at which this request is created

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

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

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

due_by_time (datetime)

Indicates the time at which this request is scheduled to be completed

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

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

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is schedule

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

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

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

is_fcr (boolean)

Boolean value indicating if the request has been marked as First Call Resolution

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

status_change_comments (string)

The reason why the status is changed

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

Example 

Sample Content

scheduled_start_time (datetime)

Date and time at which the request is scheduled to start

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

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

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

scheduled_end_time (datetime)

Date and time at which the request is scheduled to end

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

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

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

impact (impact)

Impact of this request

impact (impact)
Indicates the impact of the request

Example 

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

status (status)

Indicates the current status of this request

status (status)
Indicates the current status of the request

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

Indicates the requester of this request

requester (user)
Indicates the requester of the request

Example 

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

mode (mode)

The mode in which this request is created

mode (mode)
The Mode in which the request is created.

Example 

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

site (site)

Denotes the site to which this request belongs

site (site)
Denotes the site to which this request belongs

Example 

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

template (request_template)

Indicates the template which is used to create this request

template (request_template)
Indicates the template which is used to create the request

Example 

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

sla (sla)

SLA details associated with this request

sla (sla)
Denotes SLA details associated with the request

Example 

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

service_category (service_category)

Service category to which this request belongs

service_category (service_category)
Service category to which this request belongs

Example 

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

group (group)

The group to which the request is assigned to

group (group)
Denotes the group to which the request belongs

Example 

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

technician (technician)

Technician assigned to this request

technician (technician)
Indicates the technician assigned to the request

Example 

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

priority (priority)

Priority of the request

priority (priority)
Indicates the priority of the request

Example 

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

level (level)

Level of the request

level (level)
Indicates the level of the request

Example 

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

category (category)

Category to which the request belongs

category (category)
Indicates the category to which the request belongs

Example 

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

subcategory (subcategory)

Subcategory to which the request belongs

subcategory (subcategory)
Subcategory to which the request belongs

Example 

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

item (item)

Item of the request

item (item)
Item of the request.

Example 

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

urgency (urgency)

Urgency of the request

urgency (urgency)
Denotes the urgency of the request

Example 

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

request_type (request_type)

Type of the request

request_type (request_type)
Indicates the type of the request

Example 

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

assets (asset)

Array of asset objects associated to this request

assets (asset)
Array of asset objects associated to the request.

Example 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the request

udf_fields (udf_fields)
Holds user defined fields’ values associated with the request

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

summary (request_summary)

No Description

summary (request_summary)

attachments (request_attachment)

Files that are attached to the request.

attachments (request_attachment)
Files that are attached to the request. Maximum of 50 attachments can be attached to a request.

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

Holds the resource data mapped to the request

resources (resources)
Denotes the resource data that is mapped to the request.

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "Dell Latitude E7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBook Air",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

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

on_behalf_of (user)
 This field denotes the user, on whose behalf the request is raised

Example 

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

configuration_items (configuration_item)

Critical Items for which the request has been raised

configuration_items (configuration_item)

Example 

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

editor (user)

The user who is configured as the Editor of the request

editor (user)
Indicates the editor of the request

Example 

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

resolution (JSONObject)

A solution for the request, provided by the technician
show attribute

resolution (JSONObject)
Contains the resolution details of the request.

Example 

{
  "resolution": {
    "content": "Resolution content"
  }
}

content (html)

Resolution content provided by the technician to resolve this request.

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

Example 

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

submitted_by (user)

No Description

submitted_by (user)

Example 

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

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

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

Example 

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

users (user)

The users who are configured as service approvers for the request

users (user)

Example 

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

onhold_scheduler (JSONObject)

Contains the scheduling details for the request, when the request is in Onhold status
show attribute

onhold_scheduler (JSONObject)
Contains onhold scheduling details.

Example 

{
  "onhold_scheduler": {
    "comments": "Reasons for Onhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan 5, 2018 01:16 PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time (datetime)

Denotes the scheduled time for the onhold scheduler to change the Request’s status

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

comments (string)

Comments added for linking requests[Max-length : 250]

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

Example 

Sample Content

change_to_status (status)

Status object to which the request is scheduled to move to, after the onhold scheduler is completed.

change_to_status (status)
Status object to which the request is scheduled to move to, after the onhold scheduler is completed

Example 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

The technician who stopped the timer/who changed the status to OnHold of the Request

held_by (technician)
User object of the user who put the request onhold.

Example 

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

closure_info (JSONObject)

Contains the closure information when the request is in Closed status
show attribute

closure_info (JSONObject)
Contains closure info of the request.

Example 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledged comments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution (boolean)

Denotes if the requester has acknowledged the resolution he/she has been given.

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]

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

Example 

Sample Content

closure_comments (string)

Closure comments denotes the reason for closing the request. Closure comments can only be given by technician.

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

Example 

Sample Content

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

closure_code (closure_code)
Closure Code denotes the reason for closing a request.

Example 

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

linked_to_request (JSONObject)

Holds linked request details
show attribute

linked_to_request (JSONObject)

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.

request (request)
Holds linked request details.

Example 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed (long)read only

Indicates the time spent on this request

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

Example 

234759602834500

email_cc (string)read only

List of e-mail addresses(cc addresses) which receives the request through e-mail.

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

Example 

abc.gmail.com

email_to (string)read only

List of email addresses(to addresses) while receiving the request

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

Example 

abc.gmail.com

email_bcc (string)read only

List of email addresses(bcc addresses) which receives the request

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

Example 

abc.gmail.com

completed_by_denial (boolean)read only

Boolean which denotes whether the request is completed, when the request was denied

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

cancellation_requested (boolean)read only

Boolean which indicates whether the request is raised for cancelation by the requester

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

cancel_flag_comments (action_comment)read only

Information provided by the requester to cancel a request to the technician

cancel_flag_comments (action_comment)
Information provided by the requester to cancel a request to the technician

Example 

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

display_id (long)read only

Display id of this request

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

Example 

234759602834500

created_by (user)read only

Indicates the requester who created this request

created_by (user)
Indicates the user who created this request

Example 

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

responded_time (datetime)read only

Indicates the time at which this request is responded

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

completed_time (datetime)read only

Indicates the time at which this request is completed

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

department (department)read only

Department to which this requester belongs

department (department)
Department to which this requester belongs

Example 

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

deleted_time (datetime)read only

Denotes the time at which the request will be deleted

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

service_cost (double)read only

Basic cost for the service which we are requesting

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

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

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

Example 

23.08

lifecycle (lifecycle)read only

Lifecycle associated with this request

lifecycle (lifecycle)

Example 

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

is_service_request (boolean)read only

Boolean value indicating whether this request is a service request or not

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

resolved_time (datetime)read only

Indicates the time at which this request is resolved

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

last_updated_time (datetime)read only

Indicates the time when this request is last updated

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

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue

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

is_first_response_overdue (boolean)read only

Boolean value indicating whether this request is in overdue to make first response

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

is_escalated (boolean)read only

A boolean value which represents whether the request is escalated or not

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

is_read (boolean)read only

Boolean value indicating whether this request’s replies are read or not

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

notification_status (string)read only

Shows the current status of request’s replies, whether last one from requester or technician

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

Example 

Sample Content

approval_status (approval_status)read only

Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

approval_status (approval_status)
Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

Example 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time (datetime)read only

Indicates the time at which this request is assigned to a technician

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

deleted_assets (string)read only

The assets that are disassociated from this request

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

Example 

Sample Content

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not

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

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not

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

has_linked_requests (boolean)read only

Boolean value indicating whether this request has any linked requests or not

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

has_project (boolean)read only

Boolean value indicating whether this request is associated to a project or not

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

has_problem (boolean)read only

Boolean value indicating whether this request is associated to a problem or not

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

has_request_initiated_change (boolean)read only

Boolean value indicating whether this request is initiated a change or not

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

has_change_initiated_request (boolean)read only

Boolean to show whether there are requests which are initated by the change

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

has_purchase_orders (boolean)read only

Boolean value indicating whether this request is associated to Purchase Order(s)

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not

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

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not

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

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash

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

unreplied_count (long)read only

The number of requester replies for which the technician haven’t replied yet

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

Example 

234759602834500

editor_status (int)read only

The status of the Editor’s review/update

editor_status (int)
Numerical digits which are considered to have smaller numbers.

Example 

39


$ 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

id (long)
Id of this request

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

Example 

234759602834500

subject (string)
Subject of this request[Max-length : 250]

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

Example 

Sample Content

created_time (datetime)
Indicates the time at which this request is created

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

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

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

due_by_time (datetime)
Indicates the time at which this request is scheduled to be completed

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

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

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

scheduled_start_time (datetime)
Date and time at which the request is scheduled to start

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

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

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

scheduled_end_time (datetime)
Date and time at which the request is scheduled to end

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

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

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

More Attributes Expand all

status (status)

Indicates the current status of this request

status (status)
Indicates the current status of the request

Example 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

Indicates the requester of this request

requester (user)
Indicates the requester of the request

Example 

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

template (request_template)

Indicates the template which is used to create this request

template (request_template)
Indicates the template which is used to create the request

Example 

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

group (group)

The group to which the request is assigned to

group (group)
Denotes the group to which the request belongs

Example 

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

technician (technician)

Technician assigned to this request

technician (technician)
Indicates the technician assigned to the request

Example 

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

attachments (request_attachment)

Files that are attached to the request.

attachments (request_attachment)
Files that are attached to the request. Maximum of 50 attachments can be attached to a request.

Example 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

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

on_behalf_of (user)
 This field denotes the user, on whose behalf the request is raised

Example 

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

cancellation_requested (boolean)read only

Boolean which indicates whether the request is raised for cancelation by the requester

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

cancel_flag_comments (action_comment)read only

Information provided by the requester to cancel a request to the technician

cancel_flag_comments (action_comment)
Information provided by the requester to cancel a request to the technician

Example 

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

display_id (long)read only

Display id of this request

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

Example 

234759602834500

service_cost (double)read only

Basic cost for the service which we are requesting

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

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

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

Example 

23.08

is_service_request (boolean)read only

Boolean value indicating whether this request is a service request or not

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

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not

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

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

filename (FILE)
The name of the file that is upload.

Example 

test-document.txt

addtoattachment (BOOLEAN)
Denotes whether to add the file as an attachment to the associated entity.

addtoattachment (BOOLEAN)
Boolean value which can have two possible values.

Example 

True or False

files (FILES)
The details of the file is contained here.
show attribute

files (FILES)
Contains the information about the file that has been uploaded.

Example 

{
  "size": "601",
  "content_type": "application/unknown-mime-type",
  "file_id": "6003",
  "name": "test-document.txt",
  "content_url": "<file path>"
  "id": "17322245500049868"
}

size (LONG)
The size of the file that is uploaded.

size (LONG)
Numerical digits which are considered to have larger values

Example 

234759602834500

content_type (STRING)
The type of the content of the file.

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

Example 

Sample Content

file_id (LONG)
The file_id is used to add that file as an attachment to the entity

file_id (LONG)
Numerical digits which are considered to have larger values

Example 

234759602834500

name (STRING)
The name of the file.

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

Example 

Sample Content

content_url (STRING)
The url of the file that is uploaded.

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

Example 

Sample Content


$ 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"
    }
  ]
}

View more