CheckmarxPythonSDK 0.9.0__tar.gz → 0.9.1__tar.gz

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.1}/CheckmarxPythonSDK/CxRestAPISDK/CustomFieldsAPI.py

@@ -10,7 +10,7 @@ class CustomFieldsAPI(object):
 
     """
     @staticmethod
-    def get_all_custom_fields(api_version="1.0"):
+    def get_all_custom_fields(api_version="5.0"):
         """
         REST API: get all custom fields
 
@@ -32,7 +32,8 @@ class CustomFieldsAPI(object):
             result = [
                 CxCustomField(
                     custom_field_id=item.get("id"),
-                    name=item.get("name")
+                    name=item.get("name"),
+                    is_mandatory=item.get("isMandatory")
                 ) for item in response.json()
             ]
         return result

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.1}/CheckmarxPythonSDK/CxRestAPISDK/EnginesAPI.py

@@ -3,7 +3,38 @@ import json
 from .httpRequests import get_request, post_request, put_request, patch_request, delete_request, get_headers
 from CheckmarxPythonSDK.utilities.compat import OK, NO_CONTENT, CREATED
 from .sast.projects.dto import CxLink
-from .sast.engines.dto import (CxEngineServer, CxEngineConfiguration, CxEngineServerStatus)
+from .sast.engines.dto import (CxEngineServer, CxEngineConfiguration, CxEngineDedication, CxEngineServerStatus)
+
+
+def construct_engine_server(item):
+    return CxEngineServer(
+        engine_server_id=item.get("id"),
+        name=item.get("name"),
+        uri=item.get("uri"),
+        min_loc=item.get("minLoc"),
+        max_loc=item.get("maxLoc"),
+        max_scans=item.get("maxScans"),
+        cx_version=item.get("cxVersion"),
+        operating_system=item.get("operatingSystem"),
+        status=CxEngineServerStatus(
+            status_id=(item.get("status", {}) or {}).get("id"),
+            value=(item.get("status", {}) or {}).get("value"),
+        ),
+        link=CxLink(
+            rel=(item.get("link", {}) or {}).get("rel"),
+            uri=(item.get("link", {}) or {}).get("uri")
+        ),
+        offline_reason_code=item.get("offlineReasonCode"),
+        offline_reason_message=item.get("offlineReasonMessage"),
+        offline_reason_message_parameters=item.get("offlineReasonMessageParameters"),
+        dedications=[
+            CxEngineDedication(
+                item_type=va.get("itemType"),
+                item_id=va.get("itemId"),
+                item_name=va.get("itemName"),
+            ) for va in item.get("dedications", [{}])
+        ]
+    )
 
 
 class EnginesAPI(object):
@@ -11,7 +42,7 @@ class EnginesAPI(object):
     engines API
     """
     @staticmethod
-    def get_all_engine_server_details(api_version="1.0"):
+    def get_all_engine_server_details(api_version="5.0"):
         """
         GET /sast/engineServers Gets details of all Engine Servers
         Args:
@@ -30,23 +61,7 @@ class EnginesAPI(object):
         response = get_request(relative_url=relative_url, headers=get_headers(api_version))
         if response.status_code == OK:
             result = [
-                CxEngineServer(
-                    engine_server_id=item.get("id"),
-                    name=item.get("name"),
-                    uri=item.get("uri"),
-                    min_loc=item.get("minLoc"),
-                    max_loc=item.get("maxLoc"),
-                    max_scans=item.get("maxScans"),
-                    cx_version=item.get("cxVersion"),
-                    status=CxEngineServerStatus(
-                        status_id=(item.get("status", {}) or {}).get("id"),
-                        value=(item.get("status", {}) or {}).get("value"),
-                    ),
-                    link=CxLink(
-                        rel=(item.get("link", {}) or {}).get("rel"),
-                        uri=(item.get("link", {}) or {}).get("uri")
-                    )
-                ) for item in response.json()
+                construct_engine_server(item) for item in response.json()
             ]
         return result
 
@@ -65,7 +80,7 @@ class EnginesAPI(object):
         return a_dict.get(engine_name)
 
     @staticmethod
-    def register_engine(name, uri, min_loc, max_loc, is_blocked, max_scans, api_version="1.0"):
+    def register_engine(name, uri, min_loc, max_loc, is_blocked, max_scans, dedications=None, api_version="5.0"):
         """
         POST  /sast/engineServers  Registers an Engine Server
         Args:
@@ -75,6 +90,7 @@ class EnginesAPI(object):
             max_loc (int): Specifies the maximum number of lines of code to scan
             is_blocked (boolean): Specifies whether or not the engine will be able to receive scan requests
             max_scans (int):
+            dedications (`list` of :obj:`CxEngineDedication`):
             api_version (str, optional):
 
         Returns:
@@ -86,8 +102,18 @@ class EnginesAPI(object):
             CxError
         """
         result = None
+        if dedications:
+            if not isinstance(dedications, list):
+                raise ValueError("parameter dedications should be a list of CxEngineDedication")
+            for dedication in dedications:
+                if not isinstance(dedication, CxEngineDedication):
+                    raise ValueError("member of dedications should be CxEngineDedication")
+
         post_data = json.dumps(
             {
+                "dedications": [
+                    item.to_dict() for item in dedications
+                ],
                 "name": name,
                 "uri": uri,
                 "minLoc": min_loc,
@@ -110,7 +136,7 @@ class EnginesAPI(object):
         return result
 
     @staticmethod
-    def unregister_engine_by_engine_id(engine_id, api_version="1.0"):
+    def unregister_engine_by_engine_id(engine_id, api_version="5.0"):
         """
         DELETE /sast/engineServers/{id} Unregister an existing engine server.
 
@@ -134,7 +160,7 @@ class EnginesAPI(object):
         return result
 
     @staticmethod
-    def get_engine_details(engine_id, api_version="1.0"):
+    def get_engine_details(engine_id, api_version="5.0"):
         """
         GET /sast/engineServers/{id} Get details of a specific engine server by Id.
 
@@ -155,28 +181,12 @@ class EnginesAPI(object):
         response = get_request(relative_url=relative_url, headers=get_headers(api_version))
         if response.status_code == OK:
             item = response.json()
-            result = CxEngineServer(
-                engine_server_id=item.get("id"),
-                name=item.get("name"),
-                uri=item.get("uri"),
-                min_loc=item.get("minLoc"),
-                max_loc=item.get("maxLoc"),
-                max_scans=item.get("maxScans"),
-                cx_version=item.get("cxVersion"),
-                status=CxEngineServerStatus(
-                    status_id=(item.get("status", {}) or {}).get("id"),
-                    value=(item.get("status", {}) or {}).get("value"),
-                ),
-                link=CxLink(
-                    rel=(item.get("link", {}) or {}).get("rel"),
-                    uri=(item.get("link", {}) or {}).get("uri")
-                )
-            )
+            result = construct_engine_server(item)
         return result
 
     @staticmethod
-    def update_engine_server(engine_id, name, uri, min_loc, max_loc, is_blocked, max_scans=None,
-                             api_version="1.0"):
+    def update_engine_server(engine_id, name, uri, min_loc, max_loc, is_blocked, max_scans=None, dedications=None,
+                             api_version="5.0"):
         """
         PUT /sast/engineServers/{id}  Update an existing engine server's configuration
                                         and enables to change certain parameters.
@@ -190,6 +200,7 @@ class EnginesAPI(object):
             max_loc (int): Specifies the maximum number of lines of code to scan
             is_blocked (boolean): Specifies whether or not the engine will be able to receive scan requests
             max_scans (int): Specifies the maximum number of concurrent scans to perform
+            dedications (`list` of :obj:`CxEngineDedication`):
             api_version (str, optional):
 
         Returns:
@@ -201,9 +212,18 @@ class EnginesAPI(object):
             CxError
         """
         result = None
+        if dedications:
+            if not isinstance(dedications, list):
+                raise ValueError("parameter dedications should be a list of CxEngineDedication")
+            for dedication in dedications:
+                if not isinstance(dedication, CxEngineDedication):
+                    raise ValueError("member of dedications should be CxEngineDedication")
         relative_url = "/cxrestapi/sast/engineServers/{id}".format(id=engine_id)
         put_data = json.dumps(
             {
+                "dedications": [
+                    item.to_dict() for item in dedications
+                ],
                 "name": name,
                 "uri": uri,
                 "minLoc": min_loc,
@@ -225,8 +245,9 @@ class EnginesAPI(object):
         return result
 
     @staticmethod
-    def update_an_engine_server_by_edit_single_field(engine_id, name, uri, min_loc, max_loc, is_blocked,
-                                                     max_scans, api_version="1.0"):
+    def update_an_engine_server_by_edit_single_field(engine_id, name=None, uri=None, min_loc=None, max_loc=None,
+                                                     is_blocked=None, max_scans=None, dedications=None,
+                                                     api_version="5.0"):
         """
         PATCH  sast/engineServers/{id}
         Args:
@@ -237,6 +258,7 @@ class EnginesAPI(object):
             max_loc (int): Specifies the maximum number of lines of code to scan
             is_blocked (boolean): Specifies whether or not the engine will be able to receive scan requests
             max_scans (int): Specifies the maximum number of concurrent scans to perform
+            dedications (`list` of :obj:`CxEngineDedication`):
             api_version (str, optional):
 
         Returns:
@@ -248,17 +270,31 @@ class EnginesAPI(object):
             CxError
         """
         result = False
+        if dedications:
+            if not isinstance(dedications, list):
+                raise ValueError("parameter dedications should be a list of CxEngineDedication")
+            for dedication in dedications:
+                if not isinstance(dedication, CxEngineDedication):
+                    raise ValueError("member of dedications should be CxEngineDedication")
         relative_url = "/cxrestapi/sast/engineServers/{id}".format(id=engine_id)
-        patch_data = json.dumps(
-            {
-                "name": name,
-                "uri": uri,
-                "minLoc": min_loc,
-                "maxLoc": max_loc,
-                "isBlocked": is_blocked,
-                "maxScans": max_scans
-            }
-        )
+        data = {}
+        if name:
+            data.update({"name": name})
+        if uri:
+            data.update({"uri": uri})
+        if min_loc:
+            data.update({"minLoc": min_loc})
+        if max_loc:
+            data.update({"maxLoc": max_loc})
+        if is_blocked:
+            data.update({"isBlocked": is_blocked})
+        if max_scans:
+            data.update({"maxScans": max_scans})
+        if dedications:
+            data.update({"dedications": [
+                    item.to_dict() for item in dedications
+                ]})
+        patch_data = json.dumps(data)
         response = patch_request(relative_url=relative_url, data=patch_data, headers=get_headers(api_version))
         if response.status_code == NO_CONTENT:
             result = True

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.1}/CheckmarxPythonSDK/CxRestAPISDK/GeneralAPI.py

@@ -3,7 +3,7 @@ import json
 
 from .httpRequests import get_request, post_request, patch_request, delete_request, get_headers
 from CheckmarxPythonSDK.utilities.compat import OK, CREATED, NO_CONTENT, ACCEPTED
-from .sast.general.dto import CxServerLicenseData, CxSupportedLanguage, CxTranslationInput
+from .sast.general.dto import CxServerLicenseData, CxSupportedLanguage, CxTranslationInput, CxUserPersistence
 
 
 class GeneralAPI:
@@ -418,3 +418,208 @@ class GeneralAPI:
             is_successful = True
         return is_successful
 
+    @staticmethod
+    def get_all_scheduled_jobs(api_version="4.0"):
+        """
+
+        Args:
+            api_version:
+
+        Returns:
+            list of dict
+            example:
+            [{'projectId': 8, 'projectName': 'jvl_git', 'scanDays': ['Sunday'], 'scanTime': '12:00 上午'}]
+        """
+        result = None
+        relative_url = "/cxrestapi/sast/scheduledJobs"
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result
+
+    @staticmethod
+    def get_user_persistence_data_for_current_user(persistence_keys, api_version="5.0"):
+        """
+        Gets user persistence data for current user
+        Args:
+            persistence_keys (`list` of `str`): persistence keys
+            api_version (str):
+
+        Returns:
+            list
+        """
+        if not isinstance(persistence_keys, list):
+            raise ValueError("parameter persistence_keys should be a list of str")
+        for item in persistence_keys:
+            if not isinstance(item, str):
+                raise ValueError("all member in persistence_keys should be a str")
+        result = None
+        relative_url = "/cxrestapi/userPersistence?"
+        relative_url += "&".join(["persistenceKeys={}".format(item) for item in persistence_keys])
+
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result
+
+    @staticmethod
+    def update_persistence_data_for_current_user(persistence_items, api_version="5.0"):
+        """
+        Updates an existing user persistence data for current user
+        Args:
+            persistence_items (list of `CxUserPersistence`):
+            api_version (str):
+
+        Returns:
+
+        """
+        is_successful = False
+        if not isinstance(persistence_items, list):
+            raise ValueError("parameter persistence_items should be a list of CxUserPersistence")
+        for item in persistence_items:
+            if not isinstance(item, CxUserPersistence):
+                raise ValueError("member in parameter persistence_items should be CxUserPersistence")
+        result = None
+        relative_url = "/cxrestapi/userPersistence"
+        data = json.dumps(
+            [item.to_dict() for item in persistence_items]
+        )
+        response = patch_request(relative_url=relative_url, data=data, headers=get_headers(api_version))
+        if response.status_code == OK:
+            is_successful = True
+        return is_successful
+
+    @staticmethod
+    def get_audit_trail_for_roles(from_date, to_date, api_version="5.0"):
+        """
+
+        Args:
+            from_date (str):  	From Date (Input Format: yyyy-mm-dd)
+            to_date (str):  To Date (Input Format: yyyy-mm-dd)
+            api_version (str):
+
+        Returns:
+            list of dict
+            example:
+            [
+              {
+                'event': 'RoleCreated',
+                'id': 1, 'ownerId': -1,
+                'ownerName': 'client_credentials_installer',
+                'roleDetails': {'id': 0, 'name': None},
+                'timeStamp': '2023-08-18T05:14:33.6851454'
+              }
+            ]
+        """
+        result = None
+        relative_url = "/cxrestapi/sast/roles/auditTrail?fromDate={fromDate}&toDate={toDate}".format(
+            fromDate=from_date, toDate=to_date
+        )
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result
+
+    @staticmethod
+    def get_audit_trail_for_teams(from_date, to_date, api_version="5.0"):
+        """
+
+        Args:
+            from_date (str):  	From Date (Input Format: yyyy-mm-dd)
+            to_date (str):  To Date (Input Format: yyyy-mm-dd)
+            api_version (str):
+
+        Returns:
+            list of dict
+            example:
+                [
+                    { 'event': 'TeamCreated',
+                      'id': 15769,
+                      'ownerId': 1,
+                      'ownerName': 'Admin',
+                      'teamDetails': None,
+                      'timeStamp': '2024-04-15T07:35:45.6458877'
+                    }
+                ]
+        """
+        result = None
+        relative_url = "/cxrestapi/sast/teams/auditTrail?fromDate={fromDate}&toDate={toDate}".format(
+            fromDate=from_date, toDate=to_date
+        )
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result
+
+    @staticmethod
+    def get_audit_trail_for_presets(from_date, to_date, api_version="5.0"):
+        """
+
+        Args:
+            from_date (str):  	From Date (Input Format: yyyy-mm-dd)
+            to_date (str):  To Date (Input Format: yyyy-mm-dd)
+            api_version (str):
+
+        Returns:
+            list of dict
+            example:
+                [
+                    {
+                        'event': 'Update',
+                        'id': 8,
+                        'isSuccessful': True,
+                        'ownerId': 1,
+                        'ownerName': 'Admin',
+                        'presetId': 100002,
+                        'presetName': 'Checkmarx Default - Customized',
+                        'timeStamp': '2024-01-11T09:44:11.78'
+                    }
+                ]
+        """
+        result = None
+        relative_url = "/cxrestapi/sast/presets/auditTrail?fromDate={fromDate}&toDate={toDate}".format(
+            fromDate=from_date, toDate=to_date
+        )
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result
+
+    @staticmethod
+    def get_audit_trail_for_results(from_date, to_date, update_type="ALL", api_version="5.0"):
+        """
+
+        Args:
+            update_type (str): Update Type (ALL, ASSIGN, RESULT_COMMENT, RESULT_SEVERITY, RESULT_STATE) ,
+                        default value is "ALL"
+            from_date (str):  	From Date (Input Format: yyyy-mm-dd)
+            to_date (str):  To Date (Input Format: yyyy-mm-dd)
+            api_version (str):
+
+        Returns:
+            list of dict
+            example:
+                [
+                    {
+                      'id': 48,
+                      'isSuccessful': True,
+                      'ownerName': 'Admin',
+                      'projectId': 5,
+                      'scanId': 1000076,
+                      'timeStamp': '2024-01-05T11:25:21.943',
+                      'updateType': 'RESULT_STATE'
+                    }
+                ]
+        """
+        result = None
+        if update_type not in ["ALL", "ASSIGN", "RESULT_COMMENT", "RESULT_SEVERITY", "RESULT_STATE"]:
+            raise ValueError('parameter update_type should be a member of list '
+                             '["ALL", "ASSIGN", "RESULT_COMMENT", "RESULT_SEVERITY", "RESULT_STATE"]')
+        relative_url = ("/cxrestapi/sast/results/auditTrail?updateType={updateType}&fromDate={fromDate}"
+                        "&toDate={toDate}").format(
+            updateType=update_type, fromDate=from_date, toDate=to_date
+        )
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.1}/CheckmarxPythonSDK/CxRestAPISDK/ProjectsAPI.py

@@ -12,7 +12,7 @@ from .sast.projects.dto import CxCreateProjectResponse, \
     CxIssueTrackingSystemType, CxIssueTrackingSystemFieldAllowedValue, \
     CxIssueTrackingSystem, CxLink, CxCustomRemoteSourceSettings, \
     CxProjectExcludeSettings, CxSVNSettings, CxURI, CxPerforceSettings, \
-    CxTFSSettings, CxPreset
+    CxTFSSettings, CxPreset, CxCustomField
 from .sast.projects.dto import construct_cx_project
 
 
@@ -21,7 +21,7 @@ class ProjectsAPI(object):
     the projects API
     """
     @staticmethod
-    def get_all_project_details(project_name=None, team_id=None, api_version="2.0"):
+    def get_all_project_details(project_name=None, team_id=None, show_also_deleted_projects=False, api_version="5.0"):
         """
         REST API: get all project details.
         For argument team_id, please consider using TeamAPI.get_team_id_by_full_name(team_full_name)
@@ -30,6 +30,7 @@ class ProjectsAPI(object):
             project_name (str, optional): Unique name of a specific project or projects
             team_id (int, str, optional): Unique Id of a specific team or teams.
                             default to id of the corresponding team full name in config.ini
+            show_also_deleted_projects (bool): Expose deleted project information, default value is "false"
             api_version (str, optional):
 
         Returns:
@@ -41,14 +42,11 @@ class ProjectsAPI(object):
             CxError
         """
         result = None
-        relative_url = "/cxrestapi/projects"
-        optionals = []
+        relative_url = "/cxrestapi/projects?showAlsoDeletedProjects={}".format(show_also_deleted_projects)
         if project_name:
-            optionals.append("projectName=" + str(project_name))
+            relative_url += "&projectName={}".format(project_name)
         if team_id:
-            optionals.append("teamId=" + str(team_id))
-        if optionals:
-            relative_url += "?" + "&".join(optionals)
+            relative_url += "&teamId={}".format(team_id)
         response = get_request(relative_url=relative_url, headers=get_headers(api_version))
         if response.status_code == OK:
             result = [
@@ -57,7 +55,7 @@ class ProjectsAPI(object):
         return result
 
     @staticmethod
-    def create_project_with_default_configuration(project_name, team_id, is_public=True, api_version="1.0"):
+    def create_project_with_default_configuration(project_name, team_id, is_public=True, api_version="5.0"):
         """
         REST API: create project
 
@@ -124,7 +122,7 @@ class ProjectsAPI(object):
             return None
 
     @staticmethod
-    def get_project_details_by_id(project_id, api_version="2.0"):
+    def get_project_details_by_id(project_id, api_version="5.0"):
         """
         REST API: get project details by project id
 
@@ -149,7 +147,7 @@ class ProjectsAPI(object):
         return result
 
     @staticmethod
-    def update_project_by_id(project_id, project_name, team_id, custom_fields=(), api_version="1.0"):
+    def update_project_by_id(project_id, project_name, team_id, custom_fields=(), api_version="5.0"):
         """
         update project info by project id
 
@@ -170,11 +168,13 @@ class ProjectsAPI(object):
         """
         result = False
         relative_url = "/cxrestapi/projects/{id}".format(id=project_id)
+        if not isinstance(custom_fields, (list, tuple)):
+            raise ValueError("parameter custom_fields should be a list of CxCustomField")
         put_data = json.dumps(
             {
                 "name": project_name,
                 "owningTeam": team_id,
-                "CustomFields": custom_fields
+                "CustomFields": [item.to_dict() for item in custom_fields]
             }
         )
         response = put_request(relative_url=relative_url, data=put_data, headers=get_headers(api_version))
@@ -184,7 +184,7 @@ class ProjectsAPI(object):
         return result
 
     @staticmethod
-    def update_project_name_team_id(project_id, project_name, team_id, api_version="1.0"):
+    def update_project_name_team_id(project_id, project_name, team_id, api_version="5.0"):
         """
         REST API: update project name, team id
 
@@ -217,7 +217,7 @@ class ProjectsAPI(object):
         return result
 
     @staticmethod
-    def delete_project_by_id(project_id, delete_running_scans=False, api_version="1.0"):
+    def delete_project_by_id(project_id, delete_running_scans=False, api_version="5.0"):
         """
         REST API: delete project by id
 
@@ -1414,8 +1414,77 @@ class ProjectsAPI(object):
             bool
         """
         is_successful = False
-        relative_url = "/cxrestapi//projects/{id}/forceScanOnNoCodeChanges".format(id=project_id)
+        relative_url = "/cxrestapi/projects/{id}/forceScanOnNoCodeChanges".format(id=project_id)
         response = post_request(relative_url=relative_url, data={}, headers=get_headers(api_version))
         if response.status_code == OK:
             is_successful = True
         return is_successful
+
+    @staticmethod
+    def get_path_filter(project_id, api_version="5.0"):
+        """
+        Get project's source code files/folders filter
+        Args:
+            project_id (int): Unique ID of a specific project
+            api_version (str):
+
+        Returns:
+            str
+        """
+        result = None
+        relative_url = "/cxrestapi/projects/{projectId}/sourceCode/pathFilter".format(projectId=project_id)
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result.get("pathFilter")
+
+    @staticmethod
+    def set_path_filter(project_id, path_filter, api_version="5.0"):
+        """
+        Set project's source code files/folders filter
+        Args:
+            project_id (int): Unique ID of a specific project
+            path_filter (str): Filter for source code files/folder
+            api_version (str):
+
+        Returns:
+            bool
+        """
+        is_successful = False
+        relative_url = "/cxrestapi/projects/{projectId}/sourceCode/pathFilter".format(projectId=project_id)
+        data = json.dumps(
+            {
+                "pathFilter": path_filter
+            }
+        )
+        response = put_request(relative_url=relative_url, data=data, headers=get_headers(api_version))
+        if response.status_code == OK:
+            is_successful = True
+        return is_successful
+
+    @staticmethod
+    def get_project_validity_for_running_incremental_scan(project_id, api_version="5.0"):
+        """
+        Get the project's validity for running Incremental scan
+        Args:
+            project_id:
+            api_version:
+
+        Returns:
+            dict
+            {
+              "validForIncrementalScan": true,
+              "consecutiveIncrementalScansLimitReached": true,
+              "enginePackUpgradedSinceLastFullScan": true,
+              "maxConsecutiveIncrementalScans": 0,
+              "incrementalScansSinceLastFullScan": 0,
+              "lastFullScanDate": "2024-07-14T12:05:47.255Z",
+              "enginePackUpgradeDate": "2024-07-14T12:05:47.255Z"
+            }
+        """
+        result = None
+        relative_url = "/cxrestapi/projects/{id}/incrementalScanValidityStatus".format(id=project_id)
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            result = response.json()
+        return result