REST API: Update Benefit Plan Per-Period-Metrics (TSV)

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

I am trying to fetch realizedBenefit & benefit tsv values from a benefit plan using tsv param.

When I try this via API, the TSV parameters seems to be not working.
Can you let me know why the API behaves differently when we hit it from outside of the application?

Resolution

Use the following call example to populate per-period-metrics (TSV) of the Benefit Plan.

PATCH [server]/ppm/rest/v1/benefitPlans/5aaaaaa/benefitPlanDetails/5bbbbbb

An example API Patch for Benefit
===== == = = = = = = ==

{
            "benefit": {

                "periodList": [
                    {

                        "periods": [
                            {
                                "start": "2025-08-01T00:00:00",
                                "finish": "2025-08-31T00:00:00",
                                "value": 110.377246
                            },
                            {
                                "start": "2025-09-01T00:00:00",
                                "finish": "2025-09-30T00:00:00",
                                "value": 111.784431
                            }
                          
                        ]
                    }
                ]
            }
        }

 

An example API patch request for Realized Benefits

================ =============== ==========

{
           "realizedBenefit": {
               "periodList": [
                    {
               
                        "periods": [
                            {
                                "start": "2025-08-01T00:00:00",
                                "finish": "2025-08-31T00:00:00",
                                "value": 70.1344
                            },
                            {
                                "start": "2025-09-01T00:00:00",
                                "finish": "2025-09-30T00:00:00",
                                "value": 454350
                            },
                            {
                                "start": "2025-10-01T00:00:00",
                                "finish": "2025-10-31T00:00:00",
                                "value": 454
                            },
                            {
                                "start": "2025-11-01T00:00:00",
                                "finish": "2025-11-30T00:00:00",
                                "value": 4354.34
                            }
                           
                        ]
                    }
                ]
          }
}