Freigeben über


SearchCriteria interface

Eigenschaften

alertIds

Wenn angegeben, werden nur Warnungen mit den angegebenen IDs zurückgegeben. <br />Andernfalls wird jede Warnung zurückgegeben.

alertType

Wenn angegeben, geben Sie nur Warnungen dieses Typs zurück. Andernfalls geben Sie Warnungen aller Typen zurück.

confidenceLevels

Wenn angegeben, werden nur Warnungen auf diesen Konfidenzniveaus zurückgegeben. <br />Sowohl hoch als auch sonstige müssen angegeben werden, um Warnungen aller Konfidenzstufen abzurufen. <br />Andernfalls werden Warnungen mit hoher Zuverlässigkeitsstufe zurückgegeben. <br />Gilt nur für geheime Warnungen.

dependencyName

Wenn angegeben, werden nur Warnungen für diese Abhängigkeit zurückgegeben. <br/>Andernfalls geben Sie Warnungen für alle Abhängigkeiten zurück. <br />In einer sarifen Übermittlung wird eine Abhängigkeit (oder Komponente) in Ergebnis angegeben. RelatedLocations[].logicalLocation. <br />Gilt nicht für geheime Warnungen.

fromDate

Wenn angegeben, werden nach diesem Datum nur Benachrichtigungen zurückgegeben. <br />Andernfalls werden alle Warnungen zurückgegeben.

hasLinkedWorkItems

Wenn angegeben, filtern Sie Warnungen basierend darauf, ob sie verknüpfte Arbeitsaufgaben haben. <br />Auf "true" gesetzt, um nur Benachrichtigungen mit verknüpften Arbeitsobjekten zurückzugeben. <br />Auf "falsch" gesetzt, um nur Benachrichtigungen ohne verknüpfte Arbeitselemente zurückzugeben. <br />Wenn nicht bereitgestellt, wird alle Benachrichtigungen unabhängig von verknüpften Arbeitseinträgen zurückgegeben. <br />Nicht anwendbar für Secret- und Abhängigkeitsscan-Warnungen.

keywords

Wenn angegeben, geben Sie nur Warnungen zurück, deren Titel diesem Muster entsprechen.

licenseName

Wenn angegeben, werden nur Warnungen zurückgegeben, die für Abhängigkeiten mit dieser Lizenz erstellt wurden. <br />Andernfalls geben Sie Benachrichtigungen für alle Lizenzen zurück. <br />In einer sarifen Übermittlung wird die Lizenz für eine Abhängigkeit (oder komponente) in Ergebnis angegeben. RelatedLocations[].logicalLocation.properties.license. <br />Gilt nicht für geheime Warnungen.

modifiedSince

Wenn angegeben, geben Sie nur Warnungen zurück, die seit diesem Datum geändert wurden. <br />Andernfalls werden alle Warnungen zurückgegeben.

onlyDefaultBranch

Wenn "true" oder nicht festgelegt ist, werden nur Warnungen zurückgegeben, die im Standardzweig des Repositorys gefunden wurden. <br />Wenn für die Standardverzweigung keine Ausgeführten ausgeführt wurden, wird die letzte Ausführung stattdessen unabhängig von der für diese Ausführung verwendeten Verzweigung verwendet. Wenn "false" zurückgegeben wird, werden Warnungen von allen Verzweigungen zurückgegeben. <br />Diese Option wird ignoriert, wenn bezug angegeben wird. <br />Gilt nicht für geheime Warnungen.

phaseId

Wenn pipelineName bereitgestellt wird, werden in dieser Pipelinephase nur Warnungen zurückgegeben, die in dieser Pipelinephase <br/>Andernfalls werden warnungen zurückgegeben, die in allen Phasen erkannt wurden. <br />Gilt nicht für geheime Warnungen.

phaseName

Wenn pipelineName bereitgestellt wird, werden in dieser Pipelinephase nur Warnungen zurückgegeben, die in dieser Pipelinephase <br/>Andernfalls werden warnungen zurückgegeben, die in allen Phasen erkannt wurden. <br />Gilt nicht für geheime Warnungen.

pipelineName

Wenn angegeben, werden nur warnungen zurückgegeben, die in dieser Pipeline erkannt wurden. <br/>Andernfalls werden warnungen zurückgegeben, die in allen Pipelines erkannt wurden. <br />Gilt nicht für geheime Warnungen.

ref

Falls angegeben, schließen Sie nur Warnungen für diesen Verweis ein. <br />Wenn nicht angegeben und OnlyDefaultBranch "true" ist, schließen Sie nur Warnungen in der Standardverzweigung oder letzten Ausführungsverzweigung ein, wenn keine Analysekonfiguration für die Standardverzweigung vorhanden ist. <br />Andernfalls enthalten Sie Warnungen von allen Filialen. <br />Gilt nicht für geheime Warnungen.

ruleId

Wenn angegeben, werden nur Warnungen für diese Regel zurückgegeben. <br />Andernfalls geben Sie Warnungen aller Regeln zurück.

ruleName

Wenn angegeben, werden nur Warnungen für diese Regel zurückgegeben. <br />Andernfalls geben Sie Warnungen für alle Regeln zurück.

severities

Wenn angegeben, werden nur Warnungen zu diesen Schweregraden zurückgegeben. <br />Andernfalls werden Warnungen mit beliebigem Schweregrad zurückgegeben.

states

Wenn angegeben, werden nur Warnungen in diesen Zuständen zurückgegeben. <br />Andernfalls geben Sie Warnungen in jedem Zustand zurück.

toDate

Wenn angegeben, werden nur Benachrichtigungen zurückgegeben, die vor diesem Datum zuletzt angezeigt wurden. <br />Andernfalls werden alle Warnungen zurückgegeben.

toolName

Wenn sie mit toolName bereitgestellt wird, werden nur warnungen zurückgegeben, die von diesem Tool erkannt wurden. <br />Andernfalls werden warnungen zurückgegeben, die von allen Tools erkannt wurden.

validity

Wenn angegeben, geben Sie nur Warnungen mit der hier angegebenen Gültigkeit zurück. Wenn der Gültigkeitsstatus unbekannt ist, rufen Sie Warnungen aller Gültigkeitsergebnisse ab. <br />Gilt nur für geheime Warnungen. <br />Das Filtern nach Gültigkeitsstatus kann dazu führen, dass weniger Warnungen zurückgegeben werden, als mit dem TOP-Parameter angefordert wurden. < >Aufgrund dieses Verhaltens wird die ContinuationToken(<![ CDATA[<Headername>]]>) im Antwortheader sollte verwendet werden, um zu entscheiden, ob ein weiterer Batch abgerufen werden muss.

Details zur Eigenschaft

alertIds

Wenn angegeben, werden nur Warnungen mit den angegebenen IDs zurückgegeben. <br />Andernfalls wird jede Warnung zurückgegeben.

alertIds: number[]

Eigenschaftswert

number[]

alertType

Wenn angegeben, geben Sie nur Warnungen dieses Typs zurück. Andernfalls geben Sie Warnungen aller Typen zurück.

alertType: AlertType

Eigenschaftswert

confidenceLevels

Wenn angegeben, werden nur Warnungen auf diesen Konfidenzniveaus zurückgegeben. <br />Sowohl hoch als auch sonstige müssen angegeben werden, um Warnungen aller Konfidenzstufen abzurufen. <br />Andernfalls werden Warnungen mit hoher Zuverlässigkeitsstufe zurückgegeben. <br />Gilt nur für geheime Warnungen.

confidenceLevels: Confidence[]

Eigenschaftswert

dependencyName

Wenn angegeben, werden nur Warnungen für diese Abhängigkeit zurückgegeben. <br/>Andernfalls geben Sie Warnungen für alle Abhängigkeiten zurück. <br />In einer sarifen Übermittlung wird eine Abhängigkeit (oder Komponente) in Ergebnis angegeben. RelatedLocations[].logicalLocation. <br />Gilt nicht für geheime Warnungen.

dependencyName: string

Eigenschaftswert

string

fromDate

Wenn angegeben, werden nach diesem Datum nur Benachrichtigungen zurückgegeben. <br />Andernfalls werden alle Warnungen zurückgegeben.

fromDate: Date

Eigenschaftswert

Date

hasLinkedWorkItems

Wenn angegeben, filtern Sie Warnungen basierend darauf, ob sie verknüpfte Arbeitsaufgaben haben. <br />Auf "true" gesetzt, um nur Benachrichtigungen mit verknüpften Arbeitsobjekten zurückzugeben. <br />Auf "falsch" gesetzt, um nur Benachrichtigungen ohne verknüpfte Arbeitselemente zurückzugeben. <br />Wenn nicht bereitgestellt, wird alle Benachrichtigungen unabhängig von verknüpften Arbeitseinträgen zurückgegeben. <br />Nicht anwendbar für Secret- und Abhängigkeitsscan-Warnungen.

hasLinkedWorkItems: boolean

Eigenschaftswert

boolean

keywords

Wenn angegeben, geben Sie nur Warnungen zurück, deren Titel diesem Muster entsprechen.

keywords: string

Eigenschaftswert

string

licenseName

Wenn angegeben, werden nur Warnungen zurückgegeben, die für Abhängigkeiten mit dieser Lizenz erstellt wurden. <br />Andernfalls geben Sie Benachrichtigungen für alle Lizenzen zurück. <br />In einer sarifen Übermittlung wird die Lizenz für eine Abhängigkeit (oder komponente) in Ergebnis angegeben. RelatedLocations[].logicalLocation.properties.license. <br />Gilt nicht für geheime Warnungen.

licenseName: string

Eigenschaftswert

string

modifiedSince

Wenn angegeben, geben Sie nur Warnungen zurück, die seit diesem Datum geändert wurden. <br />Andernfalls werden alle Warnungen zurückgegeben.

modifiedSince: Date

Eigenschaftswert

Date

onlyDefaultBranch

Wenn "true" oder nicht festgelegt ist, werden nur Warnungen zurückgegeben, die im Standardzweig des Repositorys gefunden wurden. <br />Wenn für die Standardverzweigung keine Ausgeführten ausgeführt wurden, wird die letzte Ausführung stattdessen unabhängig von der für diese Ausführung verwendeten Verzweigung verwendet. Wenn "false" zurückgegeben wird, werden Warnungen von allen Verzweigungen zurückgegeben. <br />Diese Option wird ignoriert, wenn bezug angegeben wird. <br />Gilt nicht für geheime Warnungen.

onlyDefaultBranch: boolean

Eigenschaftswert

boolean

phaseId

Wenn pipelineName bereitgestellt wird, werden in dieser Pipelinephase nur Warnungen zurückgegeben, die in dieser Pipelinephase <br/>Andernfalls werden warnungen zurückgegeben, die in allen Phasen erkannt wurden. <br />Gilt nicht für geheime Warnungen.

phaseId: string

Eigenschaftswert

string

phaseName

Wenn pipelineName bereitgestellt wird, werden in dieser Pipelinephase nur Warnungen zurückgegeben, die in dieser Pipelinephase <br/>Andernfalls werden warnungen zurückgegeben, die in allen Phasen erkannt wurden. <br />Gilt nicht für geheime Warnungen.

phaseName: string

Eigenschaftswert

string

pipelineName

Wenn angegeben, werden nur warnungen zurückgegeben, die in dieser Pipeline erkannt wurden. <br/>Andernfalls werden warnungen zurückgegeben, die in allen Pipelines erkannt wurden. <br />Gilt nicht für geheime Warnungen.

pipelineName: string

Eigenschaftswert

string

ref

Falls angegeben, schließen Sie nur Warnungen für diesen Verweis ein. <br />Wenn nicht angegeben und OnlyDefaultBranch "true" ist, schließen Sie nur Warnungen in der Standardverzweigung oder letzten Ausführungsverzweigung ein, wenn keine Analysekonfiguration für die Standardverzweigung vorhanden ist. <br />Andernfalls enthalten Sie Warnungen von allen Filialen. <br />Gilt nicht für geheime Warnungen.

ref: string

Eigenschaftswert

string

ruleId

Wenn angegeben, werden nur Warnungen für diese Regel zurückgegeben. <br />Andernfalls geben Sie Warnungen aller Regeln zurück.

ruleId: string

Eigenschaftswert

string

ruleName

Wenn angegeben, werden nur Warnungen für diese Regel zurückgegeben. <br />Andernfalls geben Sie Warnungen für alle Regeln zurück.

ruleName: string

Eigenschaftswert

string

severities

Wenn angegeben, werden nur Warnungen zu diesen Schweregraden zurückgegeben. <br />Andernfalls werden Warnungen mit beliebigem Schweregrad zurückgegeben.

severities: Severity[]

Eigenschaftswert

states

Wenn angegeben, werden nur Warnungen in diesen Zuständen zurückgegeben. <br />Andernfalls geben Sie Warnungen in jedem Zustand zurück.

states: State[]

Eigenschaftswert

State[]

toDate

Wenn angegeben, werden nur Benachrichtigungen zurückgegeben, die vor diesem Datum zuletzt angezeigt wurden. <br />Andernfalls werden alle Warnungen zurückgegeben.

toDate: Date

Eigenschaftswert

Date

toolName

Wenn sie mit toolName bereitgestellt wird, werden nur warnungen zurückgegeben, die von diesem Tool erkannt wurden. <br />Andernfalls werden warnungen zurückgegeben, die von allen Tools erkannt wurden.

toolName: string

Eigenschaftswert

string

validity

Wenn angegeben, geben Sie nur Warnungen mit der hier angegebenen Gültigkeit zurück. Wenn der Gültigkeitsstatus unbekannt ist, rufen Sie Warnungen aller Gültigkeitsergebnisse ab. <br />Gilt nur für geheime Warnungen. <br />Das Filtern nach Gültigkeitsstatus kann dazu führen, dass weniger Warnungen zurückgegeben werden, als mit dem TOP-Parameter angefordert wurden. < >Aufgrund dieses Verhaltens wird die ContinuationToken(<![ CDATA[<Headername>]]>) im Antwortheader sollte verwendet werden, um zu entscheiden, ob ein weiterer Batch abgerufen werden muss.

validity: AlertValidityStatus[]

Eigenschaftswert