ALERT: Some images may not load properly within the Knowledge Base Article. If you see a broken image, please right-click and select 'Open image in a new tab'. We apologize for this inconvenience.

Testing ServicePoint REST API Documentation Clarification

book

Article ID: 199621

calendar_today

Updated On:

Products

CA Service Management - Service Desk Manager CA Service Desk Manager

Issue/Introduction

The following contains further clarifications on steps in the existing documentation on setting up the ServicePoint REST API for testing:
 
Documentation link provided below:

Environment

Release : 17.3

Component : XFLOW INTERFACE FOR SDM

Resolution

 
Starting from the section:

"For testing the REST APIs, follow the steps:"

1.  Download the Swagger-ui dist folder .

The above link will send users to GitHub and the objective is to download the swagger-ui zip file.

When you access the above link, click on the green "Code" button and choose "Download ZIP" to download "swagger-ui-XXXX.zip" (XXXX is the current version of Swagger)


2.  Host the dist folder in any web server container (ex: Tomcat container) or paste it inside incidentMicroService Public folder.

In the above example, the "dist" folder, extracted from the swagger-ui zip file, is placed here:
C:\Program Files\CA\xFlow\APPS\Services\incidentmicroservice-17.0.479\public\dist

The following screencap is an illustration of the dist folder's contents in an xFlow installation.

3.  Download the JSON file from CA Service Point REST API page and paste it inside the dist folder.

This KB article describes the procedure to follow and also provides the direct file download:

https://knowledge.broadcom.com/external/article?articleId=199144

4.  Navigate to the dist folder and open the index.html file. Edit the "URL" value to point it to the path of the JSON file.

For Step #4  one must provide the URL to the location where the the json file resides, not a physical path such as "c:\folders\file1.json".  It needs to be on a web server and to be accessible. 

For those who are placing the JSON file in the incidentMicroService Public folder from Step 3, the value that needs to be added, assuming the file name is "file1.json" should be:

"http://SERVER:9002/dist/file1.json"

Replace "SERVER" with the server name where you have xFlow installed.

 

5.  Open the JSON file and change the host and port value to point it to the CA Service Point URL.

For Step #5 you need to update the JSON file and replace "<host_name>:<port_number>" with the host_name and port_number where the REST API resides.

 

6.  Navigate to the hosted URL and access the index.html file.

For example: http://SERVER:9002/dist/index.html (if Service Point is hosted in SERVER at port number 9002 and the dist folder is inside incidentMicroService public folder).

Additional Information

The above instructions are meant to allow end users to test the Service Point REST API using the Swagger method specifically.  Other methods to test REST calls are available, such as SoapUI or Postman.  

Any information on the CA Service Point REST API page is meant specifically for Swagger based testing. 

For instance, information on using the method "/api/getAccess" indicates "This is only for BASIC AUTHENTICATION scenario".  Service Point REST does allow for authentication via methods such as NTLM (often applicable when Single Sign On is in play).  The above text about using BASIC AUTHENTICATION is meant for Swagger based testing.

Attachments