REST API documentation and Swagger API for Clarity [CAPPM]
search cancel

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

Product doc on the REST api is located at: Getting Started with Clarity APIs

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

Make sure to:

  1. Open one tab
  2. Authenticate to Clarity
  3. After authenticated open a second tab for swagger.

Additional Information

REST API Documentation for 16.1.0