REST API Fields Documentation and Record Limits

Products

• Clarity PPM SaaS

Issue/Introduction

You require information regarding the list of available fields for REST API calls (Project or Task objects) and the specific record limits for GET, PUT, and POST operations․​​​​​​‌​ Use this article to understand where to find field definitions and the hard limits for API transactions․

SYMPTOMS:

• Need to identify available fields beyond the standard API URL

• Need to verify maximum record counts for API operations

• Questions regarding increasing API record limits

Environment

Release: 16․3․2

Resolution

FIELD DOCUMENTATION:

The Swagger URL is the definitive source for all field lists and definitions․

URL: https://[ServerName]/niku/rest/describe/index․html

RECORD LIMITS BY OPERATION:

1. GET REQUESTS Use the "limit" parameter to control results․

   • Default Value: 25 records

   • Parent Objects (e․g․, Projects): Max 500 records

   • Child Objects (e․g․, Tasks): Max 200 records

   Example: projects?limit=50

2. PUT REQUESTS

   • Maximum Limit: 50 records

3. POST REQUESTS

   • Maximum Limit: No defined limit

4. DELETE REQUESTS

   • Maximum Limit: 1 record per request

IMPORTANT: These values are hard limits and cannot be increased․

Additional Information

RELATED RESOURCES:

• Documentation: Using Clarity REST APIs

URL: 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