Manageengine Servicedesk Plus
The ManageEngine ServiceDesk Plus connector streamlines IT service management by automating interactions with the ServiceDesk Plus platform.
ManageEngine ServiceDesk Plus is a comprehensive IT service management (ITSM) solution that enables organizations to manage and resolve service requests efficiently. The Swimlane Turbine connector for ServiceDesk Plus allows users to automate a wide range of ITSM tasks, including the creation, update, and deletion of service requests, tasks, approvals, notes, and worklogs. By integrating with ServiceDesk Plus, Swimlane Turbine users can streamline their ITSM workflows, enhance incident response with detailed documentation, and improve overall efficiency by reducing manual processes.
The ManageEngine ServiceDesk Plus Connector allows the Cloud API allows you to perform all the operations that you do with our web client.
Prerequisites
To effectively utilize the ManageEngine ServiceDesk Plus connector for Turbine, ensure you have the following prerequisites:
- API Key Authentication with the following parameters:
- URL: Endpoint URL for the ServiceDesk Plus API.
- API Key: Unique identifier to authenticate API requests.
- Custom Authentication with the following parameters:
- url: Endpoint URL for the ServiceDesk Plus API.
- Client ID: Identifier for the OAuth client.
- Client Secret: Secret key for the OAuth client.
- Code: Authorization code obtained during OAuth flow.
Custom Authentication
The ServiceDesk Plus Connector requires a client ID, a client secret and a temporary code.
The following steps are required to set up the asset. The procedure is somewhat different than with other Connectors.
- go to the ZOHO API Console https://api-console.zoho.com/
- Add Client with Self Client
- It will show Client ID and Client Secret
- Create ManageEngine ServiceDesk Plus Asset
- Host: ο»Ώ
- Paste the Client ID and Client Secret values from 2
- Save the asset
- Go back to the Self Client application created in https://api-console.zoho.com
- Click 'Generate Code'
- For the tasks currently available, the needed scope is SDPOnDemand.requests.ALL
- Time Duration: 10 minutes
- Scope Description: Whatever you want
- Copy the 'Generated Code'
- Create 'Generate Refresh Token' task
- Go to the Generate Refresh Token task inputs ... and so on
API Key Authentication
The ManageEngine ServiceDesk Plus connector uses the API Key authentication method to connect to the ManageEngine ServiceDesk Plus API.
The following are required to set up the asset:
API KEY : This key is unique and serves as a credential for API requests. An Administrator generates an API key from the ServiceDesk Plus web interface.
URL : The URL is the base URL of the ServiceDesk Plus API.
Capabilities
This Connector provides the following capabilities:
- Requests
- Get Request
- Get List Request
- Delete request
- Add attachment
- Add new request
- Request Note
- Add Request Note
- Edit Request Note
- Get Request Note
- Get List Request Note
- Delete Request Note
- Request Approval
- Add Request Approval
- Get Request Approval
- Get List Request Approval
- Delete Request Approval
- Request Task
- Add Request Task
- Edit Request Task
- Get Request Task
- Get List Request Task
- Delete Request Task
- Add attachment to a request task
- Request Worklow
- Add Request Worklog
- Edit Request Worklog
- Get Request Worklog
- Get List Request Worklog
- Delete Request Worklog
- Request Task Worklog
- Add Request Task Worklog
- Edit Request Task Worklog
- Get Request Task Worklog
- Get List Request Task Worklog
- Delete Request Task Worklog
Notes
For more information on ManageEngine ServiceDesk Plus is found at:
Configurations
ManageEngine ServiceDesk Plus API Key
Authenticates using an API Key.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
apikey | API key. | string | Required |
verify_ssl | Verify SSL certificate. | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Manageengine Servicedesk Asset
Authenticates using Client ID, Client Secret and Code.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | Server Host Address. | string | Required |
client_id | The Client ID. | string | Required |
client_secret | The Client Secret. | string | Required |
code | The Code. | string | Required |
verify_ssl | Verify SSL certificate. | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Add Attachment
Adds an attachment to a specified request in ManageEngine ServiceDesk Plus using the request ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/_uploads
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add Attachment action |
form_data | object | Required | Response data |
form_data.addtoattachment | boolean | Optional | Response data |
form_data.files | array | Optional | Response data |
form_data.files.file_name | string | Required | Response data |
form_data.files.file | string | Required | Response data |
Input Example
{"path_parameters":{"request_id":2443600536133958},"form_data":{"addtoattachment":false,"files":[{"file":"../data/files/s.png","file_name":"s.png"}]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
files | array | Output field: files |
files.content_type | string | Type of the resource |
files.size | string | Output field: files.size |
files.file_id | string | Unique identifier |
files.name | string | Name of the resource |
files.content_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"files":[{}]}}
Add attachment to a request task
Adds an attachment to a specific task within a request in ManageEngine ServiceDesk Plus using the provided request and task IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}/_uploads
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add attachment to a request task action |
path_parameters.task_id | number | Required | Parameters for the Add attachment to a request task action |
form_data | object | Required | Response data |
form_data.addtoattachment | boolean | Optional | Response data |
form_data.files | array | Optional | Response data |
form_data.files.file_name | string | Required | Response data |
form_data.files.file | string | Required | Response data |
Input Example
{"path_parameters":{"request_id":2443600536133958},"form_data":{"addtoattachment":false,"files":[{"file":"../data/files/s.png","file_name":"s.png"}]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
files | array | Output field: files |
files.content_type | string | Type of the resource |
files.size | string | Output field: files.size |
files.file_id | string | Unique identifier |
files.name | string | Name of the resource |
files.content_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"files":[{}]}}
Add Request
Adds a new service request to ManageEngine ServiceDesk Plus using the 'subject' parameter provided by the user.
Endpoint
- URL: /api/v3/requests
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.request_id | number | Optional | Parameters for the Add Request action |
parameters.subject | string | Required | Parameters for the Add Request action |
parameters.description | string | Optional | Parameters for the Add Request action |
parameters.impact_details | string | Optional | Parameters for the Add Request action |
parameters.email_ids_to_notify | string | Optional | Parameters for the Add Request action |
parameters.delete_pre_template_tasks | boolean | Optional | Parameters for the Add Request action |
Input Example
{"parameters":{"request_id":2443600536133958,"subject":"Need an External Monitor","description":"Description","impact_details":"Details of the impact","email_ids_to_notify":"[email protected]","delete_pre_template_tasks":false}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
request | object | Output field: request |
request.total_cost | string | Output field: request.total_cost |
request.subject | string | Output field: request.subject |
request.resolution | object | Output field: request.resolution |
request.resolution.add_to_linked_requests | boolean | Output field: request.resolution.add_to_linked_requests |
request.resolution.content | string | Response content |
request.is_read | boolean | Output field: request.is_read |
request.mode | object | Output field: request.mode |
request.mode.name | string | Name of the resource |
request.mode.id | string | Unique identifier |
request.lifecycle | object | Output field: request.lifecycle |
request.lifecycle.inactive | boolean | Output field: request.lifecycle.inactive |
request.lifecycle.is_published | boolean | Output field: request.lifecycle.is_published |
request.lifecycle.name | string | Name of the resource |
request.lifecycle.id | string | Unique identifier |
request.assets | array | Output field: request.assets |
request.assets.name | string | Name of the resource |
request.assets.id | string | Unique identifier |
request.assets.barcode | string | Output field: request.assets.barcode |
request.configuration_items | array | Output field: request.configuration_items |
request.configuration_items.linked_instance | string | Output field: request.configuration_items.linked_instance |
request.configuration_items.name | string | Name of the resource |
request.configuration_items.id | string | Unique identifier |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"request":{"total_cost":"250","subject":"Need an External Monitor","resolution":{},"is_read":false,"mode":{},"lifecycle":{},"assets":[],"configuration_items":[],"project_id":"test-project_id","cancellation_requested":false,"is_trashed":false,"has_change_initiated_request":"true","id":"2290537481381500","assigned_time":{}}}}
Add Request Approval
Adds an approval for a specific request in ManageEngine ServiceDesk Plus using the request ID and approval level ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/approval_levels/{{approval_level_id}}/approvals
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add Request Approval action |
path_parameters.approval_level_id | number | Required | Parameters for the Add Request Approval action |
parameters.comments | string | Optional | Comments given on the approval by the approver [Max-length 250] |
parameters.approver | object | Optional | Approver of the approval |
parameters.approver.email_id | string | Optional | Parameters for the Add Request Approval action |
parameters.original_approver | object | Optional | The back approver, to whom the approval has been sent when the approver is on leave/not available |
parameters.original_approver.email_id | string | Optional | Parameters for the Add Request Approval action |
parameters.xpath | object | Optional | Parameters for the Add Request Approval action |
parameters.xpath.path | string | Optional | Parameters for the Add Request Approval action |
parameters.xpath.display_name | string | Optional | Parameters for the Add Request Approval action |
Input Example
{"parameters":{"comments":"Comments for why this entity is approved/rejected","approver":{"email_id":"[email protected]"},"original_approver":{"email_id":"[email protected]"},"xpath":{"path":"orgroles.udf_ref6","display_name":"General Manager"}},"path_parameters":{"request_id":2443600536133958,"approval_level_id":234567890123456}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
approval | object | Output field: approval |
approval.approver | object | Output field: approval.approver |
approval.approver.email_id | string | Unique identifier |
approval.approver.is_technician | boolean | Output field: approval.approver.is_technician |
approval.approver.sms_mail | string | Output field: approval.approver.sms_mail |
approval.approver.phone | string | Output field: approval.approver.phone |
approval.approver.name | string | Name of the resource |
approval.approver.mobile | string | Output field: approval.approver.mobile |
approval.approver.id | string | Unique identifier |
approval.approver.photo_url | string | URL endpoint for the request |
approval.approver.is_vip_user | boolean | Output field: approval.approver.is_vip_user |
approval.xpath | object | Output field: approval.xpath |
approval.xpath.path | object | Output field: approval.xpath.path |
approval.comments | string | Output field: approval.comments |
approval.original_approver | object | Output field: approval.original_approver |
approval.original_approver.email_id | string | Unique identifier |
approval.original_approver.is_technician | boolean | Output field: approval.original_approver.is_technician |
approval.original_approver.sms_mail | string | Output field: approval.original_approver.sms_mail |
approval.original_approver.phone | string | Output field: approval.original_approver.phone |
approval.original_approver.name | string | Name of the resource |
approval.original_approver.mobile | string | Output field: approval.original_approver.mobile |
approval.original_approver.id | string | Unique identifier |
approval.original_approver.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"approval":{"approver":{},"xpath":{},"comments":"Comments for why this entity is approved/rejected","original_approver":{},"approval_level":{}}}}
Add Request Note
Adds a note to an existing request in ManageEngine ServiceDesk Plus using the specified request ID and note description.
Endpoint
- URL: /api/v3/requests/{{request_id}}/notes
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add Request Note action |
parameters.description | string | Required | Indicates the description of the Note |
parameters.show_to_requester | boolean | Optional | Parameters for the Add Request Note action |
parameters.notify_technician | boolean | Optional | Parameters for the Add Request Note action |
parameters.mark_first_response | boolean | Optional | Parameters for the Add Request Note action |
parameters.add_to_linked_requests | boolean | Optional | Parameters for the Add Request Note action |
Input Example
{"parameters":{"description":"The following is the note for the associated request","show_to_requester":false,"notify_technician":false,"mark_first_response":false,"add_to_linked_requests":false},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
request_note | object | Output field: request_note |
request_note.mark_first_response | boolean | Output field: request_note.mark_first_response |
request_note.created_time | object | Time value |
request_note.created_time.display_value | string | Value for the parameter |
request_note.created_time.value | string | Value for the parameter |
request_note.add_to_linked_requests | boolean | Output field: request_note.add_to_linked_requests |
request_note.request | object | Output field: request_note.request |
request_note.request.display_id | string | Unique identifier |
request_note.request.subject | string | Output field: request_note.request.subject |
request_note.request.id | string | Unique identifier |
request_note.notify_technician | boolean | Output field: request_note.notify_technician |
request_note.show_to_requester | boolean | Output field: request_note.show_to_requester |
request_note.description | string | Output field: request_note.description |
request_note.id | string | Unique identifier |
request_note.created_by | object | Output field: request_note.created_by |
request_note.created_by.email_id | string | Unique identifier |
request_note.created_by.is_technician | boolean | Output field: request_note.created_by.is_technician |
request_note.created_by.sms_mail | string | Output field: request_note.created_by.sms_mail |
request_note.created_by.phone | string | Output field: request_note.created_by.phone |
request_note.created_by.name | string | Name of the resource |
request_note.created_by.mobile | string | Output field: request_note.created_by.mobile |
request_note.created_by.id | string | Unique identifier |
request_note.created_by.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"request_note":{"mark_first_response":false,"created_time":{},"add_to_linked_requests":false,"request":{},"notify_technician":false,"show_to_requester":false,"description":"The following is the note for the associated request","id":"1997129173325228","created_by":{}}}}
Add Request Task
Adds a new task to an existing request in ManageEngine ServiceDesk Plus using the specified request ID and task title.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add Request Task action |
parameters.title | string | Required | Title of the task |
parameters.description | string | Optional | Parameters for the Add Request Task action |
parameters.scheduled_start_time | object | Optional | Parameters for the Add Request Task action |
parameters.scheduled_start_time.value | string | Optional | Parameters for the Add Request Task action |
parameters.scheduled_end_time | object | Optional | Parameters for the Add Request Task action |
parameters.scheduled_end_time.value | string | Optional | Parameters for the Add Request Task action |
parameters.actual_start_time | object | Optional | Parameters for the Add Request Task action |
parameters.actual_start_time.value | string | Optional | Parameters for the Add Request Task action |
Input Example
{"parameters":{"title":"Create SRS","description":"The SRS must contain all the requirements for the feature","scheduled_start_time":{"value":"1421988300000"},"scheduled_end_time":{"value":"1512974940000"},"actual_start_time":{"value":"1421988300000"}},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
task | object | Output field: task |
task.percentage_completion | string | Output field: task.percentage_completion |
task.request | object | Output field: task.request |
task.request.id | string | Unique identifier |
task.estimated_effort_hours | string | Output field: task.estimated_effort_hours |
task.attachments | array | Output field: task.attachments |
task.attachments.file_name | string | Name of the resource |
task.attachments.file | string | Output field: task.attachments.file |
task.email_before | string | Output field: task.email_before |
task.description | string | Output field: task.description |
task.title | string | Output field: task.title |
task.marked_technician | object | Output field: task.marked_technician |
task.marked_technician.email_id | string | Unique identifier |
task.marked_technician.is_technician | boolean | Output field: task.marked_technician.is_technician |
task.marked_technician.sms_mail | string | Output field: task.marked_technician.sms_mail |
task.marked_technician.phone | string | Output field: task.marked_technician.phone |
task.marked_technician.name | string | Name of the resource |
task.marked_technician.mobile | string | Output field: task.marked_technician.mobile |
task.marked_technician.id | string | Unique identifier |
task.marked_technician.photo_url | string | URL endpoint for the request |
task.marked_technician.is_vip_user | boolean | Output field: task.marked_technician.is_vip_user |
task.marked_technician.department | object | Output field: task.marked_technician.department |
task.overdue | boolean | Output field: task.overdue |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"task":{"percentage_completion":"30","request":{},"estimated_effort_hours":"20","attachments":[],"email_before":"3600000","description":"The SRS must contain all the requirements for the feature","title":"Create SRS","marked_technician":{},"overdue":false,"additional_cost":"100","actual_end_time":{},"id":"1504379411346066","actual_start_time":{},"owner":{},"associated_entity":"request"}}}
Add Request Task Worklog
Adds a worklog entry for a specific task within a request in ManageEngine ServiceDesk Plus, requiring request_id, task_id, and owner.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}/worklogs
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add Request Task Worklog action |
path_parameters.task_id | number | Required | Parameters for the Add Request Task Worklog action |
parameters.owner | string | Required | Owner of the worklog |
parameters.description | string | Optional | Parameters for the Add Request Task Worklog action |
parameters.start_time | object | Optional | Parameters for the Add Request Task Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Add Request Task Worklog action |
parameters.end_time | object | Optional | Parameters for the Add Request Task Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Add Request Task Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Add Request Task Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Add Request Task Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
worklog | object | Output field: worklog |
worklog.owner | object | Output field: worklog.owner |
worklog.owner.email_id | string | Unique identifier |
worklog.owner.is_technician | boolean | Output field: worklog.owner.is_technician |
worklog.owner.sms_mail | string | Output field: worklog.owner.sms_mail |
worklog.owner.phone | string | Output field: worklog.owner.phone |
worklog.owner.name | string | Name of the resource |
worklog.owner.mobile | string | Output field: worklog.owner.mobile |
worklog.owner.id | string | Unique identifier |
worklog.owner.photo_url | string | URL endpoint for the request |
worklog.owner.is_vip_user | boolean | Output field: worklog.owner.is_vip_user |
worklog.include_nonoperational_hours | boolean | Output field: worklog.include_nonoperational_hours |
worklog.end_time | object | Time value |
worklog.end_time.display_value | string | Value for the parameter |
worklog.end_time.value | string | Value for the parameter |
worklog.description | string | Output field: worklog.description |
worklog.other_charge | number | Output field: worklog.other_charge |
worklog.total_charge | number | Output field: worklog.total_charge |
worklog.created_by | object | Output field: worklog.created_by |
worklog.created_by.email_id | string | Unique identifier |
worklog.created_by.is_technician | boolean | Output field: worklog.created_by.is_technician |
worklog.created_by.sms_mail | string | Output field: worklog.created_by.sms_mail |
worklog.created_by.phone | string | Output field: worklog.created_by.phone |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"worklog":{"owner":{},"include_nonoperational_hours":false,"end_time":{},"description":"test-description","other_charge":1343434.4333,"total_charge":1343434.4333,"created_by":{},"recorded_time":{},"tech_charge":1343434.4333,"time_spent":{},"mark_first_response":false,"start_time":{},"worklog_type":{},"id":"2469549357974301"}}}
Add Request Worklog
Adds a worklog entry to a specific request in ManageEngine ServiceDesk Plus using the request ID and owner details.
Endpoint
- URL: /api/v3/requests/{{request_id}}/worklogs
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Add Request Worklog action |
parameters.owner | string | Required | Owner for the worklog |
parameters.description | string | Optional | Parameters for the Add Request Worklog action |
parameters.start_time | object | Optional | Parameters for the Add Request Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Add Request Worklog action |
parameters.end_time | object | Optional | Parameters for the Add Request Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Add Request Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Add Request Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Add Request Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
worklog | object | Output field: worklog |
worklog.owner | object | Output field: worklog.owner |
worklog.owner.email_id | string | Unique identifier |
worklog.owner.is_technician | boolean | Output field: worklog.owner.is_technician |
worklog.owner.sms_mail | string | Output field: worklog.owner.sms_mail |
worklog.owner.phone | string | Output field: worklog.owner.phone |
worklog.owner.name | string | Name of the resource |
worklog.owner.mobile | string | Output field: worklog.owner.mobile |
worklog.owner.id | string | Unique identifier |
worklog.owner.photo_url | string | URL endpoint for the request |
worklog.owner.is_vip_user | boolean | Output field: worklog.owner.is_vip_user |
worklog.include_nonoperational_hours | boolean | Output field: worklog.include_nonoperational_hours |
worklog.end_time | object | Time value |
worklog.end_time.display_value | string | Value for the parameter |
worklog.end_time.value | string | Value for the parameter |
worklog.description | string | Output field: worklog.description |
worklog.other_charge | number | Output field: worklog.other_charge |
worklog.total_charge | number | Output field: worklog.total_charge |
worklog.created_by | object | Output field: worklog.created_by |
worklog.created_by.email_id | string | Unique identifier |
worklog.created_by.is_technician | boolean | Output field: worklog.created_by.is_technician |
worklog.created_by.sms_mail | string | Output field: worklog.created_by.sms_mail |
worklog.created_by.phone | string | Output field: worklog.created_by.phone |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"worklog":{"owner":{},"include_nonoperational_hours":false,"end_time":{},"description":"test-description","other_charge":1343434.4333,"total_charge":1343434.4333,"created_by":{},"recorded_time":{},"tech_charge":1343434.4333,"time_spent":{},"mark_first_response":false,"start_time":{},"worklog_type":{},"id":"2469549357974301"}}}
Delete Request
Permanently removes a specified request from ManageEngine ServiceDesk Plus using the request ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Delete Request action |
Input Example
{"path_parameters":{"request_id":2079997951635005}}
Delete Request Approval
Deletes a specified request approval in ManageEngine ServiceDesk Plus using the request ID, approval level ID, and approval ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/approval_levels/{{approval_level_id}}/approvals/{{approval_id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Delete Request Approval action |
path_parameters.approval_level_id | number | Required | Parameters for the Delete Request Approval action |
path_parameters.approval_id | number | Required | Parameters for the Delete Request Approval action |
Input Example
{"path_parameters":{"request_id":573363737610000,"approval_level_id":234567890123456,"approval_id":1807795817979319}}
Delete Request Note
Remove a specific note from a service request in ManageEngine ServiceDesk Plus using the request ID and note ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/notes/{{request_note_id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Delete Request Note action |
path_parameters.request_note_id | number | Required | Parameters for the Delete Request Note action |
Input Example
{"path_parameters":{"request_id":2443600536133958,"request_note_id":2156096055331149}}
Delete Request Task
Deletes a specific task from a service request in ManageEngine ServiceDesk Plus using the provided request and task IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Delete Request Task action |
path_parameters.task_id | number | Required | Parameters for the Delete Request Task action |
Input Example
{"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512}}
Delete Request Task Worklog
Deletes a specified worklog for a task within a request in ManageEngine ServiceDesk Plus using the provided request, task, and worklog IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}/worklogs/{{worklog_id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Delete Request Task Worklog action |
path_parameters.task_id | number | Required | Parameters for the Delete Request Task Worklog action |
path_parameters.worklog_id | number | Required | Parameters for the Delete Request Task Worklog action |
Input Example
{"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512,"worklog_id":1778953679609145}}
Delete Request Worklog
Deletes a specific worklog entry from a service request in ManageEngine ServiceDesk Plus using the provided request and worklog IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/worklogs/{{worklog_id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Delete Request Worklog action |
path_parameters.worklog_id | number | Required | Parameters for the Delete Request Worklog action |
Input Example
{"path_parameters":{"request_id":2443600536133958,"worklog_id":1778953679609145}}
Edit Request Note
Updates an existing note for a specific request in ManageEngine ServiceDesk Plus using the request ID and note ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/notes/{{request_note_id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Edit Request Note action |
path_parameters.request_note_id | number | Required | Parameters for the Edit Request Note action |
parameters.mark_first_response | boolean | Optional | Parameters for the Edit Request Note action |
parameters.add_to_linked_requests | boolean | Optional | Parameters for the Edit Request Note action |
parameters.notify_technician | boolean | Optional | Parameters for the Edit Request Note action |
parameters.show_to_requester | boolean | Optional | Parameters for the Edit Request Note action |
parameters.description | string | Optional | Parameters for the Edit Request Note action |
Input Example
{"parameters":{"mark_first_response":false,"add_to_linked_requests":false,"notify_technician":false,"show_to_requester":false,"description":"The following is the note for the associated request"},"path_parameters":{"request_id":2443600536133958,"request_note_id":2156096055331149}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
request_note | object | Output field: request_note |
request_note.mark_first_response | boolean | Output field: request_note.mark_first_response |
request_note.created_time | object | Time value |
request_note.created_time.display_value | string | Value for the parameter |
request_note.created_time.value | string | Value for the parameter |
request_note.add_to_linked_requests | boolean | Output field: request_note.add_to_linked_requests |
request_note.request | object | Output field: request_note.request |
request_note.request.display_id | string | Unique identifier |
request_note.request.subject | string | Output field: request_note.request.subject |
request_note.request.id | string | Unique identifier |
request_note.notify_technician | boolean | Output field: request_note.notify_technician |
request_note.show_to_requester | boolean | Output field: request_note.show_to_requester |
request_note.description | string | Output field: request_note.description |
request_note.id | string | Unique identifier |
request_note.created_by | object | Output field: request_note.created_by |
request_note.created_by.email_id | string | Unique identifier |
request_note.created_by.is_technician | boolean | Output field: request_note.created_by.is_technician |
request_note.created_by.sms_mail | string | Output field: request_note.created_by.sms_mail |
request_note.created_by.phone | string | Output field: request_note.created_by.phone |
request_note.created_by.name | string | Name of the resource |
request_note.created_by.mobile | string | Output field: request_note.created_by.mobile |
request_note.created_by.id | string | Unique identifier |
request_note.created_by.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"request_note":{"mark_first_response":false,"created_time":{},"add_to_linked_requests":false,"request":{},"notify_technician":false,"show_to_requester":false,"description":"The following is the note for the associated request","id":"2156096055331149","created_by":{}}}}
Edit Request Task
Update a specific task within a request in ManageEngine ServiceDesk Plus using the provided request and task IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Edit Request Task action |
path_parameters.task_id | number | Required | Parameters for the Edit Request Task action |
parameters.title | string | Optional | Parameters for the Edit Request Task action |
parameters.description | string | Optional | Parameters for the Edit Request Task action |
parameters.scheduled_start_time | object | Optional | Parameters for the Edit Request Task action |
parameters.scheduled_start_time.value | string | Optional | Parameters for the Edit Request Task action |
parameters.scheduled_end_time | object | Optional | Parameters for the Edit Request Task action |
parameters.scheduled_end_time.value | string | Optional | Parameters for the Edit Request Task action |
parameters.actual_start_time | object | Optional | Parameters for the Edit Request Task action |
parameters.actual_start_time.value | string | Optional | Parameters for the Edit Request Task action |
Input Example
{"parameters":{"title":"Create SRS","description":"The SRS must contain all the requirements for the feature","scheduled_start_time":{"value":"1421988300000"},"scheduled_end_time":{"value":"1512974940000"},"actual_start_time":{"value":"1421988300000"}},"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
task | object | Output field: task |
task.percentage_completion | string | Output field: task.percentage_completion |
task.request | object | Output field: task.request |
task.request.id | string | Unique identifier |
task.estimated_effort_hours | string | Output field: task.estimated_effort_hours |
task.attachments | array | Output field: task.attachments |
task.attachments.file_name | string | Name of the resource |
task.attachments.file | string | Output field: task.attachments.file |
task.email_before | string | Output field: task.email_before |
task.description | string | Output field: task.description |
task.title | string | Output field: task.title |
task.marked_technician | object | Output field: task.marked_technician |
task.marked_technician.email_id | string | Unique identifier |
task.marked_technician.is_technician | boolean | Output field: task.marked_technician.is_technician |
task.marked_technician.sms_mail | string | Output field: task.marked_technician.sms_mail |
task.marked_technician.phone | string | Output field: task.marked_technician.phone |
task.marked_technician.name | string | Name of the resource |
task.marked_technician.mobile | string | Output field: task.marked_technician.mobile |
task.marked_technician.id | string | Unique identifier |
task.marked_technician.photo_url | string | URL endpoint for the request |
task.marked_technician.is_vip_user | boolean | Output field: task.marked_technician.is_vip_user |
task.marked_technician.department | object | Output field: task.marked_technician.department |
task.overdue | boolean | Output field: task.overdue |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"task":{"percentage_completion":"30","request":{},"estimated_effort_hours":"20","attachments":[],"email_before":"3600000","description":"The SRS must contain all the requirements for the feature","title":"Create SRS","marked_technician":{},"overdue":false,"additional_cost":"100","actual_end_time":{},"id":"1850904131920933","actual_start_time":{},"owner":{},"associated_entity":"request"}}}
Edit Request Task Worklog
Updates the worklog for a specific task within a request in ManageEngine ServiceDesk Plus using the provided request, task, and worklog IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}/worklogs/{{worklog_id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Edit Request Task Worklog action |
path_parameters.task_id | number | Required | Parameters for the Edit Request Task Worklog action |
path_parameters.worklog_id | number | Required | Parameters for the Edit Request Task Worklog action |
parameters.owner | string | Optional | Parameters for the Edit Request Task Worklog action |
parameters.description | string | Optional | Parameters for the Edit Request Task Worklog action |
parameters.start_time | object | Optional | Parameters for the Edit Request Task Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Edit Request Task Worklog action |
parameters.end_time | object | Optional | Parameters for the Edit Request Task Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Edit Request Task Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Edit Request Task Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Edit Request Task Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512,"worklog_id":1509662054134177}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
worklog | object | Output field: worklog |
worklog.owner | object | Output field: worklog.owner |
worklog.owner.email_id | string | Unique identifier |
worklog.owner.is_technician | boolean | Output field: worklog.owner.is_technician |
worklog.owner.sms_mail | string | Output field: worklog.owner.sms_mail |
worklog.owner.phone | string | Output field: worklog.owner.phone |
worklog.owner.name | string | Name of the resource |
worklog.owner.mobile | string | Output field: worklog.owner.mobile |
worklog.owner.id | string | Unique identifier |
worklog.owner.photo_url | string | URL endpoint for the request |
worklog.owner.is_vip_user | boolean | Output field: worklog.owner.is_vip_user |
worklog.include_nonoperational_hours | boolean | Output field: worklog.include_nonoperational_hours |
worklog.end_time | object | Time value |
worklog.end_time.display_value | string | Value for the parameter |
worklog.end_time.value | string | Value for the parameter |
worklog.description | string | Output field: worklog.description |
worklog.other_charge | number | Output field: worklog.other_charge |
worklog.total_charge | number | Output field: worklog.total_charge |
worklog.created_by | object | Output field: worklog.created_by |
worklog.created_by.email_id | string | Unique identifier |
worklog.created_by.is_technician | boolean | Output field: worklog.created_by.is_technician |
worklog.created_by.sms_mail | string | Output field: worklog.created_by.sms_mail |
worklog.created_by.phone | string | Output field: worklog.created_by.phone |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"worklog":{"owner":{},"include_nonoperational_hours":false,"end_time":{},"description":"test-description","other_charge":1343434.4333,"total_charge":1343434.4333,"created_by":{},"recorded_time":{},"tech_charge":1343434.4333,"time_spent":{},"mark_first_response":false,"start_time":{},"worklog_type":{},"id":"1778953679609145"}}}
Edit Request Worklog
Updates the worklog for a specific request in ManageEngine ServiceDesk Plus using request and worklog IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/worklogs/{{worklog_id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Edit Request Worklog action |
path_parameters.worklog_id | number | Required | Parameters for the Edit Request Worklog action |
parameters.owner | string | Optional | Parameters for the Edit Request Worklog action |
parameters.description | string | Optional | Parameters for the Edit Request Worklog action |
parameters.start_time | object | Optional | Parameters for the Edit Request Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Edit Request Worklog action |
parameters.end_time | object | Optional | Parameters for the Edit Request Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Edit Request Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Edit Request Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Edit Request Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958,"worklog_id":1778953679609145}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
worklog | object | Output field: worklog |
worklog.owner | object | Output field: worklog.owner |
worklog.owner.email_id | string | Unique identifier |
worklog.owner.is_technician | boolean | Output field: worklog.owner.is_technician |
worklog.owner.sms_mail | string | Output field: worklog.owner.sms_mail |
worklog.owner.phone | string | Output field: worklog.owner.phone |
worklog.owner.name | string | Name of the resource |
worklog.owner.mobile | string | Output field: worklog.owner.mobile |
worklog.owner.id | string | Unique identifier |
worklog.owner.photo_url | string | URL endpoint for the request |
worklog.owner.is_vip_user | boolean | Output field: worklog.owner.is_vip_user |
worklog.include_nonoperational_hours | boolean | Output field: worklog.include_nonoperational_hours |
worklog.end_time | object | Time value |
worklog.end_time.display_value | string | Value for the parameter |
worklog.end_time.value | string | Value for the parameter |
worklog.description | string | Output field: worklog.description |
worklog.other_charge | number | Output field: worklog.other_charge |
worklog.total_charge | number | Output field: worklog.total_charge |
worklog.created_by | object | Output field: worklog.created_by |
worklog.created_by.email_id | string | Unique identifier |
worklog.created_by.is_technician | boolean | Output field: worklog.created_by.is_technician |
worklog.created_by.sms_mail | string | Output field: worklog.created_by.sms_mail |
worklog.created_by.phone | string | Output field: worklog.created_by.phone |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"worklog":{"owner":{},"include_nonoperational_hours":false,"end_time":{},"description":"test-description","other_charge":1343434.4333,"total_charge":1343434.4333,"created_by":{},"recorded_time":{},"tech_charge":1343434.4333,"time_spent":{},"mark_first_response":false,"start_time":{},"worklog_type":{},"id":"1778953679609145"}}}
Get List Request
Retrieve all service requests from ManageEngine ServiceDesk Plus, providing a comprehensive overview of user submissions.
Endpoint
- URL: /api/v3/requests
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.id | number | Optional | Parameters for the Get List Request action |
parameters.subject | string | Optional | Parameters for the Get List Request action |
parameters.update_reason | string | Optional | Parameters for the Get List Request action |
parameters.created_time | string | Optional | Parameters for the Get List Request action |
parameters.due_by_time | string | Optional | Parameters for the Get List Request action |
parameters.scheduled_start_time | string | Optional | Parameters for the Get List Request action |
Input Example
{"parameters":{"id":2079997951635005,"subject":"Need an External Monitor","update_reason":"The request is updated for this reason","created_time":"Nov 10, 2016 11:44 AM","due_by_time":"Nov 10, 2016 11:44 AM","scheduled_start_time":"Nov 10, 2016 11:44 AM"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
list_info | object | Output field: list_info |
list_info.has_more_rows | boolean | Output field: list_info.has_more_rows |
list_info.start_index | number | Output field: list_info.start_index |
list_info.sort_field | string | Output field: list_info.sort_field |
list_info.page | number | Output field: list_info.page |
list_info.sort_order | string | Output field: list_info.sort_order |
list_info.row_count | number | Count value |
requests | array | Output field: requests |
requests.total_cost | string | Output field: requests.total_cost |
requests.subject | string | Output field: requests.subject |
requests.cancellation_requested | boolean | Output field: requests.cancellation_requested |
requests.id | string | Unique identifier |
requests.group | object | Output field: requests.group |
requests.group.site | string | Output field: requests.group.site |
requests.group.deleted | boolean | Output field: requests.group.deleted |
requests.group.name | string | Name of the resource |
requests.group.id | string | Unique identifier |
requests.requester | object | Output field: requests.requester |
requests.requester.email_id | string | Unique identifier |
requests.requester.is_technician | boolean | Output field: requests.requester.is_technician |
requests.requester.sms_mail | string | Output field: requests.requester.sms_mail |
requests.requester.phone | string | Output field: requests.requester.phone |
requests.requester.name | string | Name of the resource |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"list_info":{"has_more_rows":false,"start_index":1,"sort_field":"created_time","page":1,"sort_order":"desc","row_count":3},"requests":[{}]}}
Get List Request Approval
Retrieve all approval details for a specific request and approval level in ManageEngine ServiceDesk Plus, using the request_id and approval_level_id.
Endpoint
- URL: /api/v3/requests/{{request_id}}/approval_levels/{{approval_level_id}}/approvals
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get List Request Approval action |
path_parameters.approval_level_id | number | Required | Parameters for the Get List Request Approval action |
parameters.comments | string | Optional | Parameters for the Get List Request Approval action |
parameters.approver | object | Optional | Parameters for the Get List Request Approval action |
parameters.approver.email_id | string | Optional | Parameters for the Get List Request Approval action |
parameters.approver.name | string | Optional | Parameters for the Get List Request Approval action |
parameters.approver.id | string | Optional | Parameters for the Get List Request Approval action |
parameters.original_approver | object | Optional | Parameters for the Get List Request Approval action |
parameters.original_approver.name | string | Optional | Parameters for the Get List Request Approval action |
parameters.original_approver.id | string | Optional | Parameters for the Get List Request Approval action |
parameters.xpath | object | Optional | Parameters for the Get List Request Approval action |
parameters.xpath.path | string | Optional | Parameters for the Get List Request Approval action |
parameters.xpath.display_name | string | Optional | Parameters for the Get List Request Approval action |
Input Example
{"parameters":{"comments":"Comments for why this entity is approved/rejected","approver":{"email_id":"[email protected]","name":"test-approver","id":"234567890123456"},"original_approver":{"name":"test-original_approver","id":"234567890123456"},"xpath":{"path":"org_roles.org_ref1","display_name":"General Manager"}},"path_parameters":{"request_id":573363737610000,"approval_level_id":234567890123456}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
approvals | array | Output field: approvals |
approvals.approver | object | Output field: approvals.approver |
approvals.approver.email_id | string | Unique identifier |
approvals.approver.is_technician | boolean | Output field: approvals.approver.is_technician |
approvals.approver.sms_mail | string | Output field: approvals.approver.sms_mail |
approvals.approver.phone | string | Output field: approvals.approver.phone |
approvals.approver.name | string | Name of the resource |
approvals.approver.mobile | string | Output field: approvals.approver.mobile |
approvals.approver.id | string | Unique identifier |
approvals.approver.photo_url | string | URL endpoint for the request |
approvals.approver.is_vip_user | boolean | Output field: approvals.approver.is_vip_user |
approvals.xpath | object | Output field: approvals.xpath |
approvals.xpath.path | object | Output field: approvals.xpath.path |
approvals.comments | string | Output field: approvals.comments |
approvals.original_approver | object | Output field: approvals.original_approver |
approvals.original_approver.email_id | string | Unique identifier |
approvals.original_approver.is_technician | boolean | Output field: approvals.original_approver.is_technician |
approvals.original_approver.sms_mail | string | Output field: approvals.original_approver.sms_mail |
approvals.original_approver.phone | string | Output field: approvals.original_approver.phone |
approvals.original_approver.name | string | Name of the resource |
approvals.original_approver.mobile | string | Output field: approvals.original_approver.mobile |
approvals.original_approver.id | string | Unique identifier |
approvals.original_approver.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"approvals":[{}]}}
Get List Request Note
Retrieve all notes associated with a given request ID in ManageEngine ServiceDesk Plus.
Endpoint
- URL: /api/v3/requests/{{request_id}}/notes
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get List Request Note action |
parameters.description | string | Optional | Parameters for the Get List Request Note action |
parameters.show_to_requester | boolean | Optional | Parameters for the Get List Request Note action |
parameters.notify_technician | boolean | Optional | Parameters for the Get List Request Note action |
parameters.mark_first_response | boolean | Optional | Parameters for the Get List Request Note action |
parameters.add_to_linked_requests | boolean | Optional | Parameters for the Get List Request Note action |
Input Example
{"parameters":{"description":"The following is the note for the associated request","show_to_requester":false,"notify_technician":false,"mark_first_response":false,"add_to_linked_requests":false},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
notes | array | Output field: notes |
notes.mark_first_response | boolean | Output field: notes.mark_first_response |
notes.created_time | object | Time value |
notes.created_time.display_value | string | Value for the parameter |
notes.created_time.value | string | Value for the parameter |
notes.add_to_linked_requests | boolean | Output field: notes.add_to_linked_requests |
notes.request | object | Output field: notes.request |
notes.request.display_id | string | Unique identifier |
notes.request.subject | string | Output field: notes.request.subject |
notes.request.id | string | Unique identifier |
notes.notify_technician | boolean | Output field: notes.notify_technician |
notes.show_to_requester | boolean | Output field: notes.show_to_requester |
notes.description | string | Output field: notes.description |
notes.id | string | Unique identifier |
notes.created_by | object | Output field: notes.created_by |
notes.created_by.email_id | string | Unique identifier |
notes.created_by.is_technician | boolean | Output field: notes.created_by.is_technician |
notes.created_by.sms_mail | string | Output field: notes.created_by.sms_mail |
notes.created_by.phone | string | Output field: notes.created_by.phone |
notes.created_by.name | string | Name of the resource |
notes.created_by.mobile | string | Output field: notes.created_by.mobile |
notes.created_by.id | string | Unique identifier |
notes.created_by.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"notes":[{}]}}
Get List Request Task
Retrieve all tasks associated with a specific request in ManageEngine ServiceDesk Plus using the request ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get List Request Task action |
parameters.title | string | Optional | Parameters for the Get List Request Task action |
parameters.description | string | Optional | Parameters for the Get List Request Task action |
parameters.scheduled_start_time | object | Optional | Parameters for the Get List Request Task action |
parameters.scheduled_start_time.value | string | Optional | Parameters for the Get List Request Task action |
parameters.scheduled_end_time | object | Optional | Parameters for the Get List Request Task action |
parameters.scheduled_end_time.value | string | Optional | Parameters for the Get List Request Task action |
parameters.actual_start_time | object | Optional | Parameters for the Get List Request Task action |
parameters.actual_start_time.value | string | Optional | Parameters for the Get List Request Task action |
Input Example
{"parameters":{"title":"Create SRS","description":"The SRS must contain all the requirements for the feature","scheduled_start_time":{"value":"1421988300000"},"scheduled_end_time":{"value":"1512974940000"},"actual_start_time":{"value":"1421988300000"}},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
list_info | object | Output field: list_info |
list_info.has_more_rows | boolean | Output field: list_info.has_more_rows |
list_info.row_count | number | Count value |
tasks | array | Output field: tasks |
tasks.percentage_completion | string | Output field: tasks.percentage_completion |
tasks.request | object | Output field: tasks.request |
tasks.request.id | string | Unique identifier |
tasks.estimated_effort_hours | string | Output field: tasks.estimated_effort_hours |
tasks.email_before | string | Output field: tasks.email_before |
tasks.description | string | Output field: tasks.description |
tasks.title | string | Output field: tasks.title |
tasks.marked_technician | object | Output field: tasks.marked_technician |
tasks.marked_technician.email_id | string | Unique identifier |
tasks.marked_technician.is_technician | boolean | Output field: tasks.marked_technician.is_technician |
tasks.marked_technician.sms_mail | string | Output field: tasks.marked_technician.sms_mail |
tasks.marked_technician.phone | string | Output field: tasks.marked_technician.phone |
tasks.marked_technician.name | string | Name of the resource |
tasks.marked_technician.mobile | string | Output field: tasks.marked_technician.mobile |
tasks.marked_technician.id | string | Unique identifier |
tasks.marked_technician.photo_url | string | URL endpoint for the request |
tasks.marked_technician.is_vip_user | boolean | Output field: tasks.marked_technician.is_vip_user |
tasks.marked_technician.department | object | Output field: tasks.marked_technician.department |
tasks.overdue | boolean | Output field: tasks.overdue |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"list_info":{"has_more_rows":false,"row_count":1},"tasks":[{}]}}
Get List Request Task Worklog
Retrieve all worklogs associated with a specific task and request in ManageEngine ServiceDesk Plus, using the provided request_id and task_id.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}/worklogs
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get List Request Task Worklog action |
path_parameters.task_id | number | Required | Parameters for the Get List Request Task Worklog action |
parameters.owner | string | Optional | Parameters for the Get List Request Task Worklog action |
parameters.description | string | Optional | Parameters for the Get List Request Task Worklog action |
parameters.start_time | object | Optional | Parameters for the Get List Request Task Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Get List Request Task Worklog action |
parameters.end_time | object | Optional | Parameters for the Get List Request Task Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Get List Request Task Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Get List Request Task Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Get List Request Task Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
list_info | object | Output field: list_info |
list_info.has_more_rows | boolean | Output field: list_info.has_more_rows |
list_info.row_count | number | Count value |
worklogs | array | Output field: worklogs |
worklogs.owner | object | Output field: worklogs.owner |
worklogs.owner.email_id | string | Unique identifier |
worklogs.owner.is_technician | boolean | Output field: worklogs.owner.is_technician |
worklogs.owner.sms_mail | string | Output field: worklogs.owner.sms_mail |
worklogs.owner.phone | string | Output field: worklogs.owner.phone |
worklogs.owner.name | string | Name of the resource |
worklogs.owner.mobile | string | Output field: worklogs.owner.mobile |
worklogs.owner.id | string | Unique identifier |
worklogs.owner.photo_url | string | URL endpoint for the request |
worklogs.owner.is_vip_user | boolean | Output field: worklogs.owner.is_vip_user |
worklogs.include_nonoperational_hours | boolean | Output field: worklogs.include_nonoperational_hours |
worklogs.end_time | object | Time value |
worklogs.end_time.display_value | string | Value for the parameter |
worklogs.end_time.value | string | Value for the parameter |
worklogs.description | string | Output field: worklogs.description |
worklogs.other_charge | number | Output field: worklogs.other_charge |
worklogs.total_charge | number | Output field: worklogs.total_charge |
worklogs.id | string | Unique identifier |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"list_info":{"has_more_rows":false,"row_count":1},"worklogs":[{}]}}
Get List Request Worklog
Retrieve all worklog entries for a specific request in ManageEngine ServiceDesk Plus using the request ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/worklogs
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get List Request Worklog action |
parameters.owner | string | Optional | Parameters for the Get List Request Worklog action |
parameters.description | string | Optional | Parameters for the Get List Request Worklog action |
parameters.start_time | object | Optional | Parameters for the Get List Request Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Get List Request Worklog action |
parameters.end_time | object | Optional | Parameters for the Get List Request Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Get List Request Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Get List Request Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Get List Request Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
list_info | object | Output field: list_info |
list_info.has_more_rows | boolean | Output field: list_info.has_more_rows |
list_info.row_count | number | Count value |
worklogs | array | Output field: worklogs |
worklogs.owner | object | Output field: worklogs.owner |
worklogs.owner.email_id | string | Unique identifier |
worklogs.owner.is_technician | boolean | Output field: worklogs.owner.is_technician |
worklogs.owner.sms_mail | string | Output field: worklogs.owner.sms_mail |
worklogs.owner.phone | string | Output field: worklogs.owner.phone |
worklogs.owner.name | string | Name of the resource |
worklogs.owner.mobile | string | Output field: worklogs.owner.mobile |
worklogs.owner.id | string | Unique identifier |
worklogs.owner.photo_url | string | URL endpoint for the request |
worklogs.owner.is_vip_user | boolean | Output field: worklogs.owner.is_vip_user |
worklogs.description | string | Output field: worklogs.description |
worklogs.other_charge | number | Output field: worklogs.other_charge |
worklogs.total_charge | number | Output field: worklogs.total_charge |
worklogs.created_by | object | Output field: worklogs.created_by |
worklogs.created_by.email_id | string | Unique identifier |
worklogs.created_by.is_technician | boolean | Output field: worklogs.created_by.is_technician |
worklogs.created_by.sms_mail | string | Output field: worklogs.created_by.sms_mail |
worklogs.created_by.phone | string | Output field: worklogs.created_by.phone |
worklogs.created_by.name | string | Name of the resource |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"list_info":{"has_more_rows":false,"row_count":1},"worklogs":[{}]}}
Get Request
Retrieve detailed information for a specific request in ManageEngine ServiceDesk Plus using the provided request ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get Request action |
parameters.subject | string | Optional | Parameters for the Get Request action |
parameters.description | string | Optional | Parameters for the Get Request action |
parameters.impact_details | string | Optional | Parameters for the Get Request action |
parameters.email_ids_to_notify | string | Optional | Parameters for the Get Request action |
parameters.delete_pre_template_tasks | boolean | Optional | Parameters for the Get Request action |
Input Example
{"parameters":{"subject":"Need an External Monitor","description":"Description","impact_details":"Details of the impact","email_ids_to_notify":"[email protected]","delete_pre_template_tasks":false},"path_parameters":{"request_id":2443600536133958}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
request | object | Output field: request |
request.total_cost | string | Output field: request.total_cost |
request.subject | string | Output field: request.subject |
request.resolution | object | Output field: request.resolution |
request.resolution.add_to_linked_requests | boolean | Output field: request.resolution.add_to_linked_requests |
request.resolution.content | string | Response content |
request.is_read | boolean | Output field: request.is_read |
request.mode | object | Output field: request.mode |
request.mode.name | string | Name of the resource |
request.mode.id | string | Unique identifier |
request.lifecycle | object | Output field: request.lifecycle |
request.lifecycle.inactive | boolean | Output field: request.lifecycle.inactive |
request.lifecycle.is_published | boolean | Output field: request.lifecycle.is_published |
request.lifecycle.name | string | Name of the resource |
request.lifecycle.id | string | Unique identifier |
request.assets | array | Output field: request.assets |
request.assets.name | string | Name of the resource |
request.assets.id | string | Unique identifier |
request.assets.barcode | string | Output field: request.assets.barcode |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"request":{"total_cost":"250","subject":"Need an External Monitor","resolution":{},"is_read":false,"mode":{},"lifecycle":{},"assets":[]}}}
Get Request Approval
Retrieve approval details for a specific request in ManageEngine ServiceDesk Plus using request ID, approval level ID, and approval ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/approval_levels/{{approval_level_id}}/approvals/{{approval_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get Request Approval action |
path_parameters.approval_level_id | number | Required | Parameters for the Get Request Approval action |
path_parameters.approval_id | number | Required | Parameters for the Get Request Approval action |
parameters.comments | string | Optional | Parameters for the Get Request Approval action |
parameters.approver | object | Optional | Parameters for the Get Request Approval action |
parameters.approver.email_id | string | Optional | Parameters for the Get Request Approval action |
parameters.approver.name | string | Optional | Parameters for the Get Request Approval action |
parameters.approver.id | string | Optional | Parameters for the Get Request Approval action |
parameters.original_approver | object | Optional | Parameters for the Get Request Approval action |
parameters.original_approver.name | string | Optional | Parameters for the Get Request Approval action |
parameters.original_approver.id | string | Optional | Parameters for the Get Request Approval action |
parameters.xpath | object | Optional | Parameters for the Get Request Approval action |
parameters.xpath.path | string | Optional | Parameters for the Get Request Approval action |
parameters.xpath.display_name | string | Optional | Parameters for the Get Request Approval action |
Input Example
{"parameters":{"comments":"Comments for why this entity is approved/rejected","approver":{"email_id":"[email protected]","name":"test-approver","id":"234567890123456"},"original_approver":{"name":"test-original_approver","id":"234567890123456"},"xpath":{"path":"org_roles.org_ref1","display_name":"General Manager"}},"path_parameters":{"request_id":573363737610000,"approval_level_id":234567890123456,"approval_id":1807795817979319}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
approval | object | Output field: approval |
approval.approver | object | Output field: approval.approver |
approval.approver.email_id | string | Unique identifier |
approval.approver.is_technician | boolean | Output field: approval.approver.is_technician |
approval.approver.sms_mail | string | Output field: approval.approver.sms_mail |
approval.approver.phone | string | Output field: approval.approver.phone |
approval.approver.name | string | Name of the resource |
approval.approver.mobile | string | Output field: approval.approver.mobile |
approval.approver.id | string | Unique identifier |
approval.approver.photo_url | string | URL endpoint for the request |
approval.approver.is_vip_user | boolean | Output field: approval.approver.is_vip_user |
approval.xpath | object | Output field: approval.xpath |
approval.xpath.path | object | Output field: approval.xpath.path |
approval.comments | string | Output field: approval.comments |
approval.original_approver | object | Output field: approval.original_approver |
approval.original_approver.email_id | string | Unique identifier |
approval.original_approver.is_technician | boolean | Output field: approval.original_approver.is_technician |
approval.original_approver.sms_mail | string | Output field: approval.original_approver.sms_mail |
approval.original_approver.phone | string | Output field: approval.original_approver.phone |
approval.original_approver.name | string | Name of the resource |
approval.original_approver.mobile | string | Output field: approval.original_approver.mobile |
approval.original_approver.id | string | Unique identifier |
approval.original_approver.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"approval":{"approver":{},"xpath":{},"comments":"Comments for why this entity is approved/rejected","original_approver":{},"approval_level":{},"id":"1668157746997366","sent_on":null,"action_taken_on":null,"status":{}}}}
Get Request Note
Retrieves a specific note from a service request in ManageEngine ServiceDesk Plus using the request ID and note ID.
Endpoint
- URL: /api/v3/requests/{{request_id}}/notes/{{request_note_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get Request Note action |
path_parameters.request_note_id | number | Required | Parameters for the Get Request Note action |
parameters.mark_first_response | boolean | Optional | Parameters for the Get Request Note action |
parameters.add_to_linked_requests | boolean | Optional | Parameters for the Get Request Note action |
parameters.notify_technician | boolean | Optional | Parameters for the Get Request Note action |
parameters.show_to_requester | boolean | Optional | Parameters for the Get Request Note action |
parameters.description | string | Optional | Parameters for the Get Request Note action |
Input Example
{"parameters":{"mark_first_response":false,"add_to_linked_requests":false,"notify_technician":false,"show_to_requester":false,"description":"The following is the note for the associated request"},"path_parameters":{"request_id":2443600536133958,"request_note_id":2156096055331149}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
request_note | object | Output field: request_note |
request_note.mark_first_response | boolean | Output field: request_note.mark_first_response |
request_note.created_time | object | Time value |
request_note.created_time.display_value | string | Value for the parameter |
request_note.created_time.value | string | Value for the parameter |
request_note.add_to_linked_requests | boolean | Output field: request_note.add_to_linked_requests |
request_note.request | object | Output field: request_note.request |
request_note.request.display_id | string | Unique identifier |
request_note.request.subject | string | Output field: request_note.request.subject |
request_note.request.id | string | Unique identifier |
request_note.notify_technician | boolean | Output field: request_note.notify_technician |
request_note.show_to_requester | boolean | Output field: request_note.show_to_requester |
request_note.description | string | Output field: request_note.description |
request_note.id | string | Unique identifier |
request_note.created_by | object | Output field: request_note.created_by |
request_note.created_by.email_id | string | Unique identifier |
request_note.created_by.is_technician | boolean | Output field: request_note.created_by.is_technician |
request_note.created_by.sms_mail | string | Output field: request_note.created_by.sms_mail |
request_note.created_by.phone | string | Output field: request_note.created_by.phone |
request_note.created_by.name | string | Name of the resource |
request_note.created_by.mobile | string | Output field: request_note.created_by.mobile |
request_note.created_by.id | string | Unique identifier |
request_note.created_by.photo_url | string | URL endpoint for the request |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"request_note":{"mark_first_response":false,"created_time":{},"add_to_linked_requests":false,"request":{},"notify_technician":false,"show_to_requester":false,"description":"The following is the note for the associated request","id":"2399537119347635","created_by":{}}}}
Get Request Task
Retrieves detailed information for a specific task associated with a given request in ManageEngine ServiceDesk Plus using the request and task IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get Request Task action |
path_parameters.task_id | number | Required | Parameters for the Get Request Task action |
parameters.title | string | Optional | Parameters for the Get Request Task action |
parameters.description | string | Optional | Parameters for the Get Request Task action |
parameters.scheduled_start_time | object | Optional | Parameters for the Get Request Task action |
parameters.scheduled_start_time.value | string | Optional | Parameters for the Get Request Task action |
parameters.scheduled_end_time | object | Optional | Parameters for the Get Request Task action |
parameters.scheduled_end_time.value | string | Optional | Parameters for the Get Request Task action |
parameters.actual_start_time | object | Optional | Parameters for the Get Request Task action |
parameters.actual_start_time.value | string | Optional | Parameters for the Get Request Task action |
Input Example
{"parameters":{"title":"Create SRS","description":"The SRS must contain all the requirements for the feature","scheduled_start_time":{"value":"1421988300000"},"scheduled_end_time":{"value":"1512974940000"},"actual_start_time":{"value":"1421988300000"}},"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
task | object | Output field: task |
task.percentage_completion | string | Output field: task.percentage_completion |
task.request | object | Output field: task.request |
task.request.id | string | Unique identifier |
task.estimated_effort_hours | string | Output field: task.estimated_effort_hours |
task.attachments | array | Output field: task.attachments |
task.attachments.file_name | string | Name of the resource |
task.attachments.file | string | Output field: task.attachments.file |
task.email_before | string | Output field: task.email_before |
task.description | string | Output field: task.description |
task.title | string | Output field: task.title |
task.marked_technician | object | Output field: task.marked_technician |
task.marked_technician.email_id | string | Unique identifier |
task.marked_technician.is_technician | boolean | Output field: task.marked_technician.is_technician |
task.marked_technician.sms_mail | string | Output field: task.marked_technician.sms_mail |
task.marked_technician.phone | string | Output field: task.marked_technician.phone |
task.marked_technician.name | string | Name of the resource |
task.marked_technician.mobile | string | Output field: task.marked_technician.mobile |
task.marked_technician.id | string | Unique identifier |
task.marked_technician.photo_url | string | URL endpoint for the request |
task.marked_technician.is_vip_user | boolean | Output field: task.marked_technician.is_vip_user |
task.marked_technician.department | object | Output field: task.marked_technician.department |
task.id | string | Unique identifier |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"task":{"percentage_completion":"30","request":{},"estimated_effort_hours":"20","attachments":[],"email_before":"3600000","description":"The SRS must contain all the requirements for the feature","title":"Create SRS","marked_technician":{},"id":"1812392449864730","actual_start_time":{},"associated_entity":"request","module":"Request","priority":{}}}}
Get Request Task Worklog
Retrieve worklog details for a specific task within a request in ManageEngine ServiceDesk Plus, using the request, task, and worklog IDs.
Endpoint
- URL: /api/v3/requests/{{request_id}}/tasks/{{task_id}}/worklogs/{{worklog_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get Request Task Worklog action |
path_parameters.task_id | number | Required | Parameters for the Get Request Task Worklog action |
path_parameters.worklog_id | number | Required | Parameters for the Get Request Task Worklog action |
parameters.owner | string | Optional | Parameters for the Get Request Task Worklog action |
parameters.description | string | Optional | Parameters for the Get Request Task Worklog action |
parameters.start_time | object | Optional | Parameters for the Get Request Task Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Get Request Task Worklog action |
parameters.end_time | object | Optional | Parameters for the Get Request Task Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Get Request Task Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Get Request Task Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Get Request Task Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958,"task_id":1904788127933512,"worklog_id":1509662054134177}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
worklog | object | Output field: worklog |
worklog.owner | object | Output field: worklog.owner |
worklog.owner.email_id | string | Unique identifier |
worklog.owner.is_technician | boolean | Output field: worklog.owner.is_technician |
worklog.owner.sms_mail | string | Output field: worklog.owner.sms_mail |
worklog.owner.phone | string | Output field: worklog.owner.phone |
worklog.owner.name | string | Name of the resource |
worklog.owner.mobile | string | Output field: worklog.owner.mobile |
worklog.owner.id | string | Unique identifier |
worklog.owner.photo_url | string | URL endpoint for the request |
worklog.owner.is_vip_user | boolean | Output field: worklog.owner.is_vip_user |
worklog.include_nonoperational_hours | boolean | Output field: worklog.include_nonoperational_hours |
worklog.end_time | object | Time value |
worklog.end_time.display_value | string | Value for the parameter |
worklog.end_time.value | string | Value for the parameter |
worklog.description | string | Output field: worklog.description |
worklog.other_charge | number | Output field: worklog.other_charge |
worklog.total_charge | number | Output field: worklog.total_charge |
worklog.created_by | object | Output field: worklog.created_by |
worklog.created_by.email_id | string | Unique identifier |
worklog.created_by.is_technician | boolean | Output field: worklog.created_by.is_technician |
worklog.created_by.sms_mail | string | Output field: worklog.created_by.sms_mail |
worklog.created_by.phone | string | Output field: worklog.created_by.phone |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"worklog":{"owner":{},"include_nonoperational_hours":false,"end_time":{},"description":"test-description","other_charge":1343434.4333,"total_charge":1343434.4333,"created_by":{},"recorded_time":{},"tech_charge":1343434.4333,"time_spent":{},"mark_first_response":false,"start_time":{},"worklog_type":{},"id":"1962124438644868"}}}
Get Request Worklog
Retrieves the worklog details for a specific request using the request_id and worklog_id in ManageEngine ServiceDesk Plus.
Endpoint
- URL: /api/v3/requests/{{request_id}}/worklogs/{{worklog_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | number | Required | Parameters for the Get Request Worklog action |
path_parameters.worklog_id | number | Required | Parameters for the Get Request Worklog action |
parameters.owner | string | Optional | Parameters for the Get Request Worklog action |
parameters.description | string | Optional | Parameters for the Get Request Worklog action |
parameters.start_time | object | Optional | Parameters for the Get Request Worklog action |
parameters.start_time.value | string | Optional | Parameters for the Get Request Worklog action |
parameters.end_time | object | Optional | Parameters for the Get Request Worklog action |
parameters.end_time.value | string | Optional | Parameters for the Get Request Worklog action |
parameters.recorded_time | object | Optional | Parameters for the Get Request Worklog action |
parameters.recorded_time.value | string | Optional | Parameters for the Get Request Worklog action |
Input Example
{"parameters":{"owner":"test-owner","description":"test-description","start_time":{"value":"1421988300000"},"end_time":{"value":"1512974940000"},"recorded_time":{"value":"1478758440000"}},"path_parameters":{"request_id":2443600536133958,"worklog_id":1778953679609145}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
worklog | object | Output field: worklog |
worklog.owner | object | Output field: worklog.owner |
worklog.owner.email_id | string | Unique identifier |
worklog.owner.is_technician | boolean | Output field: worklog.owner.is_technician |
worklog.owner.sms_mail | string | Output field: worklog.owner.sms_mail |
worklog.owner.phone | string | Output field: worklog.owner.phone |
worklog.owner.name | string | Name of the resource |
worklog.owner.mobile | string | Output field: worklog.owner.mobile |
worklog.owner.id | string | Unique identifier |
worklog.owner.photo_url | string | URL endpoint for the request |
worklog.owner.is_vip_user | boolean | Output field: worklog.owner.is_vip_user |
worklog.include_nonoperational_hours | boolean | Output field: worklog.include_nonoperational_hours |
worklog.end_time | object | Time value |
worklog.end_time.display_value | string | Value for the parameter |
worklog.end_time.value | string | Value for the parameter |
worklog.description | string | Output field: worklog.description |
worklog.other_charge | number | Output field: worklog.other_charge |
worklog.total_charge | number | Output field: worklog.total_charge |
worklog.created_by | object | Output field: worklog.created_by |
worklog.created_by.email_id | string | Unique identifier |
worklog.created_by.is_technician | boolean | Output field: worklog.created_by.is_technician |
worklog.created_by.sms_mail | string | Output field: worklog.created_by.sms_mail |
worklog.created_by.phone | string | Output field: worklog.created_by.phone |
Output Example
{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"worklog":{"owner":{},"include_nonoperational_hours":false,"end_time":{},"description":"test-description","other_charge":1343434.4333,"total_charge":1343434.4333,"created_by":{},"recorded_time":{},"tech_charge":1343434.4333,"time_spent":{},"mark_first_response":false,"start_time":{},"worklog_type":{},"id":"1962124438644868"}}}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |