跳转到内容

发布

发布管理包括流程、系统和功能，用于打包、构建、测试和部署发布到运行环境。发布流程从收到已批准的变更请求开始，以部署生产准备好的发布包。

属性

id (long)
唯一标识发布请求，创建时分配

id (long)
数值位，被视为较大的值。

例子 

234759602834500

标题 (string)
发布标题。纯文本格式。不允许富文本或换行符。

标题 (string)
纯文本格式。不允许富文本或换行符。

例子 

ReleaseforDatabaseServerfirewallupgrades

模板 (release_template)
发布模板通过定义布局帮助创建自定义的发布模板表单，适用于最常见的发布。这样可以快速创建发布，自动填写所有必填字段。

模板 (release_template)
指示用于创建发布的发布模板

例子 

{
  "template": {
    "name": "test_template",
    "id": "105678900111042007"
  }
}

阶段 (release_stage)
指示发布的当前阶段

阶段 (release_stage)
指示发布的当前阶段

例子 

{
  "stage": {
    "name": "Submission_stage",
    "id": "100000000111042007"
  }
}

状态 (release_status)
指示发布的当前状态

状态 (release_status)
指示发布的当前状态

例子 

{
  "status": {
    "name": "test_status",
    "id": "100333300111042099"
  }
}

描述 (html)
发布请求的描述

描述 (html)
包含发布请求的描述

例子 

SuitableDescriptionoftherelease

更多属性 全部展开

计划开始时间 (datetime)

指示发布的计划开始时间

计划开始时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time (datetime)

指示完成发布的预定时间

scheduled_end_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

created_time (datetime)

指示发布请求的创建时间

created_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time (datetime)

指示发布请求的完成时间

completed_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

comment (string)

状态更新原因。每当用户修改状态时，comment* 为必填项注：通过模板配置默认强制填写 comment，可设为非必填

comment (string)
纯文本格式。不允许富文本或换行符。

例子 

Migrationapproved

next_review_on (datetime)

指示下一次审核的预定日期。

next_review_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow （workflow）

描述发布工作流及各阶段审批情况

workflow （workflow）
定义发布请求在各阶段所需的完整生命周期和相应审批

例子 

{
  "workflow": {
    "name": "test_workflow",
    "id": "105678900111069003"
  }
}

release_requester （user）

发布请求的发起人

release_requester （user）
指示发布请求的发起人

例子 

{
  "release_requester": {
    "email_id": "test@test.com",
    "name": "test_requester",
    "id": "100000000000042013"
  }
}

release_engineer （technician）

发布请求的负责人

release_engineer （technician）
发布请求的负责人

例子 

{
  "release_engineer": {
    "email_id": "test@test.com",
    "name": "test_release_engineer",
    "id": "100000000000042013"
  }
}

release_manager （technician）

管理发布请求整个生命周期的用户

release_manager （technician）
管理发布请求整个生命周期的用户

例子 

{
  "release_manager": {
    "email_id": "test@test.com",
    "name": "test_release_manager",
    "id": "100000000000042013"
  }
}

reason_for_release （reason_for_change）

发布发起的原因

reason_for_release （reason_for_change）
指示发布发起的原因

例子 

{
  "release_for_release": {
    "name": "test_reason_for_release",
    "id": "105678900111042007"
  }
}

impact （impact）

描述此发布将如何影响业务、部门、团队或用户

impact （impact）
指示发布对业务、部门、团队或用户的影响

例子 

{
  "impact": {
    "name": "test_impact",
    "id": "100000000111099077"
  }
}

priority （priority）

指示发布优先级为高、低或中

priority （priority）
指示发布的优先级

例子 

{
  "priority": {
    "name": "test_priority",
    "id": "10033330011177799"
  }
}

category （category）

为涉及的 CI 分配类别，如路由器、交换机、软件等

category （category）
指示发布涉及的 CI 的类别

例子 

{
  "category": {
    "name": "test_category",
    "id": "100333300111042000"
  }
}

subcategory （subcategory）

为选定类别分配子类别

subcategory （subcategory）
为选定类别分配子类别

例子 

{
  "subcategory": {
    "name": "test_subcategory",
    "id": "106666600111042099"
  }
}

item （item）

将项目分配至选定的类别和子类别

item （item）
指示分配至选定类别和子类别的项目

例子 

{
  "item": {
    "name": "test_item",
    "id": "100333300111042099"
  }
}

release_type （change_type）

指示发布类型是次要、重大、重要还是标准

release_type （change_type）
指示发布类型是次要、重大、重要还是标准

例子 

{
  "release_type": {
    "name": "test_release_type",
    "id": "100333300111042077"
  }
}

urgency （urgency）

指示发布请求的紧急程度

urgency （urgency）
指示发布请求的紧急程度

例子 

{
  "urgency": {
    "name": "test-urgency",
    "id": "100670890127890"
  }
}

services （service_category）

可能因发布受到影响的服务

services （service_category）
列出可能因发布受到影响的服务

例子 

{
  "services": [
    {
      "name": "test_service_1",
      "id": "122233390123003"
    },
    {
      "name": "test_service_2",
      "id": "122233390123011"
    },
    {
      "name": "test_service_3",
      "id": "122233390123015"
    }
  ]
}

assets （asset）

指示受影响或涉及的资产

assets （asset）
指示可能因发布受到影响或涉及的资产

例子 

{
  "assets": [
    {
      "name": "test-asset_1",
      "id": "234567890120999"
    },
    {
      "name": "test-asset_2",
      "id": "234567890123001"
    }
  ]
}

site （site）

指示发布请求所在站点

site （site）
指示发布请求所在站点

例子 

{
  "site": {
    "name": "test_site",
    "id": "100654320111042099"
  }
}

group （group）

发布请求分配的组

group （group）
指示发布请求分配的组

例子 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

risk （change_risk）

指示风险级别为高、低或中

risk （change_risk）
指示是否涉及高、低或中风险

例子 

{
  "risk": {
    "name": "test_risk",
    "id": "100333300111042001"
  }
}

roles （roles）

分配到各发布角色的用户

roles （roles）
指示分配到各发布角色的用户

例子 

{
  "roles": {
    "mref_development_head": [
      {
        "id": "100000000000033531"
      }
    ],
    "mref_release_reviewer": [
      {
        "id": "100000000000042007"
      },
      {
        "id": "100000000000042019"
      }
    ],
    "mref_qa_manager": [
      {
        "id": "100000000000033531"
      }
    ]
  }
}

attachments （release_attachment）

附加到发布的文件。最多可附加 10 个附件

attachments （release_attachment）
包含附加到发布的文件。最多可附加 10 个附件

例子 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields （udf_fields）

包含发布的用户自定义字段值

udf_fields （udf_fields）
包含与发布关联的用户自定义字段值

例子 

{
  "udf_fields": {
    "udf_long2": "1459402730964",
    "udf_long1": "1225",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

configuration_items （configuration_item）

发布请求涉及的关键项目

configuration_items （configuration_item）
指示发布请求涉及的关键项目

例子 

{
  "configuration_items": [
    {
      "name": "Floor 1 - Router",
      "id": "100000000000028792"
    },
    {
      "name": "Floor 12 - Router",
      "id": "100000000000028796"
    }
  ]
}

roll_out_plan （JSONObject）

描述发布流程的实施方式
show attribute

roll_out_plan （JSONObject）
描述发布流程的实施方式

例子 

{
  "roll_out_plan": {
    "roll_out_plan_description": "Rollout plan"
  }
}

roll_out_plan_description (html)

详细描述发布计划的实施

roll_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

roll_out_plan_updated_on (datetime)

指示发布计划最后实施时间

roll_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

roll_out_plan_updated_by （user）

最后更新发布计划的用户

roll_out_plan_updated_by （user）
最后更新发布计划的用户

例子 

{
  "roll_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

back_out_plan （JSONObject）

发布技术人员决定回滚发布时，将在回滚计划部分记录/规划应急方案
show attribute

back_out_plan （JSONObject）
描述如果发布请求取消，发布流程将如何进行

例子 

{
  "back_out_plan": {
    "back_out_plan_description": "Backout plan"
  }
}

back_out_plan_description (html)

详细描述发布实施回滚的缓解方案

back_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

back_out_plan_updated_on (datetime)

指示回滚计划最后实施时间

back_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

back_out_plan_updated_by （user）

最后更新回滚计划的用户

back_out_plan_updated_by （user）
最后更新回滚计划的用户

例子 

{
  "back_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

impact_details （JSONObject）

描述发布流程将如何影响业务
show attribute

impact_details （JSONObject）
描述发布流程将如何影响业务

例子 

{
  "impact_details": {
    "impact_details_description": "affects user"
  }
}

impact_details_description (html)

包含发布对组织影响的详细信息，包括预期业务损失或停机时间

impact_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

impact_details_updated_on (datetime)

指示影响详情最后更新时间

impact_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact_details_updated_by （user）

最后更新影响详情的用户

impact_details_updated_by （user）
最后更新影响详情的用户

例子 

{
  "impact_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

checklist （JSONObject）

列出发布流程中的任务
show attribute

checklist （JSONObject）
列出发布流程中的任务

例子 

{
  "checklist": {
    "checklist_description": "check list"
  }
}

checklist_description (html)

待办事项列表，列出完成发布实施且满足所有要求所需的关键步骤

checklist_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

checklist_updated_on (datetime)

指示检查表最后更新时间

checklist_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

checklist_updated_by （user）

最后更新检查表的用户

checklist_updated_by （user）
指示最后更新检查表的用户

例子 

{
  "checklist_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

close_details （JSONObject）

包含发布关闭相关信息
show attribute

close_details （JSONObject）
包含发布关闭相关信息

例子 

{
  "close_details": {
    "close_details_description": "close details",
    "closure_code": {
      "name": "Closed - Cancelled",
      "id": "1791511763340999"
    }
  }
}

close_details_description (html)

包含发布的关闭描述

close_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

closure_code （closure_code）

关闭代码表示关闭发布请求的原因

closure_code （closure_code）
关闭代码表示关闭发布请求的原因

例子 

{
  "closure_code": {
    "name": "test_closure_code",
    "id": "10011139111798001"
  }
}

close_details_updated_on (datetime)

指示关闭详情更新时间

close_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

close_details_updated_by （user）

最后更新关闭详情的用户

close_details_updated_by （user）
最后更新关闭详情的用户

例子 

{
  "close_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

display_id （sequence_number）read only

发布请求的序列号

display_id （sequence_number）
发布请求的序列号

例子 

{
  "display_id": {
    "display_value": "RL-1",
    "value": "1"
  }
}

emergency （boolean）read only

指示是否为紧急发布，true 为紧急，false 为普通

emergency （boolean）
布尔值，可为 true 或 false 两种值

notes_present （boolean）read only

指示发布是否包含任何备注

notes_present （boolean）
布尔值，可为 true 或 false 两种值

deleted_time (datetime)read only

指示发布请求被移至回收站的时间

deleted_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow_instance_details （workflow_instance）read only

指示工作流执行状态

workflow_instance_details （workflow_instance）
指示工作流执行状态

例子 

{
  "workflow_instance_details": {
    "id": "36338920932885067",
    "status": {
      "name": "In Progress",
      "id": "6633543434595966"
    }
  }
}

添加发布

此操作帮助您添加新版本。

必填字段 :- title, template, stage, status

Url

<service domain|custom domain>/app/<portal>/api/v3/releases

属性

id (long)
唯一标识发布请求，创建时分配

id (long)
数值位，被视为较大的值。

例子 

234759602834500

标题 (string)
发布标题。纯文本格式。不允许富文本或换行符。

标题 (string)
纯文本格式。不允许富文本或换行符。

例子 

ReleaseforDatabaseServerfirewallupgrades

模板 (release_template)
发布模板通过定义布局帮助创建自定义的发布模板表单，适用于最常见的发布。这样可以快速创建发布，自动填写所有必填字段。

模板 (release_template)
指示用于创建发布的发布模板

例子 

{
  "template": {
    "name": "test_template",
    "id": "105678900111042007"
  }
}

阶段 (release_stage)
指示发布的当前阶段

阶段 (release_stage)
指示发布的当前阶段

例子 

{
  "stage": {
    "name": "Submission_stage",
    "id": "100000000111042007"
  }
}

状态 (release_status)
指示发布的当前状态

状态 (release_status)
指示发布的当前状态

例子 

{
  "status": {
    "name": "test_status",
    "id": "100333300111042099"
  }
}

描述 (html)
发布请求的描述

描述 (html)
包含发布请求的描述

例子 

SuitableDescriptionoftherelease

更多属性 全部展开

计划开始时间 (datetime)

指示发布的计划开始时间

计划开始时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time (datetime)

指示完成发布的预定时间

scheduled_end_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

created_time (datetime)

指示发布请求的创建时间

created_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time (datetime)

指示发布请求的完成时间

completed_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

comment (string)

状态更新原因。每当用户修改状态时，comment* 为必填项注：通过模板配置默认强制填写 comment，可设为非必填

comment (string)
纯文本格式。不允许富文本或换行符。

例子 

Migrationapproved

next_review_on (datetime)

指示下一次审核的预定日期。

next_review_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow （workflow）

描述发布工作流及各阶段审批情况

workflow （workflow）
定义发布请求在各阶段所需的完整生命周期和相应审批

例子 

{
  "workflow": {
    "name": "test_workflow",
    "id": "105678900111069003"
  }
}

release_requester （user）

发布请求的发起人

release_requester （user）
指示发布请求的发起人

例子 

{
  "release_requester": {
    "email_id": "test@test.com",
    "name": "test_requester",
    "id": "100000000000042013"
  }
}

release_engineer （technician）

发布请求的负责人

release_engineer （technician）
发布请求的负责人

例子 

{
  "release_engineer": {
    "email_id": "test@test.com",
    "name": "test_release_engineer",
    "id": "100000000000042013"
  }
}

release_manager （technician）

管理发布请求整个生命周期的用户

release_manager （technician）
管理发布请求整个生命周期的用户

例子 

{
  "release_manager": {
    "email_id": "test@test.com",
    "name": "test_release_manager",
    "id": "100000000000042013"
  }
}

reason_for_release （reason_for_change）

发布发起的原因

reason_for_release （reason_for_change）
指示发布发起的原因

例子 

{
  "release_for_release": {
    "name": "test_reason_for_release",
    "id": "105678900111042007"
  }
}

impact （impact）

描述此发布将如何影响业务、部门、团队或用户

impact （impact）
指示发布对业务、部门、团队或用户的影响

例子 

{
  "impact": {
    "name": "test_impact",
    "id": "100000000111099077"
  }
}

priority （priority）

指示发布优先级为高、低或中

priority （priority）
指示发布的优先级

例子 

{
  "priority": {
    "name": "test_priority",
    "id": "10033330011177799"
  }
}

category （category）

为涉及的 CI 分配类别，如路由器、交换机、软件等

category （category）
指示发布涉及的 CI 的类别

例子 

{
  "category": {
    "name": "test_category",
    "id": "100333300111042000"
  }
}

subcategory （subcategory）

为选定类别分配子类别

subcategory （subcategory）
为选定类别分配子类别

例子 

{
  "subcategory": {
    "name": "test_subcategory",
    "id": "106666600111042099"
  }
}

item （item）

将项目分配至选定的类别和子类别

item （item）
指示分配至选定类别和子类别的项目

例子 

{
  "item": {
    "name": "test_item",
    "id": "100333300111042099"
  }
}

release_type （change_type）

指示发布类型是次要、重大、重要还是标准

release_type （change_type）
指示发布类型是次要、重大、重要还是标准

例子 

{
  "release_type": {
    "name": "test_release_type",
    "id": "100333300111042077"
  }
}

urgency （urgency）

指示发布请求的紧急程度

urgency （urgency）
指示发布请求的紧急程度

例子 

{
  "urgency": {
    "name": "test-urgency",
    "id": "100670890127890"
  }
}

services （service_category）

可能因发布受到影响的服务

services （service_category）
列出可能因发布受到影响的服务

例子 

{
  "services": [
    {
      "name": "test_service_1",
      "id": "122233390123003"
    },
    {
      "name": "test_service_2",
      "id": "122233390123011"
    },
    {
      "name": "test_service_3",
      "id": "122233390123015"
    }
  ]
}

assets （asset）

指示受影响或涉及的资产

assets （asset）
指示可能因发布受到影响或涉及的资产

例子 

{
  "assets": [
    {
      "name": "test-asset_1",
      "id": "234567890120999"
    },
    {
      "name": "test-asset_2",
      "id": "234567890123001"
    }
  ]
}

site （site）

指示发布请求所在站点

site （site）
指示发布请求所在站点

例子 

{
  "site": {
    "name": "test_site",
    "id": "100654320111042099"
  }
}

group （group）

发布请求分配的组

group （group）
指示发布请求分配的组

例子 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

risk （change_risk）

指示风险级别为高、低或中

risk （change_risk）
指示是否涉及高、低或中风险

例子 

{
  "risk": {
    "name": "test_risk",
    "id": "100333300111042001"
  }
}

roles （roles）

分配到各发布角色的用户

roles （roles）
指示分配到各发布角色的用户

例子 

{
  "roles": {
    "mref_development_head": [
      {
        "id": "100000000000033531"
      }
    ],
    "mref_release_reviewer": [
      {
        "id": "100000000000042007"
      },
      {
        "id": "100000000000042019"
      }
    ],
    "mref_qa_manager": [
      {
        "id": "100000000000033531"
      }
    ]
  }
}

attachments （release_attachment）

附加到发布的文件。最多可附加 10 个附件

attachments （release_attachment）
包含附加到发布的文件。最多可附加 10 个附件

例子 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields （udf_fields）

包含发布的用户自定义字段值

udf_fields （udf_fields）
包含与发布关联的用户自定义字段值

例子 

{
  "udf_fields": {
    "udf_long2": "1459402730964",
    "udf_long1": "1225",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

configuration_items （configuration_item）

发布请求涉及的关键项目

configuration_items （configuration_item）
指示发布请求涉及的关键项目

例子 

{
  "configuration_items": [
    {
      "name": "Floor 1 - Router",
      "id": "100000000000028792"
    },
    {
      "name": "Floor 12 - Router",
      "id": "100000000000028796"
    }
  ]
}

roll_out_plan （JSONObject）

描述发布流程的实施方式
show attribute

roll_out_plan （JSONObject）
描述发布流程的实施方式

例子 

{
  "roll_out_plan": {
    "roll_out_plan_description": "Rollout plan"
  }
}

roll_out_plan_description (html)

详细描述发布计划的实施

roll_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

roll_out_plan_updated_on (datetime)

指示发布计划最后实施时间

roll_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

roll_out_plan_updated_by （user）

最后更新发布计划的用户

roll_out_plan_updated_by （user）
最后更新发布计划的用户

例子 

{
  "roll_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

back_out_plan （JSONObject）

发布技术人员决定回滚发布时，将在回滚计划部分记录/规划应急方案
show attribute

back_out_plan （JSONObject）
描述如果发布请求取消，发布流程将如何进行

例子 

{
  "back_out_plan": {
    "back_out_plan_description": "Backout plan"
  }
}

back_out_plan_description (html)

详细描述发布实施回滚的缓解方案

back_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

back_out_plan_updated_on (datetime)

指示回滚计划最后实施时间

back_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

back_out_plan_updated_by （user）

最后更新回滚计划的用户

back_out_plan_updated_by （user）
最后更新回滚计划的用户

例子 

{
  "back_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

impact_details （JSONObject）

描述发布流程将如何影响业务
show attribute

impact_details （JSONObject）
描述发布流程将如何影响业务

例子 

{
  "impact_details": {
    "impact_details_description": "affects user"
  }
}

impact_details_description (html)

包含发布对组织影响的详细信息，包括预期业务损失或停机时间

impact_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

impact_details_updated_on (datetime)

指示影响详情最后更新时间

impact_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact_details_updated_by （user）

最后更新影响详情的用户

impact_details_updated_by （user）
最后更新影响详情的用户

例子 

{
  "impact_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

checklist （JSONObject）

列出发布流程中的任务
show attribute

checklist （JSONObject）
列出发布流程中的任务

例子 

{
  "checklist": {
    "checklist_description": "check list"
  }
}

checklist_description (html)

待办事项列表，列出完成发布实施且满足所有要求所需的关键步骤

checklist_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

checklist_updated_on (datetime)

指示检查表最后更新时间

checklist_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

checklist_updated_by （user）

最后更新检查表的用户

checklist_updated_by （user）
指示最后更新检查表的用户

例子 

{
  "checklist_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

close_details （JSONObject）

包含发布关闭相关信息
show attribute

close_details （JSONObject）
包含发布关闭相关信息

例子 

{
  "close_details": {
    "close_details_description": "close details",
    "closure_code": {
      "name": "Closed - Cancelled",
      "id": "1791511763340999"
    }
  }
}

close_details_description (html)

包含发布的关闭描述

close_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

closure_code （closure_code）

关闭代码表示关闭发布请求的原因

closure_code （closure_code）
关闭代码表示关闭发布请求的原因

例子 

{
  "closure_code": {
    "name": "test_closure_code",
    "id": "10011139111798001"
  }
}

close_details_updated_on (datetime)

指示关闭详情更新时间

close_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

close_details_updated_by （user）

最后更新关闭详情的用户

close_details_updated_by （user）
最后更新关闭详情的用户

例子 

{
  "close_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

display_id （sequence_number）read only

发布请求的序列号

display_id （sequence_number）
发布请求的序列号

例子 

{
  "display_id": {
    "display_value": "RL-1",
    "value": "1"
  }
}

emergency （boolean）read only

指示是否为紧急发布，true 为紧急，false 为普通

emergency （boolean）
布尔值，可为 true 或 false 两种值

notes_present （boolean）read only

指示发布是否包含任何备注

notes_present （boolean）
布尔值，可为 true 或 false 两种值

deleted_time (datetime)read only

指示发布请求被移至回收站的时间

deleted_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow_instance_details （workflow_instance）read only

指示工作流执行状态

workflow_instance_details （workflow_instance）
指示工作流执行状态

例子 

{
  "workflow_instance_details": {
    "id": "36338920932885067",
    "status": {
      "name": "In Progress",
      "id": "6633543434595966"
    }
  }
}


$ 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 = "<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 = @{ '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"
        }
    }
}

编辑发布

此操作帮助您编辑或更新版本。

Url

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

属性

id (long)
唯一标识发布请求，创建时分配

id (long)
数值位，被视为较大的值。

例子 

234759602834500

标题 (string)
发布标题。纯文本格式。不允许富文本或换行符。

标题 (string)
纯文本格式。不允许富文本或换行符。

例子 

ReleaseforDatabaseServerfirewallupgrades

模板 (release_template)
发布模板通过定义布局帮助创建自定义的发布模板表单，适用于最常见的发布。这样可以快速创建发布，自动填写所有必填字段。

模板 (release_template)
指示用于创建发布的发布模板

例子 

{
  "template": {
    "name": "test_template",
    "id": "105678900111042007"
  }
}

阶段 (release_stage)
指示发布的当前阶段

阶段 (release_stage)
指示发布的当前阶段

例子 

{
  "stage": {
    "name": "Submission_stage",
    "id": "100000000111042007"
  }
}

状态 (release_status)
指示发布的当前状态

状态 (release_status)
指示发布的当前状态

例子 

{
  "status": {
    "name": "test_status",
    "id": "100333300111042099"
  }
}

描述 (html)
发布请求的描述

描述 (html)
包含发布请求的描述

例子 

SuitableDescriptionoftherelease

更多属性 全部展开

计划开始时间 (datetime)

指示发布的计划开始时间

计划开始时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time (datetime)

指示完成发布的预定时间

scheduled_end_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

created_time (datetime)

指示发布请求的创建时间

created_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time (datetime)

指示发布请求的完成时间

completed_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

comment (string)

状态更新原因。每当用户修改状态时，comment* 为必填项注：通过模板配置默认强制填写 comment，可设为非必填

comment (string)
纯文本格式。不允许富文本或换行符。

例子 

Migrationapproved

next_review_on (datetime)

指示下一次审核的预定日期。

next_review_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow （workflow）

描述发布工作流及各阶段审批情况

workflow （workflow）
定义发布请求在各阶段所需的完整生命周期和相应审批

例子 

{
  "workflow": {
    "name": "test_workflow",
    "id": "105678900111069003"
  }
}

release_requester （user）

发布请求的发起人

release_requester （user）
指示发布请求的发起人

例子 

{
  "release_requester": {
    "email_id": "test@test.com",
    "name": "test_requester",
    "id": "100000000000042013"
  }
}

release_engineer （technician）

发布请求的负责人

release_engineer （technician）
发布请求的负责人

例子 

{
  "release_engineer": {
    "email_id": "test@test.com",
    "name": "test_release_engineer",
    "id": "100000000000042013"
  }
}

release_manager （technician）

管理发布请求整个生命周期的用户

release_manager （technician）
管理发布请求整个生命周期的用户

例子 

{
  "release_manager": {
    "email_id": "test@test.com",
    "name": "test_release_manager",
    "id": "100000000000042013"
  }
}

reason_for_release （reason_for_change）

发布发起的原因

reason_for_release （reason_for_change）
指示发布发起的原因

例子 

{
  "release_for_release": {
    "name": "test_reason_for_release",
    "id": "105678900111042007"
  }
}

impact （impact）

描述此发布将如何影响业务、部门、团队或用户

impact （impact）
指示发布对业务、部门、团队或用户的影响

例子 

{
  "impact": {
    "name": "test_impact",
    "id": "100000000111099077"
  }
}

priority （priority）

指示发布优先级为高、低或中

priority （priority）
指示发布的优先级

例子 

{
  "priority": {
    "name": "test_priority",
    "id": "10033330011177799"
  }
}

category （category）

为涉及的 CI 分配类别，如路由器、交换机、软件等

category （category）
指示发布涉及的 CI 的类别

例子 

{
  "category": {
    "name": "test_category",
    "id": "100333300111042000"
  }
}

subcategory （subcategory）

为选定类别分配子类别

subcategory （subcategory）
为选定类别分配子类别

例子 

{
  "subcategory": {
    "name": "test_subcategory",
    "id": "106666600111042099"
  }
}

item （item）

将项目分配至选定的类别和子类别

item （item）
指示分配至选定类别和子类别的项目

例子 

{
  "item": {
    "name": "test_item",
    "id": "100333300111042099"
  }
}

release_type （change_type）

指示发布类型是次要、重大、重要还是标准

release_type （change_type）
指示发布类型是次要、重大、重要还是标准

例子 

{
  "release_type": {
    "name": "test_release_type",
    "id": "100333300111042077"
  }
}

urgency （urgency）

指示发布请求的紧急程度

urgency （urgency）
指示发布请求的紧急程度

例子 

{
  "urgency": {
    "name": "test-urgency",
    "id": "100670890127890"
  }
}

services （service_category）

可能因发布受到影响的服务

services （service_category）
列出可能因发布受到影响的服务

例子 

{
  "services": [
    {
      "name": "test_service_1",
      "id": "122233390123003"
    },
    {
      "name": "test_service_2",
      "id": "122233390123011"
    },
    {
      "name": "test_service_3",
      "id": "122233390123015"
    }
  ]
}

assets （asset）

指示受影响或涉及的资产

assets （asset）
指示可能因发布受到影响或涉及的资产

例子 

{
  "assets": [
    {
      "name": "test-asset_1",
      "id": "234567890120999"
    },
    {
      "name": "test-asset_2",
      "id": "234567890123001"
    }
  ]
}

site （site）

指示发布请求所在站点

site （site）
指示发布请求所在站点

例子 

{
  "site": {
    "name": "test_site",
    "id": "100654320111042099"
  }
}

group （group）

发布请求分配的组

group （group）
指示发布请求分配的组

例子 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

risk （change_risk）

指示风险级别为高、低或中

risk （change_risk）
指示是否涉及高、低或中风险

例子 

{
  "risk": {
    "name": "test_risk",
    "id": "100333300111042001"
  }
}

roles （roles）

分配到各发布角色的用户

roles （roles）
指示分配到各发布角色的用户

例子 

{
  "roles": {
    "mref_development_head": [
      {
        "id": "100000000000033531"
      }
    ],
    "mref_release_reviewer": [
      {
        "id": "100000000000042007"
      },
      {
        "id": "100000000000042019"
      }
    ],
    "mref_qa_manager": [
      {
        "id": "100000000000033531"
      }
    ]
  }
}

attachments （release_attachment）

附加到发布的文件。最多可附加 10 个附件

attachments （release_attachment）
包含附加到发布的文件。最多可附加 10 个附件

例子 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields （udf_fields）

包含发布的用户自定义字段值

udf_fields （udf_fields）
包含与发布关联的用户自定义字段值

例子 

{
  "udf_fields": {
    "udf_long2": "1459402730964",
    "udf_long1": "1225",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

configuration_items （configuration_item）

发布请求涉及的关键项目

configuration_items （configuration_item）
指示发布请求涉及的关键项目

例子 

{
  "configuration_items": [
    {
      "name": "Floor 1 - Router",
      "id": "100000000000028792"
    },
    {
      "name": "Floor 12 - Router",
      "id": "100000000000028796"
    }
  ]
}

roll_out_plan （JSONObject）

描述发布流程的实施方式
show attribute

roll_out_plan （JSONObject）
描述发布流程的实施方式

例子 

{
  "roll_out_plan": {
    "roll_out_plan_description": "Rollout plan"
  }
}

roll_out_plan_description (html)

详细描述发布计划的实施

roll_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

roll_out_plan_updated_on (datetime)

指示发布计划最后实施时间

roll_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

roll_out_plan_updated_by （user）

最后更新发布计划的用户

roll_out_plan_updated_by （user）
最后更新发布计划的用户

例子 

{
  "roll_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

back_out_plan （JSONObject）

发布技术人员决定回滚发布时，将在回滚计划部分记录/规划应急方案
show attribute

back_out_plan （JSONObject）
描述如果发布请求取消，发布流程将如何进行

例子 

{
  "back_out_plan": {
    "back_out_plan_description": "Backout plan"
  }
}

back_out_plan_description (html)

详细描述发布实施回滚的缓解方案

back_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

back_out_plan_updated_on (datetime)

指示回滚计划最后实施时间

back_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

back_out_plan_updated_by （user）

最后更新回滚计划的用户

back_out_plan_updated_by （user）
最后更新回滚计划的用户

例子 

{
  "back_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

impact_details （JSONObject）

描述发布流程将如何影响业务
show attribute

impact_details （JSONObject）
描述发布流程将如何影响业务

例子 

{
  "impact_details": {
    "impact_details_description": "affects user"
  }
}

impact_details_description (html)

包含发布对组织影响的详细信息，包括预期业务损失或停机时间

impact_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

impact_details_updated_on (datetime)

指示影响详情最后更新时间

impact_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact_details_updated_by （user）

最后更新影响详情的用户

impact_details_updated_by （user）
最后更新影响详情的用户

例子 

{
  "impact_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

checklist （JSONObject）

列出发布流程中的任务
show attribute

checklist （JSONObject）
列出发布流程中的任务

例子 

{
  "checklist": {
    "checklist_description": "check list"
  }
}

checklist_description (html)

待办事项列表，列出完成发布实施且满足所有要求所需的关键步骤

checklist_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

checklist_updated_on (datetime)

指示检查表最后更新时间

checklist_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

checklist_updated_by （user）

最后更新检查表的用户

checklist_updated_by （user）
指示最后更新检查表的用户

例子 

{
  "checklist_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

close_details （JSONObject）

包含发布关闭相关信息
show attribute

close_details （JSONObject）
包含发布关闭相关信息

例子 

{
  "close_details": {
    "close_details_description": "close details",
    "closure_code": {
      "name": "Closed - Cancelled",
      "id": "1791511763340999"
    }
  }
}

close_details_description (html)

包含发布的关闭描述

close_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

closure_code （closure_code）

关闭代码表示关闭发布请求的原因

closure_code （closure_code）
关闭代码表示关闭发布请求的原因

例子 

{
  "closure_code": {
    "name": "test_closure_code",
    "id": "10011139111798001"
  }
}

close_details_updated_on (datetime)

指示关闭详情更新时间

close_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

close_details_updated_by （user）

最后更新关闭详情的用户

close_details_updated_by （user）
最后更新关闭详情的用户

例子 

{
  "close_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

display_id （sequence_number）read only

发布请求的序列号

display_id （sequence_number）
发布请求的序列号

例子 

{
  "display_id": {
    "display_value": "RL-1",
    "value": "1"
  }
}

emergency （boolean）read only

指示是否为紧急发布，true 为紧急，false 为普通

emergency （boolean）
布尔值，可为 true 或 false 两种值

notes_present （boolean）read only

指示发布是否包含任何备注

notes_present （boolean）
布尔值，可为 true 或 false 两种值

deleted_time (datetime)read only

指示发布请求被移至回收站的时间

deleted_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow_instance_details （workflow_instance）read only

指示工作流执行状态

workflow_instance_details （workflow_instance）
指示工作流执行状态

例子 

{
  "workflow_instance_details": {
    "id": "36338920932885067",
    "status": {
      "name": "In Progress",
      "id": "6633543434595966"
    }
  }
}


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

获取发布

此操作帮助获取单个版本。

Url

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

属性

id (long)
唯一标识发布请求，创建时分配

id (long)
数值位，被视为较大的值。

例子 

234759602834500

标题 (string)
发布标题。纯文本格式。不允许富文本或换行符。

标题 (string)
纯文本格式。不允许富文本或换行符。

例子 

ReleaseforDatabaseServerfirewallupgrades

模板 (release_template)
发布模板通过定义布局帮助创建自定义的发布模板表单，适用于最常见的发布。这样可以快速创建发布，自动填写所有必填字段。

模板 (release_template)
指示用于创建发布的发布模板

例子 

{
  "template": {
    "name": "test_template",
    "id": "105678900111042007"
  }
}

阶段 (release_stage)
指示发布的当前阶段

阶段 (release_stage)
指示发布的当前阶段

例子 

{
  "stage": {
    "name": "Submission_stage",
    "id": "100000000111042007"
  }
}

状态 (release_status)
指示发布的当前状态

状态 (release_status)
指示发布的当前状态

例子 

{
  "status": {
    "name": "test_status",
    "id": "100333300111042099"
  }
}

描述 (html)
发布请求的描述

描述 (html)
包含发布请求的描述

例子 

SuitableDescriptionoftherelease

更多属性 全部展开

计划开始时间 (datetime)

指示发布的计划开始时间

计划开始时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time (datetime)

指示完成发布的预定时间

scheduled_end_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

created_time (datetime)

指示发布请求的创建时间

created_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time (datetime)

指示发布请求的完成时间

completed_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

comment (string)

状态更新原因。每当用户修改状态时，comment* 为必填项注：通过模板配置默认强制填写 comment，可设为非必填

comment (string)
纯文本格式。不允许富文本或换行符。

例子 

Migrationapproved

next_review_on (datetime)

指示下一次审核的预定日期。

next_review_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow （workflow）

描述发布工作流及各阶段审批情况

workflow （workflow）
定义发布请求在各阶段所需的完整生命周期和相应审批

例子 

{
  "workflow": {
    "name": "test_workflow",
    "id": "105678900111069003"
  }
}

release_requester （user）

发布请求的发起人

release_requester （user）
指示发布请求的发起人

例子 

{
  "release_requester": {
    "email_id": "test@test.com",
    "name": "test_requester",
    "id": "100000000000042013"
  }
}

release_engineer （technician）

发布请求的负责人

release_engineer （technician）
发布请求的负责人

例子 

{
  "release_engineer": {
    "email_id": "test@test.com",
    "name": "test_release_engineer",
    "id": "100000000000042013"
  }
}

release_manager （technician）

管理发布请求整个生命周期的用户

release_manager （technician）
管理发布请求整个生命周期的用户

例子 

{
  "release_manager": {
    "email_id": "test@test.com",
    "name": "test_release_manager",
    "id": "100000000000042013"
  }
}

reason_for_release （reason_for_change）

发布发起的原因

reason_for_release （reason_for_change）
指示发布发起的原因

例子 

{
  "release_for_release": {
    "name": "test_reason_for_release",
    "id": "105678900111042007"
  }
}

impact （impact）

描述此发布将如何影响业务、部门、团队或用户

impact （impact）
指示发布对业务、部门、团队或用户的影响

例子 

{
  "impact": {
    "name": "test_impact",
    "id": "100000000111099077"
  }
}

priority （priority）

指示发布优先级为高、低或中

priority （priority）
指示发布的优先级

例子 

{
  "priority": {
    "name": "test_priority",
    "id": "10033330011177799"
  }
}

category （category）

为涉及的 CI 分配类别，如路由器、交换机、软件等

category （category）
指示发布涉及的 CI 的类别

例子 

{
  "category": {
    "name": "test_category",
    "id": "100333300111042000"
  }
}

subcategory （subcategory）

为选定类别分配子类别

subcategory （subcategory）
为选定类别分配子类别

例子 

{
  "subcategory": {
    "name": "test_subcategory",
    "id": "106666600111042099"
  }
}

item （item）

将项目分配至选定的类别和子类别

item （item）
指示分配至选定类别和子类别的项目

例子 

{
  "item": {
    "name": "test_item",
    "id": "100333300111042099"
  }
}

release_type （change_type）

指示发布类型是次要、重大、重要还是标准

release_type （change_type）
指示发布类型是次要、重大、重要还是标准

例子 

{
  "release_type": {
    "name": "test_release_type",
    "id": "100333300111042077"
  }
}

urgency （urgency）

指示发布请求的紧急程度

urgency （urgency）
指示发布请求的紧急程度

例子 

{
  "urgency": {
    "name": "test-urgency",
    "id": "100670890127890"
  }
}

services （service_category）

可能因发布受到影响的服务

services （service_category）
列出可能因发布受到影响的服务

例子 

{
  "services": [
    {
      "name": "test_service_1",
      "id": "122233390123003"
    },
    {
      "name": "test_service_2",
      "id": "122233390123011"
    },
    {
      "name": "test_service_3",
      "id": "122233390123015"
    }
  ]
}

assets （asset）

指示受影响或涉及的资产

assets （asset）
指示可能因发布受到影响或涉及的资产

例子 

{
  "assets": [
    {
      "name": "test-asset_1",
      "id": "234567890120999"
    },
    {
      "name": "test-asset_2",
      "id": "234567890123001"
    }
  ]
}

site （site）

指示发布请求所在站点

site （site）
指示发布请求所在站点

例子 

{
  "site": {
    "name": "test_site",
    "id": "100654320111042099"
  }
}

group （group）

发布请求分配的组

group （group）
指示发布请求分配的组

例子 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

risk （change_risk）

指示风险级别为高、低或中

risk （change_risk）
指示是否涉及高、低或中风险

例子 

{
  "risk": {
    "name": "test_risk",
    "id": "100333300111042001"
  }
}

roles （roles）

分配到各发布角色的用户

roles （roles）
指示分配到各发布角色的用户

例子 

{
  "roles": {
    "mref_development_head": [
      {
        "id": "100000000000033531"
      }
    ],
    "mref_release_reviewer": [
      {
        "id": "100000000000042007"
      },
      {
        "id": "100000000000042019"
      }
    ],
    "mref_qa_manager": [
      {
        "id": "100000000000033531"
      }
    ]
  }
}

attachments （release_attachment）

附加到发布的文件。最多可附加 10 个附件

attachments （release_attachment）
包含附加到发布的文件。最多可附加 10 个附件

例子 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields （udf_fields）

包含发布的用户自定义字段值

udf_fields （udf_fields）
包含与发布关联的用户自定义字段值

例子 

{
  "udf_fields": {
    "udf_long2": "1459402730964",
    "udf_long1": "1225",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

configuration_items （configuration_item）

发布请求涉及的关键项目

configuration_items （configuration_item）
指示发布请求涉及的关键项目

例子 

{
  "configuration_items": [
    {
      "name": "Floor 1 - Router",
      "id": "100000000000028792"
    },
    {
      "name": "Floor 12 - Router",
      "id": "100000000000028796"
    }
  ]
}

roll_out_plan （JSONObject）

描述发布流程的实施方式
show attribute

roll_out_plan （JSONObject）
描述发布流程的实施方式

例子 

{
  "roll_out_plan": {
    "roll_out_plan_description": "Rollout plan"
  }
}

roll_out_plan_description (html)

详细描述发布计划的实施

roll_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

roll_out_plan_updated_on (datetime)

指示发布计划最后实施时间

roll_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

roll_out_plan_updated_by （user）

最后更新发布计划的用户

roll_out_plan_updated_by （user）
最后更新发布计划的用户

例子 

{
  "roll_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

back_out_plan （JSONObject）

发布技术人员决定回滚发布时，将在回滚计划部分记录/规划应急方案
show attribute

back_out_plan （JSONObject）
描述如果发布请求取消，发布流程将如何进行

例子 

{
  "back_out_plan": {
    "back_out_plan_description": "Backout plan"
  }
}

back_out_plan_description (html)

详细描述发布实施回滚的缓解方案

back_out_plan_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

back_out_plan_updated_on (datetime)

指示回滚计划最后实施时间

back_out_plan_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

back_out_plan_updated_by （user）

最后更新回滚计划的用户

back_out_plan_updated_by （user）
最后更新回滚计划的用户

例子 

{
  "back_out_plan_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

impact_details （JSONObject）

描述发布流程将如何影响业务
show attribute

impact_details （JSONObject）
描述发布流程将如何影响业务

例子 

{
  "impact_details": {
    "impact_details_description": "affects user"
  }
}

impact_details_description (html)

包含发布对组织影响的详细信息，包括预期业务损失或停机时间

impact_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

impact_details_updated_on (datetime)

指示影响详情最后更新时间

impact_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact_details_updated_by （user）

最后更新影响详情的用户

impact_details_updated_by （user）
最后更新影响详情的用户

例子 

{
  "impact_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

checklist （JSONObject）

列出发布流程中的任务
show attribute

checklist （JSONObject）
列出发布流程中的任务

例子 

{
  "checklist": {
    "checklist_description": "check list"
  }
}

checklist_description (html)

待办事项列表，列出完成发布实施且满足所有要求所需的关键步骤

checklist_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

checklist_updated_on (datetime)

指示检查表最后更新时间

checklist_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

checklist_updated_by （user）

最后更新检查表的用户

checklist_updated_by （user）
指示最后更新检查表的用户

例子 

{
  "checklist_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

close_details （JSONObject）

包含发布关闭相关信息
show attribute

close_details （JSONObject）
包含发布关闭相关信息

例子 

{
  "close_details": {
    "close_details_description": "close details",
    "closure_code": {
      "name": "Closed - Cancelled",
      "id": "1791511763340999"
    }
  }
}

close_details_description (html)

包含发布的关闭描述

close_details_description (html)
HTML 是一个可以使用 HTML 元素的文本区域。

例子 

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

closure_code （closure_code）

关闭代码表示关闭发布请求的原因

closure_code （closure_code）
关闭代码表示关闭发布请求的原因

例子 

{
  "closure_code": {
    "name": "test_closure_code",
    "id": "10011139111798001"
  }
}

close_details_updated_on (datetime)

指示关闭详情更新时间

close_details_updated_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

close_details_updated_by （user）

最后更新关闭详情的用户

close_details_updated_by （user）
最后更新关闭详情的用户

例子 

{
  "close_details_updated_by": {
    "email_id": "test@test.com",
    "name": "test_user",
    "id": "100000000000042013"
  }
}

display_id （sequence_number）read only

发布请求的序列号

display_id （sequence_number）
发布请求的序列号

例子 

{
  "display_id": {
    "display_value": "RL-1",
    "value": "1"
  }
}

emergency （boolean）read only

指示是否为紧急发布，true 为紧急，false 为普通

emergency （boolean）
布尔值，可为 true 或 false 两种值

notes_present （boolean）read only

指示发布是否包含任何备注

notes_present （boolean）
布尔值，可为 true 或 false 两种值

deleted_time (datetime)read only

指示发布请求被移至回收站的时间

deleted_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow_instance_details （workflow_instance）read only

指示工作流执行状态

workflow_instance_details （workflow_instance）
指示工作流执行状态

例子 

{
  "workflow_instance_details": {
    "id": "36338920932885067",
    "status": {
      "name": "In Progress",
      "id": "6633543434595966"
    }
  }
}


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

获取发布列表

此操作帮助获取版本列表。

Url

<service domain|custom domain>/app/<portal>/api/v3/releases

属性

id (long)
唯一标识发布请求，创建时分配

id (long)
数值位，被视为较大的值。

例子 

234759602834500

标题 (string)
发布标题。纯文本格式。不允许富文本或换行符。

标题 (string)
纯文本格式。不允许富文本或换行符。

例子 

ReleaseforDatabaseServerfirewallupgrades

模板 (release_template)
发布模板通过定义布局帮助创建自定义的发布模板表单，适用于最常见的发布。这样可以快速创建发布，自动填写所有必填字段。

模板 (release_template)
指示用于创建发布的发布模板

例子 

{
  "template": {
    "name": "test_template",
    "id": "105678900111042007"
  }
}

阶段 (release_stage)
指示发布的当前阶段

阶段 (release_stage)
指示发布的当前阶段

例子 

{
  "stage": {
    "name": "Submission_stage",
    "id": "100000000111042007"
  }
}

状态 (release_status)
指示发布的当前状态

状态 (release_status)
指示发布的当前状态

例子 

{
  "status": {
    "name": "test_status",
    "id": "100333300111042099"
  }
}

描述 (html)
发布请求的描述

描述 (html)
包含发布请求的描述

例子 

SuitableDescriptionoftherelease

更多属性 全部展开

计划开始时间 (datetime)

指示发布的计划开始时间

计划开始时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time (datetime)

指示完成发布的预定时间

scheduled_end_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

created_time (datetime)

指示发布请求的创建时间

created_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time (datetime)

指示发布请求的完成时间

completed_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

comment (string)

状态更新原因。每当用户修改状态时，comment* 为必填项注：通过模板配置默认强制填写 comment，可设为非必填

comment (string)
纯文本格式。不允许富文本或换行符。

例子 

Migrationapproved

next_review_on (datetime)

指示下一次审核的预定日期。

next_review_on (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow （workflow）

描述发布工作流及各阶段审批情况

workflow （workflow）
定义发布请求在各阶段所需的完整生命周期和相应审批

例子 

{
  "workflow": {
    "name": "test_workflow",
    "id": "105678900111069003"
  }
}

release_requester （user）

发布请求的发起人

release_requester （user）
指示发布请求的发起人

例子 

{
  "release_requester": {
    "email_id": "test@test.com",
    "name": "test_requester",
    "id": "100000000000042013"
  }
}

release_engineer （technician）

发布请求的负责人

release_engineer （technician）
发布请求的负责人

例子 

{
  "release_engineer": {
    "email_id": "test@test.com",
    "name": "test_release_engineer",
    "id": "100000000000042013"
  }
}

release_manager （technician）

管理发布请求整个生命周期的用户

release_manager （technician）
管理发布请求整个生命周期的用户

例子 

{
  "release_manager": {
    "email_id": "test@test.com",
    "name": "test_release_manager",
    "id": "100000000000042013"
  }
}

reason_for_release （reason_for_change）

发布发起的原因

reason_for_release （reason_for_change）
指示发布发起的原因

例子 

{
  "release_for_release": {
    "name": "test_reason_for_release",
    "id": "105678900111042007"
  }
}

impact （impact）

描述此发布将如何影响业务、部门、团队或用户

impact （impact）
指示发布对业务、部门、团队或用户的影响

例子 

{
  "impact": {
    "name": "test_impact",
    "id": "100000000111099077"
  }
}

priority （priority）

指示发布优先级为高、低或中

priority （priority）
指示发布的优先级

例子 

{
  "priority": {
    "name": "test_priority",
    "id": "10033330011177799"
  }
}

category （category）

为涉及的 CI 分配类别，如路由器、交换机、软件等

category （category）
指示发布涉及的 CI 的类别

例子 

{
  "category": {
    "name": "test_category",
    "id": "100333300111042000"
  }
}

subcategory （subcategory）

为选定类别分配子类别

subcategory （subcategory）
为选定类别分配子类别

例子 

{
  "subcategory": {
    "name": "test_subcategory",
    "id": "106666600111042099"
  }
}

item （item）

将项目分配至选定的类别和子类别

item （item）
指示分配至选定类别和子类别的项目

例子 

{
  "item": {
    "name": "test_item",
    "id": "100333300111042099"
  }
}

release_type （change_type）

指示发布类型是次要、重大、重要还是标准

release_type （change_type）
指示发布类型是次要、重大、重要还是标准

例子 

{
  "release_type": {
    "name": "test_release_type",
    "id": "100333300111042077"
  }
}

urgency （urgency）

指示发布请求的紧急程度

urgency （urgency）
指示发布请求的紧急程度

例子 

{
  "urgency": {
    "name": "test-urgency",
    "id": "100670890127890"
  }
}

services （service_category）

可能因发布受到影响的服务

services （service_category）
列出可能因发布受到影响的服务

例子 

{
  "services": [
    {
      "name": "test_service_1",
      "id": "122233390123003"
    },
    {
      "name": "test_service_2",
      "id": "122233390123011"
    },
    {
      "name": "test_service_3",
      "id": "122233390123015"
    }
  ]
}

assets （asset）

指示受影响或涉及的资产

assets （asset）
指示可能因发布受到影响或涉及的资产

例子 

{
  "assets": [
    {
      "name": "test-asset_1",
      "id": "234567890120999"
    },
    {
      "name": "test-asset_2",
      "id": "234567890123001"
    }
  ]
}

site （site）

指示发布请求所在站点

site （site）
指示发布请求所在站点

例子 

{
  "site": {
    "name": "test_site",
    "id": "100654320111042099"
  }
}

group （group）

发布请求分配的组

group （group）
指示发布请求分配的组

例子 

{
  "group": {
    "name": "test_group",
    "id": "100333300111042099"
  }
}

risk （change_risk）

指示风险级别为高、低或中

risk （change_risk）
指示是否涉及高、低或中风险

例子 

{
  "risk": {
    "name": "test_risk",
    "id": "100333300111042001"
  }
}

roles （roles）

分配到各发布角色的用户

roles （roles）
指示分配到各发布角色的用户

例子 

{
  "roles": {
    "mref_development_head": [
      {
        "id": "100000000000033531"
      }
    ],
    "mref_release_reviewer": [
      {
        "id": "100000000000042007"
      },
      {
        "id": "100000000000042019"
      }
    ],
    "mref_qa_manager": [
      {
        "id": "100000000000033531"
      }
    ]
  }
}

attachments （release_attachment）

附加到发布的文件。最多可附加 10 个附件

attachments （release_attachment）
包含附加到发布的文件。最多可附加 10 个附件

例子 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

udf_fields （udf_fields）

包含发布的用户自定义字段值

udf_fields （udf_fields）
包含与发布关联的用户自定义字段值

例子 

{
  "udf_fields": {
    "udf_long2": "1459402730964",
    "udf_long1": "1225",
    "udf_date1": {
      "display_value": "Feb 26, 2016 11:00 AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "Ned Stark"
  }
}

configuration_items （configuration_item）

发布请求涉及的关键项目

configuration_items （configuration_item）
指示发布请求涉及的关键项目

例子 

{
  "configuration_items": [
    {
      "name": "Floor 1 - Router",
      "id": "100000000000028792"
    },
    {
      "name": "Floor 12 - Router",
      "id": "100000000000028796"
    }
  ]
}

display_id （sequence_number）read only

发布请求的序列号

display_id （sequence_number）
发布请求的序列号

例子 

{
  "display_id": {
    "display_value": "RL-1",
    "value": "1"
  }
}

emergency （boolean）read only

指示是否为紧急发布，true 为紧急，false 为普通

emergency （boolean）
布尔值，可为 true 或 false 两种值

notes_present （boolean）read only

指示发布是否包含任何备注

notes_present （boolean）
布尔值，可为 true 或 false 两种值

deleted_time (datetime)read only

指示发布请求被移至回收站的时间

deleted_time (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

值 ：以长整型格式表示的时间（从1970年1月1日起的毫秒数）。

display_value ：以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

workflow_instance_details （workflow_instance）read only

指示工作流执行状态

workflow_instance_details （workflow_instance）
指示工作流执行状态

例子 

{
  "workflow_instance_details": {
    "id": "36338920932885067",
    "status": {
      "name": "In Progress",
      "id": "6633543434595966"
    }
  }
}


$ 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"
            }
        }
    ]
}

删除发布

此操作帮助您删除版本。

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