跳转到内容

变更维护

根据定义的变更字段配置和计划配置自动创建变更，确保有条不紊地生成计划变更。这有助于简化变更操作并确保及时执行。

属性

id （长整型）
创建时分配的唯一标识符

id （长整型）
被视为有较大数值的数字字符。

示例 

234759602834500

标题 （字符串）
变更维护的标题。   

标题 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

阶段 （change_stage）
维护产生的变更总是创建在提交阶段

阶段 （change_stage）
总是以变更流程的第一个阶段创建

示例 

{
  "stage": {
    "name": "submission",
    "id": "234567890123456"
  }
}

状态 （change_status）
指示变更的状态值

状态 （change_status）
指示维护创建变更时的状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

回顾性 （布尔型）
指示变更维护是否为回顾性

回顾性 （布尔型）
布尔值，可为 true 或 false。

描述 （html）
变更维护的描述

描述 （html）
HTML 是一个文本区域，可以使用 HTML 元素。

示例 

DatabaseServerfirewallupgrades

更多属性 全部展开

评论 （字符串）

每当变更由Maintenance创建时，状态备注将设置为提供的值

评论 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

maintenance (maintenance)

用于维护的计划详细信息的占位符

maintenance (maintenance)
此字段用作添加或编辑Maintenance期间的计划详细信息占位符

udf_fields (udf_fields)

包含变更的用户自定义字段值

udf_fields (udf_fields)
包含来自Maintenance关联到变更的用户自定义字段值

示例 

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

template (change_template)

变更模板通过定义其布局帮助创建自定义变更模板表单，以适应最常提出的变更。因此，可以快速创建变更，所有所需字段会自动填充。

template (change_template)
指示用于创建该变更的变更模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

change_requester (user)

指示维护的发起人

change_requester (user)
指示维护的发起人

示例 

{
  "change_requester": {
    "name": "test-change_requester",
    "id": "234567890123456"
  }
}

change_manager (technician)

管理变更整个生命周期的用户

change_manager (technician)
指示管理由Maintenance创建的变更整个生命周期的用户

示例 

{
  "change_manager": {
    "name": "test-change_manager",
    "id": "234567890123456"
  }
}

reason_for_change (reason_for_change)

发起变更的原因。

reason_for_change (reason_for_change)
指示必须发起变更的原因

示例 

{
  "reason_for_change": {
    "name": "test-reason_for_change",
    "id": "234567890123456"
  }
}

risk (change_risk)

说明是否涉及高、中或低风险。

risk (change_risk)
指示是否涉及高、中或低风险

示例 

{
  "risk": {
    "name": "test-risk",
    "id": "234567890123456"
  }
}

impact (impact)

描述来自Maintenance的变更将如何影响业务、部门、组或用户

impact (impact)
指示变更对业务、部门、组或用户的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

priority (priority)

指示变更是高优先级、低优先级还是中等优先级

priority (priority)
指示由Maintenance创建变更的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

category (category)

指定与本次维护变更相关的CI类别，如路由器、交换机、软件等

category (category)
指示将要创建变更所涉及的CI类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

指定在类别下选择的相关CI的子类别

subcategory (subcategory)
指示在类别下选择的相关CI的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

指定属于所选类别和子类别的项目

item (item)
指示受影响CI的项目分类

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

指示维护变更的紧急程度

urgency (urgency)
指示维护变更的紧急程度

示例 

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

change_type (change_type)

指示变更维护是次要的、主要的、重要的还是标准的

change_type (change_type)
指示变更维护是次要的、主要的、重要的还是标准的

示例 

{
  "change_type": {
    "name": "test-change_type",
    "id": "234567890123456"
  }
}

site (site)

指示维护所属站点

site (site)
表示维护所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

group (group)

分配给维护变更的组

group (group)
指示变更请求分配的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

change_owner (technician)

维护变更的所有者 

change_owner (technician)
维护变更的所有者

示例 

{
  "change_owner": {
    "name": "test-change_owner",
    "id": "234567890123456"
  }
}

services (service_category)

由于本次Maintenance变更可能受影响的服务

services (service_category)
由于变更创建可能受影响的服务

示例 

{
  "services": [
    {
      "name": "test-services",
      "id": "234567890123456"
    }
  ]
}

assets (asset)

受影响的资产

assets (asset)
由于此次变更可能受影响或涉及的资产

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

roles (change_to_change_role)

指示专为由Maintenance创建的变更定义的访问权限 

roles (change_to_change_role)
指示专为由Maintenance创建的变更定义的访问权限 

示例 

{
  "roles": [
    {
      "role": {
        "name": "Change Approver",
        "id": "100000000000021428"
      },
      "user": {
        "name": "Albert",
        "id": "100000000000024441"
      }
    }
  ]
}

workflow (workflow)

定义变更创建后在各阶段适当审批的完整生命周期

workflow (workflow)
定义变更创建后在各阶段适当审批的完整生命周期

示例 

{
  "workflow": {
    "name": "test-workflow",
    "id": "234567890123456"
  }
}

attachments (change_attachment)

附加到变更的文件。最多可附加10个附件。

attachments (change_attachment)
指示需附加到变更的文件，最多仅可附加10个附件

示例 

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

configuration_items (configuration_item)

必须为其创建变更的关键项目

configuration_items (configuration_item)
指示必须为其创建变更的关键项目

示例 

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

emergency （布尔型）read only

指示是否为紧急变更，若为true则为紧急变更，若为false则为正常维护变更

emergency （布尔型）
布尔值，可为 true 或 false。

添加变更维护

此操作帮助您添加新的维护变更。

必填字段 :- title, stage, status

Url

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

属性

id （长整型）
创建时分配的唯一标识符

id （长整型）
被视为有较大数值的数字字符。

示例 

234759602834500

标题 （字符串）
变更维护的标题。   

标题 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

阶段 （change_stage）
维护产生的变更总是创建在提交阶段

阶段 （change_stage）
总是以变更流程的第一个阶段创建

示例 

{
  "stage": {
    "name": "submission",
    "id": "234567890123456"
  }
}

状态 （change_status）
指示变更的状态值

状态 （change_status）
指示维护创建变更时的状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

回顾性 （布尔型）
指示变更维护是否为回顾性

回顾性 （布尔型）
布尔值，可为 true 或 false。

描述 （html）
变更维护的描述

描述 （html）
HTML 是一个文本区域，可以使用 HTML 元素。

示例 

DatabaseServerfirewallupgrades

更多属性 全部展开

评论 （字符串）

每当变更由Maintenance创建时，状态备注将设置为提供的值

评论 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

maintenance (maintenance)

用于维护的计划详细信息的占位符

maintenance (maintenance)
此字段用作添加或编辑Maintenance期间的计划详细信息占位符

udf_fields (udf_fields)

包含变更的用户自定义字段值

udf_fields (udf_fields)
包含来自Maintenance关联到变更的用户自定义字段值

示例 

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

template (change_template)

变更模板通过定义其布局帮助创建自定义变更模板表单，以适应最常提出的变更。因此，可以快速创建变更，所有所需字段会自动填充。

template (change_template)
指示用于创建该变更的变更模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

change_requester (user)

指示维护的发起人

change_requester (user)
指示维护的发起人

示例 

{
  "change_requester": {
    "name": "test-change_requester",
    "id": "234567890123456"
  }
}

change_manager (technician)

管理变更整个生命周期的用户

change_manager (technician)
指示管理由Maintenance创建的变更整个生命周期的用户

示例 

{
  "change_manager": {
    "name": "test-change_manager",
    "id": "234567890123456"
  }
}

reason_for_change (reason_for_change)

发起变更的原因。

reason_for_change (reason_for_change)
指示必须发起变更的原因

示例 

{
  "reason_for_change": {
    "name": "test-reason_for_change",
    "id": "234567890123456"
  }
}

risk (change_risk)

说明是否涉及高、中或低风险。

risk (change_risk)
指示是否涉及高、中或低风险

示例 

{
  "risk": {
    "name": "test-risk",
    "id": "234567890123456"
  }
}

impact (impact)

描述来自Maintenance的变更将如何影响业务、部门、组或用户

impact (impact)
指示变更对业务、部门、组或用户的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

priority (priority)

指示变更是高优先级、低优先级还是中等优先级

priority (priority)
指示由Maintenance创建变更的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

category (category)

指定与本次维护变更相关的CI类别，如路由器、交换机、软件等

category (category)
指示将要创建变更所涉及的CI类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

指定在类别下选择的相关CI的子类别

subcategory (subcategory)
指示在类别下选择的相关CI的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

指定属于所选类别和子类别的项目

item (item)
指示受影响CI的项目分类

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

指示维护变更的紧急程度

urgency (urgency)
指示维护变更的紧急程度

示例 

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

change_type (change_type)

指示变更维护是次要的、主要的、重要的还是标准的

change_type (change_type)
指示变更维护是次要的、主要的、重要的还是标准的

示例 

{
  "change_type": {
    "name": "test-change_type",
    "id": "234567890123456"
  }
}

site (site)

指示维护所属站点

site (site)
表示维护所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

group (group)

分配给维护变更的组

group (group)
指示变更请求分配的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

change_owner (technician)

维护变更的所有者 

change_owner (technician)
维护变更的所有者

示例 

{
  "change_owner": {
    "name": "test-change_owner",
    "id": "234567890123456"
  }
}

services (service_category)

由于本次Maintenance变更可能受影响的服务

services (service_category)
由于变更创建可能受影响的服务

示例 

{
  "services": [
    {
      "name": "test-services",
      "id": "234567890123456"
    }
  ]
}

assets (asset)

受影响的资产

assets (asset)
由于此次变更可能受影响或涉及的资产

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

roles (change_to_change_role)

指示专为由Maintenance创建的变更定义的访问权限 

roles (change_to_change_role)
指示专为由Maintenance创建的变更定义的访问权限 

示例 

{
  "roles": [
    {
      "role": {
        "name": "Change Approver",
        "id": "100000000000021428"
      },
      "user": {
        "name": "Albert",
        "id": "100000000000024441"
      }
    }
  ]
}

workflow (workflow)

定义变更创建后在各阶段适当审批的完整生命周期

workflow (workflow)
定义变更创建后在各阶段适当审批的完整生命周期

示例 

{
  "workflow": {
    "name": "test-workflow",
    "id": "234567890123456"
  }
}

attachments (change_attachment)

附加到变更的文件。最多可附加10个附件。

attachments (change_attachment)
指示需附加到变更的文件，最多仅可附加10个附件

示例 

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

configuration_items (configuration_item)

必须为其创建变更的关键项目

configuration_items (configuration_item)
指示必须为其创建变更的关键项目

示例 

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

emergency （布尔型）read only

指示是否为紧急变更，若为true则为紧急变更，若为false则为正常维护变更

emergency （布尔型）
布尔值，可为 true 或 false。

$ curl <service domain|custom domain>/app/<portal>/api/v3/change_maintenances\
      -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='{
  "change_maintenance": {
    "workflow": {
      "id": "4291000000087981"
    },
    "template": {
      "id": "4291000000088294"
    },
    "change_requester": {
      "id": "4291000004271016"
    },
    "udf_fields": {},
    "change_type": {
      "id": "4291000000007951"
    },
    "site": {
      "id": "4291000001327001"
    },
    "retrospective": "false",
    "group": {
      "id": "4291000000006679"
    },
    "impact": {
      "id": "4291000005045003"
    },
    "urgency": {
      "id": "4291000000007919"
    },
    "priority": {
      "id": "4291000000006801"
    },
    "stage": {
      "id": "4291000000087125"
    },
    "risk": {
      "id": "4291000000087080"
    },
    "status": {
      "id": "4291000000087260"
    },
    "comment": "The above Stage/Status is set as part of \u0027Change\u0027 creation",
    "category": {
      "id": "4291000000006685"
    },
    "subcategory": {
      "id": "4291000002382019"
    },
    "item": {
      "id": "4291000002382021"
    },
    "services": [
      {
        "id": "4291000000007945"
      },
      {
        "id": "4291000000007937"
      }
    ],
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "reason_for_change": {
      "id": "4291000000087089"
    },
    "title": "Title for Change  Maintenance",
    "description": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eDescriprtion here\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e",
    "impact_details": {},
    "roll_out_plan": {},
    "back_out_plan": {},
    "checklist": {},
    "release_details": {},
    "roles": [
      {
        "role": {
          "id": "4291000000087200"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087218"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000118019"
        },
        "user": {
          "id": "4291000004885015"
        }
      },
      {
        "role": {
          "id": "4291000000087215"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087212"
        },
        "user": {
          "id": "4291000000145236"
        }
      }
    ],
    "attachments": [],
    "maintenance": {
      "repetitive_schedule": {
        "start_time": {
          "value": 2027406600000,
          "display_value": "Mar 31, 2034 02:00 pm"
        },
        "frequency": "Daily",
        "is_advanced": true,
        "skip_frequency": 0,
        "exclude_weekends": false,
        "is_first_day_of_month": false
      }
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/change_maintenances";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "change_maintenance": {
    "workflow": {
      "id": "4291000000087981"
    },
    "template": {
      "id": "4291000000088294"
    },
    "change_requester": {
      "id": "4291000004271016"
    },
    "udf_fields": {},
    "change_type": {
      "id": "4291000000007951"
    },
    "site": {
      "id": "4291000001327001"
    },
    "retrospective": "false",
    "group": {
      "id": "4291000000006679"
    },
    "impact": {
      "id": "4291000005045003"
    },
    "urgency": {
      "id": "4291000000007919"
    },
    "priority": {
      "id": "4291000000006801"
    },
    "stage": {
      "id": "4291000000087125"
    },
    "risk": {
      "id": "4291000000087080"
    },
    "status": {
      "id": "4291000000087260"
    },
    "comment": "The above Stage/Status is set as part of \u0027Change\u0027 creation",
    "category": {
      "id": "4291000000006685"
    },
    "subcategory": {
      "id": "4291000002382019"
    },
    "item": {
      "id": "4291000002382021"
    },
    "services": [
      {
        "id": "4291000000007945"
      },
      {
        "id": "4291000000007937"
      }
    ],
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "reason_for_change": {
      "id": "4291000000087089"
    },
    "title": "Title for Change  Maintenance",
    "description": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eDescriprtion here\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e",
    "impact_details": {},
    "roll_out_plan": {},
    "back_out_plan": {},
    "checklist": {},
    "release_details": {},
    "roles": [
      {
        "role": {
          "id": "4291000000087200"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087218"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000118019"
        },
        "user": {
          "id": "4291000004885015"
        }
      },
      {
        "role": {
          "id": "4291000000087215"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087212"
        },
        "user": {
          "id": "4291000000145236"
        }
      }
    ],
    "attachments": [],
    "maintenance": {
      "repetitive_schedule": {
        "start_time": {
          "value": 2027406600000,
          "display_value": "Mar 31, 2034 02:00 pm"
        },
        "frequency": "Daily",
        "is_advanced": true,
        "skip_frequency": 0,
        "exclude_weekends": false,
        "is_first_day_of_month": false
      }
    }
  }
};
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/change_maintenances"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "change_maintenance": {
    "workflow": {
      "id": "4291000000087981"
    },
    "template": {
      "id": "4291000000088294"
    },
    "change_requester": {
      "id": "4291000004271016"
    },
    "udf_fields": {},
    "change_type": {
      "id": "4291000000007951"
    },
    "site": {
      "id": "4291000001327001"
    },
    "retrospective": "false",
    "group": {
      "id": "4291000000006679"
    },
    "impact": {
      "id": "4291000005045003"
    },
    "urgency": {
      "id": "4291000000007919"
    },
    "priority": {
      "id": "4291000000006801"
    },
    "stage": {
      "id": "4291000000087125"
    },
    "risk": {
      "id": "4291000000087080"
    },
    "status": {
      "id": "4291000000087260"
    },
    "comment": "The above Stage/Status is set as part of \u0027Change\u0027 creation",
    "category": {
      "id": "4291000000006685"
    },
    "subcategory": {
      "id": "4291000002382019"
    },
    "item": {
      "id": "4291000002382021"
    },
    "services": [
      {
        "id": "4291000000007945"
      },
      {
        "id": "4291000000007937"
      }
    ],
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "reason_for_change": {
      "id": "4291000000087089"
    },
    "title": "Title for Change  Maintenance",
    "description": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eDescriprtion here\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e",
    "impact_details": {},
    "roll_out_plan": {},
    "back_out_plan": {},
    "checklist": {},
    "release_details": {},
    "roles": [
      {
        "role": {
          "id": "4291000000087200"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087218"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000118019"
        },
        "user": {
          "id": "4291000004885015"
        }
      },
      {
        "role": {
          "id": "4291000000087215"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087212"
        },
        "user": {
          "id": "4291000000145236"
        }
      }
    ],
    "attachments": [],
    "maintenance": {
      "repetitive_schedule": {
        "start_time": {
          "value": 2027406600000,
          "display_value": "Mar 31, 2034 02:00 pm"
        },
        "frequency": "Daily",
        "is_advanced": true,
        "skip_frequency": 0,
        "exclude_weekends": false,
        "is_first_day_of_month": false
      }
    }
  }
}
'@
$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/change_maintenances"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "change_maintenance": {
    "workflow": {
      "id": "4291000000087981"
    },
    "template": {
      "id": "4291000000088294"
    },
    "change_requester": {
      "id": "4291000004271016"
    },
    "udf_fields": {},
    "change_type": {
      "id": "4291000000007951"
    },
    "site": {
      "id": "4291000001327001"
    },
    "retrospective": "false",
    "group": {
      "id": "4291000000006679"
    },
    "impact": {
      "id": "4291000005045003"
    },
    "urgency": {
      "id": "4291000000007919"
    },
    "priority": {
      "id": "4291000000006801"
    },
    "stage": {
      "id": "4291000000087125"
    },
    "risk": {
      "id": "4291000000087080"
    },
    "status": {
      "id": "4291000000087260"
    },
    "comment": "The above Stage/Status is set as part of \u0027Change\u0027 creation",
    "category": {
      "id": "4291000000006685"
    },
    "subcategory": {
      "id": "4291000002382019"
    },
    "item": {
      "id": "4291000002382021"
    },
    "services": [
      {
        "id": "4291000000007945"
      },
      {
        "id": "4291000000007937"
      }
    ],
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "reason_for_change": {
      "id": "4291000000087089"
    },
    "title": "Title for Change  Maintenance",
    "description": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eDescriprtion here\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e",
    "impact_details": {},
    "roll_out_plan": {},
    "back_out_plan": {},
    "checklist": {},
    "release_details": {},
    "roles": [
      {
        "role": {
          "id": "4291000000087200"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087218"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000118019"
        },
        "user": {
          "id": "4291000004885015"
        }
      },
      {
        "role": {
          "id": "4291000000087215"
        },
        "user": {
          "id": "4291000000145236"
        }
      },
      {
        "role": {
          "id": "4291000000087212"
        },
        "user": {
          "id": "4291000000145236"
        }
      }
    ],
    "attachments": [],
    "maintenance": {
      "repetitive_schedule": {
        "start_time": {
          "value": 2027406600000,
          "display_value": "Mar 31, 2034 02:00 pm"
        },
        "frequency": "Daily",
        "is_advanced": true,
        "skip_frequency": 0,
        "exclude_weekends": false,
        "is_first_day_of_month": false
      }
    }
  }
}'''
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"
  },
  "change_maintenance": {
    "roll_out_plan": {
      "roll_out_plan_updated_on": null,
      "roll_out_plan_updated_by": null,
      "roll_out_plan_description": null
    },
    "emergency": false,
    "change_type": {
      "color": "#ff6666",
      "pre_approved": false,
      "name": "Major",
      "id": "4291000000007951"
    },
    "review_details": {
      "next_review_on": null,
      "review_details_updated_by": null,
      "review_details_updated_on": null,
      "review_details_description": null
    },
    "assets": [
      {
        "site": {
          "id": "4291000001327001"
        },
        "product": {
          "id": "4291000003115016"
        },
        "product_type": {
          "id": "4291000000005925"
        },
        "name": "a1",
        "id": "4291000003115020"
      }
    ],
    "configuration_items": [],
    "entity_instance_properties": [],
    "id": "4291000007602026",
    "change_requester": {
      "email_id": "test@testing.com",
      "is_technician": false,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4291000001327001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "a",
      "id": "4291000004271016",
      "photo_url": "https://profile.user.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "a",
      "job_title": null
    },
    "group": {
      "site": {
        "id": "4291000001327001"
      },
      "deleted": false,
      "name": "Hardware Problems",
      "id": "4291000000006679"
    },
    "created_time": {
      "display_value": "Mar 25, 2026 01:05 PM",
      "value": "1774424146238"
    },
    "item": {
      "name": "New hire",
      "id": "4291000002382021"
    },
    "workflow": {
      "inactive": false,
      "validated": true,
      "sub_module_details": null,
      "name": "General Change Workflow",
      "guided_path": false,
      "id": "4291000000087981",
      "type": "General",
      "allowed_stages_config": "APPLY_GLOBAL",
      "has_transitions": false
    },
    "approval_status": null,
    "impact": {
      "name": "1. Urgent",
      "id": "4291000005045003"
    },
    "release_details": {
      "release_actual_start": null,
      "release_actual_end": null,
      "release_details_description": null,
      "release_scheduled_end": null,
      "release_details_updated_on": null,
      "release_scheduled_start": null,
      "release_details_updated_by": null
    },
    "priority": {
      "color": "#006600",
      "name": "Normal",
      "id": "4291000000006801"
    },
    "scheduled_end_time": null,
    "uat_details": {
      "uat_scheduled_start": null,
      "uat_actual_end": null,
      "uat_details_updated_by": null,
      "uat_details_description": null,
      "uat_details_updated_on": null,
      "uat_scheduled_end": null,
      "uat_actual_start": null
    },
    "reason_for_change": {
      "name": "New services",
      "id": "4291000000087089"
    },
    "udf_fields": {
      "udf_double1": null
    },
    "impact_details": {
      "impact_details_updated_on": null,
      "impact_details_updated_by": null,
      "impact_details_description": null
    },
    "subcategory": {
      "name": "Seating location",
      "id": "4291000002382019"
    },
    "deleted_time": null,
    "is_freeze_conflicted": false,
    "status": {
      "internal_name": "requested",
      "stage": {
        "id": "4291000000087125"
      },
      "name": "Requested",
      "id": "4291000000087260"
    },
    "scheduled_start_time": null,
    "template": {
      "inactive": false,
      "name": "General Template",
      "id": "4291000000088294",
      "is_planning_needed_in_submission": true
    },
    "has_release_association": false,
    "attachments": [],
    "display_id": {
      "display_value": "CHM-17",
      "value": "17"
    },
    "roles": [
      {
        "role": {
          "internal_name": "change_approver",
          "user_type": "TECH",
          "name": "Change Approver",
          "id": "4291000000087200"
        },
        "id": "4291000007602031",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User12",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "reviewer",
          "user_type": "TECH",
          "name": "Reviewer",
          "id": "4291000000087218"
        },
        "id": "4291000007602041",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "uat_owner",
          "user_type": "ALL",
          "name": "UAT Owner",
          "id": "4291000000118019"
        },
        "id": "4291000007602051",
        "user": {
          "email_id": "test@domain.com",
          "is_technician": false,
          "sms_mail": null,
          "mobile": null,
          "last_name": null,
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": null,
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": null,
          "employee_id": null,
          "name": "test",
          "id": "4291000004885015",
          "photo_url": "https://profile.url.com/file?exp=10&ID=-1&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": null,
          "first_name": "test",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "line_manager",
          "user_type": "TECH",
          "name": "Line Manager",
          "id": "4291000000087215"
        },
        "id": "4291000007602061",
        "user": {
          "email_id": "user2@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User2",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "implementer",
          "user_type": "TECH",
          "name": "Implementer",
          "id": "4291000000087212"
        },
        "id": "4291000007602071",
        "user": {
          "email_id": "user3@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User3",
          "job_title": null
        }
      }
    ],
    "description": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Descriprtion here<br/></div></div>",
    "title": "Title for Change  Maintenance",
    "change_owner": null,
    "urgency": {
      "name": "High",
      "id": "4291000000007919"
    },
    "close_details": {
      "close_details_updated_on": null,
      "close_details_description": null,
      "closure_code": null,
      "close_details_updated_by": null
    },
    "maintenance_details": {
      "created_time": {
        "display_value": "Mar 25, 2026 01:05 PM",
        "value": "1774424146731"
      },
      "one_time_schedule": null,
      "subject": "Title for Change  Maintenance",
      "schedule_frequency": "Daily",
      "module": {
        "api_plural_name": "changes",
        "name": "change",
        "display_name_plural": "sdp.module.pluralname.change",
        "id": "4291000000085044",
        "display_name": "Change",
        "category": "SYSTEM",
        "icon_name": null
      },
      "maintenancestate": 1,
      "next_schedule": {
        "display_value": "Mar 31, 2034 02:00 PM",
        "value": "2027406600000"
      },
      "id": "4291000007602018",
      "created_by": {
        "email_id": "user4@domain.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4291000001327001",
          "is_default": true
        },
        "phone": "",
        "employee_id": null,
        "name": "test",
        "id": "4291000000145236",
        "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": {
          "site": {
            "id": "4291000001327001"
          },
          "name": "Engineering",
          "id": "4291000000006625"
        },
        "first_name": "User4",
        "job_title": null
      },
      "repetitive_schedule": {
        "is_advanced": true,
        "ends_on": null,
        "days_of_month": null,
        "last_execution_time": null,
        "is_first_day_of_month": false,
        "frequency": "Daily",
        "days_of_week": null,
        "weeks_of_month": null,
        "start_time": {
          "display_value": "Mar 31, 2034 02:00 PM",
          "value": "2027406600000"
        },
        "exclude_weekends": false,
        "months_of_year": null,
        "day_config_of_month": null,
        "skip_frequency": 0,
        "end_after_occurrences": null,
        "id": "4291000007602020"
      }
    },
    "change_manager": null,
    "is_freezed": false,
    "retrospective": false,
    "checklist": {
      "checklist_description": null,
      "checklist_updated_on": null,
      "checklist_updated_by": null
    },
    "services": [
      {
        "image": "email-server",
        "parent_service_category": null,
        "inactive": false,
        "name": "Email",
        "description": "Employee email service using Exchange.",
        "id": "4291000000007937",
        "sort_index": 0
      },
      {
        "image": "corporate-website",
        "parent_service_category": null,
        "inactive": false,
        "name": "Corporate Website",
        "description": "Our external website.",
        "id": "4291000000007945",
        "sort_index": 0
      }
    ],
    "back_out_plan": {
      "back_out_plan_updated_by": null,
      "back_out_plan_updated_on": null,
      "back_out_plan_description": null
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4291000001327001",
      "is_default": true
    },
    "stage": {
      "internal_name": "submission",
      "stage_index": 1,
      "name": "Submission",
      "id": "4291000000087125"
    },
    "completed_time": null,
    "risk": {
      "name": "Low",
      "id": "4291000000087080"
    },
    "category": {
      "deleted": false,
      "name": "General",
      "id": "4291000000006685"
    },
    "notes_present": false
  }
}

编辑变更维护

此操作帮助您编辑或更新维护变更

Url

<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}

属性

id （长整型）
创建时分配的唯一标识符

id （长整型）
被视为有较大数值的数字字符。

示例 

234759602834500

标题 （字符串）
变更维护的标题。   

标题 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

阶段 （change_stage）
维护产生的变更总是创建在提交阶段

阶段 （change_stage）
总是以变更流程的第一个阶段创建

示例 

{
  "stage": {
    "name": "submission",
    "id": "234567890123456"
  }
}

状态 （change_status）
指示变更的状态值

状态 （change_status）
指示维护创建变更时的状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

回顾性 （布尔型）
指示变更维护是否为回顾性

回顾性 （布尔型）
布尔值，可为 true 或 false。

描述 （html）
变更维护的描述

描述 （html）
HTML 是一个文本区域，可以使用 HTML 元素。

示例 

DatabaseServerfirewallupgrades

更多属性 全部展开

评论 （字符串）

每当变更由Maintenance创建时，状态备注将设置为提供的值

评论 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

maintenance (maintenance)

用于维护的计划详细信息的占位符

maintenance (maintenance)
此字段用作添加或编辑Maintenance期间的计划详细信息占位符

udf_fields (udf_fields)

包含变更的用户自定义字段值

udf_fields (udf_fields)
包含来自Maintenance关联到变更的用户自定义字段值

示例 

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

template (change_template)

变更模板通过定义其布局帮助创建自定义变更模板表单，以适应最常提出的变更。因此，可以快速创建变更，所有所需字段会自动填充。

template (change_template)
指示用于创建该变更的变更模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

change_requester (user)

指示维护的发起人

change_requester (user)
指示维护的发起人

示例 

{
  "change_requester": {
    "name": "test-change_requester",
    "id": "234567890123456"
  }
}

change_manager (technician)

管理变更整个生命周期的用户

change_manager (technician)
指示管理由Maintenance创建的变更整个生命周期的用户

示例 

{
  "change_manager": {
    "name": "test-change_manager",
    "id": "234567890123456"
  }
}

reason_for_change (reason_for_change)

发起变更的原因。

reason_for_change (reason_for_change)
指示必须发起变更的原因

示例 

{
  "reason_for_change": {
    "name": "test-reason_for_change",
    "id": "234567890123456"
  }
}

risk (change_risk)

说明是否涉及高、中或低风险。

risk (change_risk)
指示是否涉及高、中或低风险

示例 

{
  "risk": {
    "name": "test-risk",
    "id": "234567890123456"
  }
}

impact (impact)

描述来自Maintenance的变更将如何影响业务、部门、组或用户

impact (impact)
指示变更对业务、部门、组或用户的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

priority (priority)

指示变更是高优先级、低优先级还是中等优先级

priority (priority)
指示由Maintenance创建变更的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

category (category)

指定与本次维护变更相关的CI类别，如路由器、交换机、软件等

category (category)
指示将要创建变更所涉及的CI类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

指定在类别下选择的相关CI的子类别

subcategory (subcategory)
指示在类别下选择的相关CI的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

指定属于所选类别和子类别的项目

item (item)
指示受影响CI的项目分类

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

指示维护变更的紧急程度

urgency (urgency)
指示维护变更的紧急程度

示例 

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

change_type (change_type)

指示变更维护是次要的、主要的、重要的还是标准的

change_type (change_type)
指示变更维护是次要的、主要的、重要的还是标准的

示例 

{
  "change_type": {
    "name": "test-change_type",
    "id": "234567890123456"
  }
}

site (site)

指示维护所属站点

site (site)
表示维护所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

group (group)

分配给维护变更的组

group (group)
指示变更请求分配的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

change_owner (technician)

维护变更的所有者 

change_owner (technician)
维护变更的所有者

示例 

{
  "change_owner": {
    "name": "test-change_owner",
    "id": "234567890123456"
  }
}

services (service_category)

由于本次Maintenance变更可能受影响的服务

services (service_category)
由于变更创建可能受影响的服务

示例 

{
  "services": [
    {
      "name": "test-services",
      "id": "234567890123456"
    }
  ]
}

assets (asset)

受影响的资产

assets (asset)
由于此次变更可能受影响或涉及的资产

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

roles (change_to_change_role)

指示专为由Maintenance创建的变更定义的访问权限 

roles (change_to_change_role)
指示专为由Maintenance创建的变更定义的访问权限 

示例 

{
  "roles": [
    {
      "role": {
        "name": "Change Approver",
        "id": "100000000000021428"
      },
      "user": {
        "name": "Albert",
        "id": "100000000000024441"
      }
    }
  ]
}

workflow (workflow)

定义变更创建后在各阶段适当审批的完整生命周期

workflow (workflow)
定义变更创建后在各阶段适当审批的完整生命周期

示例 

{
  "workflow": {
    "name": "test-workflow",
    "id": "234567890123456"
  }
}

attachments (change_attachment)

附加到变更的文件。最多可附加10个附件。

attachments (change_attachment)
指示需附加到变更的文件，最多仅可附加10个附件

示例 

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

configuration_items (configuration_item)

必须为其创建变更的关键项目

configuration_items (configuration_item)
指示必须为其创建变更的关键项目

示例 

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

emergency （布尔型）read only

指示是否为紧急变更，若为true则为紧急变更，若为false则为正常维护变更

emergency （布尔型）
布尔值，可为 true 或 false。

$ curl <service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_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='{
  "change_maintenance": {
    "urgency": {
      "id": "4291000000007923"
    },
    "priority": {
      "id": "4291000000006803"
    },
    "risk": {
      "id": "4291000000087083"
    },
    "title": "Title for Change Maintenance - edited",
    "reason_for_change": {
      "id": "4291000000087098"
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "change_maintenance": {
    "urgency": {
      "id": "4291000000007923"
    },
    "priority": {
      "id": "4291000000006803"
    },
    "risk": {
      "id": "4291000000087083"
    },
    "title": "Title for Change Maintenance - edited",
    "reason_for_change": {
      "id": "4291000000087098"
    }
  }
};
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/change_maintenances/{change_maintenance_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "change_maintenance": {
    "urgency": {
      "id": "4291000000007923"
    },
    "priority": {
      "id": "4291000000006803"
    },
    "risk": {
      "id": "4291000000087083"
    },
    "title": "Title for Change Maintenance - edited",
    "reason_for_change": {
      "id": "4291000000087098"
    }
  }
}
'@
$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/change_maintenances/{change_maintenance_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "change_maintenance": {
    "urgency": {
      "id": "4291000000007923"
    },
    "priority": {
      "id": "4291000000006803"
    },
    "risk": {
      "id": "4291000000087083"
    },
    "title": "Title for Change Maintenance - edited",
    "reason_for_change": {
      "id": "4291000000087098"
    }
  }
}'''
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"
  },
  "change_maintenance": {
    "roll_out_plan": {
      "roll_out_plan_updated_on": null,
      "roll_out_plan_updated_by": null,
      "roll_out_plan_description": null
    },
    "emergency": false,
    "change_type": {
      "color": "#ff6666",
      "pre_approved": false,
      "name": "Major",
      "id": "4291000000007951"
    },
    "review_details": {
      "next_review_on": null,
      "review_details_updated_by": null,
      "review_details_updated_on": null,
      "review_details_description": null
    },
    "maintenanceid": null,
    "assets": [
      {
        "site": {
          "id": "4291000001327001"
        },
        "product": {
          "id": "4291000003115016"
        },
        "product_type": {
          "id": "4291000000005925"
        },
        "name": "a1",
        "id": "4291000003115020"
      }
    ],
    "configuration_items": [],
    "entity_instance_properties": [],
    "id": "4291000007602026",
    "change_requester": {
      "email_id": "test@testing.com",
      "is_technician": false,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4291000001327001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "a",
      "id": "4291000004271016",
      "photo_url": "https://profile.user.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "a",
      "job_title": null
    },
    "group": {
      "site": {
        "id": "4291000001327001"
      },
      "deleted": false,
      "name": "Hardware Problems",
      "id": "4291000000006679"
    },
    "created_time": {
      "display_value": "Mar 25, 2026 01:05 PM",
      "value": "1774424146238"
    },
    "item": {
      "name": "New hire",
      "id": "4291000002382021"
    },
    "workflow": {
      "inactive": false,
      "validated": true,
      "sub_module_details": null,
      "name": "General Change Workflow",
      "guided_path": false,
      "id": "4291000000087981",
      "type": "General",
      "allowed_stages_config": "APPLY_GLOBAL",
      "has_transitions": false
    },
    "approval_status": null,
    "impact": {
      "name": "1. Urgent",
      "id": "4291000005045003"
    },
    "release_details": {
      "release_actual_start": null,
      "release_actual_end": null,
      "release_details_description": null,
      "release_scheduled_end": null,
      "release_details_updated_on": null,
      "release_scheduled_start": null,
      "release_details_updated_by": null
    },
    "priority": {
      "color": "#0066F0",
      "name": "High",
      "id": "4291000000006803"
    },
    "scheduled_end_time": null,
    "uat_details": {
      "uat_scheduled_start": null,
      "uat_actual_end": null,
      "uat_details_updated_by": null,
      "uat_details_description": null,
      "uat_details_updated_on": null,
      "uat_scheduled_end": null,
      "uat_actual_start": null
    },
    "reason_for_change": {
      "name": "New services",
      "id": "4291000000087089"
    },
    "udf_fields": {
      "udf_double1": null
    },
    "impact_details": {
      "impact_details_updated_on": null,
      "impact_details_updated_by": null,
      "impact_details_description": null
    },
    "subcategory": {
      "name": "Seating location",
      "id": "4291000002382019"
    },
    "deleted_time": null,
    "is_freeze_conflicted": false,
    "status": {
      "internal_name": "requested",
      "stage": {
        "id": "4291000000087125"
      },
      "name": "Requested",
      "id": "4291000000087260"
    },
    "scheduled_start_time": null,
    "template": {
      "inactive": false,
      "name": "General Template",
      "id": "4291000000088294",
      "is_planning_needed_in_submission": true
    },
    "has_release_association": false,
    "attachments": [],
    "display_id": {
      "display_value": "CHM-17",
      "value": "17"
    },
    "roles": [
      {
        "role": {
          "internal_name": "change_approver",
          "user_type": "TECH",
          "name": "Change Approver",
          "id": "4291000000087200"
        },
        "id": "4291000007602031",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User12",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "reviewer",
          "user_type": "TECH",
          "name": "Reviewer",
          "id": "4291000000087218"
        },
        "id": "4291000007602041",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "uat_owner",
          "user_type": "ALL",
          "name": "UAT Owner",
          "id": "4291000000118019"
        },
        "id": "4291000007602051",
        "user": {
          "email_id": "test@domain.com",
          "is_technician": false,
          "sms_mail": null,
          "mobile": null,
          "last_name": null,
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": null,
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": null,
          "employee_id": null,
          "name": "test_user",
          "id": "4291000004885015",
          "photo_url": "https://profile.url.com/file?exp=10&ID=-1&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": null,
          "first_name": "test_user",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "line_manager",
          "user_type": "TECH",
          "name": "Line Manager",
          "id": "4291000000087215"
        },
        "id": "4291000007602061",
        "user": {
          "email_id": "user2@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User2",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "implementer",
          "user_type": "TECH",
          "name": "Implementer",
          "id": "4291000000087212"
        },
        "id": "4291000007602071",
        "user": {
          "email_id": "user3@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User3",
          "job_title": null
        }
      }
    ],
    "description": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Descriprtion here<br/></div></div>",
    "title": "Title for Change  Maintenance",
    "change_owner": null,
    "urgency": {
      "name": "Low",
      "id": "4291000000007923"
    },
    "close_details": {
      "close_details_updated_on": null,
      "close_details_description": null,
      "closure_code": null,
      "close_details_updated_by": null
    },
    "maintenance_details": {
      "created_time": {
        "display_value": "Mar 25, 2026 01:05 PM",
        "value": "1774424146731"
      },
      "one_time_schedule": null,
      "subject": "Title for Change  Maintenance",
      "schedule_frequency": "Daily",
      "module": {
        "api_plural_name": "changes",
        "name": "change",
        "display_name_plural": "sdp.module.pluralname.change",
        "id": "4291000000085044",
        "display_name": "Change",
        "category": "SYSTEM",
        "icon_name": null
      },
      "maintenancestate": 1,
      "next_schedule": {
        "display_value": "Mar 31, 2034 02:00 PM",
        "value": "2027406600000"
      },
      "id": "4291000007602018",
      "created_by": {
        "email_id": "user4@domain.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4291000001327001",
          "is_default": true
        },
        "phone": "",
        "employee_id": null,
        "name": "test",
        "id": "4291000000145236",
        "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": {
          "site": {
            "id": "4291000001327001"
          },
          "name": "Engineering",
          "id": "4291000000006625"
        },
        "first_name": "User4",
        "job_title": null
      },
      "repetitive_schedule": {
        "is_advanced": true,
        "ends_on": null,
        "days_of_month": null,
        "last_execution_time": null,
        "is_first_day_of_month": false,
        "frequency": "Daily",
        "days_of_week": null,
        "weeks_of_month": null,
        "start_time": {
          "display_value": "Mar 31, 2034 02:00 PM",
          "value": "2027406600000"
        },
        "exclude_weekends": false,
        "months_of_year": null,
        "day_config_of_month": null,
        "skip_frequency": 0,
        "end_after_occurrences": null,
        "id": "4291000007602020"
      }
    },
    "change_manager": null,
    "is_freezed": false,
    "retrospective": false,
    "checklist": {
      "checklist_description": null,
      "checklist_updated_on": null,
      "checklist_updated_by": null
    },
    "services": [
      {
        "image": "email-server",
        "parent_service_category": null,
        "inactive": false,
        "name": "Email",
        "description": "Employee email service using Exchange.",
        "id": "4291000000007937",
        "sort_index": 0
      },
      {
        "image": "corporate-website",
        "parent_service_category": null,
        "inactive": false,
        "name": "Corporate Website",
        "description": "Our external website.",
        "id": "4291000000007945",
        "sort_index": 0
      }
    ],
    "back_out_plan": {
      "back_out_plan_updated_by": null,
      "back_out_plan_updated_on": null,
      "back_out_plan_description": null
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4291000001327001",
      "is_default": true
    },
    "stage": {
      "internal_name": "submission",
      "stage_index": 1,
      "name": "Submission",
      "id": "4291000000087125"
    },
    "completed_time": null,
    "risk": {
      "name": "Medium",
      "id": "4291000000087083"
    },
    "category": {
      "deleted": false,
      "name": "General",
      "id": "4291000000006685"
    },
    "notes_present": false
  }
}

获取变更维护

此操作帮助您获取变更维护

Url

<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}

属性

id （长整型）
创建时分配的唯一标识符

id （长整型）
被视为有较大数值的数字字符。

示例 

234759602834500

标题 （字符串）
变更维护的标题。   

标题 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

阶段 （change_stage）
维护产生的变更总是创建在提交阶段

阶段 （change_stage）
总是以变更流程的第一个阶段创建

示例 

{
  "stage": {
    "name": "submission",
    "id": "234567890123456"
  }
}

状态 （change_status）
指示变更的状态值

状态 （change_status）
指示维护创建变更时的状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

回顾性 （布尔型）
指示变更维护是否为回顾性

回顾性 （布尔型）
布尔值，可为 true 或 false。

描述 （html）
变更维护的描述

描述 （html）
HTML 是一个文本区域，可以使用 HTML 元素。

示例 

DatabaseServerfirewallupgrades

更多属性 全部展开

评论 （字符串）

每当变更由Maintenance创建时，状态备注将设置为提供的值

评论 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

maintenance (maintenance)

用于维护的计划详细信息的占位符

maintenance (maintenance)
此字段用作添加或编辑Maintenance期间的计划详细信息占位符

udf_fields (udf_fields)

包含变更的用户自定义字段值

udf_fields (udf_fields)
包含来自Maintenance关联到变更的用户自定义字段值

示例 

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

template (change_template)

变更模板通过定义其布局帮助创建自定义变更模板表单，以适应最常提出的变更。因此，可以快速创建变更，所有所需字段会自动填充。

template (change_template)
指示用于创建该变更的变更模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

change_requester (user)

指示维护的发起人

change_requester (user)
指示维护的发起人

示例 

{
  "change_requester": {
    "name": "test-change_requester",
    "id": "234567890123456"
  }
}

change_manager (technician)

管理变更整个生命周期的用户

change_manager (technician)
指示管理由Maintenance创建的变更整个生命周期的用户

示例 

{
  "change_manager": {
    "name": "test-change_manager",
    "id": "234567890123456"
  }
}

reason_for_change (reason_for_change)

发起变更的原因。

reason_for_change (reason_for_change)
指示必须发起变更的原因

示例 

{
  "reason_for_change": {
    "name": "test-reason_for_change",
    "id": "234567890123456"
  }
}

risk (change_risk)

说明是否涉及高、中或低风险。

risk (change_risk)
指示是否涉及高、中或低风险

示例 

{
  "risk": {
    "name": "test-risk",
    "id": "234567890123456"
  }
}

impact (impact)

描述来自Maintenance的变更将如何影响业务、部门、组或用户

impact (impact)
指示变更对业务、部门、组或用户的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

priority (priority)

指示变更是高优先级、低优先级还是中等优先级

priority (priority)
指示由Maintenance创建变更的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

category (category)

指定与本次维护变更相关的CI类别，如路由器、交换机、软件等

category (category)
指示将要创建变更所涉及的CI类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

指定在类别下选择的相关CI的子类别

subcategory (subcategory)
指示在类别下选择的相关CI的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

指定属于所选类别和子类别的项目

item (item)
指示受影响CI的项目分类

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

指示维护变更的紧急程度

urgency (urgency)
指示维护变更的紧急程度

示例 

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

change_type (change_type)

指示变更维护是次要的、主要的、重要的还是标准的

change_type (change_type)
指示变更维护是次要的、主要的、重要的还是标准的

示例 

{
  "change_type": {
    "name": "test-change_type",
    "id": "234567890123456"
  }
}

site (site)

指示维护所属站点

site (site)
表示维护所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

group (group)

分配给维护变更的组

group (group)
指示变更请求分配的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

change_owner (technician)

维护变更的所有者 

change_owner (technician)
维护变更的所有者

示例 

{
  "change_owner": {
    "name": "test-change_owner",
    "id": "234567890123456"
  }
}

services (service_category)

由于本次Maintenance变更可能受影响的服务

services (service_category)
由于变更创建可能受影响的服务

示例 

{
  "services": [
    {
      "name": "test-services",
      "id": "234567890123456"
    }
  ]
}

assets (asset)

受影响的资产

assets (asset)
由于此次变更可能受影响或涉及的资产

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

roles (change_to_change_role)

指示专为由Maintenance创建的变更定义的访问权限 

roles (change_to_change_role)
指示专为由Maintenance创建的变更定义的访问权限 

示例 

{
  "roles": [
    {
      "role": {
        "name": "Change Approver",
        "id": "100000000000021428"
      },
      "user": {
        "name": "Albert",
        "id": "100000000000024441"
      }
    }
  ]
}

workflow (workflow)

定义变更创建后在各阶段适当审批的完整生命周期

workflow (workflow)
定义变更创建后在各阶段适当审批的完整生命周期

示例 

{
  "workflow": {
    "name": "test-workflow",
    "id": "234567890123456"
  }
}

attachments (change_attachment)

附加到变更的文件。最多可附加10个附件。

attachments (change_attachment)
指示需附加到变更的文件，最多仅可附加10个附件

示例 

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

configuration_items (configuration_item)

必须为其创建变更的关键项目

configuration_items (configuration_item)
指示必须为其创建变更的关键项目

示例 

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

emergency （布尔型）read only

指示是否为紧急变更，若为true则为紧急变更，若为false则为正常维护变更

emergency （布尔型）
布尔值，可为 true 或 false。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_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/change_maintenances/{change_maintenance_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/change_maintenances/{change_maintenance_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/change_maintenances/{change_maintenance_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"
  },
  "change_maintenance": {
    "roll_out_plan": {
      "roll_out_plan_updated_on": null,
      "roll_out_plan_updated_by": null,
      "roll_out_plan_description": null
    },
    "emergency": false,
    "change_type": {
      "color": "#ff6666",
      "pre_approved": false,
      "name": "Major",
      "id": "4291000000007951"
    },
    "review_details": {
      "next_review_on": null,
      "review_details_updated_by": null,
      "review_details_updated_on": null,
      "review_details_description": null
    },
    "maintenanceid": null,
    "assets": [
      {
        "site": {
          "id": "4291000001327001"
        },
        "product": {
          "id": "4291000003115016"
        },
        "product_type": {
          "id": "4291000000005925"
        },
        "name": "a1",
        "id": "4291000003115020"
      }
    ],
    "configuration_items": [],
    "entity_instance_properties": [],
    "id": "4291000007602026",
    "change_requester": {
      "email_id": "test@testing.com",
      "is_technician": false,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4291000001327001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "a",
      "id": "4291000004271016",
      "photo_url": "https://profile.user.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "a",
      "job_title": null
    },
    "group": {
      "site": {
        "id": "4291000001327001"
      },
      "deleted": false,
      "name": "Hardware Problems",
      "id": "4291000000006679"
    },
    "created_time": {
      "display_value": "Mar 25, 2026 01:05 PM",
      "value": "1774424146238"
    },
    "item": {
      "name": "New hire",
      "id": "4291000002382021"
    },
    "workflow": {
      "inactive": false,
      "validated": true,
      "sub_module_details": null,
      "name": "General Change Workflow",
      "guided_path": false,
      "id": "4291000000087981",
      "type": "General",
      "allowed_stages_config": "APPLY_GLOBAL",
      "has_transitions": false
    },
    "approval_status": null,
    "impact": {
      "name": "1. Urgent",
      "id": "4291000005045003"
    },
    "release_details": {
      "release_actual_start": null,
      "release_actual_end": null,
      "release_details_description": null,
      "release_scheduled_end": null,
      "release_details_updated_on": null,
      "release_scheduled_start": null,
      "release_details_updated_by": null
    },
    "priority": {
      "color": "#006600",
      "name": "Normal",
      "id": "4291000000006801"
    },
    "scheduled_end_time": null,
    "uat_details": {
      "uat_scheduled_start": null,
      "uat_actual_end": null,
      "uat_details_updated_by": null,
      "uat_details_description": null,
      "uat_details_updated_on": null,
      "uat_scheduled_end": null,
      "uat_actual_start": null
    },
    "reason_for_change": {
      "name": "New services",
      "id": "4291000000087089"
    },
    "udf_fields": {
      "udf_double1": null
    },
    "impact_details": {
      "impact_details_updated_on": null,
      "impact_details_updated_by": null,
      "impact_details_description": null
    },
    "subcategory": {
      "name": "Seating location",
      "id": "4291000002382019"
    },
    "deleted_time": null,
    "is_freeze_conflicted": false,
    "status": {
      "internal_name": "requested",
      "stage": {
        "id": "4291000000087125"
      },
      "name": "Requested",
      "id": "4291000000087260"
    },
    "scheduled_start_time": null,
    "template": {
      "inactive": false,
      "name": "General Template",
      "id": "4291000000088294",
      "is_planning_needed_in_submission": true
    },
    "has_release_association": false,
    "attachments": [],
    "display_id": {
      "display_value": "CHM-17",
      "value": "17"
    },
    "roles": [
      {
        "role": {
          "internal_name": "change_approver",
          "user_type": "TECH",
          "name": "Change Approver",
          "id": "4291000000087200"
        },
        "id": "4291000007602031",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User12",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "reviewer",
          "user_type": "TECH",
          "name": "Reviewer",
          "id": "4291000000087218"
        },
        "id": "4291000007602041",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "uat_owner",
          "user_type": "ALL",
          "name": "UAT Owner",
          "id": "4291000000118019"
        },
        "id": "4291000007602051",
        "user": {
          "email_id": "test@domain.com",
          "is_technician": false,
          "sms_mail": null,
          "mobile": null,
          "last_name": null,
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": null,
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": null,
          "employee_id": null,
          "name": "test",
          "id": "4291000004885015",
          "photo_url": "https://profile.url.com/file?exp=10&ID=-1&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": null,
          "first_name": "test",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "line_manager",
          "user_type": "TECH",
          "name": "Line Manager",
          "id": "4291000000087215"
        },
        "id": "4291000007602061",
        "user": {
          "email_id": "user2@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User2",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "implementer",
          "user_type": "TECH",
          "name": "Implementer",
          "id": "4291000000087212"
        },
        "id": "4291000007602071",
        "user": {
          "email_id": "user3@domain.com.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User3",
          "job_title": null
        }
      }
    ],
    "description": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Descriprtion here<br/></div></div>",
    "title": "Title for Change  Maintenance",
    "change_owner": null,
    "urgency": {
      "name": "High",
      "id": "4291000000007919"
    },
    "close_details": {
      "close_details_updated_on": null,
      "close_details_description": null,
      "closure_code": null,
      "close_details_updated_by": null
    },
    "maintenance_details": {
      "created_time": {
        "display_value": "Mar 25, 2026 01:05 PM",
        "value": "1774424146731"
      },
      "one_time_schedule": null,
      "subject": "Title for Change  Maintenance",
      "schedule_frequency": "Daily",
      "module": {
        "api_plural_name": "changes",
        "name": "change",
        "display_name_plural": "sdp.module.pluralname.change",
        "id": "4291000000085044",
        "display_name": "Change",
        "category": "SYSTEM",
        "icon_name": null
      },
      "maintenancestate": 1,
      "next_schedule": {
        "display_value": "Mar 31, 2034 02:00 PM",
        "value": "2027406600000"
      },
      "id": "4291000007602018",
      "created_by": {
        "email_id": "user4@domain.com.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4291000001327001",
          "is_default": true
        },
        "phone": "",
        "employee_id": null,
        "name": "test",
        "id": "4291000000145236",
        "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": {
          "site": {
            "id": "4291000001327001"
          },
          "name": "Engineering",
          "id": "4291000000006625"
        },
        "first_name": "User4",
        "job_title": null
      },
      "repetitive_schedule": {
        "is_advanced": true,
        "ends_on": null,
        "days_of_month": null,
        "last_execution_time": null,
        "is_first_day_of_month": false,
        "frequency": "Daily",
        "days_of_week": null,
        "weeks_of_month": null,
        "start_time": {
          "display_value": "Mar 31, 2034 02:00 PM",
          "value": "2027406600000"
        },
        "exclude_weekends": false,
        "months_of_year": null,
        "day_config_of_month": null,
        "skip_frequency": 0,
        "end_after_occurrences": null,
        "id": "4291000007602020"
      }
    },
    "change_manager": null,
    "is_freezed": false,
    "retrospective": false,
    "checklist": {
      "checklist_description": null,
      "checklist_updated_on": null,
      "checklist_updated_by": null
    },
    "services": [
      {
        "image": "email-server",
        "parent_service_category": null,
        "inactive": false,
        "name": "Email",
        "description": "Employee email service using Exchange.",
        "id": "4291000000007937",
        "sort_index": 0
      },
      {
        "image": "corporate-website",
        "parent_service_category": null,
        "inactive": false,
        "name": "Corporate Website",
        "description": "Our external website.",
        "id": "4291000000007945",
        "sort_index": 0
      }
    ],
    "back_out_plan": {
      "back_out_plan_updated_by": null,
      "back_out_plan_updated_on": null,
      "back_out_plan_description": null
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4291000001327001",
      "is_default": true
    },
    "stage": {
      "internal_name": "submission",
      "stage_index": 1,
      "name": "Submission",
      "id": "4291000000087125"
    },
    "completed_time": null,
    "risk": {
      "name": "Low",
      "id": "4291000000087080"
    },
    "category": {
      "deleted": false,
      "name": "General",
      "id": "4291000000006685"
    },
    "notes_present": false
  }
}

获取变更维护列表

此操作帮助获取所有变更维护的列表

Url

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

属性

id （长整型）
创建时分配的唯一标识符

id （长整型）
被视为有较大数值的数字字符。

示例 

234759602834500

标题 （字符串）
变更维护的标题。   

标题 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

阶段 （change_stage）
维护产生的变更总是创建在提交阶段

阶段 （change_stage）
总是以变更流程的第一个阶段创建

示例 

{
  "stage": {
    "name": "submission",
    "id": "234567890123456"
  }
}

状态 （change_status）
指示变更的状态值

状态 （change_status）
指示维护创建变更时的状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

回顾性 （布尔型）
指示变更维护是否为回顾性

回顾性 （布尔型）
布尔值，可为 true 或 false。

描述 （html）
变更维护的描述

描述 （html）
HTML 是一个文本区域，可以使用 HTML 元素。

示例 

DatabaseServerfirewallupgrades

更多属性 全部展开

评论 （字符串）

每当变更由Maintenance创建时，状态备注将设置为提供的值

评论 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

DatabaseServerfirewallupgrades

maintenance (maintenance)

用于维护的计划详细信息的占位符

maintenance (maintenance)
此字段用作添加或编辑Maintenance期间的计划详细信息占位符

udf_fields (udf_fields)

包含变更的用户自定义字段值

udf_fields (udf_fields)
包含来自Maintenance关联到变更的用户自定义字段值

示例 

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

template (change_template)

变更模板通过定义其布局帮助创建自定义变更模板表单，以适应最常提出的变更。因此，可以快速创建变更，所有所需字段会自动填充。

template (change_template)
指示用于创建该变更的变更模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

change_requester (user)

指示维护的发起人

change_requester (user)
指示维护的发起人

示例 

{
  "change_requester": {
    "name": "test-change_requester",
    "id": "234567890123456"
  }
}

change_manager (technician)

管理变更整个生命周期的用户

change_manager (technician)
指示管理由Maintenance创建的变更整个生命周期的用户

示例 

{
  "change_manager": {
    "name": "test-change_manager",
    "id": "234567890123456"
  }
}

reason_for_change (reason_for_change)

发起变更的原因。

reason_for_change (reason_for_change)
指示必须发起变更的原因

示例 

{
  "reason_for_change": {
    "name": "test-reason_for_change",
    "id": "234567890123456"
  }
}

risk (change_risk)

说明是否涉及高、中或低风险。

risk (change_risk)
指示是否涉及高、中或低风险

示例 

{
  "risk": {
    "name": "test-risk",
    "id": "234567890123456"
  }
}

impact (impact)

描述来自Maintenance的变更将如何影响业务、部门、组或用户

impact (impact)
指示变更对业务、部门、组或用户的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

priority (priority)

指示变更是高优先级、低优先级还是中等优先级

priority (priority)
指示由Maintenance创建变更的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

category (category)

指定与本次维护变更相关的CI类别，如路由器、交换机、软件等

category (category)
指示将要创建变更所涉及的CI类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

指定在类别下选择的相关CI的子类别

subcategory (subcategory)
指示在类别下选择的相关CI的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

指定属于所选类别和子类别的项目

item (item)
指示受影响CI的项目分类

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

指示维护变更的紧急程度

urgency (urgency)
指示维护变更的紧急程度

示例 

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

change_type (change_type)

指示变更维护是次要的、主要的、重要的还是标准的

change_type (change_type)
指示变更维护是次要的、主要的、重要的还是标准的

示例 

{
  "change_type": {
    "name": "test-change_type",
    "id": "234567890123456"
  }
}

site (site)

指示维护所属站点

site (site)
表示维护所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

group (group)

分配给维护变更的组

group (group)
指示变更请求分配的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

change_owner (technician)

维护变更的所有者 

change_owner (technician)
维护变更的所有者

示例 

{
  "change_owner": {
    "name": "test-change_owner",
    "id": "234567890123456"
  }
}

services (service_category)

由于本次Maintenance变更可能受影响的服务

services (service_category)
由于变更创建可能受影响的服务

示例 

{
  "services": [
    {
      "name": "test-services",
      "id": "234567890123456"
    }
  ]
}

assets (asset)

受影响的资产

assets (asset)
由于此次变更可能受影响或涉及的资产

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

roles (change_to_change_role)

指示专为由Maintenance创建的变更定义的访问权限 

roles (change_to_change_role)
指示专为由Maintenance创建的变更定义的访问权限 

示例 

{
  "roles": [
    {
      "role": {
        "name": "Change Approver",
        "id": "100000000000021428"
      },
      "user": {
        "name": "Albert",
        "id": "100000000000024441"
      }
    }
  ]
}

workflow (workflow)

定义变更创建后在各阶段适当审批的完整生命周期

workflow (workflow)
定义变更创建后在各阶段适当审批的完整生命周期

示例 

{
  "workflow": {
    "name": "test-workflow",
    "id": "234567890123456"
  }
}

attachments (change_attachment)

附加到变更的文件。最多可附加10个附件。

attachments (change_attachment)
指示需附加到变更的文件，最多仅可附加10个附件

示例 

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

configuration_items (configuration_item)

必须为其创建变更的关键项目

configuration_items (configuration_item)
指示必须为其创建变更的关键项目

示例 

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

emergency （布尔型）read only

指示是否为紧急变更，若为true则为紧急变更，若为false则为正常维护变更

emergency （布尔型）
布尔值，可为 true 或 false。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/change_maintenances\
      -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/change_maintenances";
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/change_maintenances"
$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/change_maintenances"
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"
  },
  "change_maintenances":[ {
    "roll_out_plan": {
      "roll_out_plan_updated_on": null,
      "roll_out_plan_updated_by": null,
      "roll_out_plan_description": null
    },
    "emergency": false,
    "change_type": {
      "color": "#ff6666",
      "pre_approved": false,
      "name": "Major",
      "id": "4291000000007951"
    },
    "review_details": {
      "next_review_on": null,
      "review_details_updated_by": null,
      "review_details_updated_on": null,
      "review_details_description": null
    },
    "maintenanceid": null,
    "assets": [
      {
        "site": {
          "id": "4291000001327001"
        },
        "product": {
          "id": "4291000003115016"
        },
        "product_type": {
          "id": "4291000000005925"
        },
        "name": "a1",
        "id": "4291000003115020"
      }
    ],
    "configuration_items": [],
    "entity_instance_properties": [],
    "id": "4291000007602026",
    "change_requester": {
      "email_id": "test@testing.com",
      "is_technician": false,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "cost_per_hour": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4291000001327001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "a",
      "id": "4291000004271016",
      "photo_url": "https://profile.user.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "a",
      "job_title": null
    },
    "group": {
      "site": {
        "id": "4291000001327001"
      },
      "deleted": false,
      "name": "Hardware Problems",
      "id": "4291000000006679"
    },
    "created_time": {
      "display_value": "Mar 25, 2026 01:05 PM",
      "value": "1774424146238"
    },
    "item": {
      "name": "New hire",
      "id": "4291000002382021"
    },
    "workflow": {
      "inactive": false,
      "validated": true,
      "sub_module_details": null,
      "name": "General Change Workflow",
      "guided_path": false,
      "id": "4291000000087981",
      "type": "General",
      "allowed_stages_config": "APPLY_GLOBAL",
      "has_transitions": false
    },
    "approval_status": null,
    "impact": {
      "name": "1. Urgent",
      "id": "4291000005045003"
    },
    "release_details": {
      "release_actual_start": null,
      "release_actual_end": null,
      "release_details_description": null,
      "release_scheduled_end": null,
      "release_details_updated_on": null,
      "release_scheduled_start": null,
      "release_details_updated_by": null
    },
    "priority": {
      "color": "#006600",
      "name": "Normal",
      "id": "4291000000006801"
    },
    "scheduled_end_time": null,
    "uat_details": {
      "uat_scheduled_start": null,
      "uat_actual_end": null,
      "uat_details_updated_by": null,
      "uat_details_description": null,
      "uat_details_updated_on": null,
      "uat_scheduled_end": null,
      "uat_actual_start": null
    },
    "reason_for_change": {
      "name": "New services",
      "id": "4291000000087089"
    },
    "udf_fields": {
      "udf_double1": null
    },
    "impact_details": {
      "impact_details_updated_on": null,
      "impact_details_updated_by": null,
      "impact_details_description": null
    },
    "subcategory": {
      "name": "Seating location",
      "id": "4291000002382019"
    },
    "deleted_time": null,
    "is_freeze_conflicted": false,
    "status": {
      "internal_name": "requested",
      "stage": {
        "id": "4291000000087125"
      },
      "name": "Requested",
      "id": "4291000000087260"
    },
    "scheduled_start_time": null,
    "template": {
      "inactive": false,
      "name": "General Template",
      "id": "4291000000088294",
      "is_planning_needed_in_submission": true
    },
    "has_release_association": false,
    "attachments": [],
    "display_id": {
      "display_value": "CHM-17",
      "value": "17"
    },
    "roles": [
      {
        "role": {
          "internal_name": "change_approver",
          "user_type": "TECH",
          "name": "Change Approver",
          "id": "4291000000087200"
        },
        "id": "4291000007602031",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User12",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "reviewer",
          "user_type": "TECH",
          "name": "Reviewer",
          "id": "4291000000087218"
        },
        "id": "4291000007602041",
        "user": {
          "email_id": "user@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.url.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "uat_owner",
          "user_type": "ALL",
          "name": "UAT Owner",
          "id": "4291000000118019"
        },
        "id": "4291000007602051",
        "user": {
          "email_id": "test@test.com",
          "is_technician": false,
          "sms_mail": null,
          "mobile": null,
          "last_name": null,
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": null,
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": null,
          "employee_id": null,
          "name": "test",
          "id": "4291000004885015",
          "photo_url": "https://profile.url.com/file?exp=10&ID=-1&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": null,
          "first_name": "test",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "line_manager",
          "user_type": "TECH",
          "name": "Line Manager",
          "id": "4291000000087215"
        },
        "id": "4291000007602061",
        "user": {
          "email_id": "user2@domain.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User2",
          "job_title": null
        }
      },
      {
        "role": {
          "internal_name": "implementer",
          "user_type": "TECH",
          "name": "Implementer",
          "id": "4291000000087212"
        },
        "id": "4291000007602071",
        "user": {
          "email_id": "user3@domain.com.com",
          "is_technician": true,
          "sms_mail": null,
          "mobile": "",
          "last_name": "",
          "user_scope": "internal_user",
          "sms_mail_id": null,
          "cost_per_hour": "0",
          "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
          },
          "phone": "",
          "employee_id": null,
          "name": "test",
          "id": "4291000000145236",
          "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
          "is_vip_user": false,
          "department": {
            "site": {
              "id": "4291000001327001"
            },
            "name": "Engineering",
            "id": "4291000000006625"
          },
          "first_name": "User3",
          "job_title": null
        }
      }
    ],
    "description": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Descriprtion here<br/></div></div>",
    "title": "Title for Change  Maintenance",
    "change_owner": null,
    "urgency": {
      "name": "High",
      "id": "4291000000007919"
    },
    "close_details": {
      "close_details_updated_on": null,
      "close_details_description": null,
      "closure_code": null,
      "close_details_updated_by": null
    },
    "maintenance_details": {
      "created_time": {
        "display_value": "Mar 25, 2026 01:05 PM",
        "value": "1774424146731"
      },
      "one_time_schedule": null,
      "subject": "Title for Change  Maintenance",
      "schedule_frequency": "Daily",
      "module": {
        "api_plural_name": "changes",
        "name": "change",
        "display_name_plural": "sdp.module.pluralname.change",
        "id": "4291000000085044",
        "display_name": "Change",
        "category": "SYSTEM",
        "icon_name": null
      },
      "maintenancestate": 1,
      "next_schedule": {
        "display_value": "Mar 31, 2034 02:00 PM",
        "value": "2027406600000"
      },
      "id": "4291000007602018",
      "created_by": {
        "email_id": "user4@domain.com.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4291000001327001",
          "is_default": true
        },
        "phone": "",
        "employee_id": null,
        "name": "test",
        "id": "4291000000145236",
        "photo_url": "https://profile.domain.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": {
          "site": {
            "id": "4291000001327001"
          },
          "name": "Engineering",
          "id": "4291000000006625"
        },
        "first_name": "User4",
        "job_title": null
      },
      "repetitive_schedule": {
        "is_advanced": true,
        "ends_on": null,
        "days_of_month": null,
        "last_execution_time": null,
        "is_first_day_of_month": false,
        "frequency": "Daily",
        "days_of_week": null,
        "weeks_of_month": null,
        "start_time": {
          "display_value": "Mar 31, 2034 02:00 PM",
          "value": "2027406600000"
        },
        "exclude_weekends": false,
        "months_of_year": null,
        "day_config_of_month": null,
        "skip_frequency": 0,
        "end_after_occurrences": null,
        "id": "4291000007602020"
      }
    },
    "change_manager": null,
    "is_freezed": false,
    "retrospective": false,
    "checklist": {
      "checklist_description": null,
      "checklist_updated_on": null,
      "checklist_updated_by": null
    },
    "services": [
      {
        "image": "email-server",
        "parent_service_category": null,
        "inactive": false,
        "name": "Email",
        "description": "Employee email service using Exchange.",
        "id": "4291000000007937",
        "sort_index": 0
      },
      {
        "image": "corporate-website",
        "parent_service_category": null,
        "inactive": false,
        "name": "Corporate Website",
        "description": "Our external website.",
        "id": "4291000000007945",
        "sort_index": 0
      }
    ],
    "back_out_plan": {
      "back_out_plan_updated_by": null,
      "back_out_plan_updated_on": null,
      "back_out_plan_description": null
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4291000001327001",
      "is_default": true
    },
    "stage": {
      "internal_name": "submission",
      "stage_index": 1,
      "name": "Submission",
      "id": "4291000000087125"
    },
    "completed_time": null,
    "risk": {
      "name": "Low",
      "id": "4291000000087080"
    },
    "category": {
      "deleted": false,
      "name": "General",
      "id": "4291000000006685"
    },
    "notes_present": false
  }],
  "list_info": {
    "row_count": 1,
    "start_index": 1,
    "search_criteria": [
      {
        "field": "title",
        "condition": "is",
        "value": "DB server upgrade"
      }
    ]
  }
}

删除变更维护

此操作允许删除变更维护

Url

<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}


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

启用

此操作允许启用变更维护

Url

<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_enable


$ curl <service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_enable\
      -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='{
  "comments": "Comments while enabling"
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_enable";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "comments": "Comments while enabling"
};
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/change_maintenances/{change_maintenance_id}/_enable"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "comments": "Comments while enabling"
}
'@
$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/change_maintenances/{change_maintenance_id}/_enable"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "comments": "Comments while enabling"
}'''
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"
    },
    "enable": {
        "id": "4291000004120001",
        "message": "Maintenance enabled successfully"
    }
}

查看更多

立即执行

此操作允许立即从Maintenance创建变更

Url

<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_execute_now


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_execute_now\
      -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/change_maintenances/{change_maintenance_id}/_execute_now";
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/change_maintenances/{change_maintenance_id}/_execute_now"
$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/change_maintenances/{change_maintenance_id}/_execute_now"
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"
    },
    "maintenance": {
        "display_id": {
            "display_value": "CH-2",
            "value": "2"
        },
        "message": "New Change Created"
    }
}

查看更多

暂停

此操作允许挂起变更维护

Url

<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_suspend


$ curl <service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_suspend\
      -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='{
  "comments": "Comments here"
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/change_maintenances/{change_maintenance_id}/_suspend";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "comments": "Comments here"
};
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/change_maintenances/{change_maintenance_id}/_suspend"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "comments": "Comments here"
}
'@
$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/change_maintenances/{change_maintenance_id}/_suspend"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "comments": "Comments here"
}'''
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())

{
    "suspend": {
        "id": "4291000004120001",
        "message": "Maintenance suspended successfully"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

查看更多