Skip to content

Problem

End users can raise a problem when they find a disruption in services offered to them.

Attributes

id (long)
The unique identifier assigned at creation of the problem

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

Example

234759602834500

title (string)
Title of the problem

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

Example

Sample Content

description (html)
Description of the problem

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

Example

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

reported_time (datetime)
Indicates the reported time of the problem

reported_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.

due_by_time (datetime)
Indicates the due by time of the problem

due_by_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.

closed_time (datetime)
Indicates the closed time of the problem

closed_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.

More Attributes Expand all

reported_by (user)

Indicates the reported user of the problem

reported_by (user)
Indicates the user who reported the problem

Example

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

category (category)

Indicates the category of the CIs involved with the problem.

category (category)
Indicates the category of the CIs involved with the problem.

Example

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

impact (impact)

Indicates the impact of the problem

impact (impact)
Indicates the impact the problem has on business, group, or user

Example

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

priority (priority)

Indicates the priority of the problem

priority (priority)
Indicates the priority of the the problem.

Example

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

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

Example

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

item (item)

Indicates the item categorization

item (item)
Indicates the item categorization of the problem.

Example

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

urgency (urgency)

Indicates urgency of the problem

urgency (urgency)
Indicates the urgency level of the problem

Example

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

site (site)

Indicates the site of the problem

site (site)
Indicates the site of the problem

Example

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

group (group)

The assigned group of the problem

group (group)
Indicates the assigned group of the problem

Example

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

technician (technician)

Indicates the assigned technician for the problem

technician (technician)
Indicates the technician assigned to the problem

Example

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

status (status)

Indicates the current status of the problem

status (status)
Indicates the current status of the problem

Example

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

assets (asset)

Indicates the assets that might be affected due to this problem..

assets (asset)
Indicates assets that might be affected due to the problem

Example

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

services (service_category)

The services that might be affected due to this problem

services (service_category)
The services that might be affected due to this problem

Example

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

udf_fields (udf_fields)

Contains user defined field values of the problem

udf_fields (udf_fields)

attachments (problem_attachment)

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

attachments (problem_attachment)
Indicates the files that are attached to the problem. A maximum of only 10 attachments can be attached to a problem.

Example

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

template (problem_template)

Indicates the template used to create the problem

template (problem_template)
Indicates the template used to create the problem

Example

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

configuration_items (configuration_item)

The configuration items that might be affected due to this problem

configuration_items (configuration_item)
The configuration items that might be affected due to this problem

Example

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

impact_details (JSONObject)

Describes how the problem will affect the business
show attribute

impact_details (JSONObject)

impact_details_description (html)

Contains detailed information on how the problem will affect the organization

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

Example

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

impact_details_updated_on (datetime)

Indicates when the impact details were last updated 

impact_details_updated_on (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_details_updated_by (user)

Indicates the user who last updated the impact details

impact_details_updated_by (user)

Example

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

root_cause (JSONObject)

Describes the cause of the problem
show attribute

root_cause (JSONObject)

root_cause_description (html)

Contains detailed information on root cause of the problem

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

Example

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

root_cause_updated_on (datetime)

Indicates when the root cause was last updated

root_cause_updated_on (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.

root_cause_updated_by (user)

User who last updated the root cause

root_cause_updated_by (user)

Example

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

symptoms (JSONObject)

Describes symptoms of the problem will affect the business
show attribute

symptoms (JSONObject)

symptoms_description (html)

Contains detailed information on symptoms of the problem

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

Example

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

symptoms_updated_on (datetime)

Indicates when symptoms were last updated

symptoms_updated_on (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.

symptoms_updated_by (user)

User who last updated the symptoms

symptoms_updated_by (user)

known_error_details (JSONObject)

Describes the known error details of the problem
show attribute

known_error_details (JSONObject)
Indicates the known error information

known_error_comments (string)

Contains detailed information about known error

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

Example

Sample Content

is_known_error (boolean)

Indicates whether the problem is a known error

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

known_error_details_updated_on (datetime)

Indicates when the known error was last updated

known_error_details_updated_on (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.

known_error_details_updated_by (user)

indicates the user who last updated the known error

known_error_details_updated_by (user)

Example

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

close_details (JSONObject)

Contains information about problem closure
show attribute

close_details (JSONObject)

close_details_comments (string)

Contains close comments for the problem.

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

Example

Sample Content

closure_code (closure_code)

Closure Code denotes the reason for closing a problem

closure_code (closure_code)

close_details_updated_on (datetime)

Indicates when close details was last updated

close_details_updated_on (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.

close_details_updated_by (user)

User who last updated the close details.

close_details_updated_by (user)

resolution_details (JSONObject)

A resolution provided by the technician for the problem
show attribute

resolution_details (JSONObject)

resolution_details_description (html)

Contains detailed information on resolution of the problem

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

Example

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

resolution_details_updated_on (datetime)

Indicates when resolution was last updated

resolution_details_updated_on (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.

resolution_details_updated_by (user)

User who last updated the resolution

resolution_details_updated_by (user)

workaround_details (JSONObject)

A workaround provided by the technician for the problem
show attribute

workaround_details (JSONObject)

workaround_details_description (html)

Contains detailed information on workaround of the problem

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

Example

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

workaround_details_updated_on (datetime)

Indicates when workaround was last updated

workaround_details_updated_on (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.

workaround_details_updated_by (user)

User who last updated the workaround

workaround_details_updated_by (user)

display_id (sequence_number)read only

Sequence number of the problem

display_id (sequence_number)

notes_present (boolean)read only

Indicates if the problem contains any notes

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

updated_time (datetime)read only

Indicates the last updated time of the problem

updated_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.

lifecycle (problem_lifecycle)read only

Describes the problem lifecycle, along with statuswise process

lifecycle (problem_lifecycle)
Describes the problem lifecycle, along with status wise process

Example

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

Add Problem

This operation helps you add a problem.

Mandatory Fields :- title

Url

api/v3/problems

Attributes

id (long)
The unique identifier assigned at creation of the problem

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

Example

234759602834500

title (string)
Title of the problem

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

Example

Sample Content

description (html)
Description of the problem

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

Example

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

reported_time (datetime)
Indicates the reported time of the problem

reported_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.

due_by_time (datetime)
Indicates the due by time of the problem

due_by_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.

closed_time (datetime)
Indicates the closed time of the problem

closed_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.

More Attributes Expand all

reported_by (user)

Indicates the reported user of the problem

reported_by (user)
Indicates the user who reported the problem

Example

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

category (category)

Indicates the category of the CIs involved with the problem.

category (category)
Indicates the category of the CIs involved with the problem.

Example

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

impact (impact)

Indicates the impact of the problem

impact (impact)
Indicates the impact the problem has on business, group, or user

Example

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

priority (priority)

Indicates the priority of the problem

priority (priority)
Indicates the priority of the the problem.

Example

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

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

Example

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

item (item)

Indicates the item categorization

item (item)
Indicates the item categorization of the problem.

Example

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

urgency (urgency)

Indicates urgency of the problem

urgency (urgency)
Indicates the urgency level of the problem

Example

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

site (site)

Indicates the site of the problem

site (site)
Indicates the site of the problem

Example

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

group (group)

The assigned group of the problem

group (group)
Indicates the assigned group of the problem

Example

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

technician (technician)

Indicates the assigned technician for the problem

technician (technician)
Indicates the technician assigned to the problem

Example

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

status (status)

Indicates the current status of the problem

status (status)
Indicates the current status of the problem

Example

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

assets (asset)

Indicates the assets that might be affected due to this problem..

assets (asset)
Indicates assets that might be affected due to the problem

Example

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

services (service_category)

The services that might be affected due to this problem

services (service_category)
The services that might be affected due to this problem

Example

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

udf_fields (udf_fields)

Contains user defined field values of the problem

udf_fields (udf_fields)

attachments (problem_attachment)

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

attachments (problem_attachment)
Indicates the files that are attached to the problem. A maximum of only 10 attachments can be attached to a problem.

Example

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

template (problem_template)

Indicates the template used to create the problem

template (problem_template)
Indicates the template used to create the problem

Example

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

configuration_items (configuration_item)

The configuration items that might be affected due to this problem

configuration_items (configuration_item)
The configuration items that might be affected due to this problem

Example

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

impact_details (JSONObject)

Describes how the problem will affect the business
show attribute

impact_details (JSONObject)

impact_details_description (html)

Contains detailed information on how the problem will affect the organization

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

Example

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

impact_details_updated_on (datetime)

Indicates when the impact details were last updated 

impact_details_updated_on (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_details_updated_by (user)

Indicates the user who last updated the impact details

impact_details_updated_by (user)

Example

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

root_cause (JSONObject)

Describes the cause of the problem
show attribute

root_cause (JSONObject)

root_cause_description (html)

Contains detailed information on root cause of the problem

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

Example

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

root_cause_updated_on (datetime)

Indicates when the root cause was last updated

root_cause_updated_on (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.

root_cause_updated_by (user)

User who last updated the root cause

root_cause_updated_by (user)

Example

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

symptoms (JSONObject)

Describes symptoms of the problem will affect the business
show attribute

symptoms (JSONObject)

symptoms_description (html)

Contains detailed information on symptoms of the problem

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

Example

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

symptoms_updated_on (datetime)

Indicates when symptoms were last updated

symptoms_updated_on (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.

symptoms_updated_by (user)

User who last updated the symptoms

symptoms_updated_by (user)

known_error_details (JSONObject)

Describes the known error details of the problem
show attribute

known_error_details (JSONObject)
Indicates the known error information

known_error_comments (string)

Contains detailed information about known error

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

Example

Sample Content

is_known_error (boolean)

Indicates whether the problem is a known error

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

known_error_details_updated_on (datetime)

Indicates when the known error was last updated

known_error_details_updated_on (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.

known_error_details_updated_by (user)

indicates the user who last updated the known error

known_error_details_updated_by (user)

Example

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

close_details (JSONObject)

Contains information about problem closure
show attribute

close_details (JSONObject)

close_details_comments (string)

Contains close comments for the problem.

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

Example

Sample Content

closure_code (closure_code)

Closure Code denotes the reason for closing a problem

closure_code (closure_code)

close_details_updated_on (datetime)

Indicates when close details was last updated

close_details_updated_on (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.

close_details_updated_by (user)

User who last updated the close details.

close_details_updated_by (user)

resolution_details (JSONObject)

A resolution provided by the technician for the problem
show attribute

resolution_details (JSONObject)

resolution_details_description (html)

Contains detailed information on resolution of the problem

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

Example

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

resolution_details_updated_on (datetime)

Indicates when resolution was last updated

resolution_details_updated_on (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.

resolution_details_updated_by (user)

User who last updated the resolution

resolution_details_updated_by (user)

workaround_details (JSONObject)

A workaround provided by the technician for the problem
show attribute

workaround_details (JSONObject)

workaround_details_description (html)

Contains detailed information on workaround of the problem

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

Example

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

workaround_details_updated_on (datetime)

Indicates when workaround was last updated

workaround_details_updated_on (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.

workaround_details_updated_by (user)

User who last updated the workaround

workaround_details_updated_by (user)

display_id (sequence_number)read only

Sequence number of the problem

display_id (sequence_number)

notes_present (boolean)read only

Indicates if the problem contains any notes

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

updated_time (datetime)read only

Indicates the last updated time of the problem

updated_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.

lifecycle (problem_lifecycle)read only

Describes the problem lifecycle, along with statuswise process

lifecycle (problem_lifecycle)
Describes the problem lifecycle, along with status wise process

Example

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

$ curl <url>/api/v3/problems\
      -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='{
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006657",
            "name": "Open"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "closed_time": null,
        "services": [
            {
                "id": "4149000001341526",
                "name": "Communication"
            },
            {
                "id": "4149000001341618",
                "name": "Application Login"
            }
        ],
        "assets": [],
        "configuration_items": [
            {
                "id": "4149000000288117",
                "name": "Hardware Problems"
            }
        ],
        "title": "Test Problem",
        "description": "<div>Description</div>",
        "attachments": [],
        "impact_details": {
            "impact_details_description": "Impact Details"
        },
        "root_cause": {
            "root_cause_description": "Root Cause"
        },
        "symptoms": {
            "symptoms_description": "symptoms"
        },
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
}'
// Deluge Sample script
url = "<url>/api/v3/problems";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006657",
            "name": "Open"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "closed_time": null,
        "services": [
            {
                "id": "4149000001341526",
                "name": "Communication"
            },
            {
                "id": "4149000001341618",
                "name": "Application Login"
            }
        ],
        "assets": [],
        "configuration_items": [
            {
                "id": "4149000000288117",
                "name": "Hardware Problems"
            }
        ],
        "title": "Test Problem",
        "description": "<div>Description</div>",
        "attachments": [],
        "impact_details": {
            "impact_details_description": "Impact Details"
        },
        "root_cause": {
            "root_cause_description": "Root Cause"
        },
        "symptoms": {
            "symptoms_description": "symptoms"
        },
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<url>/api/v3/problems"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006657",
            "name": "Open"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "closed_time": null,
        "services": [
            {
                "id": "4149000001341526",
                "name": "Communication"
            },
            {
                "id": "4149000001341618",
                "name": "Application Login"
            }
        ],
        "assets": [],
        "configuration_items": [
            {
                "id": "4149000000288117",
                "name": "Hardware Problems"
            }
        ],
        "title": "Test Problem",
        "description": "<div>Description</div>",
        "attachments": [],
        "impact_details": {
            "impact_details_description": "Impact Details"
        },
        "root_cause": {
            "root_cause_description": "Root Cause"
        },
        "symptoms": {
            "symptoms_description": "symptoms"
        },
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
}
'@
$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 = "<url>/api/v3/problems"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006657",
            "name": "Open"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "closed_time": null,
        "services": [
            {
                "id": "4149000001341526",
                "name": "Communication"
            },
            {
                "id": "4149000001341618",
                "name": "Application Login"
            }
        ],
        "assets": [],
        "configuration_items": [
            {
                "id": "4149000000288117",
                "name": "Hardware Problems"
            }
        ],
        "title": "Test Problem",
        "description": "<div>Description</div>",
        "attachments": [],
        "impact_details": {
            "impact_details_description": "Impact Details"
        },
        "root_cause": {
            "root_cause_description": "Root Cause"
        },
        "symptoms": {
            "symptoms_description": "symptoms"
        },
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
}'''
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())
{
  "problem": {
    "known_error_details": {
      "known_error_details_updated_by": {
        "email_id": "john@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "known_error_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283689"
      },
      "known_error_comments": null,
      "is_known_error": false
    },
    "template": {
      "inactive": false,
      "name": "General Problem Template",
      "id": "4149000000128011"
    },
    "updated_time": null,
    "attachments": [],
    "display_id": {
      "display_value": "PB-140",
      "value": "140"
    },
    "description": "<div>Description</div>",
    "title": "Test Problem",
    "lifecycle": null,
    "assets": [],
    "configuration_items": [
      {
        "ci_type": {
          "id": "4149000000141328"
        },
        "name": "Hardware Problems",
        "id": "4149000000288117"
      }
    ],
    "urgency": {
      "name": "Normal",
      "id": "4149000000007921"
    },
    "close_details": {
      "close_details_updated_on": null,
      "closure_code": null,
      "close_details_comments": null,
      "close_details_updated_by": null
    },
    "rel": {
      "workarounds": null,
      "resolutions": null
    },
    "reported_by": {
      "email_id": "john@zylker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4149000001242001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "John",
      "id": "4149000000871029",
      "photo_url": "https://contacts.localzoho.com/file?sample",
      "is_vip_user": false,
      "department": null,
      "first_name": "John",
      "job_title": null
    },
    "id": "4149000001355051",
    "group": {
      "site": {
        "id": "4149000001242001"
      },
      "deleted": false,
      "name": "DBA Group",
      "id": "4149000001032137"
    },
    "root_cause": {
      "root_cause_updated_by": {
        "email_id": "john@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "root_cause_description": "Root Cause",
      "root_cause_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "item": {
      "name": "Install",
      "id": "4149000000006773"
    },
    "resolution_details": {
      "resolution_details_updated_by": {
        "email_id": "john@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "resolution_details_description": "Resolution",
      "resolution_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "workaround_details": {
      "workaround_details_description": "Workaround",
      "workaround_details_updated_by": {
        "email_id": "john@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "workaround_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "impact": {
      "name": "Affects Group",
      "id": "4149000000008036"
    },
    "technician": {
      "email_id": "chine@haods.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": "4149000001242001"
      },
      "phone": null,
      "employee_id": null,
      "name": "china ech",
      "id": "4149000000766091",
      "photo_url": "https://contacts.localzoho.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "china ech",
      "job_title": null
    },
    "closed_time": null,
    "services": [
      {
        "inactive": false,
        "name": "Communication",
        "id": "4149000001341526",
        "sort_index": 0
      },
      {
        "inactive": false,
        "name": "Application Login",
        "id": "4149000001341618",
        "sort_index": 0
      }
    ],
    "priority": {
      "color": "#ff6600",
      "name": "Medium",
      "id": "4149000000006803"
    },
    "due_by_time": {
      "display_value": "Mar 8, 2023 02:07 PM",
      "value": "1678264620000"
    },
    "symptoms": {
      "symptoms_updated_by": {
        "email_id": "john@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "symptoms_description": "symptoms",
      "symptoms_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283689"
      }
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4149000001242001",
      "is_default": true
    },
    "udf_fields": {
      "udf_char6": null,
      "udf_char1": "YES",
      "udf_char2": null,
      "udf_char5": null,
      "udf_ref2": null,
      "udf_ref1": null,
      "udf_ref8": null,
      "udf_ref7": null,
      "udf_ref6": null,
      "udf_ref5": null,
      "udf_ref4": null,
      "udf_date3": null,
      "udf_date2": null,
      "udf_ref3": null
    },
    "impact_details": {
      "impact_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      },
      "impact_details_updated_by": {
        "email_id": "john@zylker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "impact_details_description": "Impact Details"
    },
    "reported_time": {
      "display_value": "Mar 6, 2023 03:21 PM",
      "value": "1678096283612"
    },
    "problem_template_task_ids": [],
    "category": {
      "deleted": false,
      "name": "Software",
      "id": "4149000000006689"
    },
    "subcategory": {
      "name": "MS Office",
      "id": "4149000000006717"
    },
    "notes_present": false,
    "status": {
      "in_progress": true,
      "internal_name": "Open",
      "stop_timer": false,
      "color": "#0066ff",
      "name": "Open",
      "id": "4149000000006657"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Edit Problem

This operation helps you edit a problem.

Url

api/v3/problems/{problem_id}

Attributes

id (long)
The unique identifier assigned at creation of the problem

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

Example

234759602834500

title (string)
Title of the problem

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

Example

Sample Content

description (html)
Description of the problem

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

Example

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

reported_time (datetime)
Indicates the reported time of the problem

reported_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.

due_by_time (datetime)
Indicates the due by time of the problem

due_by_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.

closed_time (datetime)
Indicates the closed time of the problem

closed_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.

More Attributes Expand all

reported_by (user)

Indicates the reported user of the problem

reported_by (user)
Indicates the user who reported the problem

Example

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

category (category)

Indicates the category of the CIs involved with the problem.

category (category)
Indicates the category of the CIs involved with the problem.

Example

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

impact (impact)

Indicates the impact of the problem

impact (impact)
Indicates the impact the problem has on business, group, or user

Example

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

priority (priority)

Indicates the priority of the problem

priority (priority)
Indicates the priority of the the problem.

Example

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

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

Example

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

item (item)

Indicates the item categorization

item (item)
Indicates the item categorization of the problem.

Example

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

urgency (urgency)

Indicates urgency of the problem

urgency (urgency)
Indicates the urgency level of the problem

Example

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

site (site)

Indicates the site of the problem

site (site)
Indicates the site of the problem

Example

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

group (group)

The assigned group of the problem

group (group)
Indicates the assigned group of the problem

Example

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

technician (technician)

Indicates the assigned technician for the problem

technician (technician)
Indicates the technician assigned to the problem

Example

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

status (status)

Indicates the current status of the problem

status (status)
Indicates the current status of the problem

Example

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

assets (asset)

Indicates the assets that might be affected due to this problem..

assets (asset)
Indicates assets that might be affected due to the problem

Example

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

services (service_category)

The services that might be affected due to this problem

services (service_category)
The services that might be affected due to this problem

Example

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

udf_fields (udf_fields)

Contains user defined field values of the problem

udf_fields (udf_fields)

attachments (problem_attachment)

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

attachments (problem_attachment)
Indicates the files that are attached to the problem. A maximum of only 10 attachments can be attached to a problem.

Example

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

conversations (conversation)

No Description

conversations (conversation)

template (problem_template)

Indicates the template used to create the problem

template (problem_template)
Indicates the template used to create the problem

Example

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

configuration_items (configuration_item)

The configuration items that might be affected due to this problem

configuration_items (configuration_item)
The configuration items that might be affected due to this problem

Example

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

impact_details (JSONObject)

Describes how the problem will affect the business
show attribute

impact_details (JSONObject)

impact_details_description (html)

Contains detailed information on how the problem will affect the organization

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

Example

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

impact_details_updated_on (datetime)

Indicates when the impact details were last updated 

impact_details_updated_on (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_details_updated_by (user)

Indicates the user who last updated the impact details

impact_details_updated_by (user)

Example

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

root_cause (JSONObject)

Describes the cause of the problem
show attribute

root_cause (JSONObject)

root_cause_description (html)

Contains detailed information on root cause of the problem

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

Example

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

root_cause_updated_on (datetime)

Indicates when the root cause was last updated

root_cause_updated_on (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.

root_cause_updated_by (user)

User who last updated the root cause

root_cause_updated_by (user)

Example

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

symptoms (JSONObject)

Describes symptoms of the problem will affect the business
show attribute

symptoms (JSONObject)

symptoms_description (html)

Contains detailed information on symptoms of the problem

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

Example

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

symptoms_updated_on (datetime)

Indicates when symptoms were last updated

symptoms_updated_on (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.

symptoms_updated_by (user)

User who last updated the symptoms

symptoms_updated_by (user)

known_error_details (JSONObject)

Describes the known error details of the problem
show attribute

known_error_details (JSONObject)
Indicates the known error information

known_error_comments (string)

Contains detailed information about known error

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

Example

Sample Content

is_known_error (boolean)

Indicates whether the problem is a known error

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

known_error_details_updated_on (datetime)

Indicates when the known error was last updated

known_error_details_updated_on (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.

known_error_details_updated_by (user)

indicates the user who last updated the known error

known_error_details_updated_by (user)

Example

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

close_details (JSONObject)

Contains information about problem closure
show attribute

close_details (JSONObject)

close_details_comments (string)

Contains close comments for the problem.

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

Example

Sample Content

closure_code (closure_code)

Closure Code denotes the reason for closing a problem

closure_code (closure_code)

close_details_updated_on (datetime)

Indicates when close details was last updated

close_details_updated_on (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.

close_details_updated_by (user)

User who last updated the close details.

close_details_updated_by (user)

resolution_details (JSONObject)

A resolution provided by the technician for the problem
show attribute

resolution_details (JSONObject)

resolution_details_description (html)

Contains detailed information on resolution of the problem

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

Example

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

resolution_details_updated_on (datetime)

Indicates when resolution was last updated

resolution_details_updated_on (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.

resolution_details_updated_by (user)

User who last updated the resolution

resolution_details_updated_by (user)

workaround_details (JSONObject)

A workaround provided by the technician for the problem
show attribute

workaround_details (JSONObject)

workaround_details_description (html)

Contains detailed information on workaround of the problem

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

Example

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

workaround_details_updated_on (datetime)

Indicates when workaround was last updated

workaround_details_updated_on (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.

workaround_details_updated_by (user)

User who last updated the workaround

workaround_details_updated_by (user)

display_id (sequence_number)read only

Sequence number of the problem

display_id (sequence_number)

notes_present (boolean)read only

Indicates if the problem contains any notes

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

updated_time (datetime)read only

Indicates the last updated time of the problem

updated_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.

lifecycle (problem_lifecycle)read only

Describes the problem lifecycle, along with statuswise process

lifecycle (problem_lifecycle)
Describes the problem lifecycle, along with status wise process

Example

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

$ curl <url>/api/v3/problems/{problem_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='{
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006661",
            "name": "Closed"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "close_details": {
            "closure_code": {
                "id": "4149000001015012",
                "name": "Success"
            },
            "close_details_comments": "Problem Resolved"
        },
        "title": "Edit Test Problem",
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
}'
// Deluge Sample script
url = "<url>/api/v3/problems/{problem_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006661",
            "name": "Closed"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "close_details": {
            "closure_code": {
                "id": "4149000001015012",
                "name": "Success"
            },
            "close_details_comments": "Problem Resolved"
        },
        "title": "Edit Test Problem",
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;
#Powershell version - 5.1
$url = "<url>/api/v3/problems/{problem_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006661",
            "name": "Closed"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "close_details": {
            "closure_code": {
                "id": "4149000001015012",
                "name": "Success"
            },
            "close_details_comments": "Problem Resolved"
        },
        "title": "Edit Test Problem",
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
}
'@
$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 = "<url>/api/v3/problems/{problem_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "problem": {
        "template": {
            "id": "4149000000128011",
            "name": "General Problem Template"
        },
        "problem_template_task_ids": [],
        "reported_by": {
            "id": "4149000000871029",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "site": {
            "id": "4149000001242001",
            "name": "Base Site"
        },
        "impact": {
            "id": "4149000000008036",
            "name": "Affects Group"
        },
        "group": {
            "id": "4149000001032137",
            "name": "DBA Group"
        },
        "urgency": {
            "id": "4149000000007921",
            "name": "Normal"
        },
        "technician": {
            "id": "4149000000766091",
            "name": "John",
            "email_id": "john@zlyker.com"
        },
        "priority": {
            "id": "4149000000006803",
            "name": "Medium"
        },
        "udf_fields": {
            "udf_date3": null,
            "udf_char6": null,
            "udf_char1": "YES",
            "udf_date2": null
        },
        "status": {
            "id": "4149000000006661",
            "name": "Closed"
        },
        "category": {
            "id": "4149000000006689",
            "name": "Software"
        },
        "subcategory": {
            "id": "4149000000006717",
            "name": "MS Office"
        },
        "item": {
            "id": "4149000000006773",
            "name": "item"
        },
        "due_by_time": {
            "value": 1678264620000
        },
        "close_details": {
            "closure_code": {
                "id": "4149000001015012",
                "name": "Success"
            },
            "close_details_comments": "Problem Resolved"
        },
        "title": "Edit Test Problem",
        "resolution_details": {
            "resolution_details_description": "Resolution"
        },
        "workaround_details": {
            "workaround_details_description": "Workaround"
        }
    }
}'''
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())
{
  "problem": {
    "known_error_details": {
      "known_error_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "known_error_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283689"
      },
      "known_error_comments": null,
      "is_known_error": false
    },
    "template": {
      "inactive": false,
      "name": "General Problem Template",
      "id": "4149000000128011"
    },
    "updated_time": {
      "display_value": "Mar 6, 2023 03:34 PM",
      "value": "1678097051883"
    },
    "attachments": [],
    "display_id": {
      "display_value": "PB-140",
      "value": "140"
    },
    "description": "<div>Description</div>",
    "title": "Edit Test Problem",
    "lifecycle": null,
    "assets": [],
    "configuration_items": [
      {
        "ci_type": {
          "id": "4149000000141328"
        },
        "name": "Hardware Problems",
        "id": "4149000000288117"
      }
    ],
    "urgency": {
      "name": "Normal",
      "id": "4149000000007921"
    },
    "close_details": {
      "close_details_updated_on": {
        "display_value": "Mar 6, 2023 03:34 PM",
        "value": "1678097051891"
      },
      "closure_code": {
        "name": "Success",
        "id": "4149000001015012"
      },
      "close_details_comments": "Problem Resolved",
      "close_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      }
    },
    "rel": {
      "workarounds": null,
      "resolutions": null
    },
    "reported_by": {
      "email_id": "john@zlyker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4149000001242001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "John",
      "id": "4149000000871029",
      "photo_url": "https://contacts.localzoho.com/file?sample",
      "is_vip_user": false,
      "department": null,
      "first_name": "John",
      "job_title": null
    },
    "id": "4149000001355051",
    "group": {
      "site": {
        "id": "4149000001242001"
      },
      "deleted": false,
      "name": "DBA Group",
      "id": "4149000001032137"
    },
    "root_cause": {
      "root_cause_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "root_cause_description": "Root Cause",
      "root_cause_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "item": {
      "name": "Install",
      "id": "4149000000006773"
    },
    "resolution_details": {
      "resolution_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "resolution_details_description": "Resolution",
      "resolution_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "workaround_details": {
      "workaround_details_description": "Workaround",
      "workaround_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "workaround_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "impact": {
      "name": "Affects Group",
      "id": "4149000000008036"
    },
    "technician": {
      "email_id": "chine@haods.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": "4149000001242001"
      },
      "phone": null,
      "employee_id": null,
      "name": "china ech",
      "id": "4149000000766091",
      "photo_url": "https://contacts.localzoho.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "china ech",
      "job_title": null
    },
    "closed_time": {
      "display_value": "Mar 6, 2023 03:34 PM",
      "value": "1678097051885"
    },
    "services": [
      {
        "inactive": false,
        "name": "Communication",
        "id": "4149000001341526",
        "sort_index": 0
      },
      {
        "inactive": false,
        "name": "Application Login",
        "id": "4149000001341618",
        "sort_index": 0
      }
    ],
    "priority": {
      "color": "#ff6600",
      "name": "Medium",
      "id": "4149000000006803"
    },
    "due_by_time": {
      "display_value": "Mar 8, 2023 02:07 PM",
      "value": "1678264620000"
    },
    "symptoms": {
      "symptoms_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "symptoms_description": "symptoms",
      "symptoms_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283689"
      }
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4149000001242001",
      "is_default": true
    },
    "udf_fields": {
      "udf_char6": null,
      "udf_char1": "YES",
      "udf_char2": null,
      "udf_char5": null,
      "udf_ref2": null,
      "udf_ref1": null,
      "udf_ref8": null,
      "udf_ref7": null,
      "udf_ref6": null,
      "udf_ref5": null,
      "udf_ref4": null,
      "udf_date3": null,
      "udf_date2": null,
      "udf_ref3": null
    },
    "impact_details": {
      "impact_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      },
      "impact_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "impact_details_description": "Impact Details"
    },
    "reported_time": {
      "display_value": "Mar 6, 2023 03:21 PM",
      "value": "1678096283612"
    },
    "problem_template_task_ids": [],
    "category": {
      "deleted": false,
      "name": "Software",
      "id": "4149000000006689"
    },
    "subcategory": {
      "name": "MS Office",
      "id": "4149000000006717"
    },
    "notes_present": false,
    "status": {
      "in_progress": false,
      "internal_name": "Closed",
      "stop_timer": false,
      "color": "#006600",
      "name": "Closed",
      "id": "4149000000006661"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Get Problem

This operation helps you get a problem.

Url

api/v3/problems/{problem_id}

Attributes

id (long)
The unique identifier assigned at creation of the problem

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

Example

234759602834500

title (string)
Title of the problem

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

Example

Sample Content

description (html)
Description of the problem

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

Example

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

reported_time (datetime)
Indicates the reported time of the problem

reported_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.

due_by_time (datetime)
Indicates the due by time of the problem

due_by_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.

closed_time (datetime)
Indicates the closed time of the problem

closed_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.

More Attributes Expand all

reported_by (user)

Indicates the reported user of the problem

reported_by (user)
Indicates the user who reported the problem

Example

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

category (category)

Indicates the category of the CIs involved with the problem.

category (category)
Indicates the category of the CIs involved with the problem.

Example

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

impact (impact)

Indicates the impact of the problem

impact (impact)
Indicates the impact the problem has on business, group, or user

Example

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

priority (priority)

Indicates the priority of the problem

priority (priority)
Indicates the priority of the the problem.

Example

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

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

Example

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

item (item)

Indicates the item categorization

item (item)
Indicates the item categorization of the problem.

Example

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

urgency (urgency)

Indicates urgency of the problem

urgency (urgency)
Indicates the urgency level of the problem

Example

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

site (site)

Indicates the site of the problem

site (site)
Indicates the site of the problem

Example

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

group (group)

The assigned group of the problem

group (group)
Indicates the assigned group of the problem

Example

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

technician (technician)

Indicates the assigned technician for the problem

technician (technician)
Indicates the technician assigned to the problem

Example

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

status (status)

Indicates the current status of the problem

status (status)
Indicates the current status of the problem

Example

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

assets (asset)

Indicates the assets that might be affected due to this problem..

assets (asset)
Indicates assets that might be affected due to the problem

Example

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

services (service_category)

The services that might be affected due to this problem

services (service_category)
The services that might be affected due to this problem

Example

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

udf_fields (udf_fields)

Contains user defined field values of the problem

udf_fields (udf_fields)

attachments (problem_attachment)

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

attachments (problem_attachment)
Indicates the files that are attached to the problem. A maximum of only 10 attachments can be attached to a problem.

Example

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

template (problem_template)

Indicates the template used to create the problem

template (problem_template)
Indicates the template used to create the problem

Example

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

configuration_items (configuration_item)

The configuration items that might be affected due to this problem

configuration_items (configuration_item)
The configuration items that might be affected due to this problem

Example

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

impact_details (JSONObject)

Describes how the problem will affect the business
show attribute

impact_details (JSONObject)

impact_details_description (html)

Contains detailed information on how the problem will affect the organization

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

Example

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

impact_details_updated_on (datetime)

Indicates when the impact details were last updated 

impact_details_updated_on (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_details_updated_by (user)

Indicates the user who last updated the impact details

impact_details_updated_by (user)

Example

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

root_cause (JSONObject)

Describes the cause of the problem
show attribute

root_cause (JSONObject)

root_cause_description (html)

Contains detailed information on root cause of the problem

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

Example

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

root_cause_updated_on (datetime)

Indicates when the root cause was last updated

root_cause_updated_on (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.

root_cause_updated_by (user)

User who last updated the root cause

root_cause_updated_by (user)

Example

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

symptoms (JSONObject)

Describes symptoms of the problem will affect the business
show attribute

symptoms (JSONObject)

symptoms_description (html)

Contains detailed information on symptoms of the problem

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

Example

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

symptoms_updated_on (datetime)

Indicates when symptoms were last updated

symptoms_updated_on (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.

symptoms_updated_by (user)

User who last updated the symptoms

symptoms_updated_by (user)

known_error_details (JSONObject)

Describes the known error details of the problem
show attribute

known_error_details (JSONObject)
Indicates the known error information

known_error_comments (string)

Contains detailed information about known error

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

Example

Sample Content

is_known_error (boolean)

Indicates whether the problem is a known error

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

known_error_details_updated_on (datetime)

Indicates when the known error was last updated

known_error_details_updated_on (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.

known_error_details_updated_by (user)

indicates the user who last updated the known error

known_error_details_updated_by (user)

Example

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

close_details (JSONObject)

Contains information about problem closure
show attribute

close_details (JSONObject)

close_details_comments (string)

Contains close comments for the problem.

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

Example

Sample Content

closure_code (closure_code)

Closure Code denotes the reason for closing a problem

closure_code (closure_code)

close_details_updated_on (datetime)

Indicates when close details was last updated

close_details_updated_on (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.

close_details_updated_by (user)

User who last updated the close details.

close_details_updated_by (user)

resolution_details (JSONObject)

A resolution provided by the technician for the problem
show attribute

resolution_details (JSONObject)

resolution_details_description (html)

Contains detailed information on resolution of the problem

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

Example

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

resolution_details_updated_on (datetime)

Indicates when resolution was last updated

resolution_details_updated_on (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.

resolution_details_updated_by (user)

User who last updated the resolution

resolution_details_updated_by (user)

workaround_details (JSONObject)

A workaround provided by the technician for the problem
show attribute

workaround_details (JSONObject)

workaround_details_description (html)

Contains detailed information on workaround of the problem

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

Example

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

workaround_details_updated_on (datetime)

Indicates when workaround was last updated

workaround_details_updated_on (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.

workaround_details_updated_by (user)

User who last updated the workaround

workaround_details_updated_by (user)

display_id (sequence_number)read only

Sequence number of the problem

display_id (sequence_number)

notes_present (boolean)read only

Indicates if the problem contains any notes

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

updated_time (datetime)read only

Indicates the last updated time of the problem

updated_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.

lifecycle (problem_lifecycle)read only

Describes the problem lifecycle, along with statuswise process

lifecycle (problem_lifecycle)
Describes the problem lifecycle, along with status wise process

Example

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

$ curl -G <url>/api/v3/problems/{problem_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 = "<url>/api/v3/problems/{problem_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 = "<url>/api/v3/problems/{problem_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 = "<url>/api/v3/problems/{problem_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"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "problem": {
    "known_error_details": {
      "known_error_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "known_error_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283689"
      },
      "known_error_comments": null,
      "is_known_error": false
    },
    "template": {
      "inactive": false,
      "name": "General Problem Template",
      "id": "4149000000128011"
    },
    "updated_time": {
      "display_value": "Mar 6, 2023 03:34 PM",
      "value": "1678097051883"
    },
    "attachments": [],
    "display_id": {
      "display_value": "PB-140",
      "value": "140"
    },
    "description": "<div>Description</div>",
    "title": "Edit Test Problem",
    "lifecycle": null,
    "assets": [],
    "configuration_items": [
      {
        "ci_type": {
          "id": "4149000000141328"
        },
        "name": "Hardware Problems",
        "id": "4149000000288117"
      }
    ],
    "urgency": {
      "name": "Normal",
      "id": "4149000000007921"
    },
    "close_details": {
      "close_details_updated_on": {
        "display_value": "Mar 6, 2023 03:34 PM",
        "value": "1678097051891"
      },
      "closure_code": {
        "name": "Success",
        "id": "4149000001015012"
      },
      "close_details_comments": "Problem Resolved",
      "close_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      }
    },
    "rel": {
      "workarounds": null,
      "resolutions": null
    },
    "reported_by": {
      "email_id": "john@zlyker.com",
      "is_technician": true,
      "sms_mail": null,
      "mobile": null,
      "last_name": null,
      "user_scope": "internal_user",
      "sms_mail_id": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "4149000001242001",
        "is_default": true
      },
      "phone": null,
      "employee_id": null,
      "name": "John",
      "id": "4149000000871029",
      "photo_url": "https://contacts.localzoho.com/file?sample",
      "is_vip_user": false,
      "department": null,
      "first_name": "John",
      "job_title": null
    },
    "id": "4149000001355051",
    "group": {
      "site": {
        "id": "4149000001242001"
      },
      "deleted": false,
      "name": "DBA Group",
      "id": "4149000001032137"
    },
    "root_cause": {
      "root_cause_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "root_cause_description": "Root Cause",
      "root_cause_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "item": {
      "name": "Install",
      "id": "4149000000006773"
    },
    "resolution_details": {
      "resolution_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "resolution_details_description": "Resolution",
      "resolution_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "workaround_details": {
      "workaround_details_description": "Workaround",
      "workaround_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "workaround_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      }
    },
    "impact": {
      "name": "Affects Group",
      "id": "4149000000008036"
    },
    "technician": {
      "email_id": "chine@haods.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": "4149000001242001"
      },
      "phone": null,
      "employee_id": null,
      "name": "china ech",
      "id": "4149000000766091",
      "photo_url": "https://contacts.localzoho.com/file?exp=10&ID=-1&t=user&height=60&width=60",
      "is_vip_user": false,
      "department": null,
      "first_name": "china ech",
      "job_title": null
    },
    "closed_time": {
      "display_value": "Mar 6, 2023 03:34 PM",
      "value": "1678097051885"
    },
    "services": [
      {
        "inactive": false,
        "name": "Communication",
        "id": "4149000001341526",
        "sort_index": 0
      },
      {
        "inactive": false,
        "name": "Application Login",
        "id": "4149000001341618",
        "sort_index": 0
      }
    ],
    "priority": {
      "color": "#ff6600",
      "name": "Medium",
      "id": "4149000000006803"
    },
    "due_by_time": {
      "display_value": "Mar 8, 2023 02:07 PM",
      "value": "1678264620000"
    },
    "symptoms": {
      "symptoms_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "symptoms_description": "symptoms",
      "symptoms_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283689"
      }
    },
    "site": {
      "deleted": false,
      "name": "Base Site",
      "id": "4149000001242001",
      "is_default": true
    },
    "udf_fields": {
      "udf_char6": null,
      "udf_char1": "YES",
      "udf_char2": null,
      "udf_char5": null,
      "udf_ref2": null,
      "udf_ref1": null,
      "udf_ref8": null,
      "udf_ref7": null,
      "udf_ref6": null,
      "udf_ref5": null,
      "udf_ref4": null,
      "udf_date3": null,
      "udf_date2": null,
      "udf_ref3": null
    },
    "impact_details": {
      "impact_details_updated_on": {
        "display_value": "Mar 6, 2023 03:21 PM",
        "value": "1678096283690"
      },
      "impact_details_updated_by": {
        "email_id": "john@zlyker.com",
        "is_technician": true,
        "sms_mail": null,
        "mobile": null,
        "last_name": null,
        "user_scope": "internal_user",
        "sms_mail_id": null,
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "4149000001242001",
          "is_default": true
        },
        "phone": null,
        "employee_id": null,
        "name": "John",
        "id": "4149000000871029",
        "photo_url": "https://contacts.localzoho.com/file?sample",
        "is_vip_user": false,
        "department": null,
        "first_name": "John",
        "job_title": null
      },
      "impact_details_description": "Impact Details"
    },
    "reported_time": {
      "display_value": "Mar 6, 2023 03:21 PM",
      "value": "1678096283612"
    },
    "problem_template_task_ids": [],
    "category": {
      "deleted": false,
      "name": "Software",
      "id": "4149000000006689"
    },
    "subcategory": {
      "name": "MS Office",
      "id": "4149000000006717"
    },
    "notes_present": false,
    "status": {
      "in_progress": false,
      "internal_name": "Closed",
      "stop_timer": false,
      "color": "#006600",
      "name": "Closed",
      "id": "4149000000006661"
    }
  }
}

Get List Problem

This operation helps you get all problems.

Url

api/v3/problems

Attributes

id (long)
The unique identifier assigned at creation of the problem

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

Example

234759602834500

title (string)
Title of the problem

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

Example

Sample Content

description (html)
Description of the problem

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

Example

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

reported_time (datetime)
Indicates the reported time of the problem

reported_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.

due_by_time (datetime)
Indicates the due by time of the problem

due_by_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.

closed_time (datetime)
Indicates the closed time of the problem

closed_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.

More Attributes Expand all

reported_by (user)

Indicates the reported user of the problem

reported_by (user)
Indicates the user who reported the problem

Example

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

category (category)

Indicates the category of the CIs involved with the problem.

category (category)
Indicates the category of the CIs involved with the problem.

Example

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

impact (impact)

Indicates the impact of the problem

impact (impact)
Indicates the impact the problem has on business, group, or user

Example

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

priority (priority)

Indicates the priority of the problem

priority (priority)
Indicates the priority of the the problem.

Example

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

subcategory (subcategory)

Assign the Sub Category of the involved CIs selected under Category

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

Example

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

item (item)

Indicates the item categorization

item (item)
Indicates the item categorization of the problem.

Example

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

urgency (urgency)

Indicates urgency of the problem

urgency (urgency)
Indicates the urgency level of the problem

Example

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

worklogs (worklog)

No Description

worklogs (worklog)

site (site)

Indicates the site of the problem

site (site)
Indicates the site of the problem

Example

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

group (group)

The assigned group of the problem

group (group)
Indicates the assigned group of the problem

Example

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

technician (technician)

Indicates the assigned technician for the problem

technician (technician)
Indicates the technician assigned to the problem

Example

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

status (status)

Indicates the current status of the problem

status (status)
Indicates the current status of the problem

Example

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

assets (asset)

Indicates the assets that might be affected due to this problem..

assets (asset)
Indicates assets that might be affected due to the problem

Example

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

services (service_category)

The services that might be affected due to this problem

services (service_category)
The services that might be affected due to this problem

Example

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

udf_fields (udf_fields)

Contains user defined field values of the problem

udf_fields (udf_fields)

attachments (problem_attachment)

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

attachments (problem_attachment)
Indicates the files that are attached to the problem. A maximum of only 10 attachments can be attached to a problem.

Example

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

conversations (conversation)

No Description

conversations (conversation)

template (problem_template)

Indicates the template used to create the problem

template (problem_template)
Indicates the template used to create the problem

Example

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

configuration_items (configuration_item)

The configuration items that might be affected due to this problem

configuration_items (configuration_item)
The configuration items that might be affected due to this problem

Example

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

display_id (sequence_number)read only

Sequence number of the problem

display_id (sequence_number)

notes_present (boolean)read only

Indicates if the problem contains any notes

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

updated_time (datetime)read only

Indicates the last updated time of the problem

updated_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.

$ curl -G <url>/api/v3/problems\
      -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 = "<url>/api/v3/problems";
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 = "<url>/api/v3/problems"
$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 = "<url>/api/v3/problems"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())
{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "problems": [
    {
      "template": {
        "name": "test-name",
        "id": "1682944423003748"
      },
      "updated_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "display_id": {
        "display_value": "PB-3",
        "value": "3"
      },
      "description": "test-description",
      "title": "test-title",
      "urgency": {
        "name": "Urgent",
        "id": "2356072979101894"
      },
      "reported_by": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "mobile": "test-mobile",
        "id": "2210656321195338",
        "photo_url": "test-photo_url",
        "is_vip_user": false,
        "job_title": "test-job_title"
      },
      "id": "1760624530278842",
      "group": {
        "site": {
          "id": "100000001111005757"
        },
        "deleted": false,
        "name": "Hardware Problems",
        "id": "2387199213602060"
      },
      "item": {
        "name": "Install",
        "id": "2389245760765183"
      },
      "impact": {
        "name": "Affects Business",
        "id": "1755679161346636"
      },
      "technician": {
        "email_id": "test@test.com",
        "cost_per_hour": 1343434.4333,
        "phone": "test-phone",
        "name": "Einstein",
        "mobile": "test-mobile",
        "id": "2281141910381802",
        "photo_url": "test-photo_url",
        "sms_mail_id": "test-sms_mail_id"
      },
      "closed_time": null,
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "2190663872127443"
      },
      "due_by_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "site": {
        "deleted": false,
        "name": "Custom Site",
        "id": "2038147713121720"
      },
      "udf_fields": {
        "udf_long1": "2430314675163833",
        "udf_char1": "test-udf_char1"
      },
      "category": {
        "deleted": false,
        "name": "Software",
        "id": "2121363349144358"
      },
      "subcategory": {
        "name": "Adobe Reader",
        "id": "2343366083030176"
      },
      "notes_present": false,
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "stop_timer": false,
        "color": "#ffffff",
        "name": "Open",
        "id": "1984587510883300"
      }
    }
  ]
}

Delete Problem

This operation helps you delete a problem.

Url

api/v3/problems/{problem_id}

$ curl <url>/api/v3/problems/{problem_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 = "<url>/api/v3/problems/{problem_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 = "<url>/api/v3/problems/{problem_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 = "<url>/api/v3/problems/{problem_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"
  }
}