Skip to content

Change Note

This API helps you to add additional information including technical information to a particular change based on your observations. 

Attributes

id (long)
Denotes the unique ID of the note 

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

Example 

234759602834500

description (html)
Contains description about the Note 

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

Example 

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

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

attachments (attachment)
No Description

attachments (attachment)

performed_by (user)read only
Denotes the user who created the note 

performed_by (user)
Denotes the user who created the note 

performed_time (datetime)read only
Indicates the created time of the note 

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

Add Change Note

This operation helps you to add a note to a change.

Mandatory Fields :- description

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes

Attributes

id (long)
Denotes the unique ID of the note 

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

Example 

234759602834500

description (html)
Contains description about the Note 

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

Example 

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

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

attachments (attachment)
No Description

attachments (attachment)

performed_by (user)read only
Denotes the user who created the note 

performed_by (user)
Denotes the user who created the note 

performed_time (datetime)read only
Indicates the created time of the note 

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

$ curl <url>/app/<portal>//api/v3/changes/2000000033487/notes\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "note": {
    "description": "<div>Test Add Notes</div>",
    "notify_to": {
      "users": [
        {
          "id": "2000000033133",
          "name": "Bruce"
        }
      ],
      "xpaths": [
        {
          "xpath": "change.change_owner"
        }
      ]
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "note": {
    "description": "<div>Test Add Notes</div>",
    "notify_to": {
      "users": [
        {
          "id": "2000000033133",
          "name": "Bruce"
        }
      ],
      "xpaths": [
        {
          "xpath": "change.change_owner"
        }
      ]
    }
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "note": {
    "description": "<div>Test Add Notes</div>",
    "notify_to": {
      "users": [
        {
          "id": "2000000033133",
          "name": "Bruce"
        }
      ],
      "xpaths": [
        {
          "xpath": "change.change_owner"
        }
      ]
    }
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

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

url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "note": {
    "description": "<div>Test Add Notes</div>",
    "notify_to": {
      "users": [
        {
          "id": "2000000033133",
          "name": "Bruce"
        }
      ],
      "xpaths": [
        {
          "xpath": "change.change_owner"
        }
      ]
    }
  }
}'''
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())

{
  "note": {
    "performed_by": {
      "email_id": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zyker-2723.com",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "description": "<div>Test Add Notes</div>",
    "id": "2000000033536",
    "performed_time": {
      "display_value": "Aug 26, 2021 12:47 PM",
      "value": "1629962234247"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Edit Change Note

This operation helps you to edit or update a note of a change.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536

Attributes

id (long)
Denotes the unique ID of the note 

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

Example 

234759602834500

description (html)
Contains description about the Note 

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

Example 

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

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

attachments (attachment)
No Description

attachments (attachment)

performed_by (user)read only
Denotes the user who created the note 

performed_by (user)
Denotes the user who created the note 

performed_time (datetime)read only
Indicates the created time of the note 

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

$ curl <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "note": {
    "description": "<div>Test Edit Notes<br></div>",
    "notify_to": {
      "users": [],
      "xpaths": []
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "note": {
    "description": "<div>Test Edit Notes<br></div>",
    "notify_to": {
      "users": [],
      "xpaths": []
    }
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "note": {
    "description": "<div>Test Edit Notes<br></div>",
    "notify_to": {
      "users": [],
      "xpaths": []
    }
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

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

url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "note": {
    "description": "<div>Test Edit Notes<br></div>",
    "notify_to": {
      "users": [],
      "xpaths": []
    }
  }
}'''
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())

{
  "note": {
    "performed_by": {
      "email_id": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker-2723.com",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "description": "<div>Test Edit Notes<br /></div>",
    "id": "2000000033536",
    "performed_time": {
      "display_value": "Aug 26, 2021 12:47 PM",
      "value": "1629962234247"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Get Change Note

This operation helps you to get a note of a change.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536

Attributes

id (long)
Denotes the unique ID of the note 

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

Example 

234759602834500

description (html)
Contains description about the Note 

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

Example 

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

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

attachments (attachment)
No Description

attachments (attachment)

performed_by (user)read only
Denotes the user who created the note 

performed_by (user)
Denotes the user who created the note 

performed_time (datetime)read only
Indicates the created time of the note 

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

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "note": {
    "performed_by": {
      "email_id": "ad-360@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": "",
      "user_scope": "0",
      "phone": null,
      "name": "Bruce",
      "id": "2000000033133",
      "photo_url": "https://contacts.zylker.com/file?exp=10&ID=151&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "Bruce",
      "job_title": null
    },
    "description": "<div>Test Add Notes</div>",
    "id": "2000000033536",
    "performed_time": {
      "display_value": "Aug 26, 2021 12:47 PM",
      "value": "1629962234247"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Get List Change Note

This operation helps you to get all notes of a change.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes

Attributes

id (long)
Denotes the unique ID of the note 

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

Example 

234759602834500

description (html)
Contains description about the Note 

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

Example 

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

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

notify_to (notify_to)
Contains info on users or roles to be notified on add/edit operation of the note

attachments (attachment)
No Description

attachments (attachment)

performed_by (user)read only
Denotes the user who created the note 

performed_by (user)
Denotes the user who created the note 

performed_time (datetime)read only
Indicates the created time of the note 

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

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "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 = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "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())

{
  "notes": [
    {
      "performed_by": {
        "email_id": "ad-360@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": "",
        "user_scope": "0",
        "phone": null,
        "name": "Bruce",
        "id": "2000000033133",
        "photo_url": "https://contacts.zylker.com/file?exp=10&ID=150&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "Bruce",
        "job_title": null
      },
      "description": "Test Add Notes",
      "id": "2000000033536",
      "performed_time": {
        "display_value": "Aug 26, 2021 12:47 PM",
        "value": "1629962234247"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

Delete Change Note

This operation helps you to delete a note of a change.

Url

<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536


$ curl <service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

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

url = "<service domain|custom domain>/app/<portal>/api/v3/changes/2000000033487/notes/2000000033536"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}