Skip to content

Request Maintenance

Automatically creates requests as per given request fields configurations and schedule configuration, ensuring recurring requests are generated systematically. This helps streamline maintenance operations and reduces manual effort.

Attributes

id (long)
Id of this maintenance

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

Example 

234759602834500

subject (string)
Subject of this maintenance[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this maintenance

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

Example 

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

impact_details (string)
Description about the impact of this maintenance[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be filled in request created through this maintenance

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

Example 

guest@zylker.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

created_time (datetime)

Indicates the time at which this maintenance is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

impact (impact)

Impact of this maintenance

impact (impact)

Example 

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

status (status)

Indicates the status configured for request in this maintenance

status (status)

Example 

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

requester (user)

Technician assigned to this maintenance

requester (user)

Example 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

The mode configured for request to be created from  this maintenance

mode (mode)

Example 

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

site (site)

Denotes the site to which this maintenance belongs

site (site)

Example 

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

template (request_template)

Indicates the template which is used to create this maintenance

template (request_template)

Example 

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

service_category (service_category)

Service category to which this maintenance belong

service_category (service_category)

Example 

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

group (group)

The group to which the maintenance is assigned to

group (group)

Example 

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

technician (technician)

Technician assigned to this maintenance

technician (technician)

Example 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

Priority of the maintenance

priority (priority)

Example 

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

level (level)

Level of the maintenance

level (level)

Example 

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

category (category)

Category to which the maintenance belongs

category (category)

Example 

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

subcategory (subcategory)

Subcategory to which the maintenance belongs

subcategory (subcategory)

Example 

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

item (item)

Item of the maintenance

item (item)

Example 

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

urgency (urgency)

Urgency of the maintenance

urgency (urgency)

Example 

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

request_type (request_type)

Request Type of the maintenance

request_type (request_type)

Example 

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

assets (asset)

Array of asset objects associated to this maintenance

assets (asset)

Example 

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

configuration_items (configuration_item)

Configuration Items for which the maintenance has been raised

configuration_items (configuration_item)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the maintenance

udf_fields (udf_fields)

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (attachment)

Files that are attached to the maintenance.

attachments (attachment)

Example 

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

resources (resources)

Holds the resource data mapped to the maintenance

resources (resources)

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

editor (user)

The user who is configured as the Editor of the maintenance

editor (user)

Example 

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

department (department)

Department to which this requester belongs

department (department)

Example 

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

space (space_instance)

Array of space objects associated to this maintenance

space (space_instance)

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

one_time_schedule (one_time_schedule)

Indicates the one_time_schedule of the maintenance

one_time_schedule (one_time_schedule)

repetitive_schedule (calendar_repetitive_schedule)

Indicates the repetitive_schedule of the maintenance

repetitive_schedule (calendar_repetitive_schedule)

resolution (JSONObject)

A solution for the maintenance, provided by the technician
show attribute

resolution (JSONObject)

service_approvers (JSONObject)

The configured users will be added to the first stage of approval for the service maintenance. It can be added only by Requesters.
show attribute

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

service_cost (double)read only

Basic cost for the service which we are requesting

service_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

total_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

is_service (boolean)read only

Boolean value indicating whether this maintenance is a service maintenance or not

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

created_by (user)read only

Indicates the user who created this maintenance

created_by (user)

maintenancestate (int)read only

Indicates the  current state of maintenance

maintenancestate (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

next_schedule (datetime)read only

Indicates the next schedule of this maintenance

next_schedule (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

schedule_frequency (string)read only

Indicates the type of schedule for this maintenance

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

Example 

Sample Content

repeat_details (string)read only

Indicates the repetition behavior of maintenance’s schedule  in readable format

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

Example 

Sample Content

maintenance_end (string)read only

Indicates the ends configuration of maintenance’s schedule

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

Example 

Sample Content

events (JSONArray)read only

Indicates the recurrence config of maintenance’s schedule

events (JSONArray)

Add Request Maintenance

This operation helps to create a Request Maintenance

Mandatory Fields :- subject

Url

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

Attributes

id (long)
Id of this maintenance

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

Example 

234759602834500

subject (string)
Subject of this maintenance[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this maintenance

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

Example 

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

impact_details (string)
Description about the impact of this maintenance[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be filled in request created through this maintenance

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

Example 

guest@zylker.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

created_time (datetime)

Indicates the time at which this maintenance is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

impact (impact)

Impact of this maintenance

impact (impact)

Example 

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

status (status)

Indicates the status configured for request in this maintenance

status (status)

Example 

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

requester (user)

Technician assigned to this maintenance

requester (user)

Example 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

The mode configured for request to be created from  this maintenance

mode (mode)

Example 

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

site (site)

Denotes the site to which this maintenance belongs

site (site)

Example 

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

template (request_template)

Indicates the template which is used to create this maintenance

template (request_template)

Example 

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

service_category (service_category)

Service category to which this maintenance belong

service_category (service_category)

Example 

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

group (group)

The group to which the maintenance is assigned to

group (group)

Example 

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

technician (technician)

Technician assigned to this maintenance

technician (technician)

Example 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

Priority of the maintenance

priority (priority)

Example 

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

level (level)

Level of the maintenance

level (level)

Example 

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

category (category)

Category to which the maintenance belongs

category (category)

Example 

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

subcategory (subcategory)

Subcategory to which the maintenance belongs

subcategory (subcategory)

Example 

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

item (item)

Item of the maintenance

item (item)

Example 

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

urgency (urgency)

Urgency of the maintenance

urgency (urgency)

Example 

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

request_type (request_type)

Request Type of the maintenance

request_type (request_type)

Example 

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

assets (asset)

Array of asset objects associated to this maintenance

assets (asset)

Example 

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

configuration_items (configuration_item)

Configuration Items for which the maintenance has been raised

configuration_items (configuration_item)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the maintenance

udf_fields (udf_fields)

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (attachment)

Files that are attached to the maintenance.

attachments (attachment)

Example 

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

resources (resources)

Holds the resource data mapped to the maintenance

resources (resources)

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

editor (user)

The user who is configured as the Editor of the maintenance

editor (user)

Example 

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

department (department)

Department to which this requester belongs

department (department)

Example 

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

space (space_instance)

Array of space objects associated to this maintenance

space (space_instance)

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

one_time_schedule (one_time_schedule)

Indicates the one_time_schedule of the maintenance

one_time_schedule (one_time_schedule)

repetitive_schedule (calendar_repetitive_schedule)

Indicates the repetitive_schedule of the maintenance

repetitive_schedule (calendar_repetitive_schedule)

resolution (JSONObject)

A solution for the maintenance, provided by the technician
show attribute

resolution (JSONObject)

service_approvers (JSONObject)

The configured users will be added to the first stage of approval for the service maintenance. It can be added only by Requesters.
show attribute

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

service_cost (double)read only

Basic cost for the service which we are requesting

service_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

total_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

is_service (boolean)read only

Boolean value indicating whether this maintenance is a service maintenance or not

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

created_by (user)read only

Indicates the user who created this maintenance

created_by (user)

maintenancestate (int)read only

Indicates the  current state of maintenance

maintenancestate (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

next_schedule (datetime)read only

Indicates the next schedule of this maintenance

next_schedule (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

schedule_frequency (string)read only

Indicates the type of schedule for this maintenance

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

Example 

Sample Content

repeat_details (string)read only

Indicates the repetition behavior of maintenance’s schedule  in readable format

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

Example 

Sample Content

maintenance_end (string)read only

Indicates the ends configuration of maintenance’s schedule

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

Example 

Sample Content

events (JSONArray)read only

Indicates the recurrence config of maintenance’s schedule

events (JSONArray)

$ curl <service domain|custom domain>/app/<portal>/api/v3/request_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='{
  "request_maintenance": {
    "template": {
      "id": "4291000000006655"
    },
    "request_template_task_ids": [
      {
        "id": "4291000001479001"
      }
    ],
    "priority": {
      "id": "4291000000006805"
    },
    "impact": {
      "id": "4291000000008033"
    },
    "status": {
      "id": "4291000000006657"
    },
    "impact_details": "Impacts Business in many aspects",
    "configuration_items": [],
    "urgency": {
      "id": "4291000000007919"
    },
    "mode": {
      "id": "4291000000006665"
    },
    "level": {
      "id": "4291000000006671"
    },
    "email_ids_to_notify": [],
    "requester": {
      "id": "4291000000145236"
    },
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "site": {
      "id": "4291000001327001"
    },
    "category": {
      "id": "4291000002997019"
    },
    "subcategory": {
      "id": "4291000002997021"
    },
    "technician": {
      "id": "4291000000145236"
    },
    "subject": "Request Maintenance Subject Here",
    "description": "Description goes here",
    "attachments": [],
    "resolution": {
      "content": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eResolution for created Maintenance\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e"
    },
    "department": {
      "id": "4291000000006625"
    },
    "repetitive_schedule": {
      "start_time": {
        "value": 1742279400000,
        "display_value": "Mar 18, 2025 12:00 pm"
      },
      "frequency": "Weekly",
      "is_advanced": true,
      "skip_frequency": 0,
      "exclude_weekends": false,
      "days_of_week": [
        3,
        5
      ],
      "is_first_day_of_month": false,
      "end_after_occurrences": "7"
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/request_maintenances";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "request_maintenance": {
    "template": {
      "id": "4291000000006655"
    },
    "request_template_task_ids": [
      {
        "id": "4291000001479001"
      }
    ],
    "priority": {
      "id": "4291000000006805"
    },
    "impact": {
      "id": "4291000000008033"
    },
    "status": {
      "id": "4291000000006657"
    },
    "impact_details": "Impacts Business in many aspects",
    "configuration_items": [],
    "urgency": {
      "id": "4291000000007919"
    },
    "mode": {
      "id": "4291000000006665"
    },
    "level": {
      "id": "4291000000006671"
    },
    "email_ids_to_notify": [],
    "requester": {
      "id": "4291000000145236"
    },
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "site": {
      "id": "4291000001327001"
    },
    "category": {
      "id": "4291000002997019"
    },
    "subcategory": {
      "id": "4291000002997021"
    },
    "technician": {
      "id": "4291000000145236"
    },
    "subject": "Request Maintenance Subject Here",
    "description": "Description goes here",
    "attachments": [],
    "resolution": {
      "content": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eResolution for created Maintenance\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e"
    },
    "department": {
      "id": "4291000000006625"
    },
    "repetitive_schedule": {
      "start_time": {
        "value": 1742279400000,
        "display_value": "Mar 18, 2025 12:00 pm"
      },
      "frequency": "Weekly",
      "is_advanced": true,
      "skip_frequency": 0,
      "exclude_weekends": false,
      "days_of_week": [
        3,
        5
      ],
      "is_first_day_of_month": false,
      "end_after_occurrences": "7"
    }
  }
};
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/request_maintenances"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "request_maintenance": {
    "template": {
      "id": "4291000000006655"
    },
    "request_template_task_ids": [
      {
        "id": "4291000001479001"
      }
    ],
    "priority": {
      "id": "4291000000006805"
    },
    "impact": {
      "id": "4291000000008033"
    },
    "status": {
      "id": "4291000000006657"
    },
    "impact_details": "Impacts Business in many aspects",
    "configuration_items": [],
    "urgency": {
      "id": "4291000000007919"
    },
    "mode": {
      "id": "4291000000006665"
    },
    "level": {
      "id": "4291000000006671"
    },
    "email_ids_to_notify": [],
    "requester": {
      "id": "4291000000145236"
    },
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "site": {
      "id": "4291000001327001"
    },
    "category": {
      "id": "4291000002997019"
    },
    "subcategory": {
      "id": "4291000002997021"
    },
    "technician": {
      "id": "4291000000145236"
    },
    "subject": "Request Maintenance Subject Here",
    "description": "Description goes here",
    "attachments": [],
    "resolution": {
      "content": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eResolution for created Maintenance\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e"
    },
    "department": {
      "id": "4291000000006625"
    },
    "repetitive_schedule": {
      "start_time": {
        "value": 1742279400000,
        "display_value": "Mar 18, 2025 12:00 pm"
      },
      "frequency": "Weekly",
      "is_advanced": true,
      "skip_frequency": 0,
      "exclude_weekends": false,
      "days_of_week": [
        3,
        5
      ],
      "is_first_day_of_month": false,
      "end_after_occurrences": "7"
    }
  }
}
'@
$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/request_maintenances"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "request_maintenance": {
    "template": {
      "id": "4291000000006655"
    },
    "request_template_task_ids": [
      {
        "id": "4291000001479001"
      }
    ],
    "priority": {
      "id": "4291000000006805"
    },
    "impact": {
      "id": "4291000000008033"
    },
    "status": {
      "id": "4291000000006657"
    },
    "impact_details": "Impacts Business in many aspects",
    "configuration_items": [],
    "urgency": {
      "id": "4291000000007919"
    },
    "mode": {
      "id": "4291000000006665"
    },
    "level": {
      "id": "4291000000006671"
    },
    "email_ids_to_notify": [],
    "requester": {
      "id": "4291000000145236"
    },
    "assets": [
      {
        "id": "4291000003115020"
      }
    ],
    "site": {
      "id": "4291000001327001"
    },
    "category": {
      "id": "4291000002997019"
    },
    "subcategory": {
      "id": "4291000002997021"
    },
    "technician": {
      "id": "4291000000145236"
    },
    "subject": "Request Maintenance Subject Here",
    "description": "Description goes here",
    "attachments": [],
    "resolution": {
      "content": "\u003cdiv class\u003d\"personalize-wrapper\" style\u003d\"font-family: \u0027Zoho Puvi\u0027,Roboto, sans-serif;font-size: 13px;\"\u003e\u003cdiv\u003eResolution for created Maintenance\u003cbr\u003e\u003c/div\u003e\u003c/div\u003e"
    },
    "department": {
      "id": "4291000000006625"
    },
    "repetitive_schedule": {
      "start_time": {
        "value": 1742279400000,
        "display_value": "Mar 18, 2025 12:00 pm"
      },
      "frequency": "Weekly",
      "is_advanced": true,
      "skip_frequency": 0,
      "exclude_weekends": false,
      "days_of_week": [
        3,
        5
      ],
      "is_first_day_of_month": false,
      "end_after_occurrences": "7"
    }
  }
}'''
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"
    },
    "request_maintenance": {
        "template": {
            "id": "4291000000006655",
            "name": "Default Request"
        },
        "attachments": [],
        "request_type": null,
        "subject": "Request Maintenance Subject Here",
        "description": "Description goes here",
        "next_schedule": {
            "display_value": "Mar 18, 2025 12:00 PM",
            "value": "1742279400000"
        },
        "title": "Request Maintenance Subject Here",
        "resolution": {
            "content": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Resolution for created Maintenance<br><\/div><\/div>"
        },
        "repetitive_schedule": {
            "is_advanced": true,
            "next_execution_time": {
                "display_value": "Mar 18, 2025 12:00 PM",
                "value": "1742279400000"
            },
            "ends_on": null,
            "days_of_month": null,
            "parent_entity": "request_maintenance",
            "last_execution_time": null,
            "is_first_day_of_month": false,
            "frequency": "Weekly",
            "days_of_week": [
                3,
                5
            ],
            "weeks_of_month": null,
            "start_time": {
                "display_value": "Mar 18, 2025 12:00 PM",
                "value": "1742279400000"
            },
            "last_updated_by": {
                "email_id": "testuser@domain.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": null,
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "4291000001327001",
                    "is_default": true
                },
                "phone": null,
                "employee_id": null,
                "name": "test",
                "id": "4291000000145236",
                "photo_url": "https://contacts.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": "testuser",
                "job_title": null
            },
            "exclude_weekends": false,
            "months_of_year": null,
            "day_config_of_month": null,
            "last_updated_time": null,
            "skip_frequency": "0",
            "end_after_occurrences": "7",
            "id": "4291000004120008",
            "status": "enabled"
        },
        "mode": {
            "internal_name": "E-Mail",
            "name": "E-Mail",
            "id": "4291000000006665"
        },
        "is_service": false,
        "assets": [
            {
                "site": {
                    "id": "4291000001327001"
                },
                "product": {
                    "id": "4291000003115016"
                },
                "product_type": {
                    "id": "4291000000005925"
                },
                "name": "a1",
                "id": "4291000003115020"
            }
        ],
        "configuration_items": [],
        "urgency": {
            "name": "High",
            "id": "4291000000007919"
        },
        "maintenance_end": "After 7 Occurrences",
        "id": "4291000004120001",
        "request_template_task_ids": [
            {
                "id": "4291000001479001"
            }
        ],
        "events": [
            {
                "end_date": "2025-04-09 12:00",
                "event_length": "1",
                "rec_type": "week_1___2,4#7",
                "module": "request_maintenance",
                "is_created": false,
                "start_longvalue": "1742279400000",
                "maintenance": "4291000004120001",
                "start_date": "2025-03-18 12:00"
            }
        ],
        "group": null,
        "requester": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4291000001327001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "photo_url": "https://contacts.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": "testuser",
            "job_title": null
        },
        "created_time": {
            "display_value": "Mar 18, 2025 11:12 AM",
            "value": "1742276532086"
        },
        "item": null,
        "one_time_schedule": null,
        "level": {
            "name": "Tier 1",
            "id": "4291000000006671"
        },
        "schedule_frequency": "Weekly",
        "impact": {
            "name": "Affects Business",
            "id": "4291000000008033"
        },
        "module": {
            "api_plural_name": "requests",
            "name": "request",
            "display_name_plural": "sdp.module.pluralname.request",
            "id": "4291000000085038",
            "display_name": "Request",
            "category": "SYSTEM",
            "icon_name": null
        },
        "sla": null,
        "technician": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "id": "4291000001327001"
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "is_vip_user": false,
            "photo_url": "https://contacts.zoho.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
            "department": {
                "id": "4291000000006625"
            },
            "first_name": "testuser",
            "job_title": null
        },
        "priority": {
            "color": "#ff0000",
            "name": "High",
            "id": "4291000000006805"
        },
        "created_by": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4291000001327001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "photo_url": "https://contacts.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": "testuser",
            "job_title": null
        },
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
        },
        "udf_fields": {
            "udf_ref9": null
        },
        "repeat_details": "Every 1 week on Tue, Thu  ",
        "maintenancestate": 1,
        "impact_details": "Impacts Business in many aspects",
        "category": {
            "deleted": false,
            "name": "Centenary Court Building Maintenance",
            "id": "4291000002997019"
        },
        "subcategory": {
            "name": "Hard FM",
            "id": "4291000002997021"
        },
        "generated_events": [],
        "status": {
            "in_progress": true,
            "internal_name": "Open",
            "stop_timer": false,
            "color": "#0066ff",
            "name": "Open",
            "id": "4291000000006657"
        }
    }
}

Edit Request Maintenance

This operation helps to edit a Request Maintenance

Url

<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_maintenance_id}

Attributes

id (long)
Id of this maintenance

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

Example 

234759602834500

subject (string)
Subject of this maintenance[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this maintenance

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

Example 

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

impact_details (string)
Description about the impact of this maintenance[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be filled in request created through this maintenance

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

Example 

guest@zylker.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

created_time (datetime)

Indicates the time at which this maintenance is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

impact (impact)

Impact of this maintenance

impact (impact)

Example 

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

status (status)

Indicates the status configured for request in this maintenance

status (status)

Example 

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

requester (user)

Technician assigned to this maintenance

requester (user)

Example 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

The mode configured for request to be created from  this maintenance

mode (mode)

Example 

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

site (site)

Denotes the site to which this maintenance belongs

site (site)

Example 

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

template (request_template)

Indicates the template which is used to create this maintenance

template (request_template)

Example 

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

service_category (service_category)

Service category to which this maintenance belong

service_category (service_category)

Example 

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

group (group)

The group to which the maintenance is assigned to

group (group)

Example 

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

technician (technician)

Technician assigned to this maintenance

technician (technician)

Example 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

Priority of the maintenance

priority (priority)

Example 

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

level (level)

Level of the maintenance

level (level)

Example 

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

category (category)

Category to which the maintenance belongs

category (category)

Example 

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

subcategory (subcategory)

Subcategory to which the maintenance belongs

subcategory (subcategory)

Example 

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

item (item)

Item of the maintenance

item (item)

Example 

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

urgency (urgency)

Urgency of the maintenance

urgency (urgency)

Example 

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

request_type (request_type)

Request Type of the maintenance

request_type (request_type)

Example 

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

assets (asset)

Array of asset objects associated to this maintenance

assets (asset)

Example 

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

configuration_items (configuration_item)

Configuration Items for which the maintenance has been raised

configuration_items (configuration_item)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the maintenance

udf_fields (udf_fields)

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (attachment)

Files that are attached to the maintenance.

attachments (attachment)

Example 

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

resources (resources)

Holds the resource data mapped to the maintenance

resources (resources)

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

editor (user)

The user who is configured as the Editor of the maintenance

editor (user)

Example 

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

department (department)

Department to which this requester belongs

department (department)

Example 

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

space (space_instance)

Array of space objects associated to this maintenance

space (space_instance)

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

one_time_schedule (one_time_schedule)

Indicates the one_time_schedule of the maintenance

one_time_schedule (one_time_schedule)

repetitive_schedule (calendar_repetitive_schedule)

Indicates the repetitive_schedule of the maintenance

repetitive_schedule (calendar_repetitive_schedule)

resolution (JSONObject)

A solution for the maintenance, provided by the technician
show attribute

resolution (JSONObject)

service_approvers (JSONObject)

The configured users will be added to the first stage of approval for the service maintenance. It can be added only by Requesters.
show attribute

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

service_cost (double)read only

Basic cost for the service which we are requesting

service_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

total_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

is_service (boolean)read only

Boolean value indicating whether this maintenance is a service maintenance or not

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

created_by (user)read only

Indicates the user who created this maintenance

created_by (user)

maintenancestate (int)read only

Indicates the  current state of maintenance

maintenancestate (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

next_schedule (datetime)read only

Indicates the next schedule of this maintenance

next_schedule (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

schedule_frequency (string)read only

Indicates the type of schedule for this maintenance

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

Example 

Sample Content

repeat_details (string)read only

Indicates the repetition behavior of maintenance’s schedule  in readable format

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

Example 

Sample Content

maintenance_end (string)read only

Indicates the ends configuration of maintenance’s schedule

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

Example 

Sample Content

events (JSONArray)read only

Indicates the recurrence config of maintenance’s schedule

events (JSONArray)

$ curl <service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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='{
  "request_maintenance": {
    "subject": "Request Maintenance Subject Here - Edited",
    "impact_details": "Impacts Business in many aspects- edited"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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 = {
  "request_maintenance": {
    "subject": "Request Maintenance Subject Here - Edited",
    "impact_details": "Impacts Business in many aspects- edited"
  }
};
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/request_maintenances/{request_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 = @'
{
  "request_maintenance": {
    "subject": "Request Maintenance Subject Here - Edited",
    "impact_details": "Impacts Business in many aspects- edited"
  }
}
'@
$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/request_maintenances/{request_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 = '''{
  "request_maintenance": {
    "subject": "Request Maintenance Subject Here - Edited",
    "impact_details": "Impacts Business in many aspects- edited"
  }
}'''
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"
    },
    "request_maintenance": {
        "template": {
            "id": "4291000000006655",
            "name": "Default Request"
        },
        "attachments": [],
        "request_type": null,
        "subject": "Request Maintenance Subject Here - Edited",
        "description": "Description goes here",
        "next_schedule": {
            "display_value": "Mar 18, 2025 12:00 PM",
            "value": "1742279400000"
        },
        "title": "Request Maintenance Subject Here - Edited",
        "resolution": {
            "content": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Resolution for created Maintenance<br><\/div><\/div>"
        },
        "repetitive_schedule": {
            "is_advanced": true,
            "next_execution_time": {
                "display_value": "Mar 18, 2025 12:00 PM",
                "value": "1742279400000"
            },
            "ends_on": null,
            "days_of_month": null,
            "parent_entity": "request_maintenance",
            "last_execution_time": null,
            "is_first_day_of_month": false,
            "frequency": "Weekly",
            "days_of_week": [
                3,
                5
            ],
            "weeks_of_month": null,
            "start_time": {
                "display_value": "Mar 18, 2025 12:00 PM",
                "value": "1742279400000"
            },
            "last_updated_by": {
                "email_id": "testuser@domain.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": null,
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "4291000001327001",
                    "is_default": true
                },
                "phone": null,
                "employee_id": null,
                "name": "test",
                "id": "4291000000145236",
                "photo_url": "https://contacts.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": "testuser",
                "job_title": null
            },
            "exclude_weekends": false,
            "months_of_year": null,
            "day_config_of_month": null,
            "last_updated_time": null,
            "skip_frequency": "0",
            "end_after_occurrences": "7",
            "id": "4291000004120008",
            "status": "enabled"
        },
        "mode": {
            "internal_name": "E-Mail",
            "name": "E-Mail",
            "id": "4291000000006665"
        },
        "is_service": false,
        "assets": [
            {
                "site": {
                    "id": "4291000001327001"
                },
                "product": {
                    "id": "4291000003115016"
                },
                "product_type": {
                    "id": "4291000000005925"
                },
                "name": "a1",
                "id": "4291000003115020"
            }
        ],
        "configuration_items": [],
        "urgency": {
            "name": "High",
            "id": "4291000000007919"
        },
        "id": "4291000004120001",
        "request_template_task_ids": [
            {
                "id": "4291000001479001"
            }
        ],
        "group": null,
        "requester": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4291000001327001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "photo_url": "https://contacts.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": "testuser",
            "job_title": null
        },
        "created_time": {
            "display_value": "Mar 18, 2025 11:12 AM",
            "value": "1742276532086"
        },
        "item": null,
        "one_time_schedule": null,
        "level": {
            "name": "Tier 1",
            "id": "4291000000006671"
        },
        "impact": {
            "name": "Affects Business",
            "id": "4291000000008033"
        },
        "module": {
            "api_plural_name": "requests",
            "name": "request",
            "display_name_plural": "sdp.module.pluralname.request",
            "id": "4291000000085038",
            "display_name": "Request",
            "category": "SYSTEM",
            "icon_name": null
        },
        "sla": null,
        "technician": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "id": "4291000001327001"
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "is_vip_user": false,
            "photo_url": "https://contacts.zoho.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
            "department": {
                "id": "4291000000006625"
            },
            "first_name": "testuser",
            "job_title": null
        },
        "priority": null,
        "created_by": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4291000001327001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "photo_url": "https://contacts.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": "testuser",
            "job_title": null
        },
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
        },
        "udf_fields": {
            "udf_ref9": null
        },
        "maintenancestate": 1,
        "impact_details": "Impacts Business in many aspects- edited",
        "category": {
            "deleted": false,
            "name": "Centenary Court Building Maintenance",
            "id": "4291000002997019"
        },
        "subcategory": {
            "name": "Hard FM",
            "id": "4291000002997021"
        },
        "status": {
            "in_progress": true,
            "internal_name": "Open",
            "stop_timer": false,
            "color": "#0066ff",
            "name": "Open",
            "id": "4291000000006657"
        }
    }
}

Get Request Maintenance

This operation helps to get a single request maintenance

Url

<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_maintenance_id}

Attributes

id (long)
Id of this maintenance

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

Example 

234759602834500

subject (string)
Subject of this maintenance[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this maintenance

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

Example 

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

impact_details (string)
Description about the impact of this maintenance[Max-length : 250]

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

Example 

Sample Content

email_ids_to_notify (string)
Array of Email ids, which needs to be filled in request created through this maintenance

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

Example 

guest@zylker.com

delete_pre_template_tasks (boolean)
Boolean value indicating whether the pre template tasks need to be deleted

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

More Attributes Expand all

created_time (datetime)

Indicates the time at which this maintenance is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

impact (impact)

Impact of this maintenance

impact (impact)

Example 

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

status (status)

Indicates the status configured for request in this maintenance

status (status)

Example 

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

requester (user)

Technician assigned to this maintenance

requester (user)

Example 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

The mode configured for request to be created from  this maintenance

mode (mode)

Example 

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

site (site)

Denotes the site to which this maintenance belongs

site (site)

Example 

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

template (request_template)

Indicates the template which is used to create this maintenance

template (request_template)

Example 

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

service_category (service_category)

Service category to which this maintenance belong

service_category (service_category)

Example 

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

group (group)

The group to which the maintenance is assigned to

group (group)

Example 

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

technician (technician)

Technician assigned to this maintenance

technician (technician)

Example 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

Priority of the maintenance

priority (priority)

Example 

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

level (level)

Level of the maintenance

level (level)

Example 

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

category (category)

Category to which the maintenance belongs

category (category)

Example 

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

subcategory (subcategory)

Subcategory to which the maintenance belongs

subcategory (subcategory)

Example 

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

item (item)

Item of the maintenance

item (item)

Example 

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

urgency (urgency)

Urgency of the maintenance

urgency (urgency)

Example 

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

request_type (request_type)

Request Type of the maintenance

request_type (request_type)

Example 

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

assets (asset)

Array of asset objects associated to this maintenance

assets (asset)

Example 

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

configuration_items (configuration_item)

Configuration Items for which the maintenance has been raised

configuration_items (configuration_item)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the maintenance

udf_fields (udf_fields)

Example 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (attachment)

Files that are attached to the maintenance.

attachments (attachment)

Example 

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

resources (resources)

Holds the resource data mapped to the maintenance

resources (resources)

Example 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

editor (user)

The user who is configured as the Editor of the maintenance

editor (user)

Example 

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

department (department)

Department to which this requester belongs

department (department)

Example 

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

space (space_instance)

Array of space objects associated to this maintenance

space (space_instance)

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

one_time_schedule (one_time_schedule)

Indicates the one_time_schedule of the maintenance

one_time_schedule (one_time_schedule)

repetitive_schedule (calendar_repetitive_schedule)

Indicates the repetitive_schedule of the maintenance

repetitive_schedule (calendar_repetitive_schedule)

resolution (JSONObject)

A solution for the maintenance, provided by the technician
show attribute

resolution (JSONObject)

service_approvers (JSONObject)

The configured users will be added to the first stage of approval for the service maintenance. It can be added only by Requesters.
show attribute

service_approvers (JSONObject)

org_roles (org_role)

Org roles of the service approvers configured. For ex: CEO, CFO, etc

org_roles (org_role)

service_cost (double)read only

Basic cost for the service which we are requesting

service_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

total_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

is_service (boolean)read only

Boolean value indicating whether this maintenance is a service maintenance or not

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

created_by (user)read only

Indicates the user who created this maintenance

created_by (user)

maintenancestate (int)read only

Indicates the  current state of maintenance

maintenancestate (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

next_schedule (datetime)read only

Indicates the next schedule of this maintenance

next_schedule (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

schedule_frequency (string)read only

Indicates the type of schedule for this maintenance

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

Example 

Sample Content

repeat_details (string)read only

Indicates the repetition behavior of maintenance’s schedule  in readable format

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

Example 

Sample Content

maintenance_end (string)read only

Indicates the ends configuration of maintenance’s schedule

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

Example 

Sample Content

events (JSONArray)read only

Indicates the recurrence config of maintenance’s schedule

events (JSONArray)

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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"
    },
    "request_maintenance": {
        "template": {
            "id": "4291000000006655",
            "name": "Default Request"
        },
        "attachments": [],
        "request_type": null,
        "subject": "Request Maintenance Subject Here",
        "description": "Description goes here",
        "next_schedule": {
            "display_value": "Mar 18, 2025 12:00 PM",
            "value": "1742279400000"
        },
        "title": "Request Maintenance Subject Here",
        "resolution": {
            "content": "<div class=\"personalize-wrapper\" style=\"font-family:&quot;Zoho Puvi&quot;, Roboto, sans-serif; font-size:13px\"><div>Resolution for created Maintenance<br><\/div><\/div>"
        },
        "repetitive_schedule": {
            "is_advanced": true,
            "next_execution_time": {
                "display_value": "Mar 18, 2025 12:00 PM",
                "value": "1742279400000"
            },
            "ends_on": null,
            "days_of_month": null,
            "parent_entity": "request_maintenance",
            "last_execution_time": null,
            "is_first_day_of_month": false,
            "frequency": "Weekly",
            "days_of_week": [
                3,
                5
            ],
            "weeks_of_month": null,
            "start_time": {
                "display_value": "Mar 18, 2025 12:00 PM",
                "value": "1742279400000"
            },
            "last_updated_by": {
                "email_id": "testuser@domain.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": null,
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "4291000001327001",
                    "is_default": true
                },
                "phone": null,
                "employee_id": null,
                "name": "test",
                "id": "4291000000145236",
                "photo_url": "https://contacts.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": "testuser",
                "job_title": null
            },
            "exclude_weekends": false,
            "months_of_year": null,
            "day_config_of_month": null,
            "last_updated_time": null,
            "skip_frequency": "0",
            "end_after_occurrences": "7",
            "id": "4291000004120008",
            "status": "enabled"
        },
        "mode": {
            "internal_name": "E-Mail",
            "name": "E-Mail",
            "id": "4291000000006665"
        },
        "is_service": false,
        "assets": [
            {
                "site": {
                    "id": "4291000001327001"
                },
                "product": {
                    "id": "4291000003115016"
                },
                "product_type": {
                    "id": "4291000000005925"
                },
                "name": "a1",
                "id": "4291000003115020"
            }
        ],
        "configuration_items": [],
        "urgency": {
            "name": "High",
            "id": "4291000000007919"
        },
        "maintenance_end": "After 7 Occurrences",
        "id": "4291000004120001",
        "request_template_task_ids": [
            {
                "id": "4291000001479001"
            }
        ],
        "events": [
            {
                "end_date": "2025-04-09 12:00",
                "event_length": "1",
                "rec_type": "week_1___2,4#7",
                "module": "request_maintenance",
                "is_created": false,
                "start_longvalue": "1742279400000",
                "maintenance": "4291000004120001",
                "start_date": "2025-03-18 12:00"
            }
        ],
        "group": null,
        "requester": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4291000001327001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "photo_url": "https://contacts.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": "testuser",
            "job_title": null
        },
        "created_time": {
            "display_value": "Mar 18, 2025 11:12 AM",
            "value": "1742276532086"
        },
        "item": null,
        "one_time_schedule": null,
        "level": {
            "name": "Tier 1",
            "id": "4291000000006671"
        },
        "schedule_frequency": "Weekly",
        "impact": {
            "name": "Affects Business",
            "id": "4291000000008033"
        },
        "module": {
            "api_plural_name": "requests",
            "name": "request",
            "display_name_plural": "sdp.module.pluralname.request",
            "id": "4291000000085038",
            "display_name": "Request",
            "category": "SYSTEM",
            "icon_name": null
        },
        "sla": null,
        "technician": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "id": "4291000001327001"
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "is_vip_user": false,
            "photo_url": "https://contacts.zoho.com/file?exp=10&ID=63184126&t=user&height=60&width=60",
            "department": {
                "id": "4291000000006625"
            },
            "first_name": "testuser",
            "job_title": null
        },
        "priority": {
            "color": "#ff0000",
            "name": "High",
            "id": "4291000000006805"
        },
        "created_by": {
            "email_id": "testuser@domain.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": null,
            "last_name": null,
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "4291000001327001",
                "is_default": true
            },
            "phone": null,
            "employee_id": null,
            "name": "test",
            "id": "4291000000145236",
            "photo_url": "https://contacts.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": "testuser",
            "job_title": null
        },
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "4291000001327001",
            "is_default": true
        },
        "udf_fields": {
            "udf_ref9": null
        },
        "repeat_details": "Every 1 week on Tue, Thu  ",
        "maintenancestate": 1,
        "impact_details": "Impacts Business in many aspects",
        "category": {
            "deleted": false,
            "name": "Centenary Court Building Maintenance",
            "id": "4291000002997019"
        },
        "subcategory": {
            "name": "Hard FM",
            "id": "4291000002997021"
        },
        "generated_events": [],
        "status": {
            "in_progress": true,
            "internal_name": "Open",
            "stop_timer": false,
            "color": "#0066ff",
            "name": "Open",
            "id": "4291000000006657"
        }
    }
}

Get List Request Maintenance

This operation helps to get the list of all Request Maintenances

Url

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

Attributes

id (long)
Id of this maintenance

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

Example 

234759602834500

subject (string)
Subject of this maintenance[Max-length : 250]

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

Example 

Sample Content

description (html)
Description of this maintenance

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

Example 

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

created_time (datetime)
Indicates the time at which this maintenance is created

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

requester (user)
Technician assigned to this maintenance

requester (user)

Example 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

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

More Attributes Expand all

one_time_schedule (one_time_schedule)

Indicates the one_time_schedule of the maintenance

one_time_schedule (one_time_schedule)

repetitive_schedule (calendar_repetitive_schedule)

Indicates the repetitive_schedule of the maintenance

repetitive_schedule (calendar_repetitive_schedule)

service_cost (double)read only

Basic cost for the service which we are requesting

service_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

total_cost (double)read only

Total Cost is the cumulative value of service cost and the cost of the individual resources selected

total_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

is_service (boolean)read only

Boolean value indicating whether this maintenance is a service maintenance or not

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

created_by (user)read only

Indicates the user who created this maintenance

created_by (user)

maintenancestate (int)read only

Indicates the  current state of maintenance

maintenancestate (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

next_schedule (datetime)read only

Indicates the next schedule of this maintenance

next_schedule (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

schedule_frequency (string)read only

Indicates the type of schedule for this maintenance

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

Example 

Sample Content

repeat_details (string)read only

Indicates the repetition behavior of maintenance’s schedule  in readable format

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

Example 

Sample Content

maintenance_end (string)read only

Indicates the ends configuration of maintenance’s schedule

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

Example 

Sample Content


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/request_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/request_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/request_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/request_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"
    }
  ],
  "request_maintenances": [
    {
      "created_time": {
        "display_value": "Mar 18, 2025 11:12 AM",
        "value": "1742276532086"
      },
      "one_time_schedule": null,
      "subject": "Request Maintenance Subject Here",
      "schedule_frequency": "Weekly",
      "description": "Description goes here",
      "next_schedule": {
        "display_value": "Mar 18, 2025 12:00 PM",
        "value": "1742279400000"
      },
      "repetitive_schedule": {
        "is_advanced": true,
        "ends_on": null,
        "days_of_month": null,
        "last_execution_time": null,
        "is_first_day_of_month": false,
        "frequency": "Weekly",
        "days_of_week": [
          3,
          5
        ],
        "weeks_of_month": null,
        "start_time": {
          "display_value": "Mar 18, 2025 12:00 PM",
          "value": "1742279400000"
        },
        "exclude_weekends": false,
        "months_of_year": null,
        "day_config_of_month": null,
        "skip_frequency": 0,
        "end_after_occurrences": 7,
        "id": "4291000004120008"
      },
      "is_service": false,
      "repeat_details": "Every 1 week on Tue, Thu  ",
      "maintenancestate": 1,
      "maintenance_end": "After 7 Occurrences",
      "id": "4291000004120001",
      "category": {
        "deleted": false,
        "name": "Centenary Court Building Maintenance",
        "id": "4291000002997019"
      }
    },
    {
      "created_time": {
        "display_value": "Feb 21, 2025 04:45 PM",
        "value": "1740136517341"
      },
      "one_time_schedule": null,
      "subject": "Please provide me an account in our CRM system",
      "schedule_frequency": "Daily",
      "description": "Please provide me an account in our CRM system",
      "next_schedule": {
        "display_value": "Mar 18, 2025 05:00 PM",
        "value": "1742297400000"
      },
      "repetitive_schedule": {
        "is_advanced": true,
        "ends_on": null,
        "days_of_month": null,
        "last_execution_time": {
          "display_value": "Mar 17, 2025 05:00 PM",
          "value": "1742211020435"
        },
        "is_first_day_of_month": false,
        "frequency": "Daily",
        "days_of_week": null,
        "weeks_of_month": null,
        "start_time": {
          "display_value": "Feb 21, 2025 05:00 PM",
          "value": "1740137400000"
        },
        "exclude_weekends": false,
        "months_of_year": null,
        "day_config_of_month": null,
        "skip_frequency": 0,
        "end_after_occurrences": null,
        "id": "4291000003927029"
      },
      "is_service": true,
      "repeat_details": "Every 1 day",
      "maintenancestate": 1,
      "maintenance_end": "Never",
      "id": "4291000003927025",
      "category": null
    }
  ],
"list_info": {
    "has_more_rows": false,
    "sort_field": "id",
    "row_count": 4
  }
}

Delete Request Maintenance

This operation allows to delete a Request Maintenance

Url

<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_maintenance_id}


$ curl <service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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 Request Maintenance

Url

<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_maintenance_id}/_enable


$ curl <service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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 Request from Maintenance

Url

<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_maintenance_id}/_execute_now


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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": "1",
        "message": "New request created"
    }
}

View more

Suspend

This operation allows to suspend a  Request Maintenance

Url

<service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_maintenance_id}/_suspend


$ curl <service domain|custom domain>/app/<portal>/api/v3/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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/request_maintenances/{request_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