API
How to add total_time_spent in worklog using API
Please use milli-seconds as value to the attribute URL: <URL>/api/v3/worklog?OPERATION_NAME=add&TECHNICIAN_KEY=XXXXXXXXXXXXX JSON: input_date={ "worklog": { "request": { "id": "6" }, "description": "Adding a worklog", "technician": { "name": ...
10.5 API - How APIs can be used in the version 10.5 and above ?
Introduction: REST API acts as a bridge between ServiceDesk Plus MSP and other applications. The communication of information happens via HTTP Request. The REST API authenticates users using Technician Key, thus eliminating the need for the users to ...
Reply request through API (POSTMAN example)
Params: Body: Result:
Update - CMDB API - using criteria through postman
Params : Body - form-data - Refer to Input_data values from our API documentation in the application (Admin -> API - Documentation) -> CMDP - Update CI {"mode":"full","isActive":false}
CMDB API- Assigning Asset to user based on Login name, Domain name, and Account:
If just the user name is given and if there are more than one user with the same name then it gets associated to the first person who is retrieved from DB. The below API call can be used to assign the asset to the user based on Login name, Domain ...
API to get request based on date criteria like today , last 30 days
{ "list_info": { "row_count": 20, "start_index": 1, "sort_field": "subject", "sort_order": "asc", "get_total_count": true, "search_criteria": [ { "field": "last_updated_time", "condition": "between", ...
API - Get filterby
Please be informed that from the build 10500 onwards, the Parameters should be encoded for it to be working. Please check the below screenshot for your reference: Parameters ...
Close a request using API - Postman example
INPUT_DATA Value as follows {"operation": {"details": { "closeAccepted": "Accepted", "closeComment": "The closing comment" }}} PUT API example ...
API -Listing Requesters with E-mail Address
1. Encode the below mentioned and change the highlighted as per yours: { "list_info": { "sort_field": "name", "start_index": 1, "sort_order": "asc", "row_count": "100", "get_total_count": true, "search_fields": { "email_id": "req1@msp.com" } ...
API -Listing Open Requests of a specific Requester
1. Encode the below values and replace the highlighted as per yours: { "list_info": { "row_count": 20, "start_index": 1, "sort_field": "subject", "sort_order": "asc", "get_total_count": true, ...
API -Listing Requesters with Phone Number
1. Encode the below mentioned and change the highlighted as per yours: { "list_info": { "sort_field": "name", "start_index": 1, "sort_order": "asc", "row_count": "25", "get_total_count": true, ...
CMDB API - Add CI along with users name
<?xml version="1.0" encoding="UTF-8"?> <API version="1.0" locale="en"> <records> <record> <parameter> <name>CI Name</name> <value>saharsh</value> </parameter> <parameter> ...
API -Listing Account Specific Requesters
1. Encode (Used for GET calls alone) the below values thereby replacing the Account Name as per yours : { "operation":{ "details":{ "accountname": "Sample Account", "sitename": "0" } } } 2. The site name value is set as "0", which will list the ...
API -Listing Requester details based on Requester name
1. Encode the below value, thereby replacing the Account, Site Name, followed by the Requester name in "Searchstring": { "operation": { "details": { "accountname": "Sample Account", "sitename": "Sample Site", "searchstring": "Alex Smith" } } } 2. ...
API -Listing requests based on Additional Field Values
This can be met through V3 API. Go to Admin > Incident Additional Fields and make a note of the "API Field Name" as highlighted below: Please follow the below mentioned to pull the requests based on the additional field values: 1. Use the Input as ...
API to GET Requests in POSTMAN when trying to input data
When you're using GET method and trying to input data, the JSON data has to be encoded like below: %7B%22operation%22%3A%7B%22details%22%3A%7B%22from%22%3A%220%22%2C%22limit%22%3A%2250%22%2C%22filterby%22%3A%22All_Requests%22%7D%7D%7D The same can be ...
How to create a request along with requester email address through API ?
Format : INPUT_DATA= { "operation": { "details": { "subject": "Cannot browse", "description": "Unable to connect to the internet", "requester": "Will Hamilton", "requesterEmail": "will.h@mycompany.com", "site": "Sample Site", "account": "Sample ...
Pre-define 'Email IDs to notify' with API
Email ids to notify can be pre-defined while adding through v1 API. The key is "interestedParty" for the same : Please check the below example : data={ "operation": { "details": { "subject": "Cannot browse", "description": "Unable to connect to the ...
API Documentation Link
https://servicedeskplusmsp.wiki.zoho.com/REST-API-for-native-app.html
Add Attachment API assistance for other tools
Our sample html to test Add Attachment API works well. However many customers are having trouble converting it to code/other tools (Powershell, python, Postman, Curl). Hence we are posting this article to get it using Postman for other tools. We can ...