HTTP GET deprecation in Sustainable Investment - Portfolio Securities and organizations SI totals enpoints
Summary (What?)
Currently we are offering 2 GET
endpoints for SI that will now transition to be POST
. The reason why we are doing this is because we wanted to enable customization of the SI parameters in these SI endpoints. The only way for us to allow for that was by transitioning from a GET
to a POST
.
Impact (How?)
This change will allow you to customize the 3 Sustainable Investment criteria in the same way that Clarity AI offers as of today in the webapp channel. The parameters can be customized by changing the following call:
{
"profile": {
"CRITERIA_1": {
"SI_SUSTAINABLE_REVENUE_ALIGNMENT_CONTRIBUTION": {
"contributesToCriteria": true, - this can be set true or false
"minPercentage_SUSTAINABLE_REVENUE_ALIGNMENT": 20 - this % can be set between 0 to 100
},
"SI_EU_TAXONOMY_ALIGNMENT_CONTRIBUTION": {
"contributesToCriteria": true, - this can be set true or false
"minPercentage_EU_TAX_ALIGNMENT": 0 - this % can be set between 0 to 100
},
"PAI_CONTRIBUTION": {
"contributesToCriteria": true, - this can be set true or false
"minPaisToPass_SI_PAI_COUNT": 2 - this can be set to 2,3 or 4 PAIs
},
"SI_SBTI_CONTRIBUTION": {
"contributesToCriteria": false - this can be set true or false
}
},
"CRITERIA_2": {
"DNSH": {
"contributesToCriteria": true, - this can be set true or false
"minPaisToFail_SI_DNSH_PAI_COUNT": 1 - this can be set to 1,2 or 3 PAIs
}
}
}
}
Modules and Endpoints impacted (Where?)
List of endpoints by module impacted by this release:
Module | Endpoints | Action |
---|---|---|
Sustainable Investment | GET clarity/v1/public/portfolios/{portfolioId}/sustainable-investment/securities/value | Deprecation |
Sustainable Investment | GET clarity/v1/public/portfolios/{portfolioId}/sustainable-investment/organizations/value | Deprecation |
Sustainable Investment | POST clarity/v1/public/portfolios/{portfolioId}/sustainable-investment/securities/value | Addition |
Sustainable Investment | POST clarity/v1/public/portfolios/{portfolioId}/sustainable-investment/organizations/value | Addition |
Deprecation of the feature (How?)
By
02/Jul/2025
the GET
endpoints in the table above will be deprecated. Until then, both HTTPs will be available in order to provide you with enough time to transition from the GET
to the POST