Using Rest APIs for Roadmaps to export and then reimport to Clarity PPM

book

Article ID: 142940

calendar_today

Updated On:

Products

Clarity PPM On Premise

Issue/Introduction

  1. Is it possible to pull an entire roadmap, then delete it, and post it back using the Rest API? 
  2. If yes, how can this be done?

Environment

Release : 15.6.1

Component : CA PPM PROJECT MANAGEMENT

Resolution

1. Retrieve the API Documentation URL listed in Clarity's system options

2. Open that URL in a tab in your browser, where you see the objects available

3. Use GET to retrieve one of the Roadmaps manually created via UI 

4. To update, ensure you post the roadmap and then roadmap items in order to maintain the dependency

5. If you want to retrieve Roadmap using the internal ID and then click on Try out, you will get the response

sample for creating a roadmap:

roadmap { "lastUpdatedBy": "string", "code": "RD999999", "author": "1", "description": "testroadmap", "type": "INVESTMENT", "duration": 1, "startPeriod": "5000267", "createdBy": "1", "name": "test_API2", "finishDate": "2020-01-31T00:00:00", "startDate": "2020-01-01T00:00:00", "status": "DRAFT" }

6. If you are looking for how to also get roadmapItems, below call can be used
http://your_server/ppm/rest/v1/roadmaps/5001001?expand=(roadmapItems=(fields=(projectType)), roadmapDependencies) 
Note: in the fields it is expecting for you to provide which fields you want to see coming from the roadmapItems object.

Additional Information

See: Standard REST API Methods for more details on using APIs and Clarity

See KB 141061 - How to search for known Clarity PPM Issues using Self Service