Returns a Recommendation Based on Object

POST {{baseUrl}}/recommendations/request

The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.

Request Body

{"requests"=>[{"identityId"=>"2c938083633d259901633d25c68c00fa", "item"=>{"id"=>"2c938083633d259901633d2623ec0375", "type"=>"ENTITLEMENT"}}, {"identityId"=>"2c938083633d259901633d25c68c00fa", "item"=>{"id"=>"2c938083633d259901633d2623ec0375", "type"=>"ENTITLEMENT"}}], "excludeInterpretations"=>"false", "includeTranslationMessages"=>"false", "includeDebugInformation"=>"false", "prescribeMode"=>"false"}

HEADERS

KeyDatatypeRequiredDescription
X-SailPoint-Experimentalboolean(Required) Use this header to enable this experimental API.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"response":[{"request":{"identityId":"2c938083633d259901633d25c68c00fa","item":{"id":"2c938083633d259901633d2623ec0375","type":"ENTITLEMENT"}},"recommendation":"YES","interpretations":["75% of identities with the same department have this access. This information had a high impact on the overall score.","67% of identities with the same peer group have this access. This information had a low impact on the overall score.","42% of identities with the same location have this access. This information had a low impact on the overall score."],"translationMessages":[{"key":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH","values":["75","department"]}],"recommenderCalculations":{"identityId":"2c91808457d8f3ab0157e3e62cb4213c","entitlementId":"2c91809050db617d0150e0bf3215385e","recommendation":"YES","overallWeightedScore":-83263905.32039589,"featureWeightedScores":{"dolore7b3":16249257.40164262},"threshold":-68533512.08163953,"identityAttributes":{"ullamco_07":{"value":"irure ea cupidatat"},"dolor_1_":{"value":"eiusmod consectetur velit dolore et"}},"featureValues":{"feature":"department","numerator":14,"denominator":14}}},{"request":{"identityId":"2c938083633d259901633d25c68c00fa","item":{"id":"2c938083633d259901633d2623ec0375","type":"ENTITLEMENT"}},"recommendation":"YES","interpretations":["75% of identities with the same department have this access. This information had a high impact on the overall score.","67% of identities with the same peer group have this access. This information had a low impact on the overall score.","42% of identities with the same location have this access. This information had a low impact on the overall score."],"translationMessages":[{"key":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH","values":["75","department"]}],"recommenderCalculations":{"identityId":"2c91808457d8f3ab0157e3e62cb4213c","entitlementId":"2c91809050db617d0150e0bf3215385e","recommendation":"YES","overallWeightedScore":-62033586.323557444,"featureWeightedScores":{"eu_41":11996428.447786033,"reprehenderitd":32173731.607737154,"Excepteur21":28309218.636618197},"threshold":-79283762.86525314,"identityAttributes":{"exercitation_f26":{"value":"Duis magna tempor et ut"},"occaecat7a8":{"value":"in"}},"featureValues":{"feature":"department","numerator":14,"denominator":14}}}]}