REST API Calls for Objective-to-Investment Associations

Products

• Clarity PPM SaaS
• Clarity PPM On Premise

Issue/Introduction

Need a Rest API call to get a list of investments associated with an objective. Assuming one has to use rest call on obaInvestments but not finding how in the API documentation. 

Environment

Clarity 16.4.1

Resolution

To successfully frame the API GET call to return the Investment Name and Code for a specific associated Objective, follow the private API call example:

GET https://[URL]/ppm/rest/v1/private/investments?fields=investments____name,investments____code&filter=((obaAssociation+%3D+5xxxx))

Header:
x-api-association-key= investments~objectives~default~5xxxxxx

Note:

Retrieving associated objects through the Private API requires specific authorization headers and filter parameters that are not mandatory for standard public object calls.

Replace 5xxxxxx with the internal id of the concerned objective.