CodeScanningAlerts

Lists code scanning alerts for the repository.

Table-Specific Information

Select

The connector uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:

Number supports the '=' comparison operator.
State supports the '=' comparison operator.
RuleSecuritySeverityLevel supports the '=' comparison operator.
ToolName supports the '=' comparison operator.
ToolGuid supports the '=' comparison operator.
MostRecentInstanceRef supports the '=' comparison operator.
PullRequestNumber supports the '=' comparison operator.

For example, the following queries are processed server-side:

SELECT * FROM [CodeScanningAlerts]
SELECT * FROM [CodeScanningAlerts] WHERE [Number] = 123
SELECT * FROM [CodeScanningAlerts] WHERE [State] = 'open'
SELECT * FROM [CodeScanningAlerts] WHERE [RuleSecuritySeverityLevel] = 'Val1'
SELECT * FROM [CodeScanningAlerts] WHERE [ToolName] = 'Val1'
SELECT * FROM [CodeScanningAlerts] WHERE [ToolGuid] = 'Val1'
SELECT * FROM [CodeScanningAlerts] WHERE [MostRecentInstanceRef] = 'Val1'
SELECT * FROM [CodeScanningAlerts] WHERE [PullRequestNumber] = 123

The connector processes other filters client-side within the connector.

The connector uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:

CreatedAt
UpdatedAt

SELECT * FROM [CodeScanningAlerts] ORDER BY [CreatedAt]
SELECT * FROM [CodeScanningAlerts] ORDER BY [UpdatedAt]

The connector processes ordering by other columns client-side within the connector.

Update

You can use the following columns to update a record:

Number
State
DismissedReason
DismissedComment

You can use the following pseudo-column to update a record: CreateRequest

UPDATE [CodeScanningAlerts] SET State='dismissed', DismissedReason='used in tests', DismissedComment='Test comment.', CreateRequest=true WHERE Number='1'

Columns


Name	Type	ReadOnly	References	Description
Number [KEY]	Int	True		The security alert number.
Url	String	True		The REST API URL of the alert resource.
HtmlUrl	String	True		The GitHub URL of the alert resource.
InstancesUrl	String	True		The REST API URL for fetching the list of instances for an alert.
State	String	False		State of a code scanning alert.
DismissedReason	String	False		Required when state is dismissed. The reason for dismissing or closing the alert.
DismissedComment	String	False		The dismissal comment associated with the dismissal of the alert.
FixedAt	Datetime	True		The time that the alert was no longer detected and was considered fixed.
DismissedAt	Datetime	True		The time that the alert was dismissed.
DismissedByLogin	String	True		The username of the user that dismissed the alert.
DismissalApprovedByLogin	String	True		The username of the user that approved the dismissal.
Assignees	String	True		Users assigned to the alert.
RuleId	String	True		A unique identifier for the rule used to detect the alert.
RuleName	String	True		The name of the rule used to detect the alert.
RuleSeverity	String	True		The severity of the alert.
RuleSecuritySeverityLevel	String	True		The security severity of the alert.
RuleDescription	String	True		A short description of the rule used to detect the alert.
RuleFullDescription	String	True		A description of the rule used to detect the alert.
RuleTags	String	True		A set of tags applicable for the rule.
RuleHelp	String	True		Detailed documentation for the rule as GitHub Flavored Markdown.
RuleHelpUri	String	True		A link to the documentation for the rule used to detect the alert.
ToolName	String	True		The name of the tool used to generate the code scanning analysis.
ToolVersion	String	True		The version of the tool used to generate the code scanning analysis.
ToolGuid	String	True		The GUID of the tool used to generate the code scanning analysis.
MostRecentInstanceRef	String	True		The Git reference of the most recent instance.
MostRecentInstanceAnalysisKey	String	True		Identifies the configuration under which the analysis was executed.
MostRecentInstanceEnvironment	String	True		Identifies the variable values associated with the environment.
MostRecentInstanceCategory	String	True		Identifies the configuration under which the analysis was executed.
MostRecentInstanceState	String	True		State of the most recent instance.
MostRecentInstanceCommitSha	String	True		The commit SHA of the most recent instance.
MostRecentInstanceMessageText	String	True		The message text of the most recent instance.
MostRecentInstanceLocationPath	String	True		The file path where the alert was detected.
MostRecentInstanceLocationStartLine	Int	True		Line number at which the alert starts in the file.
MostRecentInstanceLocationEndLine	Int	True		Line number at which the alert ends in the file.
MostRecentInstanceLocationStartColumn	Int	True		Column at which the alert starts in the file.
MostRecentInstanceLocationEndColumn	Int	True		Column at which the alert ends in the file.
MostRecentInstanceHtmlUrl	String	True		The GitHub URL of the most recent instance.
MostRecentInstanceClassifications	String	True		Classifications that have been applied to the file (e.g., source, generated, test, library).
CreatedAt	Datetime	True		The time that the alert was created.
UpdatedAt	Datetime	True		The time that the alert was updated.
PullRequestNumber	Int	True		The number of the pull request for the results you want to list.

Pseudo-Columns

Pseudo-columns are fields that can be used in WHERE clauses to filter data, but do not contain data themselves.