get_top_non_compliant_controls_detail
Retrieve controls with low compliance scores or non-compliant status for a given period, including details on assigned users, priority, and score.
Instructions
Function overview: Fetch control with low compliant score or non compliant controls. Arguments:
period: Compliance period which denotes quarter of the year whose dashboard data is needed. By default: Q1 2024.
count:
page: If the user asks of next page use smartly decide the page.
Returns:
controls (List[NonCompliantControlVO]): A list of non-compliant controls.
name (str): Name of the control.
lastAssignedTo (List[UserVO]): List of users to whom the control was last assigned.
emailid (str): Email ID of the assigned user.
score (float): Score assigned to the control.
priority (str): Priority level of the control.
error (Optional[str]): An error message if any issues occurred during retrieval.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | Yes | ||
| count | No | ||
| page | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| controls | No | ||
| error | No |
Implementation Reference
- constants/constants.py:29-29 (helper)The API endpoint constant URL_CCF_DASHBOARD_CONTROL_DETAILS = '/v2/aggregator/ccf-dashboard-control-details' used by the handler to make the API call.
URL_CCF_DASHBOARD_CONTROL_DETAILS = "/v2/aggregator/ccf-dashboard-control-details" - tools/help/help.py:94-94 (helper)Documentation/help entry listing the tool signature and description for users: 'get_top_non_compliant_controls_detail(period, count="1", page="1") - Get non-compliant controls'.
• get_top_non_compliant_controls_detail(period, count="1", page="1") - Get non-compliant controls