<service domain|custom domain>/app/<portal>//api/v3/releases
Release
Release management includes processes, systems, and functions to package, build, test, and deploy a release into operation. The release process commences with the receipt of an approved request for a change to deploy a production-ready release package.
Attributes
id (long)
Unique identifier to identify the release request, assigned at creation
title (string)
Title of the release. A text in a plain format. No rich text or new line characters are allowed.
template (release_template)
Release templates help to create customized release template forms by defining its layout for the most frequently raised release. Thus the release can be created quickly with all the needed fields filled automatically.
stage (release_stage)
Indicates the current stage of the release
status (release_status)
Indicates the current status of the release
description (html)
Description of the release request
More Attributes Expand all
comment (string)
Reason for status update. Whenever the user modifies the status, comment* is mandatoryNote : comment mandatory by default via template configuration, can be made non mandatory
category (category)
Assign the Category of the CIs involved to this release, such as routers, switches, software etc
attachments (release_attachment)
Files that are attached to the release. A Maximum of 10 attachments can be attached to a release
configuration_items (configuration_item)
Critical items for which the release request has been raised
roll_out_plan (JSONObject)
Describe how the release process will be implemented
show attribute
back_out_plan (JSONObject)
A Contingency plan to be implemented in case release technicians decide to back out of the release will be recorded/planned under the back out plan section
show attribute
back_out_plan_description (html)
Describes in detail the mitigation plans if the release implementation were to be backed out
impact_details (JSONObject)
Describes how the release process will affect the business
show attribute
impact_details_description (html)
Contains detailed information on how the release will affect the organization, including any expected business loss or downtime
checklist (JSONObject)
Lists the tasks involved in the release process
show attribute
checklist_description (html)
A to-do list listing the essential steps to be completed in order to verify whether the release implementation is completed with all requirements fulfilled.
close_details (JSONObject)
Contains information about release closure
show attribute
Add Release
This operation helps you add a new release.
Mandatory Fields :- title, template, stage, status
Url
Attributes
id (long)
Unique identifier to identify the release request, assigned at creation
title (string)
Title of the release. A text in a plain format. No rich text or new line characters are allowed.
template (release_template)
Release templates help to create customized release template forms by defining its layout for the most frequently raised release. Thus the release can be created quickly with all the needed fields filled automatically.
stage (release_stage)
Indicates the current stage of the release
status (release_status)
Indicates the current status of the release
description (html)
Description of the release request
More Attributes Expand all
comment (string)
Reason for status update. Whenever the user modifies the status, comment* is mandatoryNote : comment mandatory by default via template configuration, can be made non mandatory
category (category)
Assign the Category of the CIs involved to this release, such as routers, switches, software etc
attachments (release_attachment)
Files that are attached to the release. A Maximum of 10 attachments can be attached to a release
configuration_items (configuration_item)
Critical items for which the release request has been raised
roll_out_plan (JSONObject)
Describe how the release process will be implemented
show attribute
back_out_plan (JSONObject)
A Contingency plan to be implemented in case release technicians decide to back out of the release will be recorded/planned under the back out plan section
show attribute
back_out_plan_description (html)
Describes in detail the mitigation plans if the release implementation were to be backed out
impact_details (JSONObject)
Describes how the release process will affect the business
show attribute
impact_details_description (html)
Contains detailed information on how the release will affect the organization, including any expected business loss or downtime
checklist (JSONObject)
Lists the tasks involved in the release process
show attribute
checklist_description (html)
A to-do list listing the essential steps to be completed in order to verify whether the release implementation is completed with all requirements fulfilled.
close_details (JSONObject)
Contains information about release closure
show attribute
$ curl <service domain|custom domain>/app/<portal>/api/v3/releases\
-X POST\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"release": {
"workflow": {
"id": "100000000000030023"
},
"template": {
"id": "100000000000030406"
},
"release_requester": null,
"release_type": {
"id": "100000000000007257"
},
"group": null,
"impact": null,
"release_engineer": {
"id": "100000000000033531"
},
"urgency": {
"id": "100000000000007272"
},
"release_manager": null,
"stage": {
"id": "100000000000029003"
},
"priority": {
"id": "100000000000005381"
},
"status": {
"id": "100000000000029381"
},
"risk": null,
"comment": "The above Stage/Status is set as part of 'Release' creation",
"category": null,
"subcategory": null,
"item": null,
"scheduled_start_time": null,
"scheduled_end_time": null,
"services": [{
"id": "100000000000007251"
}, {
"id": "100000000000007242"
}],
"assets": [],
"configuration_items": [],
"reason_for_release": {
"id": "100000000000026992"
},
"title": "Trial Release",
"description": null,
"roles": {
"mref_development_head": [{
"id": "100000000000033531"
}],
"mref_release_reviewer": [{
"id": "100000000000033531"
}]
},
"attachments": []
}
}'
// 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": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"release": {
"workflow": {
"id": "100000000000030023"
},
"template": {
"id": "100000000000030406"
},
"release_requester": null,
"release_type": {
"id": "100000000000007257"
},
"group": null,
"impact": null,
"release_engineer": {
"id": "100000000000033531"
},
"urgency": {
"id": "100000000000007272"
},
"release_manager": null,
"stage": {
"id": "100000000000029003"
},
"priority": {
"id": "100000000000005381"
},
"status": {
"id": "100000000000029381"
},
"risk": null,
"comment": "The above Stage/Status is set as part of 'Release' creation",
"category": null,
"subcategory": null,
"item": null,
"scheduled_start_time": null,
"scheduled_end_time": null,
"services": [{
"id": "100000000000007251"
}, {
"id": "100000000000007242"
}],
"assets": [],
"configuration_items": [],
"reason_for_release": {
"id": "100000000000026992"
},
"title": "Trial Release",
"description": null,
"roles": {
"mref_development_head": [{
"id": "100000000000033531"
}],
"mref_release_reviewer": [{
"id": "100000000000033531"
}]
},
"attachments": []
}
};
params = {"input_data": input_data};
response = invokeurl
[
url: url
type: POST
parameters: params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<url>/app/<portal>/api/v3/releases"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"release": {
"workflow": {
"id": "100000000000030023"
},
"template": {
"id": "100000000000030406"
},
"release_requester": null,
"release_type": {
"id": "100000000000007257"
},
"group": null,
"impact": null,
"release_engineer": {
"id": "100000000000033531"
},
"urgency": {
"id": "100000000000007272"
},
"release_manager": null,
"stage": {
"id": "100000000000029003"
},
"priority": {
"id": "100000000000005381"
},
"status": {
"id": "100000000000029381"
},
"risk": null,
"comment": "The above Stage/Status is set as part of 'Release' creation",
"category": null,
"subcategory": null,
"item": null,
"scheduled_start_time": null,
"scheduled_end_time": null,
"services": [{
"id": "100000000000007251"
}, {
"id": "100000000000007242"
}],
"assets": [],
"configuration_items": [],
"reason_for_release": {
"id": "100000000000026992"
},
"title": "Trial Release",
"description": null,
"roles": {
"mref_development_head": [{
"id": "100000000000033531"
}],
"mref_release_reviewer": [{
"id": "100000000000033531"
}]
},
"attachments": []
}
}
'@
$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" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"release": {
"workflow": {
"id": "100000000000030023"
},
"template": {
"id": "100000000000030406"
},
"release_requester": null,
"release_type": {
"id": "100000000000007257"
},
"group": null,
"impact": null,
"release_engineer": {
"id": "100000000000033531"
},
"urgency": {
"id": "100000000000007272"
},
"release_manager": null,
"stage": {
"id": "100000000000029003"
},
"priority": {
"id": "100000000000005381"
},
"status": {
"id": "100000000000029381"
},
"risk": null,
"comment": "The above Stage/Status is set as part of 'Release' creation",
"category": null,
"subcategory": null,
"item": null,
"scheduled_start_time": null,
"scheduled_end_time": null,
"services": [{
"id": "100000000000007251"
}, {
"id": "100000000000007242"
}],
"assets": [],
"configuration_items": [],
"reason_for_release": {
"id": "100000000000026992"
},
"title": "Trial Release",
"description": null,
"roles": {
"mref_development_head": [{
"id": "100000000000033531"
}],
"mref_release_reviewer": [{
"id": "100000000000033531"
}]
},
"attachments": []
}
}'''
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": {
"inactive": false,
"name": "General Template",
"id": "100000000000030406"
},
"attachments": [],
"roll_out_plan": {
"roll_out_plan_updated_on": null,
"roll_out_plan_updated_by": null,
"roll_out_plan_description": null
},
"display_id": {
"display_value": "RL-3",
"value": "3"
},
"roles": {
"mref_development_head": [{
"email_id": "test@test.com",
"is_technician": true,
"sms_mail": null,
"contact_info_id": "100000000000033529",
"mobile": null,
"last_name": "",
"user_scope": "0",
"phone": null,
"name": "Test",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
}],
"mref_release_reviewer": [{
"email_id": "test@test.com",
"is_technician": true,
"sms_mail": null,
"contact_info_id": "100000000000033529",
"mobile": null,
"last_name": "",
"user_scope": "0",
"phone": null,
"name": "Test",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
}],
"mref_uat_owner": [],
"mref_qa_manager": []
},
"emergency": false,
"release_requester": null,
"description": null,
"title": "Trial Release",
"release_engineer": {
"email_id": "test@test.com",
"cost_per_hour": "0",
"phone": null,
"name": "Test",
"mobile": null,
"last_name": "",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"sms_mail_id": null,
"first_name": "Test"
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Normal",
"id": "100000000000007272"
},
"workflow_instance_details": {
"id": "100000000000038019",
"status": {
"name": "Started",
"id": "100000000000027827"
}
},
"close_details": {
"close_details_updated_on": null,
"close_details_description": null,
"closure_code": null,
"close_details_updated_by": null
},
"rel": {
"projects": null,
"changes": null
},
"id": "100000000000038009",
"group": null,
"reason_for_release": {
"name": "Anti virus,firewall upgrades",
"id": "100000000000026992"
},
"created_time": {
"display_value": "Jan 25, 2022 06:52 PM",
"value": "1643116944706"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "100000000000030023",
"allowed_stages_config": "APPLY_GLOBAL"
},
"release_manager": null,
"impact": null,
"release_type": {
"color": "#f7c4c4",
"pre_approved": false,
"name": "Major",
"id": "100000000000007257"
},
"checklist": {
"checklist_description": null,
"checklist_updated_on": null,
"checklist_updated_by": null
},
"services": [{
"inactive": false,
"name": "Internet Access",
"id": "100000000000007242",
"sort_index": 0
}, {
"inactive": false,
"name": "Intranet",
"id": "100000000000007251",
"sort_index": 0
}],
"priority": {
"color": "#006600",
"name": "Normal",
"id": "100000000000005381"
},
"scheduled_end_time": null,
"back_out_plan": {
"back_out_plan_updated_by": null,
"back_out_plan_updated_on": null,
"back_out_plan_description": null
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"risk": null,
"impact_details": {
"impact_details_updated_on": null,
"impact_details_updated_by": null,
"impact_details_description": null
},
"category": null,
"subcategory": null,
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"in_progress": true,
"internal_name": "requested",
"inactive": false,
"prominent": true,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"notification_template": {
"push_notification": null,
"subject": "New release with ID: ##${display_id.display_value}## requested.",
"module": "Release",
"id": "100000000000029378",
"type": "ReleaseStatus_E-Mail_submission_requested",
"display_name": null,
"content": "<div>Release with ID: ${display_id.display_value} is requested.<br><\/div><div><br><\/div><div><b>User Comments:<\/b> ${comment} <br><\/div><div><br><\/div><div><i><b>Release Overview<\/b><\/i><br><\/div><div>--------------------------------------<br><\/div><div><br><\/div><div><b>Title:<\/b> ${title} <br><\/div><div><b>Requested by:<\/b> ${release_requester} <br><\/div><div><b>Current Phase:<\/b> ${stage.name} Stage with status as ${status.name} <br><\/div><div><b>Category:<\/b> ${category.name} <br><\/div><div><b>Sub-Category:<\/b> ${subcategory.name} <br><\/div><div><b>Item:<\/b> ${item.name} <br><\/div><div><b>Scheduled Start:<\/b> ${scheduled_start_time} <br><\/div><div><b>Scheduled End:<\/b> ${scheduled_end_time} <br><\/div><div><b>Description:<\/b> ${description} <br><\/div><div><br><\/div><div><b>Roles and Ownership:<\/b><br><\/div><div>${release_roles}<br><\/div><div><br><\/div><div>For more details:<br><\/div><div>${release_link}<br><\/div>",
"notify_to": {
"xpaths": [{
"xpath": "release.release_manager",
"display_name": "Release Manager"
}]
},
"isenabled": true
},
"name": "Requested",
"description": "Release of a service is requested.",
"id": "100000000000029381"
}
}
}
Edit Release
This operation helps you to edit or update a release.
Url
<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}
Attributes
id (long)
Unique identifier to identify the release request, assigned at creation
title (string)
Title of the release. A text in a plain format. No rich text or new line characters are allowed.
template (release_template)
Release templates help to create customized release template forms by defining its layout for the most frequently raised release. Thus the release can be created quickly with all the needed fields filled automatically.
stage (release_stage)
Indicates the current stage of the release
status (release_status)
Indicates the current status of the release
description (html)
Description of the release request
More Attributes Expand all
comment (string)
Reason for status update. Whenever the user modifies the status, comment* is mandatoryNote : comment mandatory by default via template configuration, can be made non mandatory
category (category)
Assign the Category of the CIs involved to this release, such as routers, switches, software etc
attachments (release_attachment)
Files that are attached to the release. A Maximum of 10 attachments can be attached to a release
configuration_items (configuration_item)
Critical items for which the release request has been raised
roll_out_plan (JSONObject)
Describe how the release process will be implemented
show attribute
back_out_plan (JSONObject)
A Contingency plan to be implemented in case release technicians decide to back out of the release will be recorded/planned under the back out plan section
show attribute
back_out_plan_description (html)
Describes in detail the mitigation plans if the release implementation were to be backed out
impact_details (JSONObject)
Describes how the release process will affect the business
show attribute
impact_details_description (html)
Contains detailed information on how the release will affect the organization, including any expected business loss or downtime
checklist (JSONObject)
Lists the tasks involved in the release process
show attribute
checklist_description (html)
A to-do list listing the essential steps to be completed in order to verify whether the release implementation is completed with all requirements fulfilled.
close_details (JSONObject)
Contains information about release closure
show attribute
$ curl <service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"release": {
"risk": {
"id": "100000000000026968"
},
"category": {
"id": "100000000000005229"
},
"subcategory": {
"id": "100000000000005275"
},
"roles": {
"mref_development_head": []
}
}
}'
// 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": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"release": {
"risk": {
"id": "100000000000026968"
},
"category": {
"id": "100000000000005229"
},
"subcategory": {
"id": "100000000000005275"
},
"roles": {
"mref_development_head": []
}
}
};
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" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"release": {
"risk": {
"id": "100000000000026968"
},
"category": {
"id": "100000000000005229"
},
"subcategory": {
"id": "100000000000005275"
},
"roles": {
"mref_development_head": []
}
}
}
'@
$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" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"release": {
"risk": {
"id": "100000000000026968"
},
"category": {
"id": "100000000000005229"
},
"subcategory": {
"id": "100000000000005275"
},
"roles": {
"mref_development_head": []
}
}
}'''
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": {
"inactive": false,
"name": "General Template",
"id": "100000000000030406"
},
"attachments": [],
"roll_out_plan": {
"roll_out_plan_updated_on": null,
"roll_out_plan_updated_by": null,
"roll_out_plan_description": null
},
"display_id": {
"display_value": "RL-3",
"value": "3"
},
"roles": {
"mref_development_head": [],
"mref_release_reviewer": [{
"email_id": "test@test.com",
"is_technician": true,
"sms_mail": null,
"contact_info_id": "100000000000033529",
"mobile": null,
"last_name": "",
"user_scope": "0",
"phone": null,
"name": "Test",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
}],
"mref_uat_owner": [],
"mref_qa_manager": []
},
"emergency": false,
"release_requester": null,
"description": null,
"title": "Trial Release",
"release_engineer": {
"email_id": "test@test.com",
"cost_per_hour": "0",
"phone": null,
"name": "Test",
"mobile": null,
"last_name": "",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"sms_mail_id": null,
"first_name": "Test"
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Normal",
"id": "100000000000007272"
},
"workflow_instance_details": {
"id": "100000000000038019",
"status": {
"name": "In Progress",
"id": "100000000000027830"
}
},
"close_details": {
"close_details_updated_on": null,
"close_details_description": null,
"closure_code": null,
"close_details_updated_by": null
},
"rel": {
"projects": null,
"changes": null
},
"id": "100000000000038009",
"group": null,
"reason_for_release": {
"name": "Anti virus,firewall upgrades",
"id": "100000000000026992"
},
"created_time": {
"display_value": "Jan 25, 2022 06:52 PM",
"value": "1643116944706"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "100000000000030023",
"allowed_stages_config": "APPLY_GLOBAL"
},
"release_manager": null,
"impact": null,
"release_type": {
"color": "#f7c4c4",
"pre_approved": false,
"name": "Major",
"id": "100000000000007257"
},
"checklist": {
"checklist_description": null,
"checklist_updated_on": null,
"checklist_updated_by": null
},
"services": [{
"inactive": false,
"name": "Internet Access",
"id": "100000000000007242",
"sort_index": 0
}, {
"inactive": false,
"name": "Intranet",
"id": "100000000000007251",
"sort_index": 0
}],
"priority": {
"color": "#006600",
"name": "Normal",
"id": "100000000000005381"
},
"scheduled_end_time": null,
"back_out_plan": {
"back_out_plan_updated_by": null,
"back_out_plan_updated_on": null,
"back_out_plan_description": null
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"risk": {
"name": "Low",
"id": "100000000000026968"
},
"impact_details": {
"impact_details_updated_on": null,
"impact_details_updated_by": null,
"impact_details_description": null
},
"category": {
"deleted": false,
"name": "Operating System",
"id": "100000000000005229"
},
"subcategory": {
"name": "Windows Server 2000",
"id": "100000000000005275"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"in_progress": true,
"internal_name": "requested",
"stage": {
"id": "100000000000029003"
},
"name": "Requested",
"id": "100000000000029381"
}
}
}
Get Release
This operation helps to get a single release.
Url
<service domain|custom domain>/app/<portal>/api/v3/releases/{release_id}
Attributes
id (long)
Unique identifier to identify the release request, assigned at creation
title (string)
Title of the release. A text in a plain format. No rich text or new line characters are allowed.
template (release_template)
Release templates help to create customized release template forms by defining its layout for the most frequently raised release. Thus the release can be created quickly with all the needed fields filled automatically.
stage (release_stage)
Indicates the current stage of the release
status (release_status)
Indicates the current status of the release
description (html)
Description of the release request
More Attributes Expand all
comment (string)
Reason for status update. Whenever the user modifies the status, comment* is mandatoryNote : comment mandatory by default via template configuration, can be made non mandatory
category (category)
Assign the Category of the CIs involved to this release, such as routers, switches, software etc
attachments (release_attachment)
Files that are attached to the release. A Maximum of 10 attachments can be attached to a release
configuration_items (configuration_item)
Critical items for which the release request has been raised
roll_out_plan (JSONObject)
Describe how the release process will be implemented
show attribute
back_out_plan (JSONObject)
A Contingency plan to be implemented in case release technicians decide to back out of the release will be recorded/planned under the back out plan section
show attribute
back_out_plan_description (html)
Describes in detail the mitigation plans if the release implementation were to be backed out
impact_details (JSONObject)
Describes how the release process will affect the business
show attribute
impact_details_description (html)
Contains detailed information on how the release will affect the organization, including any expected business loss or downtime
checklist (JSONObject)
Lists the tasks involved in the release process
show attribute
checklist_description (html)
A to-do list listing the essential steps to be completed in order to verify whether the release implementation is completed with all requirements fulfilled.
close_details (JSONObject)
Contains information about release closure
show attribute
$ 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: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-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": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
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" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"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" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"response_status": {
"status_code": 2000,
"status": "success"
},
"release": {
"template": {
"inactive": false,
"name": "General Template",
"id": "100000000000030406"
},
"attachments": [],
"roll_out_plan": {
"roll_out_plan_updated_on": null,
"roll_out_plan_updated_by": null,
"roll_out_plan_description": null
},
"display_id": {
"display_value": "RL-3",
"value": "3"
},
"roles": {
"mref_development_head": [],
"mref_release_reviewer": [{
"email_id": "test@test.com",
"is_technician": true,
"sms_mail": null,
"contact_info_id": "100000000000033529",
"mobile": null,
"last_name": "",
"user_scope": "0",
"phone": null,
"name": "Test",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
}],
"mref_uat_owner": [],
"mref_qa_manager": []
},
"emergency": false,
"release_requester": null,
"description": null,
"title": "Trial Release",
"release_engineer": {
"email_id": "test@test.com",
"cost_per_hour": "0",
"phone": null,
"name": "Test",
"mobile": null,
"last_name": "",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"sms_mail_id": null,
"first_name": "Test"
},
"next_review_on": null,
"assets": [],
"configuration_items": [],
"urgency": {
"name": "Normal",
"id": "100000000000007272"
},
"workflow_instance_details": {
"id": "100000000000038019",
"status": {
"name": "In Progress",
"id": "100000000000027830"
}
},
"close_details": {
"close_details_updated_on": null,
"close_details_description": null,
"closure_code": null,
"close_details_updated_by": null
},
"rel": {
"projects": null,
"changes": null
},
"id": "100000000000038009",
"group": null,
"reason_for_release": {
"name": "Anti virus,firewall upgrades",
"id": "100000000000026992"
},
"created_time": {
"display_value": "Jan 25, 2022 06:52 PM",
"value": "1643116944706"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "100000000000030023",
"allowed_stages_config": "APPLY_GLOBAL"
},
"release_manager": null,
"impact": null,
"release_type": {
"color": "#f7c4c4",
"pre_approved": false,
"name": "Major",
"id": "100000000000007257"
},
"checklist": {
"checklist_description": null,
"checklist_updated_on": null,
"checklist_updated_by": null
},
"services": [{
"inactive": false,
"name": "Internet Access",
"id": "100000000000007242",
"sort_index": 0
},
{
"inactive": false,
"name": "Intranet",
"id": "100000000000007251",
"sort_index": 0
}
],
"priority": {
"color": "#006600",
"name": "Normal",
"id": "100000000000005381"
},
"scheduled_end_time": null,
"back_out_plan": {
"back_out_plan_updated_by": null,
"back_out_plan_updated_on": null,
"back_out_plan_description": null
},
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"risk": {
"name": "Low",
"id": "100000000000026968"
},
"impact_details": {
"impact_details_updated_on": null,
"impact_details_updated_by": null,
"impact_details_description": null
},
"category": {
"deleted": false,
"name": "Operating System",
"id": "100000000000005229"
},
"subcategory": {
"name": "Windows Server 2000",
"id": "100000000000005275"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"in_progress": true,
"internal_name": "requested",
"stage": {
"id": "100000000000029003"
},
"name": "Requested",
"id": "100000000000029381"
}
}
}
Get List Release
This operation helps to get a list of releases.
Url
<service domain|custom domain>/app/<portal>/api/v3/releases
Attributes
id (long)
Unique identifier to identify the release request, assigned at creation
title (string)
Title of the release. A text in a plain format. No rich text or new line characters are allowed.
template (release_template)
Release templates help to create customized release template forms by defining its layout for the most frequently raised release. Thus the release can be created quickly with all the needed fields filled automatically.
stage (release_stage)
Indicates the current stage of the release
status (release_status)
Indicates the current status of the release
description (html)
Description of the release request
More Attributes Expand all
comment (string)
Reason for status update. Whenever the user modifies the status, comment* is mandatoryNote : comment mandatory by default via template configuration, can be made non mandatory
category (category)
Assign the Category of the CIs involved to this release, such as routers, switches, software etc
attachments (release_attachment)
Files that are attached to the release. A Maximum of 10 attachments can be attached to a release
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/releases\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
--data-urlencode input_data='{}'
// Deluge 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": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};
response = invokeurl
[
url: url
type: GET
parameters:params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/releases"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{}'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers
$response
#Python 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" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{}'''
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"response_status": [{
"status_code": 2000,
"status": "success"
}],
"list_info": {
"has_more_rows": false,
"row_count": 3
},
"releases": [{
"template": {
"inactive": false,
"name": "General Template",
"id": "100000000000030406"
},
"display_id": {
"display_value": "RL-1",
"value": "1"
},
"emergency": false,
"release_requester": null,
"description": null,
"title": "R11",
"release_engineer": null,
"next_review_on": null,
"urgency": null,
"workflow_instance_details": {
"id": "100000000000034003",
"status": {
"name": "Started",
"id": "100000000000027827"
}
},
"id": "100000000000034001",
"group": null,
"reason_for_release": null,
"created_time": {
"display_value": "Jan 22, 2022 01:20 PM",
"value": "1642837811798"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "100000000000030023",
"allowed_stages_config": "APPLY_GLOBAL"
},
"release_manager": null,
"impact": null,
"release_type": null,
"priority": null,
"scheduled_end_time": null,
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"risk": null,
"category": null,
"subcategory": null,
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"in_progress": true,
"internal_name": "requested",
"stage": {
"id": "100000000000029003"
},
"name": "Requested",
"id": "100000000000029381"
}
},
{
"template": {
"inactive": false,
"name": "General Template",
"id": "100000000000030406"
},
"display_id": {
"display_value": "RL-2",
"value": "2"
},
"emergency": false,
"release_requester": null,
"description": null,
"title": "PN",
"release_engineer": null,
"next_review_on": null,
"urgency": null,
"workflow_instance_details": {
"id": "100000000000034033",
"status": {
"name": "In Progress",
"id": "100000000000027830"
}
},
"id": "100000000000034031",
"group": null,
"reason_for_release": null,
"created_time": {
"display_value": "Jan 22, 2022 10:19 PM",
"value": "1642870199680"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "100000000000030023",
"allowed_stages_config": "APPLY_GLOBAL"
},
"release_manager": null,
"impact": null,
"release_type": null,
"priority": null,
"scheduled_end_time": null,
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"risk": null,
"category": null,
"subcategory": null,
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"in_progress": true,
"internal_name": "requested",
"stage": {
"id": "100000000000029003"
},
"name": "Requested",
"id": "100000000000029381"
}
},
{
"template": {
"inactive": false,
"name": "General Template",
"id": "100000000000030406"
},
"display_id": {
"display_value": "RL-3",
"value": "3"
},
"emergency": false,
"release_requester": null,
"description": null,
"title": "Trial Release",
"release_engineer": {
"email_id": "test@test.com",
"cost_per_hour": "0",
"phone": null,
"name": "Test",
"mobile": null,
"last_name": "",
"id": "100000000000033531",
"photo_url": "https://contacts.zoho.com/file?sample",
"sms_mail_id": null,
"first_name": "Test"
},
"next_review_on": null,
"urgency": {
"name": "Normal",
"id": "100000000000007272"
},
"workflow_instance_details": {
"id": "100000000000038019",
"status": {
"name": "In Progress",
"id": "100000000000027830"
}
},
"id": "100000000000038009",
"group": null,
"reason_for_release": {
"name": "Anti virus,firewall upgrades",
"id": "100000000000026992"
},
"created_time": {
"display_value": "Jan 25, 2022 06:52 PM",
"value": "1643116944706"
},
"item": null,
"workflow": {
"validated": true,
"name": "General Release Workflow",
"id": "100000000000030023",
"allowed_stages_config": "APPLY_GLOBAL"
},
"release_manager": null,
"impact": null,
"release_type": {
"color": "#f7c4c4",
"pre_approved": false,
"name": "Major",
"id": "100000000000007257"
},
"priority": {
"color": "#006600",
"name": "Normal",
"id": "100000000000005381"
},
"scheduled_end_time": null,
"site": null,
"completed_time": null,
"stage": {
"internal_name": "submission",
"inactive": false,
"stage_index": 1,
"name": "Submission",
"id": "100000000000029003"
},
"risk": {
"name": "Low",
"id": "100000000000026968"
},
"category": {
"deleted": false,
"name": "Operating System",
"id": "100000000000005229"
},
"subcategory": {
"name": "Windows Server 2000",
"id": "100000000000005275"
},
"deleted_time": null,
"notes_present": false,
"scheduled_start_time": null,
"status": {
"in_progress": true,
"internal_name": "requested",
"stage": {
"id": "100000000000029003"
},
"name": "Requested",
"id": "100000000000029381"
}
}
]
}
Delete Release
This operation helps you to delete a release
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: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-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": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
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" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"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" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"response_status": {
"status_code": 2000,
"status": "success"
}
}