Skip to content

Release Note

Configuration entity used to manage notes present in a release.

Attributes

id (long)
Unique identifier for note

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

Example 

234759602834500

stage (release_stage)
Release Stage under which note has to be added.

stage (release_stage)

last_updated_by (user)read only
Last updated by user.

last_updated_by (user)

last_updated_time (datetime)read only
Date of last updated time.

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
Date when note has been added.

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
User by whom note has been added.

added_by (user)

More Attributes Expand all

attachments (attachment)

List of attachments.

attachments (attachment)

Add Release Note

This operation is used to add a release note.

Url

<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/notes

Attributes

id (long)
Unique identifier for note

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

Example 

234759602834500

stage (release_stage)
Release Stage under which note has to be added.

stage (release_stage)

last_updated_by (user)read only
Last updated by user.

last_updated_by (user)

last_updated_time (datetime)read only
Date of last updated time.

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
Date when note has been added.

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
User by whom note has been added.

added_by (user)

More Attributes Expand all

attachments (attachment)

List of attachments.

attachments (attachment)

$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": "<div><b>Sample </b><i>Description</i></div><span mention='3' mention-type='user'>@guest</span> - <span mention='4' mention-type='user'>@administrator</span>",
        "stage": {
            "id": "1"
        }
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": "<div><b>Sample </b><i>Description</i></div><span mention='3' mention-type='user'>@guest</span> - <span mention='4' mention-type='user'>@administrator</span>",
        "stage": {
            "id": "1"
        }
    }
};
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/releases/{release_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": "<div><b>Sample </b><i>Description</i></div><span mention='3' mention-type='user'>@guest</span> - <span mention='4' mention-type='user'>@administrator</span>",
        "stage": {
            "id": "1"
        }
    }
}
'@
$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/releases/{release_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": "<div><b>Sample </b><i>Description</i></div><span mention='3' mention-type='user'>@guest</span> - <span mention='4' mention-type='user'>@administrator</span>",
        "stage": {
            "id": "1"
        }
    }
}'''
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": {
        "last_updated_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "added_time": {
            "display_value": "Nov 2, 2020 04:38 PM",
            "value": "1604315319692"
        },
        "has_attachments": false,
        "attachments": [],
        "last_updated_time": {
            "display_value": "Nov 2, 2020 04:38 PM",
            "value": "1604315319692"
        },
        "stage": {
            "internal_name": "submission",
            "stage_index": "1",
            "name": "Submission",
            "id": "1"
        },
        "added_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "description": "<div>\n <b>Sample </b>\n <i>Description</i>\n</div>\n<span mention=\"3\" mention-type=\"user\"></span> - \n<span mention=\"4\" mention-type=\"user\"></span>",
        "id": "1"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Edit Release Note

This operation is used to update a release note.

Url

<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/notes/{note_id}

Attributes

id (long)
Unique identifier for note

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

Example 

234759602834500

stage (release_stage)
Release Stage under which note has to be added.

stage (release_stage)

last_updated_by (user)read only
Last updated by user.

last_updated_by (user)

last_updated_time (datetime)read only
Date of last updated time.

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
Date when note has been added.

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
User by whom note has been added.

added_by (user)

More Attributes Expand all

attachments (attachment)

List of attachments.

attachments (attachment)

$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": "<div><b>Sample </b><i>Description <u>Updated</u></i><br></div>"
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": "<div><b>Sample </b><i>Description <u>Updated</u></i><br></div>"
    }
};
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/releases/{release_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": "<div><b>Sample </b><i>Description <u>Updated</u></i><br></div>"
    }
}
'@
$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/releases/{release_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": "<div><b>Sample </b><i>Description <u>Updated</u></i><br></div>"
    }
}'''
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": {
        "last_updated_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "added_time": {
            "display_value": "Nov 2, 2020 04:38 PM",
            "value": "1604315319692"
        },
        "has_attachments": false,
        "attachments": [],
        "last_updated_time": {
            "display_value": "Nov 2, 2020 04:41 PM",
            "value": "1604315509122"
        },
        "stage": {
            "internal_name": "submission",
            "stage_index": "1",
            "name": "Submission",
            "id": "1"
        },
        "added_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "description": "<div>\n <b>Sample </b>\n <i>Description <u>Updated</u></i>\n <br>\n</div>",
        "id": "1"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Release Note

This operation is used to fetch a particular release note.

Url

<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/notes/{note_id}

Attributes

id (long)
Unique identifier for note

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

Example 

234759602834500

description (html)
No Description

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

Example 

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

attachments (attachment)
List of attachments.

attachments (attachment)

images (media)
No Description

images (media)

stage (release_stage)
Release Stage under which note has to be added.

stage (release_stage)

last_updated_by (user)read only
Last updated by user.

last_updated_by (user)

More Attributes Expand all

last_updated_time (datetime)read only

Date of last updated time.

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

Date when note has been added.

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

User by whom note has been added.

added_by (user)

has_attachments (boolean)read only

No Description

has_attachments (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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 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/releases/{release_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)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "note": {
        "last_updated_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "added_time": {
            "display_value": "Nov 2, 2020 04:38 PM",
            "value": "1604315319692"
        },
        "has_attachments": false,
        "attachments": [],
        "last_updated_time": {
            "display_value": "Nov 2, 2020 04:38 PM",
            "value": "1604315319692"
        },
        "stage": {
            "internal_name": "submission",
            "stage_index": "1",
            "name": "Submission",
            "id": "1"
        },
        "added_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "description": "<div>\n <b>Sample </b>\n <i>Description</i>\n</div>\n<span mention=\"3\" mention-type=\"user\"></span> - \n<span mention=\"4\" mention-type=\"user\"></span>",
        "id": "1"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get List Release Note

This operation is used to fetch all notes under a release.

Url

<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/notes

Attributes

id (long)
Unique identifier for note

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

Example 

234759602834500

attachments (attachment)
List of attachments.

attachments (attachment)

images (media)
No Description

images (media)

stage (release_stage)
Release Stage under which note has to be added.

stage (release_stage)

last_updated_by (user)read only
Last updated by user.

last_updated_by (user)

last_updated_time (datetime)read only
Date of last updated time.

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.

More Attributes Expand all

added_time (datetime)read only

Date when note has been added.

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

User by whom note has been added.

added_by (user)

$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": 100,
        "start_index": 1,
        "get_total_count": true
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": 100,
        "start_index": 1,
        "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 = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": 100,
        "start_index": 1,
        "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 = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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": 100,
        "start_index": 1,
        "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())

{
    "notes": [
        {
            "last_updated_by": {
                "email_id": null,
                "name": "administrator",
                "is_vipuser": false,
                "id": "4",
                "department": null
            },
            "added_time": {
                "display_value": "Nov 2, 2020 04:38 PM",
                "value": "1604315319692"
            },
            "last_updated_time": {
                "display_value": "Nov 2, 2020 04:38 PM",
                "value": "1604315319692"
            },
            "stage": {
                "internal_name": "submission",
                "stage_index": "1",
                "name": "Submission",
                "id": "1"
            },
            "added_by": {
                "email_id": null,
                "name": "administrator",
                "is_vipuser": false,
                "id": "4",
                "department": null
            },
            "id": "1"
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "sort_field": "last_updated_time",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": 1
    }
}

Delete Release Note

This operation is used to delete a release note.

Url

<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/notes/{note_id}


$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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 = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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 = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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 = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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"
  }
}