REST API Fields Documentation and Record Limits

Products

• Clarity PPM SaaS

Issue/Introduction

Is there any documentation listing fields available for REST API Calls (e.g Project /task object etc) in addition to the API Documentation URL?

Also what are the record limits for GET/PUT/POST etc operations..

Can these be increased?

 

Environment

Release: 16.3.1

Resolution

The Swagger URL/API Documentation URL is the only document which lists all of the fields.

https://server/niku/rest/describe/index.html

For GET requests, you can use "limit"
For example:    projects?limit=50    
Limits the number of results to be returned. The default value is 25.
The maximum you can request for "limit" is 500.

PUT requests have a defined max of 50.

POST requests do not have a defined limit.

DELETE requests only one delete at a time.

Unfortunately, it is not possible to increase these values.

Additional Information

Please see Using Clarity REST APIs for more information.

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