RecommendationSessionState
Status information for a recommendation session, including overall status, analysis status, status messages, alerts, and rerun recommendations. Provides visibility into the current state and progress of the recommendation generation process.
{
"recommendation_overall_status": "READY_TO_PUBLISH",
"recommendation_analysis_states": [
{
"site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
"status_message": "",
"status": "SUCCESS"
}
],
"recommendation_result_states": [
{
"id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
"site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
"status": "READY_TO_PUBLISH"
}
],
"rerun_recommended": false,
"alerts": [],
"groups_with_alert": []
}The overall status of the recommendation session, representing the highest-level state of the recommendation process. This status aggregates the state across all sites and stages of the recommendation generation.
Array of status values representing the current state of the recommendation analysis process. Can contain multiple status values if the analysis is being performed across multiple sites or stages.
Array of status values representing the current state of the recommendation result. Can contain multiple status values if the analysis is being performed across multiple sites or stages.
Used to communicate any information back to the user while or after processing. Examples of these are any errors/exceptions so far encountered during processing( which should be cleared if processing completes successfully). May be empty.
Boolean flag indicating whether the recommendation should be rerun. Set to true when continuous monitoring detects changes in effective members, configuration, or other factors that warrant regenerating the recommendation.
Alert reasons is set when recommendation has a alert for user. This does not inhibit the recommendation job.
During start/rerun of a recommendation, if some group(s) has alert like unsupported membership types, their respective id(s), path(s), display name(s) and unsupported membership type(s) will be stored and kept in this array.