API Documentation URL tests are failing

Products

• Clarity PPM SaaS
• Clarity PPM On Premise

Issue/Introduction

Testing on the "API Documentation URL" is failing. Unable to test any of the REST urls.

Environment

Release : ANY

Resolution

In order for the tests to be successful, first ensure that the Resource record has rights to use the API.

On the top of the API page (the URL will be formatted like:  http://HOST:PORT/niku/rest/describe/index.html ) a username and password needs to be defined. Specify the username of the Clarity Resource who has the rights.

Also note that this page isn't SSO enabled, the Password being specified needs to be populated on the Clarity Resource record directly. Attempting to use a domain password in the field will fail, as the URL is not authenticating to a domain, it's authenticating directly to Clarity.

Additional Information

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

Using REST APIs - https://techdocs.broadcom.com/us/en/ca-enterprise-software/business-management/clarity-project-and-portfolio-management-ppm-on-premise/16-0-2/reference/Clarity-REST-APIs/rest-api-documentation-for-authorized-developers.html