|Servlet API||REST API|
|The servlet is a form based input submission by the external applications. While the output is exposed in XML format.||The input data is sent as an XML string and the output is exposed as an XML string.|
|The http form is submitted to,
|The general form of the api url is,
|Authentication is through User Name and Password for every API operation.||Authentication is through Technician Key for every API operation.|
|Supports operations on features such as Request, Site, Technician, Requester and Assets.||Supports operations on Requests alone.|
<tr class="evenRow" valign="top">
<td><input type="text" class="txt" NAME="Manager" style="width:200px;" /></td>
In the above example, Manager is a user defined field. So the NAME field should also use the Label name of the Additional field to assign using API.
The following conditions are mandatory to close a request in ServiceDesk Plus.
Pass the attribute name as “asset” to capture the asset information in the request. Make sure that the asset specified in the API should exist in the ServiceDesk Plus.
If you are using a Requester login and if “Show workstations associated to requester in Self-Service Portal” is enabled in Admin → Self Service Portal Settings, then only the Assets associated to the requester can be parsed.
If login failed for a correct UserName and password then,
Requester do not have permission to delete requests. The login permissions provided in ServiceDesk Plus would be applied while using the API.
The servlet HTTP form submission based API supports operations such as,
Please refer to the link below regarding the attributes,
The operations performed with REST API is based on the operation' parameter and is sent to the URL via HTTP POST method. The URL format is as shown below,http://<servername>:<port number>/sdpapi/<module>
Authentication to the ServiceDesk Plus application is key based i.e., an API key is sent along with the URL for every operation. This key is technician based and can be generate for technicians with login privilege. The role given to the technician is also taken into consideration, so the key is valid only for the role given to the technician. Once the key is generated, the key is manually transferred to the integrated application so that the application can use the key for further API operations. If the key is invalid (key is expired or the technician login is disabled), then the operation fails and an error is propagated to the integrated application.
The authentication between ServiceDesk Plus and integrated application is through an API key. A unique key is generated for a technician with login permission in ServiceDesk Plus application.
To generate the API Key, click Admin -> Technicians under User block.
If you want to generate the API key to the existing technician, then click the edit icon beside the technician.
If you want to generate the API key to a new technician, click Add New Technician link, enter the technician details and provide login permission.
Click Generate link under the API key details block. You can select a time frame for the key to expire using the calendar icon or simply retain the same key perpetually.
If a key is already generated for the technician, a Re-generate link appears.
The REST API supports only request related operations such as,
Please refer to the link for attributes model for Rest API
The application would send back the Request ID as an XML response.
Please use the below code to add request using VB script:
Was your question answered here?
Check the other FAQ modules or you can contact our support team at