Skip to content

Archive Request

Archived requests refers to collection of old requests.

Attributes

id (long)
Unique identifier used to identify the archived request.

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

Example

234759602834500

subject (string)
Subject of archived requests.

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

Example

Sample Content

Delete Archive Request

This operation lets you delete a archived requests.

Url

/api/v3/archive_requests/{request_id}

$ curl /api/v3/archive_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 Sample script
url = "/api/v3/archive_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 version - 5.1
$url = "/api/v3/archive_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 version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "/api/v3/archive_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 Archive Request

No Description

Url

No url

Attributes

id (long)
Unique identifier used to identify the archived request.

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

Example

234759602834500

subject (string)
Subject of archived requests.

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

Example

Sample Content

time_elapsed (datetime)
No Description

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

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

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

created_time (datetime)
No Description

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

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

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

due_by_time (datetime)
No Description

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

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

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

completed_time (datetime)
No Description

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

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

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

More Attributes Expand all

resolved_time (datetime)

No Description

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

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

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

last_updated_time (datetime)

No Description

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

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

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

notification_status (string)

No Description

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

Example

Sample Content

service_cost (double)

No Description

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

Example

23.08

total_cost (double)

No Description

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

Example

23.08

archive_checklists (archive_checklist)

No Description

archive_checklists (archive_checklist)

archive_notes (archive_note)

No Description

archive_notes (archive_note)

archive_task (archive_task)

No Description

archive_task (archive_task)

archive_worklog (archive_worklog)

No Description

archive_worklog (archive_worklog)

archive_notification (archive_notification)

No Description

archive_notification (archive_notification)

archive_conversation (archive_conversation)

No Description

archive_conversation (archive_conversation)

impact_details (impact_details)

No Description

impact_details (impact_details)

description (description)

No Description

description (description)

total_unassigned_time (total_unassigned_time)

No Description

total_unassigned_time (total_unassigned_time)

age_after_violation (age_after_violation)

No Description

age_after_violation (age_after_violation)

onhold_time (onhold_time)

No Description

onhold_time (onhold_time)

sla_violated_group (sla_violated_group)

No Description

sla_violated_group (sla_violated_group)

sla_violated_technician (technician)

No Description

sla_violated_technician (technician)

age_after_sla_response_violation (age_after_sla_response_violation)

No Description

age_after_sla_response_violation (age_after_sla_response_violation)

impact (impact)

No Description

impact (impact)

status (status)

No Description

status (status)

requester (user)

No Description

requester (user)

created_by (user)

No Description

created_by (user)

responded_time (responded_time)

No Description

responded_time (responded_time)

mode (mode)

No Description

mode (mode)

sla (sla)

No Description

sla (sla)

department (department)

No Description

department (department)

site (site)

No Description

site (site)

template (request_template)

No Description

template (request_template)

first_response_due_by_time (first_response_due_by_time)

No Description

first_response_due_by_time (first_response_due_by_time)

service_category (service_category)

No Description

service_category (service_category)

is_service_request (is_service_request)

No Description

is_service_request (is_service_request)

is_overdue (is_overdue)

No Description

is_overdue (is_overdue)

is_first_response_overdue (is_first_response_overdue)

No Description

is_first_response_overdue (is_first_response_overdue)

is_fcr (is_fcr)

No Description

is_fcr (is_fcr)

has_attachments (has_attachments)

No Description

has_attachments (has_attachments)

approval_status (approval_status)

No Description

approval_status (approval_status)

group (group)

No Description

group (group)

technician (user)

No Description

technician (user)

priority (priority)

No Description

priority (priority)

level (level)

No Description

level (level)

category (category)

No Description

category (category)

subcategory (subcategory)

No Description

subcategory (subcategory)

item (item)

No Description

item (item)

urgency (urgency)

No Description

urgency (urgency)

request_type (request_type)

No Description

request_type (request_type)

udf_fields (udf_fields)

No Description

udf_fields (udf_fields)

attachments (attachment)

No Description

attachments (attachment)

assets (assets)

No Description

assets (assets)

primary_asset (primary_asset)

No Description

primary_asset (primary_asset)

deleted_assets (deleted_assets)

No Description

deleted_assets (deleted_assets)

email_to (email_to)

No Description

email_to (email_to)

email_cc (email_cc)

No Description

email_cc (email_cc)

email_ids_to_notify (email_ids_to_notify)

No Description

email_ids_to_notify (email_ids_to_notify)

is_reopened (is_reopened)

No Description

is_reopened (is_reopened)

on_behalf_of (user)

No Description

on_behalf_of (user)

editor (user)

No Description

editor (user)

resolution (JSONObject)

No Description
show attribute

resolution (JSONObject)

submitted_by (user)

No Description

submitted_by (user)

resolution_attachments (attachment)

No Description

resolution_attachments (attachment)

content (resolution)

No Description

content (resolution)

submitted_on (resolution)

No Description

submitted_on (resolution)

closure_info (JSONObject)

No Description
show attribute

closure_info (JSONObject)

requester_ack_resolution (boolean)

No Description

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

requester_ack_comments (string)

No Description

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

Example

Sample Content

closure_code (closure_info)

No Description

closure_code (closure_info)

closure_comments (closure_info)

No Description

closure_comments (closure_info)

$ curl -G No url
      -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 = '{}'
// Deluge Sample script
url = "No url";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "No url"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{}
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

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

Get List Archive Request

No Description

Url

No url

Attributes

id (long)
Unique identifier used to identify the archived request.

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

Example

234759602834500

subject (string)
Subject of archived requests.

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

Example

Sample Content

created_time (datetime)
No Description

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

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

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

due_by_time (datetime)
No Description

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

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

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

notification_status (string)
No Description

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

Example

Sample Content

archive_checklists (archive_checklist)
No Description

archive_checklists (archive_checklist)

More Attributes Expand all

archive_notes (archive_note)

No Description

archive_notes (archive_note)

archive_task (archive_task)

No Description

archive_task (archive_task)

archive_worklog (archive_worklog)

No Description

archive_worklog (archive_worklog)

archive_notification (archive_notification)

No Description

archive_notification (archive_notification)

archive_conversation (archive_conversation)

No Description

archive_conversation (archive_conversation)

status (status)

No Description

status (status)

requester (user)

No Description

requester (user)

created_by (user)

No Description

created_by (user)

site (site)

No Description

site (site)

template (request_template)

No Description

template (request_template)

is_service_request (is_service_request)

No Description

is_service_request (is_service_request)

is_overdue (is_overdue)

No Description

is_overdue (is_overdue)

has_attachments (has_attachments)

No Description

has_attachments (has_attachments)

technician (user)

No Description

technician (user)

priority (priority)

No Description

priority (priority)

on_behalf_of (user)

No Description

on_behalf_of (user)

$ curl -G No url
      -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 = '{}'
// Deluge Sample script
url = "No url";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "No url"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{}
'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

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