Updated on 2026-02-03 GMT+08:00

Description

Changes between document issues are cumulative. The latest document issue contains all the changes made in earlier issues.

Change History

Released On

This issue is the twentieth official release. It incorporates the following changes:

Added the following APIs:

  • Querying a task by ID - GetTaskInfoByID.
  • Performing a full check - CreateJob
  • Obtaining the check list based on the task type - ShowCheckList
  • Creating a check task V3 - CreateTaskV3
  • Querying a log - ShowLog. Downloading a log file - DownloadLog
  • Querying the details and context code of an issue - GetSingleDefect
  • Obtaining code metrics files V2 - GetMeasureListV2
  • Querying code issues - GetTaskStatistics

February 1, 2026

This issue is the nineteenth official release. It incorporates the following changes:

Added the following APIs:

  • Querying the shell script executed before compilation - ShowPortalServicePreCheckScript
  • Deleting a task - DeleteTaskV3
  • Querying the task list - ShowTasksList
  • Querying basic settings of a specified code check task - GetSimpleQueryConfigTemplate
  • Querying rule sets-V2 - ListAllCriterionSets
  • Querying rule filters - ShowFilter. Querying rule lists-V2 - ListCriterion
  • Obtaining code issues - IssueListByFilter
  • Obtaining code issue statistics - IssueFilter
  • Querying issues and metrics - DisplayTrend
  • Querying status change results of all issues - NextStatus
  • Modifying task configurations - ModifyPipelineTaskV2

October 30, 2025

This issue is the eighteenth official release. It incorporates the following changes:

Added the following APIs:

  • Generating a PDF report - PutPdfJob
  • Querying the progress of an asynchronous job - GetAsyncJob
  • Downloading a PDF report - GetPdfFile
  • Obtaining code metrics files - GetMeasureList
  • Querying duplicate code blocks - GetRelatedDuplicateBlocks

May 21, 2025

This issue is the seventeenth official release. It incorporates the following changes:

Added the following APIs:

  • Obtaining the directory tree of a task - ShowTaskPathTree
  • Ignoring directories for a task - UpdateIgnorePath
  • Querying advanced configurations of a task - UpdateIgnorePath
  • Configuring advanced configurations for a task - UpdateTaskSettings

March 26, 2024

This issue is the sixteenth official release. It incorporates the following changes:

Modified the following APIs:

  • Querying selected rule sets of a task (version 3) - ShowTasksRulesets
  • Querying the check parameters of a rule set (version 3) - CheckRulesetParameters

Modified section "Error Codes".

September 22, 2023

This issue is the fifteenth official release. It incorporates the following changes:

  • Modified section "Example 1: Querying the Task List".
  • Modified section "Example 2: Querying the Issue Summary".

August 29, 2023

This issue is the fourteenth official release. It incorporates the following changes:

Modified the following APIs:

  • Querying the issue summary - ShowTaskDetailV2
  • Obtaining rules - ListRules.

June 30, 2023

This issue is the thirteenth official release. It incorporates the following changes:

Added the following APIs:

  • Querying check failure logs - ShowTasklog
  • Deleting a custom rule set - ShowTasklog
  • Setting a default rule set for each language in a project - SetDefaulTemplate

Modified the following APIs:

  • Creating a check task - CreateTaskV2
  • Querying issue summary - ShowTaskDetailV2
  • Creating a custom rule set - CreateRuleset
  • Viewing the rule list of a rule set - ListTemplateRules

Modified section "Error Codes".

January 27, 2023

This issue is the twelfth official release. It incorporates the following change:

  • Modified section "Error Codes".

January 4, 2023

This issue is the eleventh official release. It incorporates the following changes:

Added the following APIs:

  • Configuring check parameters for a task - ListTaskParameter
  • Querying code metrics - ShowTaskCmetrics
  • Viewing the rule list of a rule set - ListTemplateRules

December 27, 2023

This issue is the tenth official release. It incorporates the following change:

  • Added section "Rule Management".

November 27, 2023

This issue is the ninth official release. It incorporates the following changes:

Added the following APIs:

  • Deleting a check task - DeleteTask
  • Querying issue details statistics - ShowTaskDefectsStatisticV2
  • Modifying issue status - UpdateDefectStatus

September 29, 2023

This issue is the eighth official release. It incorporates the following changes:

Modified the APIs in sections "Task Management" and "Issue Management."

November 23, 2022

This issue is the seventh official release. It incorporates the following changes:

Modified the following sections:

  • Example 1: Querying the Task List
  • Example 2: Querying the Issue Summary

November 5, 2022

This issue is the sixth official release. It incorporates the following changes:

  • Modified section "Making an API Request".
  • Modified section "Authentication".

August 6, 2022

This issue is the fifth official release. It incorporates the following changes:

Added the following sections:

  • Example 1: Querying the Task List
  • Example 2: Querying the Issue Summary

July 30, 2022

This issue is the fourth official release. It incorporates the following changes:

  • Modified the URL information in the request example.
  • Modified the endpoints.

July 10, 2022

This issue is the third official release. It incorporates the following change:

Modified the code repository address information in the code example.

May 10, 2022

This issue is the second official release. It incorporates the following changes:

Renamed CodeCheck to CodeArts Check.

April 23, 2022

This issue is the first official release.

September 30, 2022