变更说明

此 API 允许您根据观察添加额外信息，包括技术信息，至特定变更。

属性

id （长整型）
表示备注的唯一 ID

描述 （html）
包含备注的描述

notify_to （notify_to）
包含关于在添加/编辑备注操作时需要通知的用户或角色信息

附件 （attachment）
无描述

performed_by （user）read only
表示创建备注的用户

performed_time （datetime）read only
指示备注的创建时间

添加变更说明

此操作帮助您向变更添加备注。

必填字段：描述

URL

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

属性

id （长整型）
表示备注的唯一 ID

描述 （html）
包含备注的描述

notify_to （notify_to）
包含关于在添加/编辑备注操作时需要通知的用户或角色信息

附件 （attachment）
无描述

performed_by （user）read only
表示创建备注的用户

performed_time （datetime）read only
指示备注的创建时间

Curl

$ curl <service domain|custom domain>/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

// 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

#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

#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"
  }
}

编辑变更说明

此操作帮助您编辑或更新更改的备注。

URL

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

属性

id （长整型）
表示备注的唯一 ID

描述 （html）
包含备注的描述

notify_to （notify_to）
包含关于在添加/编辑备注操作时需要通知的用户或角色信息

附件 （attachment）
无描述

performed_by （user）read only
表示创建备注的用户

performed_time （datetime）read only
指示备注的创建时间

Curl

$ 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

// 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

#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

#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"
  }
}

获取变更说明

此操作帮助您获取更改的备注。

URL

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

属性

id （长整型）
表示备注的唯一 ID

描述 （html）
包含备注的描述

notify_to （notify_to）
包含关于在添加/编辑备注操作时需要通知的用户或角色信息

附件 （attachment）
无描述

performed_by （user）read only
表示创建备注的用户

performed_time （datetime）read only
指示备注的创建时间

Curl

$ 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

// 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

#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

#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"
  }
}

获取变更说明列表

此操作帮助您获取某个更改的所有备注。

URL

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

属性

id （长整型）
表示备注的唯一 ID

描述 （html）
包含备注的描述

notify_to （notify_to）
包含关于在添加/编辑备注操作时需要通知的用户或角色信息

附件 （attachment）
无描述

performed_by （user）read only
表示创建备注的用户

performed_time （datetime）read only
指示备注的创建时间

Curl

$ 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

// 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

#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

#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
  }
}

删除变更说明

此操作帮助您删除更改的备注。

URL

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

Curl

$ 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

// 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

#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

#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"
  }
}