Problem Note

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

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "problem.technician"
      }
    ],
    "users": [
      {
        "name": "John",
        "id": "100000000000036077"
      }
    ]
  }
}

attachments (attachment)
No Description

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

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

Add Problem Note

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

Mandatory Fields :- [“description”]

Url

/api/v3/problems/{problem_id}/notes

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "problem.technician"
      }
    ],
    "users": [
      {
        "name": "John",
        "id": "100000000000036077"
      }
    ]
  }
}

attachments (attachment)
No Description

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

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

Curl

$ curl <url>//api/v3/problems/{problem_id}/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": "100000000000036077",
                    "name": "John"
                }
            ],
            "xpaths": [
                {
                    "xpath": "problem.technician"
                }
            ]
        }
    }
}'

Deluge

// Deluge Sample script
url = "<url>//api/v3/problems/{problem_id}/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": "100000000000036077",
                    "name": "John"
                }
            ],
            "xpaths": [
                {
                    "xpath": "problem.technician"
                }
            ]
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<url>//api/v3/problems/{problem_id}/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": "100000000000036077",
                    "name": "John"
                }
            ],
            "xpaths": [
                {
                    "xpath": "problem.technician"
                }
            ]
        }
    }
}
'@
$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 = "<url>//api/v3/problems/{problem_id}/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": "100000000000036077",
                    "name": "John"
                }
            ],
            "xpaths": [
                {
                    "xpath": "problem.technician"
                }
            ]
        }
    }
}'''
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": "john.je@zylker.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "J",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006098",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "John",
            "id": "100000000000036077",
            "photo_url": "https://contacts.localzoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "John",
            "job_title": null
        },
        "description": "<div>Test Add Note<\/div>",
        "id": "100000000000038247",
        "performed_time": {
            "display_value": "Feb 2, 2023 12:53 PM",
            "value": "1675322599582"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Edit Problem Note

This operation helps you to edit or update a note to a problem.

Url

/api/v3/problems/{problem_id}/notes/{note_id}

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "problem.technician"
      }
    ],
    "users": [
      {
        "name": "John",
        "id": "100000000000036077"
      }
    ]
  }
}

attachments (attachment)
No Description

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

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

Curl

$ curl <url>//api/v3/problems/{problem_id}/notes/{note_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
    "note": {
        "description": "<div>Test Edit Note</div>",
        "notify_to": {
            "users": [],
            "xpaths": []
        }
    }
}'

Deluge

// Deluge Sample script
url = "<url>//api/v3/problems/{problem_id}/notes/{note_id}";
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 Note</div>",
        "notify_to": {
            "users": [],
            "xpaths": []
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<url>//api/v3/problems/{problem_id}/notes/{note_id}"
$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 Note</div>",
        "notify_to": {
            "users": [],
            "xpaths": []
        }
    }
}
'@
$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 = "<url>//api/v3/problems/{problem_id}/notes/{note_id}"
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 Note</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": "john@zylker.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4149000001242001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "John",
            "id": "4149000000871029",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "John",
            "job_title": null
        },
        "description": "<div>Test Edit Note<\/div>",
        "id": "4149000001305003",
        "performed_time": {
            "display_value": "Feb 2, 2023 12:47 PM",
            "value": "1675322245246"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Problem Note

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

Url

/api/v3/problems/{problem_id}/notes/{note_id}

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "problem.technician"
      }
    ],
    "users": [
      {
        "name": "John",
        "id": "100000000000036077"
      }
    ]
  }
}

attachments (attachment)
No Description

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

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

Curl

$ curl -G <url>//api/v3/problems/{problem_id}/notes/{note_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "<url>//api/v3/problems/{problem_id}/notes/{note_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<url>//api/v3/problems/{problem_id}/notes/{note_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

Python

#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 = "<url>//api/v3/problems/{problem_id}/notes/{note_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "note": {
        "performed_by": {
            "email_id": "john@zylker.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4149000001242001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "John",
            "id": "4149000000871029",
            "photo_url": "https://contacts.localzoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "John",
            "job_title": null
        },
        "description": "<div>Test Add Note<\/div>",
        "id": "4149000001305031",
        "performed_time": {
            "display_value": "Feb 2, 2023 01:20 PM",
            "value": "1675324206499"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get List Problem Note

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

Url

/api/v3/problems/{problem_id}/notes/

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "problem.technician"
      }
    ],
    "users": [
      {
        "name": "John",
        "id": "100000000000036077"
      }
    ]
  }
}

attachments (attachment)
No Description

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

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

Curl

$ curl -G <url>//api/v3/problems/{problem_id}/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

// Deluge Sample script
url = "<url>//api/v3/problems/{problem_id}/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

#Powershell version - 5.1
$url = "<url>//api/v3/problems/{problem_id}/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

#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 = "<url>//api/v3/problems/{problem_id}/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": "john@zylker.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": null,
          "last_name": null,
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4149000001242001",
            "is_default": true
          },
          "phone": null,
          "employee_id": null,
          "name": "John",
          "id": "4149000000871029",
          "photo_url": "https://contacts.localzoho.com/file?sample",
          "is_vip_user": false,
          "department": null,
          "first_name": "John",
          "job_title": null
        },
        "description": "Test Add Note",
        "id": "4149000001300019",
        "performed_time": {
          "display_value": "Jan 31, 2023 12:48 PM",
          "value": "1675149512922"
        }
      }
    ],
    "response_status": [
      {
        "status_code": 2000,
        "status": "success"
      }
    ],
    "list_info": {
      "has_more_rows": false,
      "row_count": 1
    }
}

Delete Problem Note

This operation helps you to delete a note in a problem.

Url

/api/v3/problems/{problem_id}/notes/{note_id}

Curl

$ curl <url>//api/v3/problems/{problem_id}/notes/{note_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

Deluge

// Deluge Sample script
url = "<url>//api/v3/problems/{problem_id}/notes/{note_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<url>//api/v3/problems/{problem_id}/notes/{note_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

Python

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

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

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