Skip to content

Change Maintenance

Automatically creates changes as per defined change fields configurations and schedule configuration, ensuring planned changes are generated systematically. This helps streamline change operations and ensures timely execution.

Attributes

id (long)
The unique identifier assigned at creation

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

Example 

234759602834500

title (string)
Title of the maintenance for change.   

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

stage (change_stage)
Change from a Maintenance will always be created in submission stage

stage (change_stage)
Always creates with First stage of change process

Example 

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

status (change_status)
Indicates the status value of the change

status (change_status)
Indicates the status in which change to be created from Maintenance

Example 

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

retrospective (boolean)
Indicates whether the maintenance for change is retrospective

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

description (html)
Description of the maintenance for change

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

Example 

DatabaseServerfirewallupgrades

More Attributes Expand all

comment (string)

Whenever the change creates from Maintennace, status comment is set with provided value

comment (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

maintenance (maintenance)

Holder for schedule details of Maintenance

maintenance (maintenance)
This field is used as holder for schedule details during add or edit Maintenance

udf_fields (udf_fields)

Contains user defined field values of the change

udf_fields (udf_fields)
Contains user defined field values associated to the change from maintenance

Example 

{
  "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)

Change templates helps to create customized change template forms by defining its layout for the most frequently raised change. Thus the change can be created quickly with all the needed fields filled automatically.

template (change_template)
Indicates the change template used to create the change

Example 

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

change_requester (user)

Indicates the initiator of the maintenance

change_requester (user)
Indicates the initiator of the maintenance

Example 

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

change_manager (technician)

User who manages the entire life cycle of the change

change_manager (technician)
Indicates the user who manages the change created from maintenance throughout its life cycle

Example 

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

reason_for_change (reason_for_change)

Reasons why the change was initiated.

reason_for_change (reason_for_change)
Indicates the reasons why the change had to be initiated

Example 

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

risk (change_risk)

Whether this involves high, low, or medium risk.

risk (change_risk)
Indicates whether this involves high, low, or medium risk

Example 

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

impact (impact)

Describes how this change from maintenance will affect the business, department, group, or user

impact (impact)
Indicates the impact of the change on business, department, group, or user

Example 

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

priority (priority)

Indicates whether the change is high, low, or medium priority

priority (priority)
Indicates priority of the change created from maintenance

Example 

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

category (category)

Assign the Category of the CIs invloved to this maintenance for change, such as routers, switches, software etc

category (category)
Indicates the Category of the CIs involved in change to be created.

Example 

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

subcategory (subcategory)
Indicates the Sub Category of the involved CIs selected under Category

Example 

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

item (item)

Assign the item belongs to the selected Category and Sub Category.

item (item)
Indicates the item categorization of the affected CI

Example 

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

urgency (urgency)

Indicates the urgency of the Maintennce for Change

urgency (urgency)
Indicates the urgency of the Maintennce for Change

Example 

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

change_type (change_type)

Indicates whether it is a minor, major, significant, or standard change maintenance

change_type (change_type)
Indicates whether it is a minor, major, significant, or standard change maintenance

Example 

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

site (site)

Indicates the site of themaintenance belongs.

site (site)
Denotes the Site to which the maintenance belongs.

Example 

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

group (group)

The assigned group of the maintenance for change

group (group)
Indicates the group to which the change request is assigned

Example 

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

change_owner (technician)

The owner of the mainteance for change 

change_owner (technician)
The owner of the mainteance for change

Example 

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

services (service_category)

The services that might be affected due to this change from Maintenance

services (service_category)
The services that might be affected due to the change creation

Example 

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

assets (asset)

Affected assets

assets (asset)
The assets that might be affected or involved due to this change

Example 

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

roles (change_to_change_role)

Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

roles (change_to_change_role)
Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

Example 

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

workflow (workflow)

Defines the complete life cycle with appropriate approvals at various stages of a change after creation

workflow (workflow)
Defines the complete life cycle with appropriate approvals at various stages of a change after creation

Example 

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

attachments (change_attachment)

Files that are attached to be the change. Maximum of 10 attachments can be attached to a change.

attachments (change_attachment)
Indicates files that are to be attached the change. A maximum of 10 attachments can only be attached

Example 

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

configuration_items (configuration_item)

critical items for which the change has to be created

configuration_items (configuration_item)
Indicates critical items for which the change has to be created

Example 

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

customer (customer)

Denotes the customer to which this request belongs

customer (customer)
Denotes the customer to which this request belongs

Example 

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

emergency (boolean)read only

Indicates emergency change, if true, or normal maintenance for change, if false

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

Add Change Maintenance

This operation helps you add a new maintenance for change.

Mandatory Fields :- title, stage, status

Url

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

Attributes

id (long)
The unique identifier assigned at creation

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

Example 

234759602834500

title (string)
Title of the maintenance for change.   

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

stage (change_stage)
Change from a Maintenance will always be created in submission stage

stage (change_stage)
Always creates with First stage of change process

Example 

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

status (change_status)
Indicates the status value of the change

status (change_status)
Indicates the status in which change to be created from Maintenance

Example 

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

retrospective (boolean)
Indicates whether the maintenance for change is retrospective

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

description (html)
Description of the maintenance for change

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

Example 

DatabaseServerfirewallupgrades

More Attributes Expand all

comment (string)

Whenever the change creates from Maintennace, status comment is set with provided value

comment (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

maintenance (maintenance)

Holder for schedule details of Maintenance

maintenance (maintenance)
This field is used as holder for schedule details during add or edit Maintenance

udf_fields (udf_fields)

Contains user defined field values of the change

udf_fields (udf_fields)
Contains user defined field values associated to the change from maintenance

Example 

{
  "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)

Change templates helps to create customized change template forms by defining its layout for the most frequently raised change. Thus the change can be created quickly with all the needed fields filled automatically.

template (change_template)
Indicates the change template used to create the change

Example 

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

change_requester (user)

Indicates the initiator of the maintenance

change_requester (user)
Indicates the initiator of the maintenance

Example 

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

change_manager (technician)

User who manages the entire life cycle of the change

change_manager (technician)
Indicates the user who manages the change created from maintenance throughout its life cycle

Example 

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

reason_for_change (reason_for_change)

Reasons why the change was initiated.

reason_for_change (reason_for_change)
Indicates the reasons why the change had to be initiated

Example 

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

risk (change_risk)

Whether this involves high, low, or medium risk.

risk (change_risk)
Indicates whether this involves high, low, or medium risk

Example 

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

impact (impact)

Describes how this change from maintenance will affect the business, department, group, or user

impact (impact)
Indicates the impact of the change on business, department, group, or user

Example 

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

priority (priority)

Indicates whether the change is high, low, or medium priority

priority (priority)
Indicates priority of the change created from maintenance

Example 

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

category (category)

Assign the Category of the CIs invloved to this maintenance for change, such as routers, switches, software etc

category (category)
Indicates the Category of the CIs involved in change to be created.

Example 

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

subcategory (subcategory)
Indicates the Sub Category of the involved CIs selected under Category

Example 

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

item (item)

Assign the item belongs to the selected Category and Sub Category.

item (item)
Indicates the item categorization of the affected CI

Example 

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

urgency (urgency)

Indicates the urgency of the Maintennce for Change

urgency (urgency)
Indicates the urgency of the Maintennce for Change

Example 

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

change_type (change_type)

Indicates whether it is a minor, major, significant, or standard change maintenance

change_type (change_type)
Indicates whether it is a minor, major, significant, or standard change maintenance

Example 

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

site (site)

Indicates the site of themaintenance belongs.

site (site)
Denotes the Site to which the maintenance belongs.

Example 

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

group (group)

The assigned group of the maintenance for change

group (group)
Indicates the group to which the change request is assigned

Example 

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

change_owner (technician)

The owner of the mainteance for change 

change_owner (technician)
The owner of the mainteance for change

Example 

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

services (service_category)

The services that might be affected due to this change from Maintenance

services (service_category)
The services that might be affected due to the change creation

Example 

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

assets (asset)

Affected assets

assets (asset)
The assets that might be affected or involved due to this change

Example 

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

roles (change_to_change_role)

Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

roles (change_to_change_role)
Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

Example 

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

workflow (workflow)

Defines the complete life cycle with appropriate approvals at various stages of a change after creation

workflow (workflow)
Defines the complete life cycle with appropriate approvals at various stages of a change after creation

Example 

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

attachments (change_attachment)

Files that are attached to be the change. Maximum of 10 attachments can be attached to a change.

attachments (change_attachment)
Indicates files that are to be attached the change. A maximum of 10 attachments can only be attached

Example 

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

configuration_items (configuration_item)

critical items for which the change has to be created

configuration_items (configuration_item)
Indicates critical items for which the change has to be created

Example 

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

customer (customer)

Denotes the customer to which this request belongs

customer (customer)
Denotes the customer to which this request belongs

Example 

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

emergency (boolean)read only

Indicates emergency change, if true, or normal maintenance for change, if false

emergency (boolean)
Boolean value which can have two possible values. The values are true and 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": "taops@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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.zoho.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.zoho.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.zoho.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
  }
}

Edit Change Maintenance

This operation helps you to edit or update a change maintenance

Url

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

Attributes

id (long)
The unique identifier assigned at creation

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

Example 

234759602834500

title (string)
Title of the maintenance for change.   

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

stage (change_stage)
Change from a Maintenance will always be created in submission stage

stage (change_stage)
Always creates with First stage of change process

Example 

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

status (change_status)
Indicates the status value of the change

status (change_status)
Indicates the status in which change to be created from Maintenance

Example 

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

retrospective (boolean)
Indicates whether the maintenance for change is retrospective

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

description (html)
Description of the maintenance for change

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

Example 

DatabaseServerfirewallupgrades

More Attributes Expand all

comment (string)

Whenever the change creates from Maintennace, status comment is set with provided value

comment (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

maintenance (maintenance)

Holder for schedule details of Maintenance

maintenance (maintenance)
This field is used as holder for schedule details during add or edit Maintenance

udf_fields (udf_fields)

Contains user defined field values of the change

udf_fields (udf_fields)
Contains user defined field values associated to the change from maintenance

Example 

{
  "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)

Change templates helps to create customized change template forms by defining its layout for the most frequently raised change. Thus the change can be created quickly with all the needed fields filled automatically.

template (change_template)
Indicates the change template used to create the change

Example 

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

change_requester (user)

Indicates the initiator of the maintenance

change_requester (user)
Indicates the initiator of the maintenance

Example 

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

change_manager (technician)

User who manages the entire life cycle of the change

change_manager (technician)
Indicates the user who manages the change created from maintenance throughout its life cycle

Example 

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

reason_for_change (reason_for_change)

Reasons why the change was initiated.

reason_for_change (reason_for_change)
Indicates the reasons why the change had to be initiated

Example 

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

risk (change_risk)

Whether this involves high, low, or medium risk.

risk (change_risk)
Indicates whether this involves high, low, or medium risk

Example 

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

impact (impact)

Describes how this change from maintenance will affect the business, department, group, or user

impact (impact)
Indicates the impact of the change on business, department, group, or user

Example 

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

priority (priority)

Indicates whether the change is high, low, or medium priority

priority (priority)
Indicates priority of the change created from maintenance

Example 

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

category (category)

Assign the Category of the CIs invloved to this maintenance for change, such as routers, switches, software etc

category (category)
Indicates the Category of the CIs involved in change to be created.

Example 

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

subcategory (subcategory)
Indicates the Sub Category of the involved CIs selected under Category

Example 

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

item (item)

Assign the item belongs to the selected Category and Sub Category.

item (item)
Indicates the item categorization of the affected CI

Example 

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

urgency (urgency)

Indicates the urgency of the Maintennce for Change

urgency (urgency)
Indicates the urgency of the Maintennce for Change

Example 

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

change_type (change_type)

Indicates whether it is a minor, major, significant, or standard change maintenance

change_type (change_type)
Indicates whether it is a minor, major, significant, or standard change maintenance

Example 

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

site (site)

Indicates the site of themaintenance belongs.

site (site)
Denotes the Site to which the maintenance belongs.

Example 

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

group (group)

The assigned group of the maintenance for change

group (group)
Indicates the group to which the change request is assigned

Example 

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

change_owner (technician)

The owner of the mainteance for change 

change_owner (technician)
The owner of the mainteance for change

Example 

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

services (service_category)

The services that might be affected due to this change from Maintenance

services (service_category)
The services that might be affected due to the change creation

Example 

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

assets (asset)

Affected assets

assets (asset)
The assets that might be affected or involved due to this change

Example 

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

roles (change_to_change_role)

Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

roles (change_to_change_role)
Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

Example 

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

workflow (workflow)

Defines the complete life cycle with appropriate approvals at various stages of a change after creation

workflow (workflow)
Defines the complete life cycle with appropriate approvals at various stages of a change after creation

Example 

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

attachments (change_attachment)

Files that are attached to be the change. Maximum of 10 attachments can be attached to a change.

attachments (change_attachment)
Indicates files that are to be attached the change. A maximum of 10 attachments can only be attached

Example 

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

configuration_items (configuration_item)

critical items for which the change has to be created

configuration_items (configuration_item)
Indicates critical items for which the change has to be created

Example 

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

customer (customer)

Denotes the customer to which this request belongs

customer (customer)
Denotes the customer to which this request belongs

Example 

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

emergency (boolean)read only

Indicates emergency change, if true, or normal maintenance for change, if false

emergency (boolean)
Boolean value which can have two possible values. The values are true and 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": "taops@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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.zoho.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.zoho.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.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.zoho.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
  }
}

Get Change Maintenance

This operation helps you Get Maintenance For change.

Url

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

Attributes

id (long)
The unique identifier assigned at creation

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

Example 

234759602834500

title (string)
Title of the maintenance for change.   

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

stage (change_stage)
Change from a Maintenance will always be created in submission stage

stage (change_stage)
Always creates with First stage of change process

Example 

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

status (change_status)
Indicates the status value of the change

status (change_status)
Indicates the status in which change to be created from Maintenance

Example 

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

retrospective (boolean)
Indicates whether the maintenance for change is retrospective

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

description (html)
Description of the maintenance for change

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

Example 

DatabaseServerfirewallupgrades

More Attributes Expand all

comment (string)

Whenever the change creates from Maintennace, status comment is set with provided value

comment (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

maintenance (maintenance)

Holder for schedule details of Maintenance

maintenance (maintenance)
This field is used as holder for schedule details during add or edit Maintenance

udf_fields (udf_fields)

Contains user defined field values of the change

udf_fields (udf_fields)
Contains user defined field values associated to the change from maintenance

Example 

{
  "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)

Change templates helps to create customized change template forms by defining its layout for the most frequently raised change. Thus the change can be created quickly with all the needed fields filled automatically.

template (change_template)
Indicates the change template used to create the change

Example 

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

change_requester (user)

Indicates the initiator of the maintenance

change_requester (user)
Indicates the initiator of the maintenance

Example 

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

change_manager (technician)

User who manages the entire life cycle of the change

change_manager (technician)
Indicates the user who manages the change created from maintenance throughout its life cycle

Example 

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

reason_for_change (reason_for_change)

Reasons why the change was initiated.

reason_for_change (reason_for_change)
Indicates the reasons why the change had to be initiated

Example 

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

risk (change_risk)

Whether this involves high, low, or medium risk.

risk (change_risk)
Indicates whether this involves high, low, or medium risk

Example 

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

impact (impact)

Describes how this change from maintenance will affect the business, department, group, or user

impact (impact)
Indicates the impact of the change on business, department, group, or user

Example 

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

priority (priority)

Indicates whether the change is high, low, or medium priority

priority (priority)
Indicates priority of the change created from maintenance

Example 

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

category (category)

Assign the Category of the CIs invloved to this maintenance for change, such as routers, switches, software etc

category (category)
Indicates the Category of the CIs involved in change to be created.

Example 

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

subcategory (subcategory)
Indicates the Sub Category of the involved CIs selected under Category

Example 

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

item (item)

Assign the item belongs to the selected Category and Sub Category.

item (item)
Indicates the item categorization of the affected CI

Example 

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

urgency (urgency)

Indicates the urgency of the Maintennce for Change

urgency (urgency)
Indicates the urgency of the Maintennce for Change

Example 

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

change_type (change_type)

Indicates whether it is a minor, major, significant, or standard change maintenance

change_type (change_type)
Indicates whether it is a minor, major, significant, or standard change maintenance

Example 

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

site (site)

Indicates the site of themaintenance belongs.

site (site)
Denotes the Site to which the maintenance belongs.

Example 

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

group (group)

The assigned group of the maintenance for change

group (group)
Indicates the group to which the change request is assigned

Example 

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

change_owner (technician)

The owner of the mainteance for change 

change_owner (technician)
The owner of the mainteance for change

Example 

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

services (service_category)

The services that might be affected due to this change from Maintenance

services (service_category)
The services that might be affected due to the change creation

Example 

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

assets (asset)

Affected assets

assets (asset)
The assets that might be affected or involved due to this change

Example 

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

roles (change_to_change_role)

Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

roles (change_to_change_role)
Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

Example 

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

workflow (workflow)

Defines the complete life cycle with appropriate approvals at various stages of a change after creation

workflow (workflow)
Defines the complete life cycle with appropriate approvals at various stages of a change after creation

Example 

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

attachments (change_attachment)

Files that are attached to be the change. Maximum of 10 attachments can be attached to a change.

attachments (change_attachment)
Indicates files that are to be attached the change. A maximum of 10 attachments can only be attached

Example 

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

configuration_items (configuration_item)

critical items for which the change has to be created

configuration_items (configuration_item)
Indicates critical items for which the change has to be created

Example 

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

customer (customer)

Denotes the customer to which this request belongs

customer (customer)
Denotes the customer to which this request belongs

Example 

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

emergency (boolean)read only

Indicates emergency change, if true, or normal maintenance for change, if false

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

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/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": "taops@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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.zoho.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.zoho.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.zoho.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
  }
}

Get List Change Maintenance

This operation helps to get the list of all Change Maintenances

Url

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

Attributes

id (long)
The unique identifier assigned at creation

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

Example 

234759602834500

title (string)
Title of the maintenance for change.   

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

stage (change_stage)
Change from a Maintenance will always be created in submission stage

stage (change_stage)
Always creates with First stage of change process

Example 

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

status (change_status)
Indicates the status value of the change

status (change_status)
Indicates the status in which change to be created from Maintenance

Example 

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

retrospective (boolean)
Indicates whether the maintenance for change is retrospective

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

description (html)
Description of the maintenance for change

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

Example 

DatabaseServerfirewallupgrades

More Attributes Expand all

comment (string)

Whenever the change creates from Maintennace, status comment is set with provided value

comment (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

DatabaseServerfirewallupgrades

maintenance (maintenance)

Holder for schedule details of Maintenance

maintenance (maintenance)
This field is used as holder for schedule details during add or edit Maintenance

udf_fields (udf_fields)

Contains user defined field values of the change

udf_fields (udf_fields)
Contains user defined field values associated to the change from maintenance

Example 

{
  "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)

Change templates helps to create customized change template forms by defining its layout for the most frequently raised change. Thus the change can be created quickly with all the needed fields filled automatically.

template (change_template)
Indicates the change template used to create the change

Example 

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

change_requester (user)

Indicates the initiator of the maintenance

change_requester (user)
Indicates the initiator of the maintenance

Example 

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

change_manager (technician)

User who manages the entire life cycle of the change

change_manager (technician)
Indicates the user who manages the change created from maintenance throughout its life cycle

Example 

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

reason_for_change (reason_for_change)

Reasons why the change was initiated.

reason_for_change (reason_for_change)
Indicates the reasons why the change had to be initiated

Example 

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

risk (change_risk)

Whether this involves high, low, or medium risk.

risk (change_risk)
Indicates whether this involves high, low, or medium risk

Example 

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

impact (impact)

Describes how this change from maintenance will affect the business, department, group, or user

impact (impact)
Indicates the impact of the change on business, department, group, or user

Example 

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

priority (priority)

Indicates whether the change is high, low, or medium priority

priority (priority)
Indicates priority of the change created from maintenance

Example 

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

category (category)

Assign the Category of the CIs invloved to this maintenance for change, such as routers, switches, software etc

category (category)
Indicates the Category of the CIs involved in change to be created.

Example 

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

subcategory (subcategory)
Indicates the Sub Category of the involved CIs selected under Category

Example 

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

item (item)

Assign the item belongs to the selected Category and Sub Category.

item (item)
Indicates the item categorization of the affected CI

Example 

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

urgency (urgency)

Indicates the urgency of the Maintennce for Change

urgency (urgency)
Indicates the urgency of the Maintennce for Change

Example 

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

change_type (change_type)

Indicates whether it is a minor, major, significant, or standard change maintenance

change_type (change_type)
Indicates whether it is a minor, major, significant, or standard change maintenance

Example 

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

site (site)

Indicates the site of themaintenance belongs.

site (site)
Denotes the Site to which the maintenance belongs.

Example 

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

group (group)

The assigned group of the maintenance for change

group (group)
Indicates the group to which the change request is assigned

Example 

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

change_owner (technician)

The owner of the mainteance for change 

change_owner (technician)
The owner of the mainteance for change

Example 

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

services (service_category)

The services that might be affected due to this change from Maintenance

services (service_category)
The services that might be affected due to the change creation

Example 

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

assets (asset)

Affected assets

assets (asset)
The assets that might be affected or involved due to this change

Example 

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

roles (change_to_change_role)

Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

roles (change_to_change_role)
Indicates the access permissions defined exclusively for the change to be created from Maintenance. 

Example 

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

workflow (workflow)

Defines the complete life cycle with appropriate approvals at various stages of a change after creation

workflow (workflow)
Defines the complete life cycle with appropriate approvals at various stages of a change after creation

Example 

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

attachments (change_attachment)

Files that are attached to be the change. Maximum of 10 attachments can be attached to a change.

attachments (change_attachment)
Indicates files that are to be attached the change. A maximum of 10 attachments can only be attached

Example 

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

configuration_items (configuration_item)

critical items for which the change has to be created

configuration_items (configuration_item)
Indicates critical items for which the change has to be created

Example 

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

customer (customer)

Denotes the customer to which this request belongs

customer (customer)
Denotes the customer to which this request belongs

Example 

{
  "customer": {
    "name": "Customer ABC",
    "id": "2000000040924",
    "is_msp": false
  }
}

emergency (boolean)read only

Indicates emergency change, if true, or normal maintenance for change, if false

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

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/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": "taops@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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": "TAOPS@fractal.ai",
          "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.zoho.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.zoho.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.zoho.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"
      }
    ]
  }
}

Delete Change Maintenance

This operation allows to delete a Change Maintenance

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

Enable

This operation allows to enable a Change Maintenance

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

View more

Execute Now

This operation allows to instantly create a Change from 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"
    }
}

View more

Suspend

This operation allows to suspend a Change Maintenance

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

View more