Request

Tickets raised by the end users are captured under the Request module. You can keep a track of the outstanding and overdue tickets as well as manage the tickets by assigning them to technicians or groups.

Attributes

id (long)
Indicates the ID of this request.

subject (string)
Subject of this request.

description (html)
Description of this request.

impact_details (string)
Description about the impact of this request.

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

update_reason (string)
The reason for updating this request.

More Attributes Expand all

created_time (datetime)

Indicates the time at which this request is created.

due_by_time (datetime)

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is scheduled.

is_fcr (boolean)

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

status_change_comments (string)

Comments added while changing the request’s status.

impact (impact)

Impact of this request.

status (status)

Indicates the current status of this request.

requester (user)

Indicates the requester of this request.

mode (mode)

The mode in which this request is created..

site (site)

Denotes the site to which this request belongs.

template (request_template)

Indicates the template which is used to create this request.

service_category (service_category)

Service category to which this request belongs.

group (support_group)

Group to which this request belongs.

technician (technician)

Technician assigned to this request.

priority (priority)

Indicates the priority of the request.

level (level)

Level of the request.

category (category)

Category to which this request belongs.

subcategory (subcategory)

Subcategory to which this request belongs.

item (item)

Indicates the item of this request.

urgency (urgency)

Urgency of the request.

request_type (request_type)

Indicates the type of this request.

assets (asset)

Array of asset objects associated to this request..

attachments (attachment)

Attached file list to this request.

udf_fields (udf_fields)

Holds udf fields’ values associated with the request.

resources (resources)

Holds the resource data mapped to the request.

resources (resources)

Example

{
  "res_301": {
    "qstn_text_308": {
      "value": "MacBook Air"
    },
    "qstn_select_310": {
      "cost": "350.00",
      "name": "Microsoft Office Enterprise 2007",
      "id": "305"
    },
    "qstn_check_307": [
      {
        "name": "access point 1",
        "id": "301"
      },
      {
        "name": "access point 2",
        "id": "302"
      }
    ],
    "qstn_simple_309": {
      "cost": "100.00",
      "name": "Yes"
    },
    "qstn_select_2": {
      "name": "Mac OSX"
    },
    "qstn_check_6": []
  }
}

editor (user)

User having intermediate editing role for this request.

on_behalf_of (user)

Requests created on behalf of an another user.

request_template_task_ids (request_template_task_ids)

Array of template tasks id objects which are associated to this request.

resolution (JSONObject)

Resolution suggested for the request.
show attribute

content (html)

Resolution content provided by the technician to resolve this request.

add_to_linked_requests (boolean)

Boolean value indicating whether to add resolution content to the linked requests.

submitted_on (datetime)

Denotes the submitted time of the resolution.

submitted_by (user)

Denotes the technician who provided the resolution.

onhold_scheduler (JSONObject)

Onhold scheduler details.
show attribute

scheduled_time (datetime)

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

comments (string)

Comments for the onhold schedule.

change_to_status (status)

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

closure_info (JSONObject)

Information like closure_code, comments while closing request is captured under this subsection.
show attribute

requester_ack_resolution (boolean)

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given.

closure_comments (string)

Comments for closing the request.

closure_code (request_closure_code)

Denotes the closure code info of the Request.

linked_to_request (JSONObject)

Contains linked to request details.
show attribute

request (request)

Request object containing minimal request data.

service_approvers (JSONObject)

Array of user objects containing the approver(s) for this request.

short_description (string)read only

A short description of this request.

time_elapsed (datetime)read only

Indicates the time spent on this request.

email_cc (string)read only

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

email_to (string)read only

List of email addresses(to addresses) which received the request through e-mail.

created_by (user)read only

Indicates the requester who created this request.

responded_time (datetime)read only

Indicates the time at which this request is responded.

completed_time (datetime)read only

Indicates the time at which this request is completed.

sla (sla)read only

Indicates the SLA details associated with this request.

department (department)read only

Department to which this requester belongs.

is_service_request (boolean)read only

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

resolved_time (datetime)read only

Indicates the time at which this request was resolved.

last_updated_time (datetime)read only

Indicates the time when this request is last updated.

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue.

is_first_response_overdue (boolean)read only

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

is_read (boolean)read only

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

notification_status (string)read only

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

approval_status (sdp_approval_status)read only

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

assigned_time (datetime)read only

Indicates the time at which this request was assigned to a technician.

deleted_assets (deleted_assets)read only

Array of deleted asset names associated to this request.

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not.

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not.

has_linked_requests (boolean)read only

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

has_project (boolean)read only

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

has_problem (boolean)read only

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

has_request_initiated_change (boolean)read only

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

has_request_caused_by_change (boolean)read only

Boolean value indicating whether this request is caused by a change or not.

has_purchase_orders (boolean)read only

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not.

has_dependency (boolean)read only

Boolean value indicating whether this request has a dependency or not.

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not.

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash.

is_editing_completed (boolean)read only

Boolean value indicating if the configured editor has already completed his editing.

deleted_on (datetime)read only

Indicates the time at which this request is deleted.

deleted_by (user)read only

Indicates the user who deleted the request.

service_cost (double)read only

Cost involved in the service other than resources.

total_cost (double)read only

Service cost plus the selected resource cost.

Get Request Summary

This operation allows you to get the summary of a request.

Url

/api/v3/requests/{request_id}/summary

Curl

$ curl -G /api/v3/requests/{request_id}/summary
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/summary";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/summary"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/summary"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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"
    },
    "request_summary": {
        "task_completed_count": 5,
        "task_total_count": 1,
        "dependency_count": 0,
        "note_count": 3,
        "link_request_count": 0
    }
}

Get Associated Change Initiated By Request

This operation lets you get the associated change that is initiated by this request.

Url

/api/v3/requests/{request_id}/request_initiated_change

Curl

$ curl -G /api/v3/requests/{request_id}/request_initiated_change
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/request_initiated_change";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/request_initiated_change"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/request_initiated_change"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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())

{
    "change": [
        {
            "change": {
                "id": "1",
                "title": "Change title"
            }
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "row_count": 1
    }
}

Unlink Requests

This operation lets you delete the links(that has already been created) between requests. Multiple links can be deleted at once.

Url

/api/v3/requests/{request_id}/link_requests

Curl

$ curl /api/v3/requests/{request_id}/link_requests
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/link_requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/link_requests"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/link_requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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"
  }
}

Assign Request

This operation allows you to assign a request to a technician.

Url

/api/v3/requests/{request_id}/assign

Curl

$ curl /api/v3/requests/{request_id}/assign
      -X PUT 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request": {
        "group": {
            "name": "Hardware Problems"
        },
        "technician": {
            "name": "heather Graham"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/assign";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request": {
        "group": {
            "name": "Hardware Problems"
        },
        "technician": {
            "name": "heather Graham"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/assign"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request": {
        "group": {
            "name": "Hardware Problems"
        },
        "technician": {
            "name": "heather Graham"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/assign"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request": {
        "group": {
            "name": "Hardware Problems"
        },
        "technician": {
            "name": "heather Graham"
        }
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success",
        "messages": [
            {
                "status_code": 2000,
                "message": "Assigned successfully.",
                "type": "success"
            }
        ]
    }
}

Add Resolution

This Operation allows you to add/update a resolution of the request.

Url

/api/v3/requests/{request_id}/resolutions

Curl

$ curl /api/v3/requests/{request_id}/resolutions
      -X POST 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "resolution": {
        "content": "sample resolution"
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/resolutions";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "resolution": {
        "content": "sample resolution"
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/resolutions"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "resolution": {
        "content": "sample resolution"
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/resolutions"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "resolution": {
        "content": "sample resolution"
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success",
        "messages": [
            {
                "status_code": 2000,
                "message": "Resolution added successfully.",
                "type": "success"
            }
        ]
    }
}

Associate Problem

This operation lets you associate a problem to an incident request.

Url

/api/v3/requests/{request_id}/problem

Curl

$ curl /api/v3/requests/{request_id}/problem
      -X POST 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request_problem_association": {
        "problem": {
            "id": "1"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/problem";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request_problem_association": {
        "problem": {
            "id": "1"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/problem"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request_problem_association": {
        "problem": {
            "id": "1"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/problem"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request_problem_association": {
        "problem": {
            "id": "1"
        }
    }
}'''
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_problem_association": {
        "request": {
            "id": 1
        },
        "problem": {
            "id": 1
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Associated Problem

This Operation allows you to get the associated Problem of a incident request.

Url

/api/v3/requests/{request_id}/problem

Curl

$ curl -G /api/v3/requests/{request_id}/problem
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/problem";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/problem"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/problem"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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())

{
    "problem": [
        {
            "problem": {
                "id": "1",
                "title": "Problem title"
            }
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "row_count": 1
    }
}

Add Request

This operation helps you to add new requests.

Mandatory Fields :- subject

Url

/api/v3/requests

Attributes

id (long)
Indicates the ID of this request.

subject (string)
Subject of this request.

description (html)
Description of this request.

impact_details (string)
Description about the impact of this request.

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

update_reason (string)
The reason for updating this request.

More Attributes Expand all

created_time (datetime)

Indicates the time at which this request is created.

due_by_time (datetime)

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is scheduled.

is_fcr (boolean)

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

status_change_comments (string)

Comments added while changing the request’s status.

impact (impact)

Impact of this request.

status (status)

Indicates the current status of this request.

requester (user)

Indicates the requester of this request.

mode (mode)

The mode in which this request is created..

site (site)

Denotes the site to which this request belongs.

template (request_template)

Indicates the template which is used to create this request.

service_category (service_category)

Service category to which this request belongs.

group (support_group)

Group to which this request belongs.

technician (technician)

Technician assigned to this request.

priority (priority)

Indicates the priority of the request.

level (level)

Level of the request.

category (category)

Category to which this request belongs.

subcategory (subcategory)

Subcategory to which this request belongs.

item (item)

Indicates the item of this request.

urgency (urgency)

Urgency of the request.

request_type (request_type)

Indicates the type of this request.

assets (asset)

Array of asset objects associated to this request..

attachments (attachment)

Attached file list to this request.

udf_fields (udf_fields)

Holds udf fields’ values associated with the request.

resources (resources)

Holds the resource data mapped to the request.

resources (resources)

Example

{
  "res_301": {
    "qstn_text_308": {
      "value": "MacBook Air"
    },
    "qstn_select_310": {
      "cost": "350.00",
      "name": "Microsoft Office Enterprise 2007",
      "id": "305"
    },
    "qstn_check_307": [
      {
        "name": "access point 1",
        "id": "301"
      },
      {
        "name": "access point 2",
        "id": "302"
      }
    ],
    "qstn_simple_309": {
      "cost": "100.00",
      "name": "Yes"
    },
    "qstn_select_2": {
      "name": "Mac OSX"
    },
    "qstn_check_6": []
  }
}

editor (user)

User having intermediate editing role for this request.

on_behalf_of (user)

Requests created on behalf of an another user.

request_template_task_ids (request_template_task_ids)

Array of template tasks id objects which are associated to this request.

resolution (JSONObject)

Resolution suggested for the request.
show attribute

content (html)

Resolution content provided by the technician to resolve this request.

add_to_linked_requests (boolean)

Boolean value indicating whether to add resolution content to the linked requests.

submitted_on (datetime)

Denotes the submitted time of the resolution.

submitted_by (user)

Denotes the technician who provided the resolution.

onhold_scheduler (JSONObject)

Onhold scheduler details.
show attribute

scheduled_time (datetime)

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

comments (string)

Comments for the onhold schedule.

change_to_status (status)

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

closure_info (JSONObject)

Information like closure_code, comments while closing request is captured under this subsection.
show attribute

requester_ack_resolution (boolean)

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given.

closure_comments (string)

Comments for closing the request.

closure_code (request_closure_code)

Denotes the closure code info of the Request.

linked_to_request (JSONObject)

Contains linked to request details.
show attribute

request (request)

Request object containing minimal request data.

service_approvers (JSONObject)

Array of user objects containing the approver(s) for this request.

short_description (string)read only

A short description of this request.

time_elapsed (datetime)read only

Indicates the time spent on this request.

email_cc (string)read only

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

email_to (string)read only

List of email addresses(to addresses) which received the request through e-mail.

created_by (user)read only

Indicates the requester who created this request.

responded_time (datetime)read only

Indicates the time at which this request is responded.

completed_time (datetime)read only

Indicates the time at which this request is completed.

sla (sla)read only

Indicates the SLA details associated with this request.

department (department)read only

Department to which this requester belongs.

is_service_request (boolean)read only

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

resolved_time (datetime)read only

Indicates the time at which this request was resolved.

last_updated_time (datetime)read only

Indicates the time when this request is last updated.

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue.

is_first_response_overdue (boolean)read only

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

is_read (boolean)read only

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

notification_status (string)read only

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

approval_status (sdp_approval_status)read only

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

assigned_time (datetime)read only

Indicates the time at which this request was assigned to a technician.

deleted_assets (deleted_assets)read only

Array of deleted asset names associated to this request.

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not.

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not.

has_linked_requests (boolean)read only

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

has_project (boolean)read only

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

has_problem (boolean)read only

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

has_request_initiated_change (boolean)read only

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

has_request_caused_by_change (boolean)read only

Boolean value indicating whether this request is caused by a change or not.

has_purchase_orders (boolean)read only

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not.

has_dependency (boolean)read only

Boolean value indicating whether this request has a dependency or not.

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not.

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash.

is_editing_completed (boolean)read only

Boolean value indicating if the configured editor has already completed his editing.

deleted_on (datetime)read only

Indicates the time at which this request is deleted.

deleted_by (user)read only

Indicates the user who deleted the request.

service_cost (double)read only

Cost involved in the service other than resources.

total_cost (double)read only

Service cost plus the selected resource cost.

Curl

$ curl /api/v3/requests
      -X POST
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request": {
        "subject": "Unable to fetch mails",
        "description": "I am unable to fetch mails from the mail server",
        "requester": {
            "id": "4",
            "name": "administrator"
        },
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request": {
        "subject": "Unable to fetch mails",
        "description": "I am unable to fetch mails from the mail server",
        "requester": {
            "id": "4",
            "name": "administrator"
        },
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request": {
        "subject": "Unable to fetch mails",
        "description": "I am unable to fetch mails from the mail server",
        "requester": {
            "id": "4",
            "name": "administrator"
        },
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request": {
        "subject": "Unable to fetch mails",
        "description": "I am unable to fetch mails from the mail server",
        "requester": {
            "id": "4",
            "name": "administrator"
        },
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
}'''
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": {
        "is_first_response_overdue": false,
        "impact_details": null,
        "impact": {
            "id": "1",
            "name": "High"
        },
        "urgency": {
            "id": "2",
            "name": "High"
        },
        "level": {
            "id": "4",
            "name": "Tier 4"
        },
        "description": "I am unable to fetch mails from the mail server",
        "priority": {
            "id": "4",
            "color": "#ff0000",
            "name": "High"
        },
        "sla": null,
        "template": {
            "id": "36",
            "name": "Request to start the process associated to a new hire"
        },
        "created_by": {
            "id": "4",
            "name": "administrator",
            "email_id": null
        },
        "requester": {
            "id": "4",
            "name": "administrator",
            "email_id": null
        },
        "first_response_due_by_time": null,
        "service_category": {
            "id": "8",
            "name": "User Management"
        },
        "is_reopened": false,
        "status": {
            "id": "3",
            "color": "#006600",
            "name": "Closed"
        },
        "approval_status": null,
        "email_cc": [],
        "due_by_time": null,
        "closure_info": {
            "closure_code": {
                "id": "3",
                "name": "Canceled"
            },
            "requester_ack_comments": null,
            "closure_comments": null,
            "requester_ack_resolution": true
        },
        "is_trashed": false,
        "request_template_task_ids": [],
        "assets": [],
        "category": {
            "id": "11",
            "name": "Operating System"
        },
        "editor": {
            "id": "5",
            "name": "Shawn Adams",
            "email_id": null
        },
        "time_elapsed": {
            "display_value": "0hrs 0min",
            "value": "2086"
        },
        "on_behalf_of": null,
        "is_service_request": true,
        "assigned_time": {
            "display_value": "Mar 10, 2017 11:37 AM",
            "value": "1489126045447"
        },
        "technician": {
            "id": "6",
            "name": "Heather Graham",
            "email_id": "heather.g@zoho.com"
        },
        "request_type": {
            "id": "2",
            "name": "Request For Information"
        },
        "subject": "Unable to fetch mails",
        "department": null,
        "udf_fields": {
            "udf_date_601": {
                "display_value": "Mar 9, 2017 04:36 PM",
                "value": "1489057560000"
            },
            "udf_pick_20": "Admin",
            "udf_mline_314": "USA",
            "udf_pick_44": "Heather Graham",
            "udf_long_367": "123654789",
            "udf_sline_25": "5 th floor",
            "udf_sline_26": "6th floor",
            "udf_decimal_42": "124.00"
        },
        "resolution": null,
        "mode": {
            "id": "2",
            "name": "Web Form"
        },
        "id": "120",
        "resolved_time": {
            "display_value": "Mar 10, 2017 11:37 AM",
            "value": "1489126047225"
        },
        "responded_time": null,
        "attachments": [],
        "completed_time": {
            "display_value": "Mar 10, 2017 11:37 AM",
            "value": "1489126047225"
        },
        "site": null,
        "email_ids_to_notify": [
            "heather.g@zoho.com"
        ],
        "is_fcr": false,
        "is_overdue": false,
        "email_to": [],
        "last_updated_time": null,
        "subcategory": {
            "id": "24",
            "name": "Mac OS X"
        },
        "item": null,
        "created_time": {
            "display_value": "Mar 10, 2017 11:37 AM",
            "value": "1489126045139"
        },
        "group": {
            "id": "1",
            "name": "Hardware Problems"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Request

This operation helps you to view the request details by the unique request id.

Url

/api/v3/requests/{request_id}

Attributes

id (long)
Indicates the ID of this request.

subject (string)
Subject of this request.

description (html)
Description of this request.

impact_details (string)
Description about the impact of this request.

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

update_reason (string)
The reason for updating this request.

More Attributes Expand all

created_time (datetime)

Indicates the time at which this request is created.

due_by_time (datetime)

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is scheduled.

is_fcr (boolean)

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

status_change_comments (string)

Comments added while changing the request’s status.

impact (impact)

Impact of this request.

status (status)

Indicates the current status of this request.

requester (user)

Indicates the requester of this request.

mode (mode)

The mode in which this request is created..

site (site)

Denotes the site to which this request belongs.

template (request_template)

Indicates the template which is used to create this request.

service_category (service_category)

Service category to which this request belongs.

group (support_group)

Group to which this request belongs.

technician (technician)

Technician assigned to this request.

priority (priority)

Indicates the priority of the request.

level (level)

Level of the request.

category (category)

Category to which this request belongs.

subcategory (subcategory)

Subcategory to which this request belongs.

item (item)

Indicates the item of this request.

urgency (urgency)

Urgency of the request.

request_type (request_type)

Indicates the type of this request.

assets (asset)

Array of asset objects associated to this request..

attachments (attachment)

Attached file list to this request.

udf_fields (udf_fields)

Holds udf fields’ values associated with the request.

resources (resources)

Holds the resource data mapped to the request.

resources (resources)

Example

{
  "res_301": {
    "qstn_text_308": {
      "value": "MacBook Air"
    },
    "qstn_select_310": {
      "cost": "350.00",
      "name": "Microsoft Office Enterprise 2007",
      "id": "305"
    },
    "qstn_check_307": [
      {
        "name": "access point 1",
        "id": "301"
      },
      {
        "name": "access point 2",
        "id": "302"
      }
    ],
    "qstn_simple_309": {
      "cost": "100.00",
      "name": "Yes"
    },
    "qstn_select_2": {
      "name": "Mac OSX"
    },
    "qstn_check_6": []
  }
}

editor (user)

User having intermediate editing role for this request.

on_behalf_of (user)

Requests created on behalf of an another user.

request_template_task_ids (request_template_task_ids)

Array of template tasks id objects which are associated to this request.

resolution (JSONObject)

Resolution suggested for the request.
show attribute

content (html)

Resolution content provided by the technician to resolve this request.

add_to_linked_requests (boolean)

Boolean value indicating whether to add resolution content to the linked requests.

submitted_on (datetime)

Denotes the submitted time of the resolution.

submitted_by (user)

Denotes the technician who provided the resolution.

onhold_scheduler (JSONObject)

Onhold scheduler details.
show attribute

scheduled_time (datetime)

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

comments (string)

Comments for the onhold schedule.

change_to_status (status)

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

closure_info (JSONObject)

Information like closure_code, comments while closing request is captured under this subsection.
show attribute

requester_ack_resolution (boolean)

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given.

closure_comments (string)

Comments for closing the request.

closure_code (request_closure_code)

Denotes the closure code info of the Request.

linked_to_request (JSONObject)

Contains linked to request details.
show attribute

request (request)

Request object containing minimal request data.

service_approvers (JSONObject)

Array of user objects containing the approver(s) for this request.

short_description (string)read only

A short description of this request.

time_elapsed (datetime)read only

Indicates the time spent on this request.

email_cc (string)read only

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

email_to (string)read only

List of email addresses(to addresses) which received the request through e-mail.

created_by (user)read only

Indicates the requester who created this request.

responded_time (datetime)read only

Indicates the time at which this request is responded.

completed_time (datetime)read only

Indicates the time at which this request is completed.

sla (sla)read only

Indicates the SLA details associated with this request.

department (department)read only

Department to which this requester belongs.

is_service_request (boolean)read only

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

resolved_time (datetime)read only

Indicates the time at which this request was resolved.

last_updated_time (datetime)read only

Indicates the time when this request is last updated.

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue.

is_first_response_overdue (boolean)read only

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

is_read (boolean)read only

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

notification_status (string)read only

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

approval_status (sdp_approval_status)read only

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

assigned_time (datetime)read only

Indicates the time at which this request was assigned to a technician.

deleted_assets (deleted_assets)read only

Array of deleted asset names associated to this request.

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not.

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not.

has_linked_requests (boolean)read only

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

has_project (boolean)read only

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

has_problem (boolean)read only

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

has_request_initiated_change (boolean)read only

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

has_request_caused_by_change (boolean)read only

Boolean value indicating whether this request is caused by a change or not.

has_purchase_orders (boolean)read only

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not.

has_dependency (boolean)read only

Boolean value indicating whether this request has a dependency or not.

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not.

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash.

is_editing_completed (boolean)read only

Boolean value indicating if the configured editor has already completed his editing.

deleted_on (datetime)read only

Indicates the time at which this request is deleted.

deleted_by (user)read only

Indicates the user who deleted the request.

service_cost (double)read only

Cost involved in the service other than resources.

total_cost (double)read only

Service cost plus the selected resource cost.

Curl

$ curl -G /api/v3/requests/{request_id}
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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())

{
    "request": {
        "ola_due_by_time": null,
        "resolution": {
            "resolution_attachments": [],
            "content": null
        },
        "onhold_time": null,
        "is_trashed": false,
        "id": "1",
        "assigned_time": null,
        "requester": {
            "email_id": null,
            "phone": "1234455",
            "name": "administrator",
            "mobile": "1234567890",
            "profile_pic": {
                "content-url": "/images/default-profile-pic2.svg"
            },
            "is_vipuser": false,
            "id": "5",
            "department": null
        },
        "cancel_requested_by": null,
        "sla_violated_technician": null,
        "item": null,
        "has_resolution_attachments": false,
        "impact": null,
        "sla": null,
        "priority": null,
        "sla_violated_group": null,
        "tags": [],
        "has_notes": false,
        "is_current_ola_violated": null,
        "image_token": "adb0d31f7c16efd114e58034f7501ff64fc7d677d14578b243b400f58337f09c4342d37f7977bc74d7dcd636669acc9f8a168218",
        "udf_fields": {
            "udf_date_304": {
                "display_value": "Oct 1, 2022 05:58 PM",
                "value": "1664627280000"
            },
            "udf_multiselect_303": [
                "1",
                "2"
            ],
            "udf_sline_301": "12345",
            "udf_pick_302": "1"
        },
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "2"
        },
        "template": {
            "is_service_template": false,
            "service_category": null,
            "name": "Default Request",
            "id": "1"
        },
        "primary_asset": null,
        "request_type": null,
        "cancel_requested_time": null,
        "chat_type": 0,
        "is_service_request": false,
        "cancel_requested": false,
        "has_request_initiated_change": false,
        "has_attachments": false,
        "has_linked_requests": false,
        "has_request_caused_by_change": false,
        "has_problem": false,
        "subject": "1234567890",
        "linked_to_request": null,
        "mode": null,
        "is_read": false,
        "lifecycle": null,
        "reason_for_cancel": null,
        "assets": [],
        "group": null,
        "email_to": [],
        "created_time": {
            "display_value": "Oct 14, 2022 01:06 PM",
            "value": "1665732987684"
        },
        "level": null,
        "approval_status": null,
        "service_category": null,
        "created_by": {
            "email_id": null,
            "phone": "1234455",
            "name": "administrator",
            "mobile": "1234567890",
            "profile_pic": {
                "content-url": "/images/default-profile-pic2.svg"
            },
            "is_vipuser": false,
            "id": "5",
            "department": null
        },
        "scheduled_end_time": null,
        "first_response_due_by_time": null,
        "last_updated_time": {
            "display_value": "Oct 20, 2022 05:59 PM",
            "value": "1666268953851"
        },
        "impact_details": null,
        "subcategory": null,
        "email_cc": [],
        "scheduled_start_time": null,
        "email_ids_to_notify": [],
        "notification_status": null,
        "description": null,
        "has_dependency": false,
        "has_conversation": false,
        "callback_url": null,
        "urgency": null,
        "is_shared": false,
        "request_template_task_ids": [],
        "department": null,
        "is_reopened": false,
        "has_draft": false,
        "is_overdue": false,
        "technician": null,
        "due_by_time": null,
        "has_project": false,
        "is_first_response_overdue": false,
        "cancel_requested_is_pending": false,
        "recommend_template": null,
        "unreplied_count": null,
        "category": null,
        "maintenance": null
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get List Request

This operation lets you to view the details of all the requests.

Url

/api/v3/requests

Attributes

id (long)
Indicates the ID of this request.

subject (string)
Subject of this request.

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

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

status (status)
Indicates the current status of this request.

requester (user)
Indicates the requester of this request.

More Attributes Expand all

site (site)

Denotes the site to which this request belongs.

template (request_template)

Indicates the template which is used to create this request.

group (support_group)

Group to which this request belongs.

technician (technician)

Technician assigned to this request.

priority (priority)

Indicates the priority of the request.

assets (asset)

Array of asset objects associated to this request..

short_description (string)read only

A short description of this request.

created_by (user)read only

Indicates the requester who created this request.

is_service_request (boolean)read only

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

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue.

Curl

$ curl -G /api/v3/requests
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '{
    "list_info": {
        "row_count": 20,
        "start_index": 1,
        "sort_field": "subject",
        "sort_order": "asc",
        "get_total_count": true,
        "search_fields": {
            "subject": "New hire",
            "priority.name": "high"
        },
        "filter_by": {
            "id": "34"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "list_info": {
        "row_count": 20,
        "start_index": 1,
        "sort_field": "subject",
        "sort_order": "asc",
        "get_total_count": true,
        "search_fields": {
            "subject": "New hire",
            "priority.name": "high"
        },
        "filter_by": {
            "id": "34"
        }
    }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "list_info": {
        "row_count": 20,
        "start_index": 1,
        "sort_field": "subject",
        "sort_order": "asc",
        "get_total_count": true,
        "search_fields": {
            "subject": "New hire",
            "priority.name": "high"
        },
        "filter_by": {
            "id": "34"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "list_info": {
        "row_count": 20,
        "start_index": 1,
        "sort_field": "subject",
        "sort_order": "asc",
        "get_total_count": true,
        "search_fields": {
            "subject": "New hire",
            "priority.name": "high"
        },
        "filter_by": {
            "id": "34"
        }
    }
}'''       
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())

{
    "requests": [
        {
            "id": 1,
            "subject": "laptopfornewhire",
            "short_description": "NeednewLapTop",
            "created_time": {
                "value": 1482151699905,
                "display_value": "Dec19,201612:48PM"
            },
            "created_by": {
                "id": 3,
                "email_id": "admin@test.com",
                "name": "administrator"
            },
            "due_by_time": {
                "value": 1482208200805,
                "display_value": "Dec20,201610:49AM"
            },
            "is_service_request": false,
            "technician": {
                "id": 9,
                "name": "JenifferDoe"
            },
            "requester": {
                "is_vipuser": false,
                "id": 4,
                "name": "Guest"
            },
            "is_overdue": false
        },
        {
            "id": 2,
            "subject": "newhire",
            "short_description": "Needlaptopdock",
            "created_time": {
                "value": 1482151699905,
                "display_value": "Dec19,201612:48PM"
            },
            "created_by": {
                "id": 3,
                "email_id": "admin1@test.com",
                "name": "administrator"
            },
            "due_by_time": {
                "value": 1482208200905,
                "display_value": "Dec20,2016"
            },
            "is_service_request": false,
            "technician": {
                "id": 9,
                "name": "JenifferDoe"
            },
            "requester": {
                "is_vipuser": false,
                "id": 4,
                "name": "Guest"
            },
            "is_overdue": false
        }
    ],
    "response_status": {
        "status": "success",
        "messages": [
            {
                "type": "success",
                "message": "Successfullyfetched.",
                "status_code": "10000"
            }
        ]
    },
    "list_info": {
        "row_count": 20,
        "start_index": 1,
        "sort_field": "subject",
        "sort_order": "asc",
        "get_total_count": true,
        "search_fields": {
            "subject": "newhire"
        },
        "has_more_rows": "false",
        "filter_by": {
            "id": "34"
        }
    }
}

Close Request

This operation allows you to close a single or multiple requests.

Url

/api/v3/requests/{request-id}/close

Curl

$ curl /api/v3/requests/{request-id}/close
      -X PUT 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request": {
        "closure_info": {
            "requester_ack_resolution": true,
            "requester_ack_comments": "Mail fetching is up and running now",
            "closure_comments": "Reset the pasword solved the issue",
            "closure_code": {
                "name": "success"
            }
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request-id}/close";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request": {
        "closure_info": {
            "requester_ack_resolution": true,
            "requester_ack_comments": "Mail fetching is up and running now",
            "closure_comments": "Reset the pasword solved the issue",
            "closure_code": {
                "name": "success"
            }
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request-id}/close"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request": {
        "closure_info": {
            "requester_ack_resolution": true,
            "requester_ack_comments": "Mail fetching is up and running now",
            "closure_comments": "Reset the pasword solved the issue",
            "closure_code": {
                "name": "success"
            }
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request-id}/close"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request": {
        "closure_info": {
            "requester_ack_resolution": true,
            "requester_ack_comments": "Mail fetching is up and running now",
            "closure_comments": "Reset the pasword solved the issue",
            "closure_code": {
                "name": "success"
            }
        }
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Request(s) closed successfully."
            }
        ],
        "status": "success"
    }
}

Get Resolution

This operation allows you to get a resolution of the request.

Url

/api/v3/requests/{request_id}/resolutions

Curl

$ curl -G /api/v3/requests/{request_id}/resolutions
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/resolutions";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/resolutions"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/resolutions"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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"
    },
    "resolution": {
        "content": "Restart the server, reset the port solved the problem",
        "submitted_by": {
            "id": "4",
            "name": "administrator",
            "email_id": null
        },
        "submitted_on": {
            "display_value": "Oct 4, 2017 12:21 AM",
            "value": "1507056660521"
        },
        "resolution_attachments": [
            {
                "module": "request",
                "authentication_id": "1",
                "content_type": "application/x-ooxml",
                "id": "2102",
                "name": "troubleshooting_guideline1.docx",
                "content_url": "/api/v3/requests/115/resolution_attachments/2102/download",
                "size": {
                    "display_value": "13.06KB",
                    "value": 13383
                }
            },
            {
                "module": "request",
                "authentication_id": "1",
                "content_type": "application/x-msoffice",
                "id": "2101",
                "name": "troubleshooting_guideline1.doc",
                "content_url": "/api/v3/requests/115/resolution_attachments/2101/download",
                "size": {
                    "display_value": "17.07KB",
                    "value": 17480
                }
            }
        ]
    }
}

Dissociate Request Initiated Change

This operation lets you detach(already attached) request initiated change from a request.

Url

/api/v3/requests/{request_id}/request_initiated_change

Curl

$ curl /api/v3/requests/{request_id}/request_initiated_change
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/request_initiated_change";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/request_initiated_change"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/request_initiated_change"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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"
  }
}

Dissociate Request Caused By Change

This operation lets you detach(already attached) request caused by change from a Request.

Url

/api/v3/requests/{request_id}/request_caused_by_change

Curl

$ curl /api/v3/requests/{request_id}/request_caused_by_change
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/request_caused_by_change";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/request_caused_by_change"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/request_caused_by_change"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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"
  }
}

Dissociate Project

This operation lets you detach(already attached) a project from a request.

Url

/api/v3/requests/{request_id}/project

Curl

$ curl /api/v3/requests/{request_id}/project
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/project";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/project"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/project"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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"
  }
}

Delete Request From Trash

This operation lets you delete the request permanently (from the trash).

Url

/api/v3/requests/{request_id}

Curl

$ curl /api/v3/requests/{request_id}
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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"
  }
}

Get Associated Project

This operation allows you to get the associated project of a request.

Url

/api/v3/requests/{request_id}/project

Curl

$ curl -G /api/v3/requests/{request_id}/project
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/project";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/project"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/project"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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())

{
    "project": [
        {
            "project": {
                "id": "1",
                "title": "Project title"
            }
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "row_count": 1
    }
}

View All Request Filters

This operation lets you to view all the request filters.

Url

/api/v3/list_view_filters/show_all

Curl

$ curl -G /api/v3/list_view_filters/show_all
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '{
    "show_all": {
        "module": "request"
    },
    "list_info": {
        "row_count": "100",
        "search_fields": {
            "module": "request"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/list_view_filters/show_all";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "show_all": {
        "module": "request"
    },
    "list_info": {
        "row_count": "100",
        "search_fields": {
            "module": "request"
        }
    }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/list_view_filters/show_all"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "show_all": {
        "module": "request"
    },
    "list_info": {
        "row_count": "100",
        "search_fields": {
            "module": "request"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/list_view_filters/show_all"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "show_all": {
        "module": "request"
    },
    "list_info": {
        "row_count": "100",
        "search_fields": {
            "module": "request"
        }
    }
}'''       
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"
        }
    ],
    "show_all": [
        {
            "name": "All Requests",
            "id": "29"
        },
        {
            "name": "Pending Requests",
            "id": "30"
        },
        {
            "name": "Requests Due Today",
            "id": "31"
        },
        {
            "name": "Overdue Requests",
            "id": "32"
        },
        {
            "name": "Open Requests",
            "id": "34"
        },
        {
            "name": "Requests On Hold",
            "id": "35"
        },
        {
            "name": "Unassigned Requests",
            "id": "37"
        },
        {
            "name": "My Open Or Unassigned",
            "id": "41"
        },
        {
            "name": "My Completed Requests",
            "id": "42"
        },
        {
            "name": "My Requests Due Today",
            "id": "43"
        },
        {
            "name": "My Pending Requests",
            "id": "44"
        },
        {
            "name": "My Overdue Requests",
            "id": "45"
        },
        {
            "name": "My Requests On Hold",
            "id": "46"
        },
        {
            "name": "My Open Requests",
            "id": "48"
        },
        {
            "name": "All My Requests",
            "id": "49"
        },
        {
            "name": "Waiting for my update",
            "id": "58"
        },
        {
            "name": "Updated by me",
            "id": "59"
        },
        {
            "name": "Requests Pending Approval",
            "id": "85"
        },
        {
            "name": "Completed Requests",
            "id": "87"
        },
        {
            "name": "Requests Shared with me",
            "id": "88"
        },
        {
            "name": "Pending Requests Shared with me",
            "id": "89"
        },
        {
            "name": "Missed chat requests",
            "id": "90"
        },
        {
            "name": "Closed chat requests",
            "id": "91"
        },
        {
            "name": "Requests Pending My Approval",
            "id": "92"
        },
        {
            "name": "OLA overdue request",
            "id": "93"
        },
        {
            "name": "Requests OLA due today",
            "id": "94"
        },
        {
            "name": "My Group OLA overdue requests",
            "id": "95"
        },
        {
            "name": "My Pending Requests or Tasks",
            "id": "96"
        }
    ]
}

Get Associated Request Caused By Change

This operation allows you to get the associated change of a request.

Url

/api/v3/requests/{request_id}/request_caused_by_change

Curl

$ curl -G /api/v3/requests/{request_id}/request_caused_by_change
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/request_caused_by_change";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/request_caused_by_change"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/request_caused_by_change"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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())

{
    "change": [
        {
            "change": {
                "id": "1",
                "title": "Change title"
            }
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "row_count": 1
    }
}

Associate Request Caused By Change

This operation lets you attach a change to a request.

Url

/api/v3/requests/{request_id}/request_caused_by_change

Curl

$ curl /api/v3/requests/{request_id}/request_caused_by_change
      -X POST 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request_caused_by_change": {
        "change": {
            "id": "1"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/request_caused_by_change";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request_caused_by_change": {
        "change": {
            "id": "1"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/request_caused_by_change"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request_caused_by_change": {
        "change": {
            "id": "1"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/request_caused_by_change"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request_caused_by_change": {
        "change": {
            "id": "1"
        }
    }
}'''
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_caused_by_change": {
        "request": {
            "id": 1
        },
        "change": {
            "id": 1
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Associate Change Initiated By Request

This operation lets you associate a change that is initiated by this request.

Url

/api/v3/requests/{request_id}/request_initiated_change

Curl

$ curl /api/v3/requests/{request_id}/request_initiated_change
      -X POST 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request_initiated_change": {
        "change": {
            "id": "1"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/request_initiated_change";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request_initiated_change": {
        "change": {
            "id": "1"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/request_initiated_change"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request_initiated_change": {
        "change": {
            "id": "1"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/request_initiated_change"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request_initiated_change": {
        "change": {
            "id": "1"
        }
    }
}'''
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_initiated_change": {
        "request": {
            "id": 1
        },
        "change": {
            "id": 1
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Link Requests

This operation lets you create a link between requests.

Url

/api/v3/requests/{request_id}/link_requests

Curl

$ curl /api/v3/requests/{request_id}/link_requests
      -X POST 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "link_requests": [
        {
            "linked_request": {
                "id": "1"
            },
            "comments": "Same incident"
        },
        {
            "linked_request": {
                "id": "2"
            },
            "comments": "Same incident"
        }
    ]
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/link_requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "link_requests": [
        {
            "linked_request": {
                "id": "1"
            },
            "comments": "Same incident"
        },
        {
            "linked_request": {
                "id": "2"
            },
            "comments": "Same incident"
        }
    ]
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/link_requests"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "link_requests": [
        {
            "linked_request": {
                "id": "1"
            },
            "comments": "Same incident"
        },
        {
            "linked_request": {
                "id": "2"
            },
            "comments": "Same incident"
        }
    ]
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/link_requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "link_requests": [
        {
            "linked_request": {
                "id": "1"
            },
            "comments": "Same incident"
        },
        {
            "linked_request": {
                "id": "2"
            },
            "comments": "Same incident"
        }
    ]
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success",
        "messages": [
            {
                "status_code": 2000,
                "message": "Request successfully linked",
                "type": "success"
            }
        ]
    }
}

Pickup Request

This operation allows you to pickup request on your name as a technician.

Url

/api/v3/requests/{request_id}/pickup

Curl

$ curl /api/v3/requests/{request_id}/pickup
      -X PUT 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/pickup";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/pickup"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/pickup"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success",
        "messages": [
            {
                "status_code": 2000,
                "message": "Request(s) picked up successfully.",
                "type": "success"
            }
        ]
    }
}

Get All Link Requests

This operation helps to to get all the linked requests under a request.

Url

/api/v3/requests/{request_id}/link_requests

Curl

$ curl -G /api/v3/requests/{request_id}/link_requests
      -X GET 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      --data-urlencode input_data = '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/link_requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/link_requests"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

Python

#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 = "/api/v3/requests/{request_id}/link_requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''       
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())

{
    "link_requests": [
        {
            "linked_request": {
                "subject": "Printer problem",
                "id": "1"
            },
            "comments": "Same incident"
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ]
}

Edit Request

This operation helps you to update a request by using the unique request_id.

Url

/api/v3/requests/{request_id}

Attributes

id (long)
Indicates the ID of this request.

subject (string)
Subject of this request.

description (html)
Description of this request.

impact_details (string)
Description about the impact of this request.

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

update_reason (string)
The reason for updating this request.

More Attributes Expand all

created_time (datetime)

Indicates the time at which this request is created.

due_by_time (datetime)

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

first_response_due_by_time (datetime)

Indicates the time at which the first response for this request is scheduled.

is_fcr (boolean)

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

status_change_comments (string)

Comments added while changing the request’s status.

impact (impact)

Impact of this request.

status (status)

Indicates the current status of this request.

requester (user)

Indicates the requester of this request.

mode (mode)

The mode in which this request is created..

site (site)

Denotes the site to which this request belongs.

template (request_template)

Indicates the template which is used to create this request.

service_category (service_category)

Service category to which this request belongs.

group (support_group)

Group to which this request belongs.

technician (technician)

Technician assigned to this request.

priority (priority)

Indicates the priority of the request.

level (level)

Level of the request.

category (category)

Category to which this request belongs.

subcategory (subcategory)

Subcategory to which this request belongs.

item (item)

Indicates the item of this request.

urgency (urgency)

Urgency of the request.

request_type (request_type)

Indicates the type of this request.

assets (asset)

Array of asset objects associated to this request..

attachments (attachment)

Attached file list to this request.

udf_fields (udf_fields)

Holds udf fields’ values associated with the request.

resources (resources)

Holds the resource data mapped to the request.

resources (resources)

Example

{
  "res_301": {
    "qstn_text_308": {
      "value": "MacBook Air"
    },
    "qstn_select_310": {
      "cost": "350.00",
      "name": "Microsoft Office Enterprise 2007",
      "id": "305"
    },
    "qstn_check_307": [
      {
        "name": "access point 1",
        "id": "301"
      },
      {
        "name": "access point 2",
        "id": "302"
      }
    ],
    "qstn_simple_309": {
      "cost": "100.00",
      "name": "Yes"
    },
    "qstn_select_2": {
      "name": "Mac OSX"
    },
    "qstn_check_6": []
  }
}

editor (user)

User having intermediate editing role for this request.

on_behalf_of (user)

Requests created on behalf of an another user.

request_template_task_ids (request_template_task_ids)

Array of template tasks id objects which are associated to this request.

resolution (JSONObject)

Resolution suggested for the request.
show attribute

content (html)

Resolution content provided by the technician to resolve this request.

add_to_linked_requests (boolean)

Boolean value indicating whether to add resolution content to the linked requests.

submitted_on (datetime)

Denotes the submitted time of the resolution.

submitted_by (user)

Denotes the technician who provided the resolution.

onhold_scheduler (JSONObject)

Onhold scheduler details.
show attribute

scheduled_time (datetime)

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

comments (string)

Comments for the onhold schedule.

change_to_status (status)

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

closure_info (JSONObject)

Information like closure_code, comments while closing request is captured under this subsection.
show attribute

requester_ack_resolution (boolean)

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

requester_ack_comments (string)

Comments from the requester in regards to the resolution he/she has been given.

closure_comments (string)

Comments for closing the request.

closure_code (request_closure_code)

Denotes the closure code info of the Request.

linked_to_request (JSONObject)

Contains linked to request details.
show attribute

request (request)

Request object containing minimal request data.

service_approvers (JSONObject)

Array of user objects containing the approver(s) for this request.

short_description (string)read only

A short description of this request.

time_elapsed (datetime)read only

Indicates the time spent on this request.

email_cc (string)read only

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

email_to (string)read only

List of email addresses(to addresses) which received the request through e-mail.

created_by (user)read only

Indicates the requester who created this request.

responded_time (datetime)read only

Indicates the time at which this request is responded.

completed_time (datetime)read only

Indicates the time at which this request is completed.

sla (sla)read only

Indicates the SLA details associated with this request.

department (department)read only

Department to which this requester belongs.

is_service_request (boolean)read only

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

resolved_time (datetime)read only

Indicates the time at which this request was resolved.

last_updated_time (datetime)read only

Indicates the time when this request is last updated.

is_overdue (boolean)read only

Boolean value indicating whether this request is overdue.

is_first_response_overdue (boolean)read only

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

is_read (boolean)read only

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

notification_status (string)read only

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

approval_status (sdp_approval_status)read only

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

assigned_time (datetime)read only

Indicates the time at which this request was assigned to a technician.

deleted_assets (deleted_assets)read only

Array of deleted asset names associated to this request.

has_attachments (boolean)read only

Boolean value indicating whether this request has any attachments or not.

has_notes (boolean)read only

Boolean value indicating whether this request has any notes or not.

has_linked_requests (boolean)read only

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

has_project (boolean)read only

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

has_problem (boolean)read only

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

has_request_initiated_change (boolean)read only

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

has_request_caused_by_change (boolean)read only

Boolean value indicating whether this request is caused by a change or not.

has_purchase_orders (boolean)read only

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

has_draft (boolean)read only

Boolean value indicating whether this request has drafts or not.

has_dependency (boolean)read only

Boolean value indicating whether this request has a dependency or not.

is_reopened (boolean)read only

Boolean value indicating whether this request is reopened or not.

is_trashed (boolean)read only

Boolean value indicating whether this request is in trash.

is_editing_completed (boolean)read only

Boolean value indicating if the configured editor has already completed his editing.

deleted_on (datetime)read only

Indicates the time at which this request is deleted.

deleted_by (user)read only

Indicates the user who deleted the request.

service_cost (double)read only

Cost involved in the service other than resources.

total_cost (double)read only

Service cost plus the selected resource cost.

Curl

$ curl /api/v3/requests/{request_id}
      -X PUT 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request": {
        "subject": "Please hold off the issuance of macbook as the employee will be joining late",
        "description": "Hold off issuance of macbook",
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request": {
        "subject": "Please hold off the issuance of macbook as the employee will be joining late",
        "description": "Hold off issuance of macbook",
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request": {
        "subject": "Please hold off the issuance of macbook as the employee will be joining late",
        "description": "Hold off issuance of macbook",
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request": {
        "subject": "Please hold off the issuance of macbook as the employee will be joining late",
        "description": "Hold off issuance of macbook",
        "impact_details": "Routine tasks are pending due to mail server problem",
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed"
        },
        "status": {
            "name": "Open"
        }
    }
}'''
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": {
        "is_first_response_overdue": false,
        "impact_details": null,
        "impact": {
            "id": "1",
            "name": "High"
        },
        "urgency": {
            "id": "2",
            "name": "High"
        },
        "level": {
            "id": "4",
            "name": "Tier 4"
        },
        "description": "Hold off issuance of macbook",
        "priority": {
            "id": "4",
            "color": "#ff0000",
            "name": "High"
        },
        "sla": null,
        "template": {
            "id": "36",
            "name": "Request to start the process associated to a new hire"
        },
        "created_by": {
            "id": "4",
            "name": "administrator",
            "email_id": null
        },
        "requester": {
            "id": "6",
            "name": "Heather Graham",
            "email_id": "heather.g@zoho.com"
        },
        "is_editing_completed": true,
        "first_response_due_by_time": null,
        "service_category": {
            "id": "8",
            "name": "User Management"
        },
        "is_reopened": false,
        "status": {
            "id": "3",
            "color": "#006600",
            "name": "Onhold"
        },
        "approval_status": {
            "id": "1",
            "name": "Pending Approval"
        },
        "email_cc": [],
        "due_by_time": null,
        "closure_info": {
            "closure_code": {
                "id": "3",
                "name": "Canceled"
            },
            "requester_ack_comments": null,
            "closure_comments": null,
            "requester_ack_resolution": true
        },
        "is_trashed": false,
        "request_template_task_ids": [],
        "assets": [],
        "category": {
            "id": "11",
            "name": "Operating System"
        },
        "editor": {
            "id": "5",
            "name": "Shawn Adams",
            "email_id": null
        },
        "time_elapsed": {
            "display_value": "0hrs 0min",
            "value": "960"
        },
        "on_behalf_of": null,
        "is_service_request": true,
        "assigned_time": {
            "display_value": "Mar 8, 2017 04:40 PM",
            "value": "1488971406493"
        },
        "technician": {
            "id": "6",
            "name": "Heather Graham",
            "email_id": "heather.g@zoho.com"
        },
        "request_type": {
            "id": "2",
            "name": "Request For Information"
        },
        "department": null,
        "subject": "Please hold off the issuance of macbook as the employee will be joining late",
        "udf_fields": {
            "udf_date_601": {
                "display_value": "Mar 9, 2017 04:36 PM",
                "value": "1489057560000"
            },
            "udf_pick_20": "Admin",
            "udf_mline_314": "USA",
            "udf_pick_44": "Heather Graham",
            "udf_long_367": "123654789",
            "udf_sline_25": "5 th floor",
            "udf_sline_26": "6th floor",
            "udf_decimal_42": "124.00"
        },
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed",
            "submitted_by": {
                "id": "4",
                "name": "administrator",
                "email_id": null
            },
            "submitted_on": {
                "display_value": "Mar 10, 2017 12:11 PM",
                "value": "1489128104538"
            }
        },
        "mode": {
            "id": "2",
            "name": "Web Form"
        },
        "id": "115",
        "resolved_time": {
            "display_value": "Mar 8, 2017 04:46 PM",
            "value": "1488971786156"
        },
        "responded_time": null,
        "attachments": [
            {
                "module": "request",
                "authentication_id": "1",
                "content_type": "application/xml",
                "id": "602",
                "name": "requests.xml",
                "content_url": "/api/v3/requests/115/attachments/602/download",
                "size": {
                    "display_value": "12.48KB",
                    "value": 12780
                }
            },
            {
                "module": "request",
                "authentication_id": "1",
                "content_type": "text/plain",
                "id": "901",
                "name": "_View all requests.md",
                "content_url": "/api/v3/requests/115/attachments/901/download",
                "size": {
                    "display_value": "13.06KB",
                    "value": 13383
                }
            }
        ],
        "completed_time": {
            "display_value": "Mar 8, 2017 04:46 PM",
            "value": "1488971786156"
        },
        "site": null,
        "email_ids_to_notify": [
            "heather.g@zoho.com"
        ],
        "is_fcr": true,
        "is_overdue": false,
        "email_to": [],
        "last_updated_time": {
            "display_value": "Mar 10, 2017 12:40 PM",
            "value": "1489129838452"
        },
        "subcategory": {
            "id": "24",
            "name": "Mac OS X"
        },
        "item": null,
        "created_time": {
            "display_value": "Mar 8, 2017 04:40 PM",
            "value": "1488971406368"
        },
        "group": {
            "id": "1",
            "name": "Hardware Problems"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Delete Request

This operation lets you delete(move to trash) a request.

Url

/api/v3/requests/{request_id}/move_to_trash

Curl

$ curl /api/v3/requests/{request_id}/move_to_trash
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/move_to_trash";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/move_to_trash"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/move_to_trash"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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"
  }
}

Restore Request From Trash

This operation lets you restore a request from trash.

Url

/api/v3/requests/{request_id}/restore_from_trash

Curl

$ curl /api/v3/requests/{request_id}/restore_from_trash
      -X PUT 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '1'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/restore_from_trash";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = 1;
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/restore_from_trash"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
1
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/restore_from_trash"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''1'''
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": {
        "is_trashed": false,
        "is_first_response_overdue": false,
        "impact_details": null,
        "impact": {
            "id": "1",
            "name": "High"
        },
        "urgency": {
            "id": "2",
            "name": "High"
        },
        "level": {
            "id": "4",
            "name": "Tier 4"
        },
        "description": "Hold off issuance of macbook",
        "priority": {
            "id": "4",
            "color": "#ff0000",
            "name": "High"
        },
        "sla": null,
        "template": {
            "id": "36",
            "name": "Request to start the process associated to a new hire"
        },
        "created_by": {
            "id": "4",
            "name": "administrator",
            "email_id": null
        },
        "requester": {
            "id": "6",
            "name": "Heather Graham",
            "email_id": "heather.g@zoho.com"
        },
        "is_editing_completed": true,
        "first_response_due_by_time": null,
        "service_category": {
            "id": "8",
            "name": "User Management"
        },
        "is_reopened": false,
        "status": {
            "id": "3",
            "color": "#006600",
            "name": "Onhold"
        },
        "approval_status": {
            "id": "1",
            "name": "Pending Approval"
        },
        "email_cc": [],
        "due_by_time": null,
        "closure_info": {
            "closure_code": {
                "id": "3",
                "name": "Canceled"
            },
            "requester_ack_comments": null,
            "closure_comments": null,
            "requester_ack_resolution": true
        },
        "assets": [],
        "category": {
            "id": "11",
            "name": "Operating System"
        },
        "editor": {
            "id": "5",
            "name": "Shawn Adams",
            "email_id": null
        },
        "time_elapsed": {
            "display_value": "0hrs 0min",
            "value": "960"
        },
        "on_behalf_of": null,
        "is_service_request": true,
        "assigned_time": {
            "display_value": "Mar 8, 2017 04:40 PM",
            "value": "1488971406493"
        },
        "technician": {
            "id": "6",
            "name": "Heather Graham",
            "email_id": "heather.g@zoho.com"
        },
        "request_type": {
            "id": "2",
            "name": "Request For Information"
        },
        "department": null,
        "subject": "Please hold off the issuance of macbook as the employee will be joining late",
        "udf_fields": {
            "udf_date_601": {
                "display_value": "Mar 9, 2017 04:36 PM",
                "value": "1489057560000"
            },
            "udf_pick_20": "Admin",
            "udf_mline_314": "USA",
            "udf_pick_44": "Heather Graham",
            "udf_long_367": "123654789",
            "udf_sline_25": "5 th floor",
            "udf_sline_26": "6th floor",
            "udf_decimal_42": "124.00"
        },
        "resolution": {
            "content": "Mail Fetching Server problem has been fixed",
            "submitted_by": {
                "id": "4",
                "name": "administrator",
                "email_id": null
            },
            "submitted_on": {
                "display_value": "Mar 10, 2017 12:11 PM",
                "value": "1489128104538"
            }
        },
        "mode": {
            "id": "2",
            "name": "Web Form"
        },
        "id": "115",
        "resolved_time": {
            "display_value": "Mar 8, 2017 04:46 PM",
            "value": "1488971786156"
        },
        "responded_time": null,
        "attachments": [
            {
                "module": "request",
                "authentication_id": "1",
                "content_type": "application/xml",
                "id": "602",
                "name": "requests.xml",
                "content_url": "/api/v3/requests/115/attachments/602/download",
                "size": {
                    "display_value": "12.48KB",
                    "value": 12780
                }
            },
            {
                "module": "request",
                "authentication_id": "1",
                "content_type": "text/plain",
                "id": "901",
                "name": "_View all requests.md",
                "content_url": "/api/v3/requests/115/attachments/901/download",
                "size": {
                    "display_value": "13.06KB",
                    "value": 13383
                }
            }
        ],
        "completed_time": {
            "display_value": "Mar 8, 2017 04:46 PM",
            "value": "1488971786156"
        },
        "site": null,
        "email_ids_to_notify": [
            "heather.g@zoho.com"
        ],
        "is_fcr": true,
        "is_overdue": false,
        "email_to": [],
        "last_updated_time": {
            "display_value": "Mar 10, 2017 12:40 PM",
            "value": "1489129838452"
        },
        "subcategory": {
            "id": "24",
            "name": "Mac OS X"
        },
        "item": null,
        "created_time": {
            "display_value": "Mar 8, 2017 04:40 PM",
            "value": "1488971406368"
        },
        "group": {
            "id": "1",
            "name": "Hardware Problems"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Associate Project

This operation lets you associate a project with a request.

Url

/api/v3/requests/{request_id}/project

Curl

$ curl /api/v3/requests/{request_id}/project
      -X POST 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "request_project_association": {
        "project": {
            "id": "1"
        }
    }
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/project";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "request_project_association": {
        "project": {
            "id": "1"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/project"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "request_project_association": {
        "project": {
            "id": "1"
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/project"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "request_project_association": {
        "project": {
            "id": "1"
        }
    }
}'''
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_project_association": {
        "request": {
            "id": 1
        },
        "project": {
            "id": 1
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Dissociate Problem

This operation lets you detach(already attached) a problem from a request.

Url

/api/v3/requests/{request_id}/problem

Curl

$ curl /api/v3/requests/{request_id}/problem
      -X DELETE 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/problem";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/problem"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/problem"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "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 Tags In Request

This operation lets you associate tags to a request.

Url

/api/v3/requests/{request_id}/tag

Curl

$ curl /api/v3/requests/{request_id}/tag
      -X PUT 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
      -H "Content-Type: application/x-www-form-urlencoded"
      -d input_data= '{
    "tags": [
        {
            "id": "1"
        }
    ]
}'

Deluge

// Deluge Sample script
url = "/api/v3/requests/{request_id}/tag";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "tags": [
        {
            "id": "1"
        }
    ]
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/tag"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "tags": [
        {
            "id": "1"
        }
    ]
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

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

url = "/api/v3/requests/{request_id}/tag"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "tags": [
        {
            "id": "1"
        }
    ]
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": [
        {
            "status_code": 2000,
            "messages": [
                {
                    "status_code": 2000,
                    "type": "success",
                    "message": "Request tags associated"
                }
            ],
            "status": "success"
        }
    ],
    "tags": [
        {
            "name": "123",
            "id": "1"
        }
    ]
}