search cancel

What is REST API documentation and Swagger API for Clarity [CAPPM]

book

Article ID: 255830

calendar_today

Updated On:

Products

Clarity PPM SaaS Clarity PPM On Premise

Issue/Introduction

What is REST API documentation URL / Swagger API for Clarity [CAPPM]

 

 

Environment

Release : 16.0.2, 16.0.3, 16.1

Resolution

We have our product doc on the REST api here:

https://techdocs.broadcom.com/us/en/ca-enterprise-software/business-management/clarity-project-and-portfolio-management-ppm-on-premise/16-1-0/reference/Clarity-REST-APIs/Getting-Started-with-Clarity-REST-APIs.html

The Swagger UI in the following URL to view the interactive API documentation:http://<ClarityHostName>:<Port>/niku/rest/describe/index.html

 

Please be sure to open one tab, authenticate to Clarity, then after authenticated open a second tab for swagger.

 

Additional Information

REST API Documentation for 16.1.0