<service domain|custom domain>/app/<portal>//api/v3/releases
Release
Release management helps in scheduling, planning, controlling, testing, and deploying an agreed and accepted change or project process for an organization.
Attributes
title (string)
Title of this release.
description (html)
Description of this release.
short_description (string)read only
A short description of this release.
impact (impact)
Impact of this release.
impact_details (release_descriptive_field)
Description about the impact of this release.
More Attributes Expand all
Add Release
This operation helps you to add new release.
Mandatory Fields :- title, template
Url
Attributes
title (string)
Title of this release.
description (html)
Description of this release.
short_description (string)read only
A short description of this release.
release_type (change_type)
Type of this release.
impact (impact)
Impact of this release.
More Attributes Expand all
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases\
-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='{
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
};
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"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
}
'@
$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"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
}'''
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"roll_out_plan": null,
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"id": "9",
"user": {
"email_id": null,
"name": "Guest",
"is_vipuser": false,
"id": "3",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"review_details": null,
"next_review_on": null,
"assets": [
{
"ci_id": "24",
"product": {
"id": "2"
},
"product_type": {
"id": "1"
},
"name": "asset1",
"id": "1",
"state": {
"id": "1"
},
"barcode": null
}
],
"configuration_items": [
{
"name": "ci1",
"id": "24"
}
],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": null,
"id": "9",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Mar 24, 2020 07:15 PM",
"value": "1585057512478"
},
"item": {
"name": "Install",
"id": "6"
},
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"name": "Standard",
"id": "1"
},
"checklist": null,
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"name": "Submission",
"id": "1"
},
"risk": {
"name": "High",
"id": "3"
},
"impact_details": null,
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}
Edit Release
This operation helps you to update the release by using the unique release_id.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}
Attributes
title (string)
Title of this release.
description (html)
Description of this release.
short_description (string)read only
A short description of this release.
release_type (change_type)
Type of this release.
impact (impact)
Impact of this release.
More Attributes Expand all
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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='{
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_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 = {
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
};
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}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
}
'@
$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}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"release": {
"roles": [
{
"role": {
"name": "release requester"
},
"user": {
"name": "guest"
}
}
],
"template": {
"id": "1",
"name": "General Template"
},
"risk": {
"name": "high"
},
"priority": {
"name": "high"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"next_review_on": null,
"urgency": {
"name": "Urgent"
},
"group": {
"site": null,
"name": "Hardware Problems"
},
"impact": {
"name": "High"
},
"release_type": {
"name": "Standard"
},
"category": {
"name": "Software"
},
"subcategory": {
"name": "IE 7"
},
"item": {
"name": "Install"
},
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820360370"
},
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820350370"
},
"stage": {
"name": "submission"
},
"status": {
"name": "Requested"
}
}
}'''
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"roll_out_plan": null,
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"id": "9",
"user": {
"email_id": null,
"name": "Guest",
"is_vipuser": false,
"id": "3",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"review_details": null,
"next_review_on": null,
"assets": [
{
"ci_id": "24",
"product": {
"id": "2"
},
"product_type": {
"id": "1"
},
"name": "asset2",
"id": "1",
"state": {
"id": "1"
},
"barcode": null
}
],
"configuration_items": [
{
"name": "ci2",
"id": "24"
}
],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": null,
"id": "9",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Mar 24, 2020 07:15 PM",
"value": "1585057512478"
},
"item": {
"name": "Install",
"id": "6"
},
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"name": "Standard",
"id": "1"
},
"checklist": null,
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"name": "Submission",
"id": "1"
},
"risk": {
"name": "High",
"id": "3"
},
"impact_details": null,
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}
Get Release
This operation helps you to view the release details by the unique release id.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}
Attributes
title (string)
Title of this release.
template (release_template)
Indicates the template which is used to create this release.
description (html)
Description of this release.
scheduled_start_time (datetime)
No Description
scheduled_end_time (datetime)
No Description
More Attributes Expand all
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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}";
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}"
$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}"
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"roll_out_plan": null,
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"id": "8",
"user": {
"email_id": null,
"name": "Guest",
"is_vipuser": false,
"id": "3",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"review_details": null,
"next_review_on": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820250370"
},
"assets": [
{
"ci_id": "24",
"product": {
"id": "2"
},
"product_type": {
"id": "1"
},
"name": "asset2",
"id": "1",
"state": {
"id": "1"
},
"barcode": null
}
],
"configuration_items": [
{
"name": "ci2",
"id": "24"
}
],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": null,
"id": "8",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Mar 24, 2020 07:04 PM",
"value": "1585056877590"
},
"item": {
"name": "Install",
"id": "6"
},
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"name": "Standard",
"id": "1"
},
"checklist": null,
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": null,
"completed_time": null,
"stage": {
"internal_name": "planning",
"name": "Planning",
"id": "2"
},
"risk": {
"name": "High",
"id": "3"
},
"impact_details": null,
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "rejected",
"stage": {
"id": "2"
},
"status_type": "Failed",
"name": "Rejected",
"id": "7"
}
}
}
Get List Release
This operation lets you to view the details of all the releases.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases
Attributes
title (string)
Title of this release.
template (release_template)
Indicates the template which is used to create this release.
description (html)
Description of this release.
scheduled_start_time (datetime)
No Description
scheduled_end_time (datetime)
No Description
More Attributes Expand all
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases\
-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": 10,
"start_index": 1,
"fields_required": [
"priority",
"release_type",
"scheduled_end_time",
"category",
"scheduled_start_time",
"created_time",
"completed_time",
"title",
"stage",
"status",
"notes_present",
"emergency",
"deleted_time"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
],
"search_criteria": {
"field": "title",
"value": "mssql",
"condition": "contains"
},
"filter_by": {
"name": "all_releases"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases";
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": 10,
"start_index": 1,
"fields_required": [
"priority",
"release_type",
"scheduled_end_time",
"category",
"scheduled_start_time",
"created_time",
"completed_time",
"title",
"stage",
"status",
"notes_present",
"emergency",
"deleted_time"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
],
"search_criteria": {
"field": "title",
"value": "mssql",
"condition": "contains"
},
"filter_by": {
"name": "all_releases"
}
}
};
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"
$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": 10,
"start_index": 1,
"fields_required": [
"priority",
"release_type",
"scheduled_end_time",
"category",
"scheduled_start_time",
"created_time",
"completed_time",
"title",
"stage",
"status",
"notes_present",
"emergency",
"deleted_time"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
],
"search_criteria": {
"field": "title",
"value": "mssql",
"condition": "contains"
},
"filter_by": {
"name": "all_releases"
}
}
}'@
$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"
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": 10,
"start_index": 1,
"fields_required": [
"priority",
"release_type",
"scheduled_end_time",
"category",
"scheduled_start_time",
"created_time",
"completed_time",
"title",
"stage",
"status",
"notes_present",
"emergency",
"deleted_time"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
],
"search_criteria": {
"field": "title",
"value": "mssql",
"condition": "contains"
},
"filter_by": {
"name": "all_releases"
}
}
}'''
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())
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"start_index": 1,
"sort_field": "title",
"search_criteria": {
"field": "title",
"value": "mssql",
"condition": "is"
},
"total_count": 1,
"sort_order": "asc",
"get_total_count": "true",
"row_count": 1
},
"releases": [
{
"template": {
"name": "General Template",
"id": "1"
},
"emergency": false,
"title": "MSSQL Server service pack upgrade release",
"next_review_on": {
"display_value": "Jun 22, 2020 03:34 PM",
"value": "1592820250370"
},
"urgency": {
"name": "Urgent",
"id": "1"
},
"id": "10",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Mar 24, 2020 07:25 PM",
"value": "1585058137756"
},
"item": {
"name": "Install",
"id": "6"
},
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"name": "Standard",
"id": "1"
},
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"completed_time": null,
"stage": {
"internal_name": "planning",
"name": "Planning",
"id": "2"
},
"risk": {
"name": "High",
"id": "3"
},
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "rejected",
"stage": {
"id": "2"
},
"status_type": "Failed",
"name": "Rejected",
"id": "7"
}
}
]
}
Delete Release
This operation lets you delete(move to trash) releases.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_move_to_trash
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_move_to_trash\
-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}/_move_to_trash";
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}/_move_to_trash"
$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}/_move_to_trash"
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"
}
}
Close Release
This operation allows you to close a single or multiple releases.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release-id}/_close
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release-id}/_close\
-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='{
"status": "completed",
"comment": "Release has been closed"
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release-id}/_close";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"status": "completed",
"comment": "Release has been closed"
};
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}/_close"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"status": "completed",
"comment": "Release has been closed"
}
'@
$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}/_close"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"status": "completed",
"comment": "Release has been closed"
}'''
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": null,
"attachments": [],
"roll_out_plan": {
"updated_on": null,
"internal_name": "roll_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "1"
},
"name": "Rollout Plan",
"updated_by": null,
"description": null,
"id": "2"
},
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_manager",
"prominent": true,
"user_type": "SDRM",
"name": "Release Manager",
"id": "1"
},
"release": {
"id": "1",
"title": "sadvcdcdxc"
},
"id": "1",
"user": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
}
}
],
"emergency": false,
"description": null,
"release_requester": null,
"title": "sadvcdcdxc",
"release_engineer": null,
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": null,
"close_details": {
"updated_on": null,
"internal_name": "close_details",
"attachments": [],
"stage": {
"internal_name": "close",
"stage_index": "9",
"name": "Closure",
"id": "9"
},
"release": {
"id": "1"
},
"name": "Close Details",
"updated_by": null,
"description": null,
"id": "5"
},
"id": "1",
"group": null,
"created_time": {
"display_value": "Jul 14, 2023 11:49 AM",
"value": "1689315540411"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "3",
"type": "General"
},
"release_manager": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
},
"impact": null,
"release_type": null,
"checklist": {
"updated_on": null,
"internal_name": "checklist",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "1"
},
"name": "CheckList",
"updated_by": null,
"description": null,
"id": "4"
},
"services": [],
"priority": null,
"scheduled_end_time": null,
"back_out_plan": {
"updated_on": null,
"internal_name": "back_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "1"
},
"name": "Backout Plan",
"updated_by": null,
"description": null,
"id": "1"
},
"site": null,
"completed_time": {
"display_value": "Jul 14, 2023 11:49 AM",
"value": "1689315586818"
},
"stage": {
"internal_name": "close",
"stage_index": "9",
"name": "Closure",
"id": "9"
},
"risk": null,
"impact_details": {
"updated_on": null,
"internal_name": "impact_details",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "1"
},
"name": "Impact Details",
"updated_by": null,
"description": null,
"id": "3"
},
"category": null,
"subcategory": null,
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"internal_name": "completed",
"stage": {
"id": "9"
},
"status_type": "Success",
"name": "Completed",
"id": "22"
}
}
}
Pickup Release
This operation allows you to pickup release on your name as a technician.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_pickup
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_pickup\
-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=''
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_pickup";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = ;
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}/_pickup"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
'@
$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}/_pickup"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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())
{
"response_status": [
{
"status_code": 2000,
"id": "3",
"status": "success"
}
],
"releases": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"attachments": [],
"roll_out_plan": {
"updated_on": null,
"internal_name": "roll_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "Rollout Plan",
"updated_by": null,
"description": null,
"id": "12"
},
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"prominent": true,
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"id": "3",
"user": {
"email_id": null,
"phone": "1122334455",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
}
},
{
"role": {
"internal_name": "release_engineer",
"prominent": true,
"user_type": "SGT",
"name": "Release Engineer",
"id": "2"
},
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"id": "6",
"user": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"release_requester": {
"email_id": null,
"phone": "8888",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
},
"title": "MSSQL Server service pack upgrade",
"release_engineer": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": {
"updated_on": null,
"internal_name": "close_details",
"attachments": [],
"stage": {
"internal_name": "close",
"stage_index": "9",
"name": "Closure",
"id": "9"
},
"release": {
"id": "3"
},
"name": "Close Details",
"updated_by": null,
"description": null,
"id": "15"
},
"id": "3",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Jul 14, 2023 11:51 AM",
"value": "1689315713969"
},
"item": {
"name": "Install",
"id": "6"
},
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "3",
"type": "General"
},
"release_manager": null,
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"pre_approved": true,
"name": "Standard",
"id": "1"
},
"checklist": {
"updated_on": null,
"internal_name": "checklist",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "CheckList",
"updated_by": null,
"description": null,
"id": "14"
},
"services": [
{
"name": "Application Login",
"id": "1",
"ciid": "1"
},
{
"name": "Communication",
"id": "2",
"ciid": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": {
"updated_on": null,
"internal_name": "back_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "Backout Plan",
"updated_by": null,
"description": null,
"id": "11"
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"stage_index": "1",
"name": "Submission",
"id": "1"
},
"image_token": "410e0161e46d140c7f178b77bbd5f595cb7883749ceec1ba122d866a648c60bafaadd61febd07e4c388b7bf809d89117ec870840",
"risk": {
"name": "High",
"id": "3"
},
"impact_details": {
"updated_on": null,
"internal_name": "impact_details",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "Impact Details",
"updated_by": null,
"description": null,
"id": "13"
},
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}
Assign Release
This operation allows you to pickup release on your name as a release engineer.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_assign
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_assign\
-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='{
"release": {
"release_engineer": {
"name": "heather graham"
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_assign";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"release": {
"release_engineer": {
"name": "heather graham"
}
}
};
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}/_assign"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"release": {
"release_engineer": {
"name": "heather graham"
}
}
}
'@
$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}/_assign"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"release": {
"release_engineer": {
"name": "heather graham"
}
}
}'''
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())
{
"response_status": [
{
"status_code": 2000,
"id": "6",
"status": "success"
}
],
"releases": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"attachments": [],
"roll_out_plan": {
"updated_on": null,
"internal_name": "roll_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "6"
},
"name": "Rollout Plan",
"updated_by": null,
"description": null,
"id": "27"
},
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"prominent": true,
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"release": {
"id": "6",
"title": "MSSQL Server service pack upgrade"
},
"id": "9",
"user": {
"email_id": null,
"phone": "1234567890",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
}
},
{
"role": {
"internal_name": "release_engineer",
"prominent": true,
"user_type": "SGT",
"name": "Release Engineer",
"id": "2"
},
"release": {
"id": "6",
"title": "MSSQL Server service pack upgrade"
},
"id": "12",
"user": {
"email_id": null,
"phone": "1234567890",
"name": "Heather Graham",
"mobile": "",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "7",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"release_requester": {
"email_id": null,
"phone": "8888",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
},
"title": "MSSQL Server service pack upgrade",
"release_engineer": {
"email_id": null,
"phone": "1234567890",
"name": "Heather Graham",
"mobile": "",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "7",
"department": null
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": {
"updated_on": null,
"internal_name": "close_details",
"attachments": [],
"stage": {
"internal_name": "close",
"stage_index": "9",
"name": "Closure",
"id": "9"
},
"release": {
"id": "6"
},
"name": "Close Details",
"updated_by": null,
"description": null,
"id": "30"
},
"id": "6",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Jul 14, 2023 11:57 AM",
"value": "1689316042661"
},
"item": {
"name": "Install",
"id": "6"
},
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "3",
"type": "General"
},
"release_manager": null,
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"pre_approved": true,
"name": "Standard",
"id": "1"
},
"checklist": {
"updated_on": null,
"internal_name": "checklist",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "6"
},
"name": "CheckList",
"updated_by": null,
"description": null,
"id": "29"
},
"services": [
{
"name": "Application Login",
"id": "1",
"ciid": "1"
},
{
"name": "Communication",
"id": "2",
"ciid": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": {
"updated_on": null,
"internal_name": "back_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "6"
},
"name": "Backout Plan",
"updated_by": null,
"description": null,
"id": "26"
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"stage_index": "1",
"name": "Submission",
"id": "1"
},
"image_token": "8ada7268ac4f2cf28c4a7594e0498cb95d7b9a263b63bb8e38eba1c31cd5b982e5a0f12e01b2944c83940b734bf90e1ba3def7b5",
"risk": {
"name": "High",
"id": "3"
},
"impact_details": {
"updated_on": null,
"internal_name": "impact_details",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "6"
},
"name": "Impact Details",
"updated_by": null,
"description": null,
"id": "28"
},
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}
Delete Release From Trash
This operation lets you delete the release permenantly(from the trash).
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_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}";
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}"
$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}"
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"
}
}
Restore Release From Trash
This operation lets you restore release from trash.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_restore_from_trash
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_restore_from_trash\
-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=''
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/_restore_from_trash";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = ;
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}/_restore_from_trash"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
'@
$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}/_restore_from_trash"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"attachments": [],
"roll_out_plan": {
"updated_on": null,
"internal_name": "roll_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "Rollout Plan",
"updated_by": null,
"description": null,
"id": "12"
},
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"prominent": true,
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"id": "3",
"user": {
"email_id": null,
"phone": "1122334455",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
}
},
{
"role": {
"internal_name": "release_engineer",
"prominent": true,
"user_type": "SGT",
"name": "Release Engineer",
"id": "2"
},
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"id": "6",
"user": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"release_requester": {
"email_id": null,
"phone": "8888",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
},
"title": "MSSQL Server service pack upgrade",
"release_engineer": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": {
"updated_on": null,
"internal_name": "close_details",
"attachments": [],
"stage": {
"internal_name": "close",
"stage_index": "9",
"name": "Closure",
"id": "9"
},
"release": {
"id": "3"
},
"name": "Close Details",
"updated_by": null,
"description": null,
"id": "15"
},
"id": "3",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Jul 14, 2023 11:51 AM",
"value": "1689315713969"
},
"item": {
"name": "Install",
"id": "6"
},
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "3",
"type": "General"
},
"release_manager": null,
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"pre_approved": true,
"name": "Standard",
"id": "1"
},
"checklist": {
"updated_on": null,
"internal_name": "checklist",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "CheckList",
"updated_by": null,
"description": null,
"id": "14"
},
"services": [
{
"name": "Application Login",
"id": "1",
"ciid": "1"
},
{
"name": "Communication",
"id": "2",
"ciid": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": {
"updated_on": null,
"internal_name": "back_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "Backout Plan",
"updated_by": null,
"description": null,
"id": "11"
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"stage_index": "1",
"name": "Submission",
"id": "1"
},
"image_token": "5746ffb59c4125fd730247345775cdceb7d18c00d3fa22b7d7268ed746f672763ca3c192c82a451b9db8bc1d395183105f64523e",
"risk": {
"name": "High",
"id": "3"
},
"impact_details": {
"updated_on": null,
"internal_name": "impact_details",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "3"
},
"name": "Impact Details",
"updated_by": null,
"description": null,
"
{
"response_status": [
{
"status_code": 2000,
"id": "4",
"status": "success"
}
],
"releases": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"attachments": [],
"roll_out_plan": {
"updated_on": null,
"internal_name": "roll_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "4"
},
"name": "Rollout Plan",
"updated_by": null,
"description": null,
"id": "17"
},
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"prominent": true,
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"release": {
"id": "4",
"title": "MSSQL Server service pack upgrade"
},
"id": "4",
"user": {
"email_id": null,
"phone": "8888",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
}
},
{
"role": {
"internal_name": "release_engineer",
"prominent": true,
"user_type": "SGT",
"name": "Release Engineer",
"id": "2"
},
"release": {
"id": "4",
"title": "MSSQL Server service pack upgrade"
},
"id": "7",
"user": {
"email_id": null,
"phone": "1234455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"release_requester": {
"email_id": null,
"phone": "8888",
"name": "Guest",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "4",
"department": null
},
"title": "MSSQL Server service pack upgrade",
"release_engineer": {
"email_id": null,
"phone": "1234455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": {
"content-url": "/images/default-profile-pic2.svg"
},
"is_vipuser": false,
"id": "5",
"department": null
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": {
"updated_on": null,
"internal_name": "close_details",
"attachments": [],
"stage": {
"internal_name": "close",
"stage_index": "9",
"name": "Closure",
"id": "9"
},
"release": {
"id": "4"
},
"name": "Close Details",
"updated_by": null,
"description": null,
"id": "20"
},
"id": "4",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Jul 14, 2023 11:51 AM",
"value": "1689315714876"
},
"item": {
"name": "Install",
"id": "6"
},
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "3",
"type": "General"
},
"release_manager": null,
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"pre_approved": true,
"name": "Standard",
"id": "1"
},
"checklist": {
"updated_on": null,
"internal_name": "checklist",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "4"
},
"name": "CheckList",
"updated_by": null,
"description": null,
"id": "19"
},
"services": [
{
"name": "Application Login",
"id": "1",
"ciid": "1"
},
{
"name": "Communication",
"id": "2",
"ciid": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": {
"updated_on": null,
"internal_name": "back_out_plan",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "4"
},
"name": "Backout Plan",
"updated_by": null,
"description": null,
"id": "16"
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"stage_index": "1",
"name": "Submission",
"id": "1"
},
"image_token": "d57bc79643beaad279a37694b623e6834a0261b5ccac5570e88202e6f3dd8045466465394be1b24f7f98156f7b43b0a746554a6b",
"risk": {
"name": "High",
"id": "3"
},
"impact_details": {
"updated_on": null,
"internal_name": "impact_details",
"attachments": [],
"stage": {
"internal_name": "planning",
"stage_index": "2",
"name": "Planning",
"id": "2"
},
"release": {
"id": "4"
},
"name": "Impact Details",
"updated_by": null,
"description": null,
"id": "18"
},
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}id": "13"
},
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}
Get Release Status Comments
This operation is used to fetch the release status comments.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/status_comments
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/status_comments\
-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}/status_comments";
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}/status_comments"
$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}/status_comments"
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())
{
"status_comments": [
{
"commented_by": {
"email_id": null,
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"stage": {
"internal_name": "planning",
"stage_index": 2,
"name": "Planning",
"id": "2"
},
"release": {
"short_description": "MSSQL Server service pack upgrade",
"id": "273",
"title": "MSSQL Server service pack upgrade"
},
"commented_on": {
"display_value": "Aug 5, 2020 11:56 PM",
"value": "1596652004059"
},
"comment": "The above Stage/Status is set as part of 'Release' creation",
"id": "1206",
"status": {
"internal_name": "rejected",
"stage": {
"id": "2"
},
"status_type": "Failed",
"name": "Rejected",
"id": "7"
}
}
],
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"start_index": 1,
"row_count": 1
}
}
Get Release Summary
This operation is used to fetch the release summary.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/summary
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/summary\
-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}/summary";
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}/summary"
$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}/summary"
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())
{
"summary": {
"reminders": {
"all": 1
},
"projects": {
"all": 1
},
"approvals": {
"all": 0
},
"changes": {
"all": 1
},
"id": "3",
"tasks": {
"all": 1,
"closed": 0
},
"worklogs": {
"all": 2
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Release History
This operation is used to fetch the release history.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/history
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/history\
-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}/history";
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}/history"
$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}/history"
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())
{
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"start_index": 1,
"row_count": 4
},
"history": [
{
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"by": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": null,
"is_vipuser": false,
"id": "5",
"department": null
},
"description": "",
"diff": [],
"id": "18",
"time": {
"display_value": "Jul 14, 2023 12:05 PM",
"date": "Jul 14, 2023",
"time": "12:05 PM",
"value": "1689316547738"
},
"operation": {
"name": "restore_from_trash",
"display_name": "Release Restored"
}
},
{
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"by": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": null,
"is_vipuser": false,
"id": "5",
"department": null
},
"description": "",
"diff": [],
"id": "17",
"time": {
"display_value": "Jul 14, 2023 12:05 PM",
"date": "Jul 14, 2023",
"time": "12:05 PM",
"value": "1689316526062"
},
"operation": {
"name": "move_to_trash",
"display_name": "Release Deleted"
}
},
{
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"by": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": null,
"is_vipuser": false,
"id": "5",
"department": null
},
"description": "",
"diff": [
{
"field": {
"name": "user",
"display_name": "User"
},
"previous_value": null,
"current_value": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": null,
"is_vipuser": false,
"id": "5",
"department": null
}
},
{
"field": {
"name": "id"
},
"previous_value": null,
"current_value": "6"
},
{
"field": {
"name": "role",
"display_name": "Role"
},
"previous_value": null,
"current_value": {
"internal_name": "release_engineer",
"prominent": true,
"user_type": "SGT",
"name": "Release Engineer",
"id": "2"
}
}
],
"id": "9",
"time": {
"display_value": "Jul 14, 2023 11:56 AM",
"date": "Jul 14, 2023",
"time": "11:56 AM",
"value": "1689315962471"
},
"operation": {
"name": "release_to_release_role_add",
"display_name": "User assigned for role"
}
},
{
"release": {
"id": "3",
"title": "MSSQL Server service pack upgrade"
},
"by": {
"email_id": null,
"phone": "1122334455",
"name": "administrator",
"mobile": "1234567890",
"profile_pic": null,
"is_vipuser": false,
"id": "5",
"department": null
},
"description": "",
"diff": [],
"id": "6",
"time": {
"display_value": "Jul 14, 2023 11:51 AM",
"date": "Jul 14, 2023",
"time": "11:51 AM",
"value": "1689315714003"
},
"operation": {
"name": "add",
"display_name": "Release Created"
}
}
]
}
Get Release Permissions
This operation is used to fetch the release permissions.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/get_permissions
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/get_permissions\
-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}/get_permissions";
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}/get_permissions"
$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}/get_permissions"
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"get_permissions": {
"1": {
"view": true,
"edit": true,
"approve": true
},
"2": {
"view": true,
"edit": true,
"approve": true
},
"3": {
"view": true,
"edit": true,
"approve": true
},
"4": {
"view": true,
"edit": true,
"approve": true
},
"5": {
"view": true,
"edit": true,
"approve": true
},
"6": {
"view": true,
"edit": true,
"approve": true
},
"7": {
"view": true,
"edit": true,
"approve": true
},
"8": {
"view": true,
"edit": true,
"approve": true
},
"9": {
"view": true,
"edit": true,
"approve": true
},
"-1": {
"edit": true,
"view": true,
"approve": true
}
}
}
Get Release Approval Summary
This operation is used to fetch the approval summary for the release. Used for Progress API.
Url
<service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/approval_levels/_approval_summary
$ curl -G <service domain|custom domain>/app/<portal>//api/v3/releases/{release_id}/approval_levels/_approval_summary\
-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}/approval_levels/_approval_summary";
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}/approval_levels/_approval_summary"
$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}/approval_levels/_approval_summary"
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())
{
"approval_summary": [
{
"latestDecision": "approve",
"comments": "Jump",
"stage": {
"internal_name": "submission",
"stage_index": 1,
"name": "Submission",
"description": "Stage when a release item is submitted",
"id": "1"
},
"approval_levels": [
{
"comments": "recommend",
"level": 1,
"associated_entity": "release",
"action_taken_by": {
"email_id": "guest@zylker.com",
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"rule": {
"type": "percent",
"value": "100"
},
"created_by": {
"email_id": "guest@zylker.com",
"name": "administrator",
"is_vipuser": false,
"id": "4",
"department": null
},
"deleted": false,
"stage": "1",
"created_on": {
"display_value": "Nov 18, 2020 07:47 PM",
"value": "1605709040349"
},
"name": "Default",
"id": "301",
"is_current": false,
"status": {
"name": "Approved",
"id": "2"
},
"action_taken_on": {
"display_value": "Nov 18, 2020 07:48 PM",
"value": "1605709123990"
}
}
],
"visited": true,
"commented_on": 1605709282091,
"status": {
"internal_name": "accepted",
"stage": {
"id": "1"
},
"status_type": "Success",
"name": "Accepted",
"id": "2"
}
},
{
"latestDecision": "inProgress",
"stage": {
"internal_name": "planning",
"stage_index": 2,
"name": "Planning",
"description": "Release planning",
"id": "2"
},
"visited": true
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "implementation",
"stage_index": 3,
"name": "Development",
"description": "Prepare the release build and test",
"id": "3"
},
"visited": false
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "testing",
"stage_index": 4,
"name": "Testing",
"description": "Test the developed release build",
"id": "4"
},
"visited": false
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "UAT",
"stage_index": 5,
"name": "UAT",
"description": "Build given to portion of Users to get tested and reviewd",
"id": "5"
},
"visited": false
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "deployment",
"stage_index": 6,
"name": "Deployment",
"description": "Release items are deployed",
"id": "6"
},
"visited": false
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "training",
"stage_index": 7,
"name": "Training",
"description": "Providing Training and Support for the deployed Release Items",
"id": "7"
},
"visited": false
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "review",
"stage_index": 8,
"name": "Review",
"description": "Review of release build",
"id": "8"
},
"visited": false
},
{
"latestDecision": "upcoming",
"stage": {
"internal_name": "close",
"stage_index": 9,
"name": "Closure",
"description": "Release closure",
"id": "9"
},
"visited": false
}
],
"response_status": [
{
"status_code": 2000,
"status": "success"
}
]
}
Add Release With Inline Images Attachments
No Description
Url
<service domain|custom domain>/app/<portal>//api/v3/releases
$ curl <service domain|custom domain>/app/<portal>//api/v3/releases\
-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='{
"release": {
"title": "test inline image",
"description": "test inline image <img src='image_url'>",
"images": {
"description": [
"image_url"
]
},
"attachments": [
{
"id": "301"
}
]
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/releases";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
"release": {
"title": "test inline image",
"description": "test inline image <img src='image_url'>",
"images": {
"description": [
"image_url"
]
},
"attachments": [
{
"id": "301"
}
]
}
};
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"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"release": {
"title": "test inline image",
"description": "test inline image <img src='image_url'>",
"images": {
"description": [
"image_url"
]
},
"attachments": [
{
"id": "301"
}
]
}
}
'@
$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"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"release": {
"title": "test inline image",
"description": "test inline image <img src='image_url'>",
"images": {
"description": [
"image_url"
]
},
"attachments": [
{
"id": "301"
}
]
}
}'''
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())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"name": "General Template",
"id": "1"
},
"short_description": "MSSQL Server service pack upgrade",
"roll_out_plan": null,
"closure_code": null,
"roles": [
{
"role": {
"internal_name": "release_requester",
"user_type": "ALL",
"name": "Release Requester",
"id": "3"
},
"id": "9",
"user": {
"email_id": null,
"name": "Guest",
"is_vipuser": false,
"id": "3",
"department": null
}
}
],
"emergency": false,
"description": "MSSQL Server service pack upgrade",
"title": "MSSQL Server service pack upgrade",
"review_details": null,
"next_review_on": null,
"assets": [
{
"ci_id": "24",
"product": {
"id": "2"
},
"product_type": {
"id": "1"
},
"name": "asset1",
"id": "1",
"state": {
"id": "1"
},
"barcode": null
}
],
"configuration_items": [
{
"name": "ci1",
"id": "24"
}
],
"urgency": {
"name": "Urgent",
"id": "1"
},
"close_details": null,
"id": "9",
"group": {
"site": null,
"name": "Hardware Problems",
"id": "1"
},
"created_time": {
"display_value": "Mar 24, 2020 07:15 PM",
"value": "1585057512478"
},
"item": {
"name": "Install",
"id": "6"
},
"impact": {
"name": "High",
"id": "1"
},
"release_type": {
"color": "#aaff66",
"name": "Standard",
"id": "1"
},
"checklist": null,
"services": [
{
"name": "Application Login",
"id": "1"
},
{
"name": "Communication",
"id": "2"
}
],
"priority": {
"color": "#ff0000",
"name": "High",
"id": "4"
},
"scheduled_end_time": {
"display_value": "Jun 22, 2020 03:36 PM",
"value": "1592820360370"
},
"back_out_plan": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"name": "Submission",
"id": "1"
},
"risk": {
"name": "High",
"id": "3"
},
"impact_details": null,
"category": {
"name": "Software",
"id": "3"
},
"subcategory": {
"name": "IE 7",
"id": "7"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": {
"display_value": "Jun 22, 2020 03:35 PM",
"value": "1592820350370"
},
"status": {
"internal_name": "requested",
"stage": {
"id": "1"
},
"status_type": "In Progress",
"name": "Requested",
"id": "1"
}
}
}