Queries regarding REST APIs of Roadmap Item object type in Clarity PPM

Products

• Clarity PPM SaaS

Issue/Introduction

You need to get all the available Roadmap Items in Clarity PPM. In the REST API documentation, there is an API: GET /roadmaps/{roadmapsInternalId}/roadmapItems through which you can get all the Roadmap Items of a particular Roadmap by providing the roadmapsInternalId.

1. Is there a way to get all the Roadmap Items present in the Clarity PPM instance without providing the roadmapsInternalId?
2. You also tried using the expand parameter in the GET /roadmaps API request to get the Roadmap Items. But this API is not working with the expand parameter after you upgraded the Clarity version from 15.9 to 16.0.2.

 

 

 

 

 

Environment

Release : 16.1.1

Cause

REST API expand stopped working after 16.0.2 and later releases

 

Steps to Reproduce: 
1- Using postman or javascript fetch this url
https://servername/ppm/rest/v1/roadmaps?filter=(_internalId > 0)&sort=_internalId&limit=200&offset=0&expand=(roadmapItems=(filter=(lastUpdatedDate > '2023-03-14T10:00:00'),fields=(_internalId, lastUpdatedDate)))
2- Response is:
{"resourceId":null,"httpStatus":"500","errorMessage":"API-1019 : Could not process the request due to internal error.","errorCode":"api.internalError"}

 

Expected Results: Use expand parameter to pull back roadmap items 

 

Actual Results:  Expand parameter products an exception

 

Workaround: 
Pull back a list of roadmap ids with a URL like this:
https://servername/ppm/rest/v1/roadmaps?filter=(_internalId > 0)&sort=_internalId&limit=200&offset=0

 

In your app iterate through each roadmap id to pull back roadmap items.
for roadmap in roadmaps fetch /roadmaps/${roadmapsInternalId}/roadmapItems

Resolution

Pull back a list of roadmap ids with a URL like this:
https://servername/ppm/rest/v1/roadmaps?filter=(_internalId > 0)&sort=_internalId&limit=200&offset=0

 

As for the expand parameter, Broadcom is pursuing this under: DE68878