Sample APIs
To view the contract details to which an asset is associated through API
Tested in 14700. PURPOSE: To view the contract details through API, with the asset ID to which an asset is associated to the contract. STEPS: URL: <domain_url>/api/v3/assets/{asset_id}/contracts Method: GET Input Data: None Response:
Adding attachment to Resolution using API
PURPOSE: To add an attachment to the resolution via API. STEPS: 1) Upload the attachment file and obtain the attachment ID: URL: <domain_url>/api/v3/requests/upload Method: POST Payload: files ( input_data = <file_content> ) Response: 2) Add the ...
API call to fill the mandatory fields and close a request simultaneously
The "Close Request" API call is used to close a request. But to fill the mandatory fields if any and close a request simultaneously, the "Update Request" API call can be utilized. Example: To fill the mandatory fields like "Resolution" and "Priority" ...
Request Merge API using Postman.
Currently, the Merge API is not included in our documentation. However, I have tested the following API in Postman, and it is working fine on our end. API used: /api/v3/requests/<request_id>/merge_requests {"merge_requests":[{"id":"1"},{"id":"2"}]} ...
Request API calls Limit
Request basic operation default limits:
Invalid URL - Task API is not working - 14001
API response - throws invalid URL error apprUrl = url + "/api/v3/changes/changeid/tasks" Reason - 14001 · Support for older version of V3 API for Tasks and Worklogs is deprecated. To use the latest format of the API, add the accept header ...
How to find the department id, siteid which can be used while adding users via API
Query to find the deptid: * In order to add a user under the correct department/site, the departmentid is required. The department id can be found using the below query. * In the application UI, go to Reports - > New query report, and execute the ...
API - Listing of Worklogtype
1. Go to Admin > API > Reports > Execute Query: select * from worklogtypedefinition 2. Sharing screenshot for your reference:
API - How to create Service Request including the pre-defined tasks through API
You can get the highlighted Task Template ID's by editing a Task Template: https://serverurl:postnumber/app#/admin/task-templates/5 The Service Category ID and Template ID (as) can be known by going to Admin > Service Category > select and edit the ...
API - How to Add Service Request through API
The Service Category ID and Template ID (as) can be known by going to Admin > Service Category > select and edit the template: http://serverurl:postnumber/app#/admin/service-category/1/templates/8 { "request": { "subject": "Unable to fetch mails ...
Add / Update Account - V1 API -> for 10606
Below works in 10606 Build MSP. Account Add API URL: http://<servername>:<portnumber>/sdpapi/admin/account/ HTTP Method: POST data= { "operation": { "details": { "AccountName": "Account 7", "LoginURL": "test", "Description": "Testing", "DoorNumber": ...
Online API documentation
Dear Users You can refer to the latest API document from our online demo page available here. (Login as administrator to view the same) Once login -> Goto Admin -> API -. Documentation to refer the same. or once login done -> click the below link to ...
Reply API
Below is a sample reply API URL: http://<servername>:<portnumber>/sdpapi/request/<Request ID>/reply CALL: POST INPUT_DATA={ "operation": { "details": { "to": "to address", "cc": "cc address", "subject": "subject", "description": "description" } } }
Add attachments using API
Attachment cannot be added when a request is created, it can be only added after request creation URL : http://localhost:8080/api/v3/attachments?TECHNICIAN_KEY=XXXXXXXXX Body
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:
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", "value": "$(today)" }, { "field": ...
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, "search_fields": { "mobile": "98765432100" } }, ...
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 ...
Add request API Using Postman
You need to send the TECHNICIAN_KEY and format in Params and the data in Body. Also, you have to encode the body and send it. Please refer to the below for your reference which is sent using postman. Attached is the SAMPLE JSON file Example : ...
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 ...
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 ...