ServiceDesk Plus Component
![ServiceDesk Plus](/docs/img/components/icons/60/c2VydmljZWRlc2stcGx1cw==.png)
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-plusDescription
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.
Data Sources
Select Asset
Select an asset from the list of assets. | key: selectAsset | type: picklist
Data Source Payload
{
"result": [
{
"label": "192.0.2.1",
"key": "1817089573167815"
},
{
"label": "192.0.2.23",
"key": "1817089573167315"
}
]
}
Actions
Create Asset
Create a new asset | key: createAsset
Output Example Payload
{
"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
Output Example Payload
{
"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 Product
Create a new product | key: createProduct
Output Example Payload
{
"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
Output Example Payload
{
"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"
}
}
}
Delete Asset
Delete an existing asset | key: deleteAsset
Output Example Payload
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Configuration Item
Delete an existing configuration item on the CMDB | key: deleteConfigurationItem
Output Example Payload
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Product
Delete a single product | key: deleteProduct
Output Example Payload
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Delete Product Type
Delete a single product type | key: deleteProductType
Output Example Payload
{
"data": {
"response_status": {
"status_code": 2000,
"status": "success"
}
}
}
Get Asset
Retrieve a single asset | key: getAsset
Output Example Payload
{
"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
Output Example Payload
{
"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 Product
Retrieve a single product | key: getProduct
Output Example Payload
{
"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
Output Example Payload
{
"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"
}
}
}
List Assets
Retrieve a list of assets | key: listAssets
Output Example Payload
{
"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
Output Example Payload
{
"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 Product Types
Retrieve a list of product types | key: listProductTypes
Output Example Payload
{
"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
Output Example Payload
{
"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"
}
]
}
}
Raw Request
Send raw HTTP request to ServiceDesk Plus | key: rawRequest
Update Asset
Edit an existing asset | key: updateAsset
Output Example Payload
{
"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
Output Example Payload
{
"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 Product
Updates an existing product | key: updateProduct
Output Example Payload
{
"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
Output Example Payload
{
"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"
}
}
}