ServiceDesk Plus Component
ServiceDesk Plus is a comprehensive service desk software that offers a suite of IT Service management, IT asset management, CBDM, and more.
Component key: servicedesk-plus
Description
ServiceDesk Plus is a comprehensive service desk software that offers a suite of IT Service management, IT asset management, CMDB, and more.
Use the ServiceDesk Plus to efficiently manage Assets and Configuration Items for integrations.
API Documentation
This component was built using the ServiceDesk Plus V3 API Reference.
Connections
ServiceDesk Plus OAuth 2.0
Self Client Applications are stand-alone applications that perform only back-end jobs (without any manual intervention) like data sync.
To register a new app as a Self Client Application for Configuration OAuth credential:
- Navigate to Zoho API Console and select GET STARTED.
- Find the Self Client Applications box and select CREATE NOW.
- In the Generate Code tab enter the Scopes, Time Duration needed for the code, and a brief description and select CREATE
- Example scopes: SDPOnDemand.cmdb.READ,SDPOnDemand.assets.READ
- When the Generated Code is provided, copy and/or download the code and enter in the connection configuration of the integration.
- In the Client Secret tab, copy and enter the Client ID, and Client Secret into the connection configuration of the integration.
Additionally, Server Based Applications may be used for setting up applications running on a dedicated HTTP server.
To register a new app as a Server-based Application for configuring OAuth credentials:
- Navigate to Zoho API Console and select GET STARTED.
- Find the Server-based Applications box and select CREATE NOW.
- Provide a Client Name, Homepage URL, and enter the Authorized Redirect URI as - https://oauth2.prismatic.io/callback
- Select CREATE and the Client ID and Client Secret credentials will be provided and can be entered into the connection configuration of the integration.
Please refer to the following Client OAuth Setup Guide for further information on OAuth setup.
| Input | Default | Notes |
|---|---|---|
Authorize URL string / Required authorizeUrl | https://accounts.zoho.com/oauth/v2/auth?access_type=offline | The OAuth 2.0 Authorization URL for ServiceDesk Plus |
Client ID string / Required clientId | ||
Client Secret password / Required clientSecret | ||
Data Center string / Required dataCenter | ||
Scopes string / Required scopes | SDPOnDemand.assets.ALL SDPOnDemand.cmdb.ALL SDPOnDemand.setup.ALL | A comma-delimited set of one or more scopes to get the user's permission to access. Refer to https://www.manageengine.com/products/service-desk/sdpod-v3-api/getting-started/oauth-2.0.html#scopes |
Token URL string / Required Hidden Field tokenUrl | https://accounts.zoho.com/oauth/v2/token | The OAuth 2.0 Token URL for ServiceDesk Plus |
Data Sources
Select Asset
Select an asset from the list of assets. | key: selectAsset | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Example Payload for Select Asset
Example Payload for Select Asset
{
"result": [
{
"label": "192.0.2.1",
"key": "1817089573167815"
},
{
"label": "192.0.2.23",
"key": "1817089573167315"
}
]
}
Select Problem
Select a problem from the list of problems. | key: selectProblem | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Example Payload for Select Problem
Example Payload for Select Problem
{
"result": [
{
"label": "Test Problem",
"key": "4149000001355051"
},
{
"label": "Test Problem 2",
"key": "4149000001355052"
}
]
}
Select Request
Select a request from the list of requests. | key: selectRequest | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Example Payload for Select Request
Example Payload for Select Request
{
"result": [
{
"label": "Test Request 1",
"key": "4149000001355051"
},
{
"label": "Test Request 2",
"key": "4149000001355052"
}
]
}
Actions
Create Asset
Create a new asset | key: createAsset
| Input | Default | Notes | Example |
|---|---|---|---|
Asset ID string assetId | Unique identifier to identify the asset | 1510894167438614 | |
Asset Name string / Required assetName | Unique name to identify the asset | 192.0.2.1 | |
Asset Tag string assetTag | Asset tag used to identify the asset | Sample Content | |
Bar Code string barCode | Unique barcode used to identify the asset | test-barcode | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Extra parameters string Key Value List keyValuePairParams | Additional parameters to add to the request | key1=value1,key2=value2 | |
Product code / Required product | Product of the asset. Remove the default value if not needed. | ||
State code / Required state | Indicates the state of the asset. Remove the default value if not needed. | ||
State History Comments string stateHistoryComments | A text in a plain format. No rich text or new line characters allowed. | Sample Content |
Example Payload for Create Asset
Example Payload for Create Asset
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
},
"asset": {
"purchase_lot_id": null,
"acknowledgement": null,
"total_cost": "0.0",
"device_type": null,
"type": {
"name": "Asset",
"id": "207953000000005903"
},
"lifecycle": null,
"last_updated_by": null,
"credential": null,
"suggested_owner": null,
"id": "207953000000314001",
"state": {
"internal_name": "In Store",
"name": "In Store",
"description": null,
"id": "207953000000006135"
},
"barcode": null,
"product_depreciation": null,
"operational_cost": "0.0",
"asset_tag": null,
"created_time": {
"display_value": "Apr 17, 2024 04:01 PM",
"value": "1713387707981"
},
"is_swscan_needed": false,
"created_by": {
"email_id": "components@prismatic.io",
"is_technician": true,
"sms_mail": null,
"mobile": "",
"last_name": "",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "207953000000222001",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "TJ Tedrow",
"id": "207953000000274942",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=850344966&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "TJ Tedrow",
"job_title": null
},
"last_updated_time": null,
"purchase_order": null,
"network_adapters": [],
"name": "UniqueName",
"is_depreciation_configured": false,
"region": null,
"is_depreciation_calculated": false,
"loan": null,
"attachments": [],
"retain_user_site": true,
"is_asset_association_possible": true,
"acquisition_date": null,
"current_cost": "0.0",
"vendor": null,
"mac_address": null,
"purchase_cost": "0.0",
"department": null,
"depreciation": null,
"product": {
"part_no": "-",
"gl_code": null,
"product_type": {
"image": "Access_Points",
"name": "Access Point",
"id": "207953000000005925",
"display_name": "Access Points",
"mandatory": true
},
"software": null,
"name": "Product Name",
"id": "207953000000313007",
"type": {
"name": "Asset",
"id": "207953000000005903"
},
"category": {
"name": "IT",
"description": "IT Assets and Components",
"id": "207953000000005899"
},
"manufacturer": "-"
},
"asset_depreciation": null,
"integration_mappings": [],
"expiry_date": null,
"used_by_asset": null,
"serial_number": null,
"warranty_expiry": null,
"ip_address": null,
"probe": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "207953000000222001",
"is_default": true
},
"product_type": {
"image": "Access_Points",
"name": "Access Point",
"id": "207953000000005925",
"display_name": "Access Points",
"mandatory": true
},
"discovered_serial_number": null,
"location": null,
"is_loaned": false,
"is_loanable": false,
"category": {
"name": "IT",
"description": "IT Assets and Components",
"id": "207953000000005899"
},
"user": null,
"last_success_audit": null,
"last_audit": null
}
}
}
Create Configuration Item
Create a new configuration item on the CMDB | key: createConfigurationItem
| Input | Default | Notes | Example |
|---|---|---|---|
Attributes code attributes | Other attributes to add to the payload | ||
CI Type API Name string / Required ciTypeApiName | Denotes the unique identifier used to identify the CI. | ci_application | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | Description of the CI | API Test | |
Name string / Required name | Indicates the unique name used to identify the CI | test-name |
Example Payload for Create Configuration Item
Example Payload for Create Configuration Item
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
},
"ci_computer": {
"linked_instance": "100000000000005416",
"created_time": {
"display_value": "Jul 30, 2021 07:44 PM",
"value": "1627654487657"
},
"attachments": [],
"ci_attributes": {
"ref_model": null,
"txt_service_tag": null,
"ref_owned_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_processor_name": null,
"txt_location": null,
"ref_managed_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_manufacturer": "Dell",
"txt_os": "Windows",
"txt_serial_number": null,
"txt_ip_address": null,
"txt_mac_address": null,
"num_processor_count": null,
"txt_service_pack": null,
"ref_business_impact": {
"name": "Affects Department",
"id": "100000000000007152"
}
},
"description": "Dell Server used for VMs",
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"data_source": [],
"last_updated_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"ci_type": {
"api_plural_name": "ci_computer",
"name": "ci_computer",
"display_name_plural": "Computer",
"id": "100000000000030014",
"display_name": "Computer",
"icon_name": "exchange_server"
},
"linked_entity": {
"api_plural_name": "departments",
"name": "department",
"display_name_plural": "sdp.module.pluralname.departments",
"id": "100000000000004786",
"display_name": "Department",
"icon_name": null
},
"last_updated_time": {
"display_value": "Jul 30, 2021 07:47 PM",
"value": "1627654669667"
},
"linked_instance_data": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"name": "Dell Server",
"id": "100000000000034020"
}
}
}
Create Problem
Create a new problem | key: createProblem
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Problem Closed Time code problemClosedTime | Indicates the closed time of the problem. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Problem Description string problemDescription | Description of the problem. | <b>The content to be displayed</b> | |
Problem Due By Time code problemDueByTime | Indicates the due by time of the problem. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Problem Reported Time code problemReportedTime | Indicates the reported time of the problem. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Problem Title string / Required problemTitle | Title of the problem. | Sample Content |
Example Payload for Create Problem
Example Payload for Create Problem
{
"data": {
"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"
}
}
}
Create Problem Note
Create a new problem note | key: createProblemNote
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_note.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Note Description string / Required noteDescription | Contains description about the note. | <b>The content to be displayed</b> | |
Problem ID string / Required noteProblemId | ID of the problem. | 234759602834500 | |
Notify To code notifyTo | Contains info on users or roles to be notified on add/edit operation of the note. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_note.html for details. |
Example Payload for Create Problem Note
Example Payload for Create Problem Note
{
"data": {
"note": {
"performed_by": {
"email_id": "john.je@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "J",
"user_scope": "internal_user",
"sms_mail_id": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "100000000000006098",
"is_default": true
},
"phone": null,
"employee_id": null,
"name": "John",
"id": "100000000000036077",
"photo_url": "https://contacts.localzoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "John",
"job_title": null
},
"description": "<div>Test Add Note</div>",
"id": "100000000000038247",
"performed_time": {
"display_value": "Feb 2, 2023 12:53 PM",
"value": "1675322599582"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Create Problem Task
Create a problem task | key: createProblemTask
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Estimated Effort Days string estimatedEffortDays | Estimated number of days to finish the task. | 234759602834500 | |
Estimated Effort Hours string estimatedEffortHours | Estimated number of hours to finish the task. | 234759602834500 | |
Estimated Effort Minutes string estimatedEffortMinutes | Estimated number of minutes to finish the task. | 234759602834500 | |
Group code group | Indicates the assigned group of the task. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
Percentage Completion string percentageCompletion | Indicates the progress of the task in percentage of completion. | 100 | |
Task Description string taskDescription | Contains description about the task. | <b>The content to be displayed</b> | |
Owner code taskOwner | The User assigned to the task. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
Problem ID string / Required taskProblemId | ID of the problem. | 234759602834500 | |
Task Title string / Required taskTitle | Title of the task. | Sample Content | |
Task Type code taskType | Used to categorize the tasks of similar cases. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. |
Example Payload for Create Problem Task
Example Payload for Create Problem Task
{
"data": {
"task": {
"percentage_completion": 45,
"estimated_effort_hours": null,
"attachments": [],
"email_before": "1800000",
"description": "<div>Add Task</div>",
"title": "Add Problem Task",
"marked_technician": null,
"problem": {
"id": "4149000001305071"
},
"overdue": false,
"additional_cost": "150",
"actual_end_time": {
"display_value": "Feb 7, 2023 02:44 PM",
"value": "1675761240000"
},
"id": "4149000001305075",
"actual_start_time": {
"display_value": "Feb 3, 2023 02:44 PM",
"value": "1675415640000"
},
"group": null,
"owner": {
"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
},
"associated_entity": "problem",
"module": "Problem",
"index": 1,
"priority": {
"color": "#ff6600",
"name": "Medium",
"id": "4149000000006803"
},
"created_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
},
"scheduled_end_time": {
"display_value": "Feb 9, 2023 02:44 PM",
"value": "1675934040000"
},
"marked_group": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "4149000001242001",
"is_default": true
},
"estimated_effort_minutes": null,
"deleted": false,
"estimated_effort": "1036800000",
"created_date": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329299172"
},
"estimated_effort_days": "12",
"task_type": null,
"scheduled_start_time": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329240000"
},
"status": {
"in_progress": true,
"internal_name": "Open",
"stop_timer": false,
"color": "#0066ff",
"name": "Open",
"id": "4149000000006657"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Create Product
Create a new product | key: createProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Attributes code attributes | Other attributes to add to the payload | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string id | Unique identifier to identify the resource | 1510894167438614 | |
Is Laptop string isLaptop | Boolean value indicating whether the product type is laptop or not. | ||
Manufacturer string manufacturer | Name to identify the product manufacturer. | test-manufacturer | |
Name string / Required name | Unique identifier to identify the resource | test-name | |
Part No string partNo | Part no of the productPart no of the product | test-part_no | |
Product Type code / Required productType | Product type of the product. Remove the default value if not needed. |
Example Payload for Create Product
Example Payload for Create Product
{
"data": {
"product": {
"is_laptop": false,
"part_no": "test-part_no",
"comments": "test-comments",
"product_type": {
"image": "test-image",
"name": "Workstation",
"id": "2247881320113485"
},
"software": {
"is_parent_suite": false,
"name": "test-name",
"id": "1970019934993439"
},
"name": "test-name",
"id": "2389334491499884",
"type": {
"name": "Asset",
"id": "2429804592656991"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1875814009075528"
},
"depreciation_detail": {
"useful_life": "2337459615672549",
"id": "2421818154117324",
"depreciation_percent": 1343434.4333,
"salvage_value": 1343434.4333
},
"manufacturer": "test-manufacturer"
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Create Product Type
Create a new product type | key: createProductType
| Input | Default | Notes | Example |
|---|---|---|---|
Asset Type code / Required assetType | Type of the product type. Remove the default value if not needed. | ||
Attributes code attributes | Other attributes to add to the payload | ||
Category code / Required category | Category of the product type. Remove the default value if not needed. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string id | Unique identifier to identify the resource | 1510894167438614 | |
Name string / Required name | Unique identifier to identify the resource | test-name |
Example Payload for Create Product Type
Example Payload for Create Product Type
{
"data": {
"product_type": {
"image": "test-image",
"name": "Workstation",
"description": "test-description",
"id": "1654204619243101",
"display_name": "test-display_name",
"type": {
"name": "Asset",
"id": "1898443623900317"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1699836392964313"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Create Request
Create a new request | key: createRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Delete Pre Template Tasks boolean deletePreTemplateTasks | false | Boolean value indicating whether the pre template tasks need to be deleted. | |
Email IDs To Notify string Value List emailIdsToNotify | Email ids, which needs to be notified about the happenings of this request. | abc.gmail.com | |
Impact Details string impactDetails | Description about the impact of this request. | Sample Content | |
Request Description string requestDescription | Description of this request. | <b>The content to be displayed</b> | |
Request Subject string / Required requestSubject | Subject of this request. | Sample Content |
Example Payload for Create Request
Example Payload for Create Request
{
"data": {
"request": {
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "1948726349434187"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "2044673193715195"
},
"assets": [
{
"name": "192.0.2.1",
"id": "2476215879232669",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "2045488344070845",
"name": "test-name",
"id": "1611839137508603"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "2290537481381500",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1646275022585519"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2374730939861945",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "2372339936802225"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1859958322770061"
},
"level": {
"name": "Tier 1",
"id": "2018182121337715"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1532347302595840",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"approval_status": {
"name": "Approved",
"id": "2383059912529037"
},
"impact": {
"name": "Affects Business",
"id": "1765848093928449"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "2329032013178322",
"sort_index": 7
},
"sla": {
"name": "High",
"duebyminutes": 21,
"id": "2267633716896305",
"duebyhours": false,
"duebydays": 41
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "1967268183361012"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2070790206912927",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2470322684475602"
},
"udf_boolean1": false,
"udf_long1": "2136851967326526",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1975292840863883"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "2204017819975726"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "2434907668683558"
},
"template": {
"is_service_template": false,
"name": "Raise a New Monitor Request",
"id": "2174353095375675"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Incident",
"id": "2147014131875404"
},
"display_id": "39",
"time_elapsed": "2371520029466911",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2104949385602485"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "2174353095375675",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "2190218995208715"
},
"is_reopened": false,
"editor_status": 27,
"editor": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2458320955274024",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "charles@zmail.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "2276596244154377",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "2222857346042280"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "4",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "test-path",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "1939084650493601",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "2411765802963298"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Create Request Task
Create a new request task | key: createRequestTask
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Request Task Actual End Time code taskRequestActualEndTime | Date and time at which the task actually got finished. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Request Task Actual Start Time code taskRequestActualStartTime | Date and time at which the task actually got started. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Request Task Additional Cost string taskRequestAdditionalCost | Cost spent other than the actual cost of the task. | 23.08 | |
Request Task Description string taskRequestDescription | Contains description about the task. | <b>The content to be displayed</b> | |
Request Task Estimated Effort Hours string taskRequestEstimatedEffortHours | Estimated number of hours to finish the task. | 12 | |
Request ID string / Required taskRequestId | ID of the request. | 4149000001300019 | |
Request Task Owner code taskRequestOwner | The User assigned to the task. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Request Task Percentage Completion string taskRequestPercentageCompletion | Indicates the progress of the task in percentage of completion. | 100 | |
Request Task Title string / Required taskRequestTitle | Title of the task. | Sample Content |
Example Payload for Create Request Task
Example Payload for Create Request Task
{
"data": {
"task": {
"percentage_completion": "30",
"request": {
"id": "1756402018589639"
},
"estimated_effort_hours": "20",
"attachments": [],
"email_before": "3600000",
"description": "The SRS must contain all the requirements for the feature",
"title": "Create SRS",
"marked_technician": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2443319112022586",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"overdue": false,
"additional_cost": "100",
"actual_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"id": "1504379411346066",
"actual_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"owner": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1871812265827162",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"associated_entity": "request",
"module": "Request",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "2474460469828007"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1577080616582153",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"scheduled_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"estimated_effort_minutes": "45",
"deleted": false,
"estimated_effort": "22845",
"created_date": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"estimated_effort_days": "15",
"task_type": {
"color": "#ffffff",
"name": "Implementation",
"id": "1898428065971893"
},
"scheduled_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "1822002620862973"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Asset
Delete an existing asset | key: deleteAsset
| Input | Default | Notes | Example |
|---|---|---|---|
Asset ID string / Required assetId | Unique identifier to identify the asset | 1510894167438614 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Delete Asset
Example Payload for Delete Asset
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Configuration Item
Delete an existing configuration item on the CMDB | key: deleteConfigurationItem
| Input | Default | Notes | Example |
|---|---|---|---|
CI IDs string / Required Value List ciIds | Unique identifier used to identify the CI. | 100000000000034020 | |
CI Type API Name string / Required ciTypeApiName | Denotes the unique identifier used to identify the CI. | ci_application | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Delete Configuration Item
Example Payload for Delete Configuration Item
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Problem
Delete a problem by ID | key: deleteProblem
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
To Delete Problem ID string / Required toDeleteProblemId | ID of the problem to be deleted. | 234759602834500 |
Example Payload for Delete Problem
Example Payload for Delete Problem
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Problem Note
Delete a problem note | key: deleteProblemNote
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Problem ID string / Required noteProblemId | ID of the problem. | 234759602834500 | |
To Delete Note ID string / Required toDeleteNoteId | ID of the note to be deleted. | 4149000001300019 |
Example Payload for Delete Problem Note
Example Payload for Delete Problem Note
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Problem Task
Delete a problem task | key: deleteProblemTask
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Problem ID string / Required taskProblemId | ID of the problem. | 234759602834500 | |
To Delete Task ID string / Required toDeleteTaskId | ID of the task to be deleted. | 4149000001300019 |
Example Payload for Delete Problem Task
Example Payload for Delete Problem Task
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Product
Delete a single product | key: deleteProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string / Required id | Unique identifier to identify the resource | 1510894167438614 |
Example Payload for Delete Product
Example Payload for Delete Product
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Product Type
Delete a single product type | key: deleteProductType
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string / Required id | Unique identifier to identify the resource | 1510894167438614 |
Example Payload for Delete Product Type
Example Payload for Delete Product Type
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Request
Delete a request by ID | key: deleteRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
To Delete Request ID string / Required toDeleteRequestId | ID of the request to be deleted. | 4149000001300019 |
Example Payload for Delete Request
Example Payload for Delete Request
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Request Task
Delete a request task by ID | key: deleteRequestTask
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Request ID string / Required taskRequestId | ID of the request. | 4149000001300019 | |
To Delete Request Task ID string / Required toDeleteRequestTaskId | ID of the task to be deleted. | 4149000001300019 |
Example Payload for Delete Request Task
Example Payload for Delete Request Task
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Asset
Retrieve a single asset | key: getAsset
| Input | Default | Notes | Example |
|---|---|---|---|
Asset ID string / Required assetId | Unique identifier to identify the asset | 1510894167438614 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Get Asset
Example Payload for Get Asset
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
},
"asset": {
"purchase_lot_id": null,
"acknowledgement": null,
"total_cost": "0.0",
"device_type": null,
"type": {
"name": "Asset",
"id": "207953000000005903"
},
"lifecycle": null,
"last_updated_by": null,
"credential": null,
"suggested_owner": null,
"id": "207953000000314001",
"state": {
"internal_name": "In Store",
"name": "In Store",
"description": null,
"id": "207953000000006135"
},
"barcode": null,
"product_depreciation": null,
"operational_cost": "0.0",
"asset_tag": null,
"created_time": {
"display_value": "Apr 17, 2024 04:01 PM",
"value": "1713387707981"
},
"is_swscan_needed": false,
"created_by": {
"email_id": "components@prismatic.io",
"is_technician": true,
"sms_mail": null,
"mobile": "",
"last_name": "",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "207953000000222001",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "TJ Tedrow",
"id": "207953000000274942",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=850344966&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "TJ Tedrow",
"job_title": null
},
"last_updated_time": null,
"purchase_order": null,
"network_adapters": [],
"name": "UniqueName",
"is_depreciation_configured": false,
"region": null,
"is_depreciation_calculated": false,
"loan": null,
"attachments": [],
"retain_user_site": true,
"is_asset_association_possible": true,
"acquisition_date": null,
"current_cost": "0.0",
"vendor": null,
"mac_address": null,
"purchase_cost": "0.0",
"department": null,
"depreciation": null,
"product": {
"part_no": "-",
"gl_code": null,
"product_type": {
"image": "Access_Points",
"name": "Access Point",
"id": "207953000000005925",
"display_name": "Access Points",
"mandatory": true
},
"software": null,
"name": "Product Name",
"id": "207953000000313007",
"type": {
"name": "Asset",
"id": "207953000000005903"
},
"category": {
"name": "IT",
"description": "IT Assets and Components",
"id": "207953000000005899"
},
"manufacturer": "-"
},
"asset_depreciation": null,
"integration_mappings": [],
"expiry_date": null,
"used_by_asset": null,
"serial_number": null,
"warranty_expiry": null,
"ip_address": null,
"probe": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "207953000000222001",
"is_default": true
},
"product_type": {
"image": "Access_Points",
"name": "Access Point",
"id": "207953000000005925",
"display_name": "Access Points",
"mandatory": true
},
"discovered_serial_number": null,
"location": null,
"is_loaned": false,
"is_loanable": false,
"category": {
"name": "IT",
"description": "IT Assets and Components",
"id": "207953000000005899"
},
"user": null,
"last_success_audit": null,
"last_audit": null
}
}
}
Get Configuration Item
Retrieve a single configuration item on the CMDB | key: getConfigurationItem
| Input | Default | Notes | Example |
|---|---|---|---|
CI ID string / Required ciId | Denotes the unique identifier used to identify the CI. | 100000000000034020 | |
CI Type API Name string / Required ciTypeApiName | Denotes the unique identifier used to identify the CI. | ci_application | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Get Configuration Item
Example Payload for Get Configuration Item
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
},
"ci_computer": {
"linked_instance": "100000000000005416",
"created_time": {
"display_value": "Jul 30, 2021 07:44 PM",
"value": "1627654487657"
},
"attachments": [],
"ci_attributes": {
"ref_model": null,
"txt_service_tag": null,
"ref_owned_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_processor_name": null,
"txt_location": null,
"ref_managed_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_manufacturer": "Dell",
"txt_os": "Windows",
"txt_serial_number": null,
"txt_ip_address": null,
"txt_mac_address": null,
"num_processor_count": null,
"txt_service_pack": null,
"ref_business_impact": {
"name": "Affects Department",
"id": "100000000000007152"
}
},
"description": "Dell Server used for VMs",
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"data_source": [],
"last_updated_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"ci_type": {
"api_plural_name": "ci_computer",
"name": "ci_computer",
"display_name_plural": "Computer",
"id": "100000000000030014",
"display_name": "Computer",
"icon_name": "exchange_server"
},
"linked_entity": {
"api_plural_name": "departments",
"name": "department",
"display_name_plural": "sdp.module.pluralname.departments",
"id": "100000000000004786",
"display_name": "Department",
"icon_name": null
},
"last_updated_time": {
"display_value": "Jul 30, 2021 07:47 PM",
"value": "1627654669667"
},
"linked_instance_data": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"name": "Dell Server",
"id": "100000000000034020"
}
}
}
Get Problem
Get a problem by ID | key: getProblem
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
To Get Problem ID string / Required toGetProblemId | ID of the problem to be retrieved. | 234759602834500 |
Example Payload for Get Problem
Example Payload for Get Problem
{
"data": {
"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@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"
}
}
}
}
Get Problem Note
Get a problem note | key: getProblemNote
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Problem ID string / Required noteProblemId | ID of the problem. | 234759602834500 | |
To Get Note ID string / Required toGetNoteId | ID of the note to be retrieved. | 4149000001300019 |
Example Payload for Get Problem Note
Example Payload for Get Problem Note
{
"data": {
"note": {
"performed_by": {
"email_id": "john.je@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "J",
"user_scope": "internal_user",
"sms_mail_id": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "100000000000006098",
"is_default": true
},
"phone": null,
"employee_id": null,
"name": "John",
"id": "100000000000036077",
"photo_url": "https://contacts.localzoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "John",
"job_title": null
},
"description": "<div>Test Add Note</div>",
"id": "100000000000038247",
"performed_time": {
"display_value": "Feb 2, 2023 12:53 PM",
"value": "1675322599582"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Problem Task
Get a problem task | key: getProblemTask
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Problem ID string / Required taskProblemId | ID of the problem. | 234759602834500 | |
To Get Task ID string / Required toGetTaskId | ID of the task to be retrieved. | 4149000001300019 |
Example Payload for Get Problem Task
Example Payload for Get Problem Task
{
"data": {
"task": {
"percentage_completion": 45,
"estimated_effort_hours": null,
"attachments": [],
"email_before": "1800000",
"description": "<div>Add Task</div>",
"title": "Add Problem Task",
"marked_technician": null,
"problem": {
"id": "4149000001305071"
},
"overdue": false,
"additional_cost": "150",
"actual_end_time": {
"display_value": "Feb 7, 2023 02:44 PM",
"value": "1675761240000"
},
"id": "4149000001305075",
"actual_start_time": {
"display_value": "Feb 3, 2023 02:44 PM",
"value": "1675415640000"
},
"group": null,
"owner": {
"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
},
"associated_entity": "problem",
"module": "Problem",
"index": 1,
"priority": {
"color": "#ff6600",
"name": "Medium",
"id": "4149000000006803"
},
"created_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
},
"scheduled_end_time": {
"display_value": "Feb 9, 2023 02:44 PM",
"value": "1675934040000"
},
"marked_group": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "4149000001242001",
"is_default": true
},
"estimated_effort_minutes": null,
"deleted": false,
"estimated_effort": "1036800000",
"created_date": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329299172"
},
"estimated_effort_days": "12",
"task_type": null,
"scheduled_start_time": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329240000"
},
"status": {
"in_progress": true,
"internal_name": "Open",
"stop_timer": false,
"color": "#0066ff",
"name": "Open",
"id": "4149000000006657"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Product
Retrieve a single product | key: getProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string / Required id | Unique identifier to identify the resource | 1510894167438614 |
Example Payload for Get Product
Example Payload for Get Product
{
"data": {
"product": {
"is_laptop": false,
"part_no": "test-part_no",
"comments": "test-comments",
"product_type": {
"image": "test-image",
"name": "Workstation",
"id": "2247881320113485"
},
"software": {
"is_parent_suite": false,
"name": "test-name",
"id": "1970019934993439"
},
"name": "test-name",
"id": "2389334491499884",
"type": {
"name": "Asset",
"id": "2429804592656991"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1875814009075528"
},
"depreciation_detail": {
"useful_life": "2337459615672549",
"id": "2421818154117324",
"depreciation_percent": 1343434.4333,
"salvage_value": 1343434.4333
},
"manufacturer": "test-manufacturer"
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Product Type
Retrieve a single product type | key: getProductType
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string / Required id | Unique identifier to identify the resource | 1510894167438614 |
Example Payload for Get Product Type
Example Payload for Get Product Type
{
"data": {
"product_type": {
"image": "test-image",
"name": "Workstation",
"description": "test-description",
"id": "1654204619243101",
"display_name": "test-display_name",
"type": {
"name": "Asset",
"id": "1898443623900317"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1699836392964313"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Request
Get a request by ID | key: getRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
To Get Request ID string / Required toGetRequestId | ID of the request to be retrieved. | 4149000001300019 |
Example Payload for Get Request
Example Payload for Get Request
{
"data": {
"request": {
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "1948726349434187"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "2044673193715195"
},
"assets": [
{
"name": "192.0.2.1",
"id": "2476215879232669",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "2045488344070845",
"name": "test-name",
"id": "1611839137508603"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "2290537481381500",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1646275022585519"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2374730939861945",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "2372339936802225"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1859958322770061"
},
"level": {
"name": "Tier 1",
"id": "2018182121337715"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1532347302595840",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"approval_status": {
"name": "Approved",
"id": "2383059912529037"
},
"impact": {
"name": "Affects Business",
"id": "1765848093928449"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "2329032013178322",
"sort_index": 7
},
"sla": {
"name": "High",
"duebyminutes": 21,
"id": "2267633716896305",
"duebyhours": false,
"duebydays": 41
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "1967268183361012"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2070790206912927",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2470322684475602"
},
"udf_boolean1": false,
"udf_long1": "2136851967326526",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1975292840863883"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "2204017819975726"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "2434907668683558"
},
"template": {
"is_service_template": false,
"name": "Raise a New Monitor Request",
"id": "2174353095375675"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Incident",
"id": "2147014131875404"
},
"display_id": "39",
"time_elapsed": "2371520029466911",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2104949385602485"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "2174353095375675",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "2190218995208715"
},
"is_reopened": false,
"editor_status": 27,
"editor": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2458320955274024",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "charles@zmail.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "2276596244154377",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "2222857346042280"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "4",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "test-path",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "1939084650493601",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "2411765802963298"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Request Task
Get a request task by ID | key: getRequestTask
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Request ID string / Required taskRequestId | ID of the request. | 4149000001300019 | |
To Get Request Task ID string / Required toGetRequestTaskId | ID of the task to be retrieved. | 4149000001300019 |
Example Payload for Get Request Task
Example Payload for Get Request Task
{
"data": {
"task": {
"percentage_completion": "30",
"request": {
"id": "1756402018589639"
},
"estimated_effort_hours": "20",
"attachments": [],
"email_before": "3600000",
"description": "The SRS must contain all the requirements for the feature",
"title": "Create SRS",
"marked_technician": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2443319112022586",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"overdue": false,
"additional_cost": "100",
"actual_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"id": "1504379411346066",
"actual_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"owner": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1871812265827162",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"associated_entity": "request",
"module": "Request",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "2474460469828007"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1577080616582153",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"scheduled_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"estimated_effort_minutes": "45",
"deleted": false,
"estimated_effort": "22845",
"created_date": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"estimated_effort_days": "15",
"task_type": {
"color": "#ffffff",
"name": "Implementation",
"id": "1898428065971893"
},
"scheduled_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "1822002620862973"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
List Assets
Retrieve a list of assets | key: listAssets
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Assets
Example Payload for List Assets
{
"data": {
"assets": [
{
"loan": {
"start_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"id": "1510894167438614",
"returned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"barcode": "test-barcode",
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"loan_id": {
"display_value": "CH 44",
"value": "44"
}
},
"retain_user_site": false,
"type": {
"name": "Asset",
"id": "2221589639239391"
},
"last_updated_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "test-phone",
"name": "Lincoln",
"mobile": "test-mobile",
"id": "1767056521034237",
"photo_url": "test-photo_url",
"is_vip_user": false
},
"id": "1535924695172238",
"purchase_cost": 1343434.4333,
"state": {
"name": "In Use",
"description": "test-description",
"id": "1880749423319170"
},
"barcode": "test-barcode",
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"product": {
"part_no": "test-part_no",
"name": "test-name",
"id": "1976861984208771",
"manufacturer": "test-manufacturer"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "test-phone",
"name": "Lincoln",
"mobile": "test-mobile",
"id": "1621855055856191",
"photo_url": "test-photo_url",
"is_vip_user": false
},
"site": {
"deleted": false,
"name": "Custom Site",
"id": "1812928581155277"
},
"product_type": {
"image": "test-image",
"name": "Workstation",
"id": "1754602739373275"
},
"last_updated_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"name": "192.0.2.1",
"location": "test-location",
"is_loanable": false,
"category": {
"name": "IT",
"description": "test-description",
"id": "1817089573167815"
},
"state_history_comments": "test-state_history_comments"
}
],
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"row_count": 1
}
}
}
List Configuration Items
Retrieve a list of all configuration items on the CMDB | key: listConfigurationItems
| Input | Default | Notes | Example |
|---|---|---|---|
CI Type API Name string / Required ciTypeApiName | Denotes the unique identifier used to identify the CI. | ci_application | |
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Configuration Items
Example Payload for List Configuration Items
{
"data": {
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"sort_field": "name",
"row_count": 1
},
"ci_computer": [
{
"created_time": {
"display_value": "Jul 30, 2021 07:44 PM",
"value": "1627654487657"
},
"last_updated_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"ci_type": {
"api_plural_name": "ci_computer",
"name": "ci_computer",
"display_name_plural": "Computer",
"id": "100000000000030014",
"display_name": "Computer",
"icon_name": "exchange_server"
},
"ci_attributes": {
"ref_model": null,
"txt_service_tag": null,
"ref_owned_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_processor_name": null,
"txt_location": null,
"ref_managed_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_manufacturer": "Dell",
"txt_os": "Windows",
"txt_serial_number": null,
"txt_ip_address": null,
"txt_mac_address": null,
"num_processor_count": null,
"txt_service_pack": null,
"ref_business_impact": {
"name": "Affects Department",
"id": "100000000000007152"
}
},
"last_updated_time": {
"display_value": "Jul 30, 2021 07:47 PM",
"value": "1627654669667"
},
"name": "Dell Server",
"description": "Dell Server used for VMs",
"id": "100000000000034020",
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"data_source": []
}
]
}
}
List Problem Notes
Retrieve a list of problem notes | key: listProblemNotes
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Problem ID string / Required noteProblemId | ID of the problem. | 234759602834500 | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Problem Notes
Example Payload for List Problem Notes
{
"data": {
"notes": [
{
"performed_by": {
"email_id": "john.je@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "J",
"user_scope": "internal_user",
"sms_mail_id": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "100000000000006098",
"is_default": true
},
"phone": null,
"employee_id": null,
"name": "John",
"id": "100000000000036077",
"photo_url": "https://contacts.localzoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "John",
"job_title": null
},
"description": "<div>Test Add Note</div>",
"id": "100000000000038247",
"performed_time": {
"display_value": "Feb 2, 2023 12:53 PM",
"value": "1675322599582"
}
}
],
"response_status": {
"status_code": 2000,
"status": "success"
},
"list_info": {
"has_more_rows": false,
"row_count": 1
}
}
}
List Problem Tasks
Retrieve a list of problem tasks | key: listProblemTasks
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Problem ID string / Required taskProblemId | ID of the problem. | 234759602834500 |
Example Payload for List Problem Tasks
Example Payload for List Problem Tasks
{
"data": {
"tasks": [
{
"percentage_completion": 45,
"estimated_effort_hours": null,
"attachments": [],
"email_before": "1800000",
"description": "<div>Add Task</div>",
"title": "Add Problem Task",
"marked_technician": null,
"problem": {
"id": "4149000001305071"
},
"overdue": false,
"additional_cost": "150",
"actual_end_time": {
"display_value": "Feb 7, 2023 02:44 PM",
"value": "1675761240000"
},
"id": "4149000001305075",
"actual_start_time": {
"display_value": "Feb 3, 2023 02:44 PM",
"value": "1675415640000"
},
"group": null,
"owner": {
"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
},
"associated_entity": "problem",
"module": "Problem",
"index": 1,
"priority": {
"color": "#ff6600",
"name": "Medium",
"id": "4149000000006803"
},
"created_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
},
"scheduled_end_time": {
"display_value": "Feb 9, 2023 02:44 PM",
"value": "1675934040000"
},
"marked_group": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "4149000001242001",
"is_default": true
},
"estimated_effort_minutes": null,
"deleted": false,
"estimated_effort": "1036800000",
"created_date": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329299172"
},
"estimated_effort_days": "12",
"task_type": null,
"scheduled_start_time": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329240000"
},
"status": {
"in_progress": true,
"internal_name": "Open",
"stop_timer": false,
"color": "#0066ff",
"name": "Open",
"id": "4149000000006657"
}
}
],
"response_status": {
"status_code": 2000,
"status": "success"
},
"list_info": {
"has_more_rows": false,
"row_count": 1
}
}
}
List Problems
Retrieve a list of problems | key: listProblems
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Problems
Example Payload for List Problems
{
"data": {
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"row_count": 1
},
"problems": [
{
"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"
}
}
]
}
}
List Product Types
Retrieve a list of product types | key: listProductTypes
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Product Types
Example Payload for List Product Types
{
"data": {
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"product_types": [
{
"image": "test-image",
"name": "Workstation",
"description": "test-description",
"id": "2011402704295145",
"display_name": "test-display_name",
"type": {
"name": "Asset",
"id": "1717928672901287"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1968174468165684"
}
}
],
"list_info": {
"has_more_rows": false,
"row_count": 1
}
}
}
List Products
Retrieve a list of products | key: listProducts
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Products
Example Payload for List Products
{
"data": {
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"row_count": 1
},
"products": [
{
"is_laptop": false,
"part_no": "test-part_no",
"comments": "test-comments",
"product_type": {
"image": "test-image",
"name": "Workstation",
"id": "1921325636821381"
},
"software": {
"is_parent_suite": false,
"name": "test-name",
"id": "2456631449619317"
},
"name": "test-name",
"id": "2390004684229909",
"type": {
"name": "Asset",
"id": "1825477048701112"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "2230240622346283"
},
"depreciation_detail": {
"useful_life": "2296589928410633",
"id": "1926721364241665",
"depreciation_percent": 1343434.4333,
"salvage_value": 1343434.4333
},
"manufacturer": "test-manufacturer"
}
]
}
}
List Request Tasks
Retrieve a list of request tasks | key: listRequestTasks
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Request ID string / Required taskRequestId | ID of the request. | 4149000001300019 |
Example Payload for List Request Tasks
Example Payload for List Request Tasks
{
"data": {
"tasks": [
{
"percentage_completion": "30",
"request": {
"id": "1756402018589639"
},
"estimated_effort_hours": "20",
"attachments": [],
"email_before": "3600000",
"description": "The SRS must contain all the requirements for the feature",
"title": "Create SRS",
"marked_technician": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2443319112022586",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"overdue": false,
"additional_cost": "100",
"actual_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"id": "1504379411346066",
"actual_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"owner": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1871812265827162",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"associated_entity": "request",
"module": "Request",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "2474460469828007"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1577080616582153",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"scheduled_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"estimated_effort_minutes": "45",
"deleted": false,
"estimated_effort": "22845",
"created_date": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"estimated_effort_days": "15",
"task_type": {
"color": "#ffffff",
"name": "Implementation",
"id": "1898428065971893"
},
"scheduled_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "1822002620862973"
}
}
],
"response_status": {
"status_code": 2000,
"status": "success"
},
"list_info": {
"has_more_rows": false,
"row_count": 1
}
}
}
List Requests
Retrieve a list of requests | key: listRequests
| Input | Default | Notes | Example |
|---|---|---|---|
Conditions Criteria string Key Value List conditionsCriteria | Conditions are the operators for criteria construction. Select the condition to be applied to the field. | created_time=Greater Than | |
Conditions Criteria Value string Key Value List conditionsCriteriaValue | The value of the field to be compared. | created_time=1488451440000 | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | true | Fetch all the data. If true, it will ignore Row Count and Page inputs. | |
Page string page | 1 | Page number to be returned | 1 |
Row Count string rowCount | 100 | Number of rows to be returned | 100 |
Example Payload for List Requests
Example Payload for List Requests
{
"data": {
"requests": [
{
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "1948726349434187"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "2044673193715195"
},
"assets": [
{
"name": "192.0.2.1",
"id": "2476215879232669",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "2045488344070845",
"name": "test-name",
"id": "1611839137508603"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "2290537481381500",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1646275022585519"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2374730939861945",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "2372339936802225"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1859958322770061"
},
"level": {
"name": "Tier 1",
"id": "2018182121337715"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1532347302595840",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"approval_status": {
"name": "Approved",
"id": "2383059912529037"
},
"impact": {
"name": "Affects Business",
"id": "1765848093928449"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "2329032013178322",
"sort_index": 7
},
"sla": {
"name": "High",
"duebyminutes": 21,
"id": "2267633716896305",
"duebyhours": false,
"duebydays": 41
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "1967268183361012"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2070790206912927",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2470322684475602"
},
"udf_boolean1": false,
"udf_long1": "2136851967326526",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1975292840863883"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "2204017819975726"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "2434907668683558"
},
"template": {
"is_service_template": false,
"name": "Raise a New Monitor Request",
"id": "2174353095375675"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Incident",
"id": "2147014131875404"
},
"display_id": "39",
"time_elapsed": "2371520029466911",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2104949385602485"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "2174353095375675",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "2190218995208715"
},
"is_reopened": false,
"editor_status": 27,
"editor": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2458320955274024",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "charles@zmail.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "2276596244154377",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "2222857346042280"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "4",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "test-path",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "1939084650493601",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "2411765802963298"
}
}
],
"response_status": {
"status_code": 2000,
"status": "success"
},
"list_info": {
"has_more_rows": false,
"row_count": 1
}
}
}
Raw Request
Send raw HTTP request to ServiceDesk Plus | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enable this to log the request and response | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | This is the URL to call. | Input the path only (/assets), The base URL is already included ({dataCenterURL}). For example, to connect to {dataCenterURL}/api/v3/assets, only /assets is entered in this field. e.g. /assets | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. |
Update Asset
Edit an existing asset | key: updateAsset
| Input | Default | Notes | Example |
|---|---|---|---|
Asset ID string / Required assetId | Unique identifier to identify the asset | 1510894167438614 | |
Asset Name string assetName | Unique name to identify the asset | 192.0.2.1 | |
Asset Tag string assetTag | Asset tag used to identify the asset | Sample Content | |
Attributes code attributes | Other attributes to add to the payload | ||
Bar Code string barCode | Unique barcode used to identify the asset | test-barcode | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Product code product | Product of the asset. Remove the default value if not needed. | ||
State code state | Indicates the state of the asset. Remove the default value if not needed. | ||
State History Comments string stateHistoryComments | A text in a plain format. No rich text or new line characters allowed. | Sample Content |
Example Payload for Update Asset
Example Payload for Update Asset
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
},
"asset": {
"purchase_lot_id": null,
"acknowledgement": null,
"total_cost": "0.0",
"device_type": null,
"type": {
"name": "Asset",
"id": "207953000000005903"
},
"lifecycle": null,
"last_updated_by": null,
"credential": null,
"suggested_owner": null,
"id": "207953000000314001",
"state": {
"internal_name": "In Store",
"name": "In Store",
"description": null,
"id": "207953000000006135"
},
"barcode": null,
"product_depreciation": null,
"operational_cost": "0.0",
"asset_tag": null,
"created_time": {
"display_value": "Apr 17, 2024 04:01 PM",
"value": "1713387707981"
},
"is_swscan_needed": false,
"created_by": {
"email_id": "components@prismatic.io",
"is_technician": true,
"sms_mail": null,
"mobile": "",
"last_name": "",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "207953000000222001",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "TJ Tedrow",
"id": "207953000000274942",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=850344966&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "TJ Tedrow",
"job_title": null
},
"last_updated_time": null,
"purchase_order": null,
"network_adapters": [],
"name": "UniqueName",
"is_depreciation_configured": false,
"region": null,
"is_depreciation_calculated": false,
"loan": null,
"attachments": [],
"retain_user_site": true,
"is_asset_association_possible": true,
"acquisition_date": null,
"current_cost": "0.0",
"vendor": null,
"mac_address": null,
"purchase_cost": "0.0",
"department": null,
"depreciation": null,
"product": {
"part_no": "-",
"gl_code": null,
"product_type": {
"image": "Access_Points",
"name": "Access Point",
"id": "207953000000005925",
"display_name": "Access Points",
"mandatory": true
},
"software": null,
"name": "Product Name",
"id": "207953000000313007",
"type": {
"name": "Asset",
"id": "207953000000005903"
},
"category": {
"name": "IT",
"description": "IT Assets and Components",
"id": "207953000000005899"
},
"manufacturer": "-"
},
"asset_depreciation": null,
"integration_mappings": [],
"expiry_date": null,
"used_by_asset": null,
"serial_number": null,
"warranty_expiry": null,
"ip_address": null,
"probe": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "207953000000222001",
"is_default": true
},
"product_type": {
"image": "Access_Points",
"name": "Access Point",
"id": "207953000000005925",
"display_name": "Access Points",
"mandatory": true
},
"discovered_serial_number": null,
"location": null,
"is_loaned": false,
"is_loanable": false,
"category": {
"name": "IT",
"description": "IT Assets and Components",
"id": "207953000000005899"
},
"user": null,
"last_success_audit": null,
"last_audit": null
}
}
}
Update Configuration Item
Edit an existing configuration item on the CMDB | key: updateConfigurationItem
| Input | Default | Notes | Example |
|---|---|---|---|
Attributes code attributes | Other attributes to add to the payload | ||
CI ID string / Required ciId | Denotes the unique identifier used to identify the CI. | 100000000000034020 | |
CI Type API Name string / Required ciTypeApiName | Denotes the unique identifier used to identify the CI. | ci_application | |
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | Description of the CI | API Test |
Example Payload for Update Configuration Item
Example Payload for Update Configuration Item
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
},
"ci_computer": {
"linked_instance": "100000000000005416",
"created_time": {
"display_value": "Jul 30, 2021 07:44 PM",
"value": "1627654487657"
},
"attachments": [],
"ci_attributes": {
"ref_model": null,
"txt_service_tag": null,
"ref_owned_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_processor_name": null,
"txt_location": null,
"ref_managed_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"txt_manufacturer": "Dell",
"txt_os": "Windows",
"txt_serial_number": null,
"txt_ip_address": null,
"txt_mac_address": null,
"num_processor_count": null,
"txt_service_pack": null,
"ref_business_impact": {
"name": "Affects Department",
"id": "100000000000007152"
}
},
"description": "Dell Server used for VMs",
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"data_source": [],
"last_updated_by": {
"email_id": "lincoln@zmail.com",
"is_technician": true,
"sms_mail": "linc123@xys_sms.co",
"contact_info_id": "100000000000034009",
"mobile": "9876543210",
"last_name": null,
"user_scope": "0",
"phone": null,
"name": "Lincoln",
"id": "100000000000034007",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"first_name": "Lincoln",
"job_title": null
},
"ci_type": {
"api_plural_name": "ci_computer",
"name": "ci_computer",
"display_name_plural": "Computer",
"id": "100000000000030014",
"display_name": "Computer",
"icon_name": "exchange_server"
},
"linked_entity": {
"api_plural_name": "departments",
"name": "department",
"display_name_plural": "sdp.module.pluralname.departments",
"id": "100000000000004786",
"display_name": "Department",
"icon_name": null
},
"last_updated_time": {
"display_value": "Jul 30, 2021 07:47 PM",
"value": "1627654669667"
},
"linked_instance_data": {
"site": null,
"name": "Engineering",
"id": "100000000000005416"
},
"name": "Dell Server",
"id": "100000000000034020"
}
}
}
Update Problem
Update an existing problem | key: updateProblem
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Problem Closed Time code problemClosedTime | Indicates the closed time of the problem. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Problem Description string problemDescription | Description of the problem. | <b>The content to be displayed</b> | |
Problem Due By Time code problemDueByTime | Indicates the due by time of the problem. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Problem Reported Time code problemReportedTime | Indicates the reported time of the problem. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem.html for details. | ||
Problem Title string problemTitle | Title of the problem. | Sample Content | |
To Update Problem ID string / Required toUpdateProblemId | ID of the problem to be updated. | 234759602834500 |
Example Payload for Update Problem
Example Payload for Update Problem
{
"data": {
"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"
}
}
}
Update Problem Note
Update a problem note | key: updateProblemNote
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_note.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Note Description string noteDescription | Contains description about the note. | <b>The content to be displayed</b> | |
Problem ID string / Required noteProblemId | ID of the problem. | 234759602834500 | |
Notify To code notifyTo | Contains info on users or roles to be notified on add/edit operation of the note. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_note.html for details. | ||
To Update Note ID string / Required toUpdateNoteId | ID of the note to be updated. | 4149000001300019 |
Example Payload for Update Problem Note
Example Payload for Update Problem Note
{
"data": {
"note": {
"performed_by": {
"email_id": "john.je@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "J",
"user_scope": "internal_user",
"sms_mail_id": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "100000000000006098",
"is_default": true
},
"phone": null,
"employee_id": null,
"name": "John",
"id": "100000000000036077",
"photo_url": "https://contacts.localzoho.com/file?sample",
"is_vip_user": false,
"department": null,
"first_name": "John",
"job_title": null
},
"description": "<div>Test Add Note</div>",
"id": "100000000000038247",
"performed_time": {
"display_value": "Feb 2, 2023 12:53 PM",
"value": "1675322599582"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Update Problem Task
Update a problem task | key: updateProblemTask
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Estimated Effort Days string estimatedEffortDays | Estimated number of days to finish the task. | 234759602834500 | |
Estimated Effort Hours string estimatedEffortHours | Estimated number of hours to finish the task. | 234759602834500 | |
Estimated Effort Minutes string estimatedEffortMinutes | Estimated number of minutes to finish the task. | 234759602834500 | |
Group code group | Indicates the assigned group of the task. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
Percentage Completion string percentageCompletion | Indicates the progress of the task in percentage of completion. | 100 | |
Task Description string taskDescription | Contains description about the task. | <b>The content to be displayed</b> | |
Owner code taskOwner | The User assigned to the task. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
Problem ID string / Required taskProblemId | ID of the problem. | 234759602834500 | |
Task Title string taskTitle | Title of the task. | Sample Content | |
Task Type code taskType | Used to categorize the tasks of similar cases. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/problems/problem_task.html for details. | ||
To Update Task ID string / Required toUpdateTaskId | ID of the task to be updated. | 4149000001300019 |
Example Payload for Update Problem Task
Example Payload for Update Problem Task
{
"data": {
"task": {
"percentage_completion": 45,
"estimated_effort_hours": null,
"attachments": [],
"email_before": "1800000",
"description": "<div>Add Task</div>",
"title": "Add Problem Task",
"marked_technician": null,
"problem": {
"id": "4149000001305071"
},
"overdue": false,
"additional_cost": "150",
"actual_end_time": {
"display_value": "Feb 7, 2023 02:44 PM",
"value": "1675761240000"
},
"id": "4149000001305075",
"actual_start_time": {
"display_value": "Feb 3, 2023 02:44 PM",
"value": "1675415640000"
},
"group": null,
"owner": {
"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
},
"associated_entity": "problem",
"module": "Problem",
"index": 1,
"priority": {
"color": "#ff6600",
"name": "Medium",
"id": "4149000000006803"
},
"created_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
},
"scheduled_end_time": {
"display_value": "Feb 9, 2023 02:44 PM",
"value": "1675934040000"
},
"marked_group": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "4149000001242001",
"is_default": true
},
"estimated_effort_minutes": null,
"deleted": false,
"estimated_effort": "1036800000",
"created_date": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329299172"
},
"estimated_effort_days": "12",
"task_type": null,
"scheduled_start_time": {
"display_value": "Feb 2, 2023 02:44 PM",
"value": "1675329240000"
},
"status": {
"in_progress": true,
"internal_name": "Open",
"stop_timer": false,
"color": "#0066ff",
"name": "Open",
"id": "4149000000006657"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Update Product
Updates an existing product | key: updateProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Attributes code attributes | Other attributes to add to the payload | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string / Required id | Unique identifier to identify the resource | 1510894167438614 | |
Is Laptop string isLaptop | Boolean value indicating whether the product type is laptop or not. | ||
Manufacturer string manufacturer | Name to identify the product manufacturer. | test-manufacturer | |
Name string name | Unique identifier to identify the resource | test-name | |
Part No string partNo | Part no of the productPart no of the product | test-part_no | |
Product Type code productType | Product type of the product. Remove the default value if not needed. |
Example Payload for Update Product
Example Payload for Update Product
{
"data": {
"product": {
"is_laptop": false,
"part_no": "test-part_no",
"comments": "test-comments",
"product_type": {
"image": "test-image",
"name": "Workstation",
"id": "2247881320113485"
},
"software": {
"is_parent_suite": false,
"name": "test-name",
"id": "1970019934993439"
},
"name": "test-name",
"id": "2389334491499884",
"type": {
"name": "Asset",
"id": "2429804592656991"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1875814009075528"
},
"depreciation_detail": {
"useful_life": "2337459615672549",
"id": "2421818154117324",
"depreciation_percent": 1343434.4333,
"salvage_value": 1343434.4333
},
"manufacturer": "test-manufacturer"
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Update Product Type
Updates an existing product type | key: updateProductType
| Input | Default | Notes | Example |
|---|---|---|---|
Asset Type code assetType | Type of the product type. Remove the default value if not needed. | ||
Attributes code attributes | Other attributes to add to the payload | ||
Category code category | Category of the product type. Remove the default value if not needed. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
ID string / Required id | Unique identifier to identify the resource | 1510894167438614 | |
Name string name | Unique identifier to identify the resource | test-name |
Example Payload for Update Product Type
Example Payload for Update Product Type
{
"data": {
"product_type": {
"image": "test-image",
"name": "Workstation",
"description": "test-description",
"id": "1654204619243101",
"display_name": "test-display_name",
"type": {
"name": "Asset",
"id": "1898443623900317"
},
"category": {
"name": "IT",
"description": "test-description",
"id": "1699836392964313"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Update Request
Update a request | key: updateRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Delete Pre Template Tasks boolean deletePreTemplateTasks | false | Boolean value indicating whether the pre template tasks need to be deleted. | |
Email IDs To Notify string Value List emailIdsToNotify | Email ids, which needs to be notified about the happenings of this request. | abc.gmail.com | |
Impact Details string impactDetails | Description about the impact of this request. | Sample Content | |
Request Description string requestDescription | Description of this request. | <b>The content to be displayed</b> | |
Request Subject string requestSubject | Subject of this request. | Sample Content | |
To Update Request ID string / Required toUpdateRequestId | ID of the request to be updated. | 4149000001300019 |
Example Payload for Update Request
Example Payload for Update Request
{
"data": {
"request": {
"total_cost": "250",
"subject": "Need an External Monitor",
"resolution": {
"add_to_linked_requests": false,
"content": "The following is the resolution to the above request"
},
"is_read": false,
"mode": {
"name": "E-Mail",
"id": "1948726349434187"
},
"lifecycle": {
"inactive": false,
"is_published": false,
"name": "test-name",
"id": "2044673193715195"
},
"assets": [
{
"name": "192.0.2.1",
"id": "2476215879232669",
"barcode": "test-barcode"
}
],
"configuration_items": [
{
"linked_instance": "2045488344070845",
"name": "test-name",
"id": "1611839137508603"
}
],
"project_id": "test-project_id",
"cancellation_requested": false,
"is_trashed": false,
"has_change_initiated_request": "true",
"id": "2290537481381500",
"assigned_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"group": {
"site": "Custom Site",
"deleted": false,
"name": "Hardware Problems",
"id": "1646275022585519"
},
"requester": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2374730939861945",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"email_to": [],
"created_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"item": {
"name": "Install",
"id": "2372339936802225"
},
"cancel_flag_comments": {
"comment": "test-comment",
"id": "1859958322770061"
},
"level": {
"name": "Tier 1",
"id": "2018182121337715"
},
"on_behalf_of": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1532347302595840",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"approval_status": {
"name": "Approved",
"id": "2383059912529037"
},
"impact": {
"name": "Affects Business",
"id": "1765848093928449"
},
"service_category": {
"inactive": false,
"name": "Corporate Website",
"id": "2329032013178322",
"sort_index": 7
},
"sla": {
"name": "High",
"duebyminutes": 21,
"id": "2267633716896305",
"duebyhours": false,
"duebydays": 41
},
"resolved_time": "null",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "1967268183361012"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2070790206912927",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"first_response_due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_escalated": false,
"last_updated_time": "null",
"has_notes": false,
"udf_fields": {
"udf_ref1": {
"name": "test-name",
"id": "2470322684475602"
},
"udf_boolean1": false,
"udf_long1": "2136851967326526",
"udf_date1": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"udf_double1": "test-udf_double1",
"udf_char1": "test-udf_char1",
"deptheadid": {
"name": "test-name",
"id": "1975292840863883"
}
},
"status_change_comments": "test-status_change_comments",
"impact_details": "Details of the impact",
"subcategory": {
"name": "Adobe Reader",
"id": "2204017819975726"
},
"email_cc": [
"andrews@zmail.com"
],
"deleted_time": "null",
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "2434907668683558"
},
"template": {
"is_service_template": false,
"name": "Raise a New Monitor Request",
"id": "2174353095375675"
},
"email_ids_to_notify": [
"andrews@zmail.com"
],
"attachments": [],
"request_type": {
"name": "Incident",
"id": "2147014131875404"
},
"display_id": "39",
"time_elapsed": "2371520029466911",
"notification_status": "test-notification_status",
"has_purchase_orders": false,
"description": "Provide me an External Monitor",
"responded_time": "null",
"is_service_request": false,
"deleted_assets": [
{}
],
"urgency": {
"name": "Urgent",
"id": "2104949385602485"
},
"has_request_initiated_change": false,
"request_template_task_ids": [
{
"id": "2174353095375675",
"title": "Create SRS"
}
],
"department": {
"name": "Administration",
"id": "2190218995208715"
},
"is_reopened": false,
"editor_status": 27,
"editor": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2458320955274024",
"photo_url": "https://contacts.zoho.com/file?sample",
"is_vip_user": false,
"job_title": "Java Developer"
},
"has_draft": false,
"has_attachments": false,
"has_linked_requests": false,
"resources": {
"res_100000000000248391": {
"qstn_check_100000000000248371": [
{
"name": "test-name-1"
},
{
"name": "test-name-2"
}
],
"qstn_text_100000000000248377": {
"value": "text-box-value"
},
"qstn_simple_100000000000248379": {
"name": "test-name"
},
"qstn_select_100000000000248385": {
"name": "test-name"
}
}
},
"is_overdue": false,
"technician": {
"email_id": "charles@zmail.com",
"cost_per_hour": 1343434.4333,
"phone": "test-phone",
"name": "Charles",
"mobile": "test-mobile",
"id": "2276596244154377",
"photo_url": "test-photo_url",
"sms_mail_id": "test-sms_mail_id"
},
"delete_pre_template_tasks": false,
"has_problem": false,
"due_by_time": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"is_fcr": false,
"has_project": false,
"site": {
"deleted": false,
"name": "Custom Site",
"id": "2222857346042280"
},
"is_first_response_overdue": false,
"completed_time": "null",
"unreplied_count": "4",
"email_bcc": [],
"service_cost": "100",
"service_approvers": {
"org_roles": [
{
"xpath": {
"path": "test-path",
"display_name": "test-display_name"
}
}
],
"users": [
{
"email_id": "test@test.com",
"is_technician": false,
"sms_mail": "test-sms_mail",
"phone": "test-phone",
"name": "test-name",
"mobile": "test-mobile",
"id": "1939084650493601",
"photo_url": "test-photo_url",
"is_vip_user": false,
"job_title": "test-job_title"
}
]
},
"category": {
"deleted": false,
"name": "Software",
"id": "2411765802963298"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Update Request Task
Update a request task | key: updateRequestTask
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Connection connection / Required connectionInput | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Request Task Actual End Time code taskRequestActualEndTime | Date and time at which the task actually got finished. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Request Task Actual Start Time code taskRequestActualStartTime | Date and time at which the task actually got started. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Request Task Additional Cost string taskRequestAdditionalCost | Cost spent other than the actual cost of the task. | 23.08 | |
Request Task Description string taskRequestDescription | Contains description about the task. | <b>The content to be displayed</b> | |
Request Task Estimated Effort Hours string taskRequestEstimatedEffortHours | Estimated number of hours to finish the task. | 12 | |
Request ID string / Required taskRequestId | ID of the request. | 4149000001300019 | |
Request Task Owner code taskRequestOwner | The User assigned to the task. See https://www.manageengine.com/products/service-desk/sdpod-v3-api/requests/request_task.html for details. | ||
Request Task Percentage Completion string taskRequestPercentageCompletion | Indicates the progress of the task in percentage of completion. | 100 | |
Request Task Title string taskRequestTitle | Title of the task. | Sample Content | |
To Update Request Task ID string / Required toUpdateRequestTaskId | ID of the task to be updated. | 4149000001300019 |
Example Payload for Update Request Task
Example Payload for Update Request Task
{
"data": {
"task": {
"percentage_completion": "30",
"request": {
"id": "1756402018589639"
},
"estimated_effort_hours": "20",
"attachments": [],
"email_before": "3600000",
"description": "The SRS must contain all the requirements for the feature",
"title": "Create SRS",
"marked_technician": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "2443319112022586",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"overdue": false,
"additional_cost": "100",
"actual_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"id": "1504379411346066",
"actual_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"owner": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1871812265827162",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"associated_entity": "request",
"module": "Request",
"priority": {
"color": "#ffffff",
"name": "High",
"id": "2474460469828007"
},
"created_by": {
"email_id": "lincoln@zmail.com",
"is_technician": false,
"sms_mail": "linc123@xys_sms.co",
"phone": "022-1234567890",
"name": "Lincoln",
"mobile": "1234567890",
"id": "1577080616582153",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123&t=user&height=60&width=60",
"is_vip_user": false,
"department": null
},
"scheduled_end_time": {
"display_value": "Dec 11, 2017 12:19 PM",
"value": "1512974940000"
},
"estimated_effort_minutes": "45",
"deleted": false,
"estimated_effort": "22845",
"created_date": {
"display_value": "Nov 10, 2016 11:44 AM",
"value": "1478758440000"
},
"estimated_effort_days": "15",
"task_type": {
"color": "#ffffff",
"name": "Implementation",
"id": "1898428065971893"
},
"scheduled_start_time": {
"display_value": "Jan 23, 2015 10:15 AM",
"value": "1421988300000"
},
"status": {
"in_progress": false,
"internal_name": "test-internal_name",
"stop_timer": false,
"color": "#ffffff",
"name": "Open",
"id": "1822002620862973"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}