Release Note

This API helps you to add additional information including technical information to a particular release.

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "release.release_engineer"
      },
      {
        "xpath": "release.roles.mref_development_head"
      }
    ],
    "users": [
      {
        "name": "test_name",
        "id": "100000000000042013"
      },
      {
        "name": "trial_name",
        "id": "100000000000042019"
      }
    ]
  }
}

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 Release Note

This operation helps to Add a note to a release.

Mandatory Fields :- description

Url

/api/v3/releases/{release_id}/notes

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "release.release_engineer"
      },
      {
        "xpath": "release.roles.mref_development_head"
      }
    ],
    "users": [
      {
        "name": "test_name",
        "id": "100000000000042013"
      },
      {
        "name": "trial_name",
        "id": "100000000000042019"
      }
    ]
  }
}

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/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>Sample note for Release&nbsp;</div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
}'

Deluge

// Deluge Sample script
url = "<url>//api/v3/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>Sample note for Release&nbsp;</div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
};
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/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>Sample note for Release&nbsp;</div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
}
'@
$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/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\" > <div>Sample note for Release&nbsp;</div> </div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
}'''
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": {
        "release_stage": {
            "internal_name": "submission",
            "inactive": false,
            "stage_index": 1,
            "name": "Submission",
            "id": "100000000000029003"
        },
        "performed_by": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"> <div>Sample note for Release&nbsp;<\/div> <\/div>",
        "id": "100000000000040101",
        "performed_time": {
            "display_value": "Jan 27, 2022 01:24 PM",
            "value": "1643270063904"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Edit Release Note

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

Url

/api/v3/releases/{release_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 information on users or roles to be notified on add/edit operation of the note

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "release.release_engineer"
      },
      {
        "xpath": "release.roles.mref_development_head"
      }
    ],
    "users": [
      {
        "name": "test_name",
        "id": "100000000000042013"
      },
      {
        "name": "trial_name",
        "id": "100000000000042019"
      }
    ]
  }
}

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/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>Sample note created for Release&nbsp;<br></div></div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
}'

Deluge

// Deluge Sample script
url = "<url>//api/v3/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>Sample note created for Release&nbsp;<br></div></div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
};
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/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>Sample note created for Release&nbsp;<br></div></div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
}
'@
$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/releases/{release_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 class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>Sample note created for Release&nbsp;<br></div></div>",
        "release_stage": {
            "id": "100000000000029003"
        }
    }
}'''
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": {
        "release_stage": {
            "internal_name": "submission",
            "inactive": false,
            "stage_index": 1,
            "name": "Submission",
            "id": "100000000000029003"
        },
        "performed_by": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>Sample note created for Release&nbsp;<br /><\/div><\/div>",
        "id": "100000000000040101",
        "performed_time": {
            "display_value": "Jan 27, 2022 01:24 PM",
            "value": "1643270063904"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Release Note

This operation helps to get a note of a release.

Url

/api/v3/releases/{release_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 information on users or roles to be notified on add/edit operation of the note

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "release.release_engineer"
      },
      {
        "xpath": "release.roles.mref_development_head"
      }
    ],
    "users": [
      {
        "name": "test_name",
        "id": "100000000000042013"
      },
      {
        "name": "trial_name",
        "id": "100000000000042019"
      }
    ]
  }
}

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/releases/{release_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/releases/{release_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/releases/{release_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/releases/{release_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": {
        "release_stage": {
            "internal_name": "submission",
            "inactive": false,
            "stage_index": 1,
            "name": "Submission",
            "id": "100000000000029003"
        },
        "performed_by": {
            "email_id": "test@test.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": "",
            "user_scope": "0",
            "phone": null,
            "name": "Test",
            "id": "100000000000033531",
            "photo_url": "https://contacts.zoho.com/file?sample",
            "is_vip_user": false,
            "department": null,
            "first_name": "Test",
            "job_title": null
        },
        "description": "<div class=\"personalize-wrapper\" style=\"font-family: &quot;PT Sans&quot;, Arial, Helvetica, sans-serif, sans-serif; font-size: 13px\"><div>Sample note created for Release&nbsp;<br /></div></div>",
        "id": "100000000000040101",
        "performed_time": {
            "display_value": "Jan 27, 2022 01:24 PM",
            "value": "1643270063904"
        }
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get List Release Note

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

Url

/api/v3/releases/{release_id}/notes

Attributes

id (long)
Denotes the unique ID of the note

description (html)
Contains description about the note

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

Example

{
  "notify_to": {
    "xpaths": [
      {
        "xpath": "release.release_engineer"
      },
      {
        "xpath": "release.roles.mref_development_head"
      }
    ],
    "users": [
      {
        "name": "test_name",
        "id": "100000000000042013"
      },
      {
        "name": "trial_name",
        "id": "100000000000042019"
      }
    ]
  }
}

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/releases/{release_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/releases/{release_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/releases/{release_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/releases/{release_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": [{
            "release_stage": {
                "internal_name": "submission",
                "inactive": false,
                "stage_index": 1,
                "name": "Submission",
                "id": "100000000000029003"
            },
            "performed_by": {
                "email_id": "test@test.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "",
                "user_scope": "0",
                "phone": null,
                "name": "Test",
                "id": "100000000000033531",
                "photo_url": "https://contacts.zoho.com/file?sample",
                "is_vip_user": false,
                "department": null,
                "first_name": "Test",
                "job_title": null
            },
            "description": "asasa",
            "id": "100000000000040091",
            "performed_time": {
                "display_value": "Jan 27, 2022 01:11 PM",
                "value": "1643269267468"
            }
        },
        {
            "release_stage": {
                "internal_name": "submission",
                "inactive": false,
                "stage_index": 1,
                "name": "Submission",
                "id": "100000000000029003"
            },
            "performed_by": {
                "email_id": "test@test.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "",
                "user_scope": "0",
                "phone": null,
                "name": "Test",
                "id": "100000000000033531",
                "photo_url": "https://contacts.zoho.com/file?sample",
                "is_vip_user": false,
                "department": null,
                "first_name": "Test",
                "job_title": null
            },
            "description": "Sample note created for Release&nbsp;",
            "id": "100000000000040101",
            "performed_time": {
                "display_value": "Jan 27, 2022 01:24 PM",
                "value": "1643270063904"
            }
        },
        {
            "release_stage": {
                "internal_name": "planning",
                "inactive": false,
                "stage_index": 1,
                "name": "Submission",
                "id": "100000000000029005"
            },
            "performed_by": {
                "email_id": "test@test.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "",
                "user_scope": "0",
                "phone": null,
                "name": "Test",
                "id": "100000000000033531",
                "photo_url": "https://contacts.zoho.com/file?sample",
                "is_vip_user": false,
                "department": null,
                "first_name": "Test",
                "job_title": null
            },
            "description": "Test Note",
            "id": "100000000000040117",
            "performed_time": {
                "display_value": "Jan 27, 2022 01:36 PM",
                "value": "1643270784044"
            }
        }
    ],
    "response_status": [{
        "status_code": 2000,
        "status": "success"
    }],
    "list_info": {
        "has_more_rows": false,
        "row_count": 3
    }
}

Delete Release Note

This operation helps you to delete note of a release.

Url

/api/v3/releases/{release_id}/notes/{note_id}

Curl

$ curl <url>//api/v3/releases/{release_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/releases/{release_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/releases/{release_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/releases/{release_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"
  }
}