Generate the RESTful Webservice API documentation for CA Service Desk Manager 14.1

book

Article ID: 15829

calendar_today

Updated On:

Products

SUPPORT AUTOMATION- SERVER CA Service Desk Manager - Unified Self Service KNOWLEDGE TOOLS CA Service Management - Asset Portfolio Management CA Service Management - Service Desk Manager

Issue/Introduction

The Restful webservice API documentation for CA Service Desk Manager is not shipped with the out of the box product.
But, in case you want to create your own SDM RESTful webservice application, you may need the sample syntax how to use the interface functions.
To create the documentation you must run the pdm_rest_util command and copy the "jax-doclets-0.9.0.jar" file/archive to the sdm java\lib.

The jar file is not shipped with CA Service Desk Manager. So you have to "GOOGLE" for it or use the CA communities link below.



I can't find the CA service Desk Manager (SDM) RESTFUL webservice API documentation?

How can I find it? 

Environment

W2k12; MS-SQLw2k14; SDM 14.1.02; nx.env file varibale points to CA SC (shared components java).Example: NX_JRE_INSTALL_DIR=C:/Program Files (x86)/CA/SC/JRE/1.7.0_10Java Release is 1.7

Resolution

Needed Environment:

W2k12; 

MS-SQLw2k14; 

SDM 14.1.02; 

nx.env file varibale points to CA SC (shared components java).

Example: NX_JRE_INSTALL_DIR=C:/Program Files (x86)/CA/SC/JRE/1.7.0_10

Java Release 1.7

 

Steps to do to generate the RESTful webservice API documentation:

1) download the doclets jar from this community entry:

   https://communities.ca.com/docs/DOC-231174222-generate-api-documentation-for-restful-services

2) copy "jax-doclets-0.9.0.jar" to %NX_ROOT%/java/lib 

3) stop SDM ; start SDM

4) open a command prompt in administrator mode

5) Run:  pdm_rest_util.cmd –undeploy

6) Run:  pdm_rest_util.cmd –deploy

7) verify that the api documentation is generated

 

Screenshots showing the result:

<Please see attached file for image>

src="/servlet/servlet.FileDownload?file=0150c000004AKYkAAO" alt="01_Restful_undeploy.PNG" width="1188" height="347">

 

<Please see attached file for image>

src="/servlet/servlet.FileDownload?file=0150c000004AKYlAAO" alt="02_Restful_deploy.PNG" width="1133" height="228">

 

<Please see attached file for image>

src="/servlet/servlet.FileDownload?file=0150c000004AKYmAAO" alt="03_Rest_api_doc_dir_html_files.PNG" width="1285" height="486">

 

 

<Please see attached file for image>

src="/servlet/servlet.FileDownload?file=0150c000004AKYnAAO" alt="04_Rest_api_doc_xlm_json_sample.PNG" width="1287" height="550">

Additional Information

Community link: 

 https://communities.ca.com/docs/DOC-231174222-generate-api-documentation-for-restful-services

CA Online documentation link:

https://docops.ca.com/ca-service-management/14-1/en/reference/ca-service-desk-manager-reference-commands/generate-api-documentation-for-restful-services

Attachments

1558717462217000015829_sktwi1f5rjvs16unm.png get_app
1558717460265000015829_sktwi1f5rjvs16unl.png get_app
1558717458463000015829_sktwi1f5rjvs16unk.png get_app
1558717456418000015829_sktwi1f5rjvs16unj.png get_app