Skip to content

Request Note

Used to provide the comments about the latest state of the incident /service request by technician. It can be private / shared to the requester also.

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

Get List Request Note

This operation lets you to view the details of all the notes under the request.

Url

/api/v3/requests/{request_id}/notes

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl -G /api/v3/requests/{request_id}/notes
      -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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
}'

// Deluge Sample script
url = "/api/v3/requests/{request_id}/notes";
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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/notes"
$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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
}
'@
$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 = "/api/v3/requests/{request_id}/notes"
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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
}'''       
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": "success",
        "statuscode": "2000"
    },
    "notes": [
        {
            "id": "1",
            "description": "Need more info on this topic. Please contact me.",
            "added_by": {
                "id": "4",
                "name": "administrator"
            },
            "show_to_requester": true,
            "request": {
                "id": "2"
            },
            "added_time": {
                "value": 1455520864880,
                "display_value": "Feb 15, 2016 12:51 PM"
            },
            "last_updated_by": {
                "id": "53",
                "name": "custom tech"
            },
            "last_updated_time": {
                "value": 1455590864880,
                "display_value": "Jan 23, 2018 12:51 PM"
            }
        }
    ]
}

Get Request Note

This operation lets you view the details of a single note under Request.

Url

/api/v3/requests/{request_id}/notes/{note_id}

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl -G /api/v3/requests/{request_id}/notes/{note_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 Sample script
url = "/api/v3/requests/{request_id}/notes/{note_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 version - 5.1
$url = "/api/v3/requests/{request_id}/notes/{note_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 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}/notes/{note_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())

{
    "response_status": {
        "status": "success",
        "statuscode": "2000"
    },
    "note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "added_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "added_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        },
        "last_updated_by": {
            "id": "53",
            "name": "custom tech"
        },
        "last_updated_time": {
            "value": 1455590864880,
            "display_value": "Jan 23, 2018 12:51 PM"
        }
    }
}

Delete Request Note

This operation lets you delete a single or multiple notes under a Request.

Url

/api/v3/requests/{request_id}/notes/{note_id}


$ curl /api/v3/requests/{request_id}/notes/{note_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/requests/{request_id}/notes/{note_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/requests/{request_id}/notes/{note_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/requests/{request_id}/notes/{note_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"
  }
}

Edit Request Note

This operation lets you update the details of a already existing note under a request.

Url

/api/v3/requests/{request_id}/notes/{note_id}

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl /api/v3/requests/{request_id}/notes/{note_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= '{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
}'

// Deluge Sample script
url = "/api/v3/requests/{request_id}/notes/{note_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 = {
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/notes/{note_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 = @'
{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

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

url = "/api/v3/requests/{request_id}/notes/{note_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 = '''{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status": "success",
        "status_code": 2000
    },
    "request_note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "added_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "added_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        },
        "last_updated_by": {
            "id": "53",
            "name": "custom tech"
        },
        "last_updated_time": {
            "value": 1455590864880,
            "display_value": "Jan 23, 2018 12:51 PM"
        }
    }
}

Add Request Note

This operations lets you add a note under a request.

Mandatory Fields :- description

Url

/api/v3/requests/{request_id}/notes

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl /api/v3/requests/{request_id}/notes
      -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= '{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
}'

// Deluge Sample script
url = "/api/v3/requests/{request_id}/notes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/notes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

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

url = "/api/v3/requests/{request_id}/notes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
}'''
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": "success",
        "statuscode": "2000"
    },
    "note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "added_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "added_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        },
        "last_updated_by": {
            "id": "53",
            "name": "custom tech"
        },
        "last_updated_time": {
            "value": 1455590864880,
            "display_value": "Jan 23, 2018 12:51 PM"
        }
    }
}

Add Request Note

This operations lets you add a note under a request.

Mandatory Fields :- description

Url

/api/v3/requests/{request_id}/notes

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl /api/v3/requests/{request_id}/notes
      -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= '{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
}'

// Deluge Sample script
url = "/api/v3/requests/{request_id}/notes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/notes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

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

url = "/api/v3/requests/{request_id}/notes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": true,
        "mark_first_response": false,
        "add_to_linked_requests": true
    }
}'''
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": "success",
        "statuscode": "2000"
    },
    "note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "added_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "added_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        },
        "last_updated_by": {
            "id": "53",
            "name": "custom tech"
        },
        "last_updated_time": {
            "value": 1455590864880,
            "display_value": "Jan 23, 2018 12:51 PM"
        }
    }
}

Edit Request Note

This operation lets you update the details of a already existing note under a request.

Url

/api/v3/requests/{request_id}/notes/{note_id}

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl /api/v3/requests/{request_id}/notes/{note_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= '{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
}'

// Deluge Sample script
url = "/api/v3/requests/{request_id}/notes/{note_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 = {
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/notes/{note_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 = @'
{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

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

url = "/api/v3/requests/{request_id}/notes/{note_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 = '''{
    "note": {
        "description": "Need more info on this topic. Please contact me.",
        "show_to_requester": false
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status": "success",
        "status_code": 2000
    },
    "request_note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "added_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "added_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        },
        "last_updated_by": {
            "id": "53",
            "name": "custom tech"
        },
        "last_updated_time": {
            "value": 1455590864880,
            "display_value": "Jan 23, 2018 12:51 PM"
        }
    }
}

Delete Request Note

This operation lets you delete a single or multiple notes under a Request.

Url

/api/v3/requests/{request_id}/notes/{note_id}


$ curl /api/v3/requests/{request_id}/notes/{note_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/requests/{request_id}/notes/{note_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/requests/{request_id}/notes/{note_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/requests/{request_id}/notes/{note_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 Request Note

This operation lets you view the details of a single note under Request.

Url

/api/v3/requests/{request_id}/notes/{note_id}

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

description (html)
Text(content) to be entered as note.

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

Example 

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

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl -G /api/v3/requests/{request_id}/notes/{note_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 Sample script
url = "/api/v3/requests/{request_id}/notes/{note_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 version - 5.1
$url = "/api/v3/requests/{request_id}/notes/{note_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 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}/notes/{note_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())

{
    "response_status": {
        "status": "success",
        "statuscode": "2000"
    },
    "note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "added_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "added_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        },
        "last_updated_by": {
            "id": "53",
            "name": "custom tech"
        },
        "last_updated_time": {
            "value": 1455590864880,
            "display_value": "Jan 23, 2018 12:51 PM"
        }
    }
}

Get List Request Note

This operation lets you to view the details of all the notes under the request.

Url

/api/v3/requests/{request_id}/notes

Attributes

id (long)
Id of the note.

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

Example 

234759602834500

last_updated_by (user)read only
Updated user details.

last_updated_by (user)

last_updated_time (datetime)read only
Updated time of note.

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.

added_time (datetime)read only
Created time of note.

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

added_by (user)read only
Created user details.

added_by (user)

$ curl -G /api/v3/requests/{request_id}/notes
      -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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
}'

// Deluge Sample script
url = "/api/v3/requests/{request_id}/notes";
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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "/api/v3/requests/{request_id}/notes"
$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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
}
'@
$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 = "/api/v3/requests/{request_id}/notes"
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": "added_time",
        "sort_order": "desc",
        "get_total_count": true
    }
}'''       
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": "success",
        "statuscode": "2000"
    },
    "notes": [
        {
            "id": "1",
            "description": "Need more info on this topic. Please contact me.",
            "added_by": {
                "id": "4",
                "name": "administrator"
            },
            "show_to_requester": true,
            "request": {
                "id": "2"
            },
            "added_time": {
                "value": 1455520864880,
                "display_value": "Feb 15, 2016 12:51 PM"
            },
            "last_updated_by": {
                "id": "53",
                "name": "custom tech"
            },
            "last_updated_time": {
                "value": 1455590864880,
                "display_value": "Jan 23, 2018 12:51 PM"
            }
        }
    ]
}