Compartir a través de


SearchCriteria interface

Propiedades

alertIds

Si se proporciona, solo devuelve alertas con los identificadores especificados. <br />Otherwise, return any alert.

alertType

Si se proporciona, solo devuelve alertas de este tipo. De lo contrario, devuelve alertas de todos los tipos.

confidenceLevels

Si se proporciona, solo devuelve alertas en estos niveles de confianza. <br />Otherwise, return alerts at any confidence level.

dependencyName

Si se proporciona, solo se devuelven las alertas de esta dependencia. <br />Otherwise, return alerts for all dependencies. <br />In a sarif submission, a dependency (or a vulnerable component) is specified in result. RelatedLocations[].logicalLocation.

fromDate

Si se proporciona, solo se devuelven las alertas que se han visto por última vez después de esta fecha. <br />Otherwise return all alerts.

keywords

Si se proporciona, solo devuelve alertas cuyos títulos coinciden con este patrón.

modifiedSince

Si se proporciona, solo devuelve alertas modificadas desde esta fecha. <br />Otherwise return all alerts.

onlyDefaultBranchAlerts

Si es true, solo se devuelven las alertas encontradas en la rama predeterminada del repositorio. <br />If there have been no runs completed on the default branch, the last run is used instead of the branch used for that run. <br />This option is ignored if ref is provided.

phaseId

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase <de canalización br />Otherwise, devuelve alertas detectadas en todas las fases.

phaseName

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase <de canalización br />Otherwise, devuelve alertas detectadas en todas las fases.

pipelineName

Si se proporciona, solo se devuelven las alertas detectadas en esta canalización. <br />Otherwise, return alerts detected in all pipelines.

ref

Si se proporciona, incluya solo alertas para esta referencia. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is not analysis configuration for the default branch. <br />Otherwise, include alerts from all branches.

ruleId

Si se proporciona, solo devuelve alertas para esta regla. <br />Otherwise, return alerts of all rules.

ruleName

Si se proporciona, solo devuelve alertas para esta regla. <br />Otherwise, return alerts for all rules.

severities

Si se proporciona, solo devuelve alertas en estas gravedades. <br />Otherwise, return alerts at any serverity.

states

Si se proporciona, solo devuelve alertas en estos estados. <br />Otherwise, return alerts in any state.

toDate

Si se proporciona, solo se devuelven las alertas que se han visto por última vez antes de esta fecha. <br />Otherwise return all alerts.

toolName

Si se proporciona con toolName, solo devuelve las alertas detectadas por esta herramienta. <br />Otherwise, return alerts detected by all tools.

Detalles de las propiedades

alertIds

Si se proporciona, solo devuelve alertas con los identificadores especificados. <br />Otherwise, return any alert.

alertIds: number[]

Valor de propiedad

number[]

alertType

Si se proporciona, solo devuelve alertas de este tipo. De lo contrario, devuelve alertas de todos los tipos.

alertType: AlertType

Valor de propiedad

confidenceLevels

Si se proporciona, solo devuelve alertas en estos niveles de confianza. <br />Otherwise, return alerts at any confidence level.

confidenceLevels: Confidence[]

Valor de propiedad

dependencyName

Si se proporciona, solo se devuelven las alertas de esta dependencia. <br />Otherwise, return alerts for all dependencies. <br />In a sarif submission, a dependency (or a vulnerable component) is specified in result. RelatedLocations[].logicalLocation.

dependencyName: string

Valor de propiedad

string

fromDate

Si se proporciona, solo se devuelven las alertas que se han visto por última vez después de esta fecha. <br />Otherwise return all alerts.

fromDate: Date

Valor de propiedad

Date

keywords

Si se proporciona, solo devuelve alertas cuyos títulos coinciden con este patrón.

keywords: string

Valor de propiedad

string

modifiedSince

Si se proporciona, solo devuelve alertas modificadas desde esta fecha. <br />Otherwise return all alerts.

modifiedSince: Date

Valor de propiedad

Date

onlyDefaultBranchAlerts

Si es true, solo se devuelven las alertas encontradas en la rama predeterminada del repositorio. <br />If there have been no runs completed on the default branch, the last run is used instead of the branch used for that run. <br />This option is ignored if ref is provided.

onlyDefaultBranchAlerts: boolean

Valor de propiedad

boolean

phaseId

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase <de canalización br />Otherwise, devuelve alertas detectadas en todas las fases.

phaseId: string

Valor de propiedad

string

phaseName

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase <de canalización br />Otherwise, devuelve alertas detectadas en todas las fases.

phaseName: string

Valor de propiedad

string

pipelineName

Si se proporciona, solo se devuelven las alertas detectadas en esta canalización. <br />Otherwise, return alerts detected in all pipelines.

pipelineName: string

Valor de propiedad

string

ref

Si se proporciona, incluya solo alertas para esta referencia. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is not analysis configuration for the default branch. <br />Otherwise, include alerts from all branches.

ref: string

Valor de propiedad

string

ruleId

Si se proporciona, solo devuelve alertas para esta regla. <br />Otherwise, return alerts of all rules.

ruleId: string

Valor de propiedad

string

ruleName

Si se proporciona, solo devuelve alertas para esta regla. <br />Otherwise, return alerts for all rules.

ruleName: string

Valor de propiedad

string

severities

Si se proporciona, solo devuelve alertas en estas gravedades. <br />Otherwise, return alerts at any serverity.

severities: Severity[]

Valor de propiedad

states

Si se proporciona, solo devuelve alertas en estos estados. <br />Otherwise, return alerts in any state.

states: State[]

Valor de propiedad

State[]

toDate

Si se proporciona, solo se devuelven las alertas que se han visto por última vez antes de esta fecha. <br />Otherwise return all alerts.

toDate: Date

Valor de propiedad

Date

toolName

Si se proporciona con toolName, solo devuelve las alertas detectadas por esta herramienta. <br />Otherwise, return alerts detected by all tools.

toolName: string

Valor de propiedad

string