SearchCriteria interface
Properti
| alert |
Jika disediakan, hanya kembalikan pemberitahuan dengan id yang ditentukan. <br />Jika tidak, kembalikan pemberitahuan apa pun. |
| alert |
Jika disediakan, hanya kembalikan pemberitahuan jenis ini. Jika tidak, kembalikan pemberitahuan dari semua jenis. |
| confidence |
Jika disediakan, hanya kembalikan pemberitahuan pada tingkat keyakinan ini. <br />Baik Tinggi maupun Lainnya perlu ditentukan untuk mengambil pemberitahuan dari semua tingkat keyakinan. <br />Jika tidak, kembalikan pemberitahuan dengan tingkat keyakinan tinggi. <br />Hanya berlaku untuk pemberitahuan rahasia. |
| dependency |
Jika disediakan, hanya pemberitahuan untuk dependensi ini yang dikembalikan. <br />Jika tidak, kembalikan pemberitahuan untuk semua dependensi. <br />Dalam pengiriman sarif, dependensi (atau komponen) ditentukan dalam hasil. RelatedLocations[].logicalLocation. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| from |
Jika disediakan, hanya kembalikan pemberitahuan yang terakhir terlihat setelah tanggal ini. <br />Jika tidak, kembalikan semua pemberitahuan. |
| has |
Jika disediakan, memfilter pemberitahuan berdasarkan apakah mereka memiliki item kerja yang ditautkan. <br />Set ke "true" untuk hanya mengembalikan pemberitahuan dengan item kerja tertaut. <br />Set ke "false" untuk hanya mengembalikan pemberitahuan tanpa item kerja tertaut. <br />Jika tidak disediakan, mengembalikan semua pemberitahuan terlepas dari item kerja yang ditautkan. <br />Tidak berlaku untuk pemberitahuan pemindaian rahasia dan dependensi. |
| keywords | Jika disediakan, hanya kembalikan pemberitahuan yang judulnya cocok dengan pola ini. |
| license |
Jika disediakan, hanya pemberitahuan yang dibuat untuk dependensi dengan lisensi ini yang dikembalikan. <br />Jika tidak, kembalikan pemberitahuan untuk semua lisensi. <br />Dalam pengiriman sarif, lisensi untuk dependensi (atau komponen) ditentukan dalam hasil. RelatedLocations[].logicalLocation.properties.license. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| modified |
Jika disediakan, hanya kembalikan pemberitahuan yang dimodifikasi sejak tanggal ini. <br />Jika tidak, kembalikan semua pemberitahuan. |
| only |
Jika benar atau tidak diatur, hanya kembalikan pemberitahuan yang ditemukan di cabang default repositori. <br />Jika belum ada eksekusi yang diselesaikan pada cabang default, eksekusi terakhir digunakan sebagai gantinya terlepas dari cabang yang digunakan untuk eksekusi tersebut. Jika false, kembalikan pemberitahuan dari semua cabang. <br />Opsi ini diabaikan jika ref disediakan. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| phase |
Jika disediakan dengan pipelineName, hanya kembalikan pemberitahuan yang terdeteksi dalam fase alur ini <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua fase. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| phase |
Jika disediakan dengan pipelineName, hanya kembalikan pemberitahuan yang terdeteksi dalam fase alur ini <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua fase. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| pipeline |
Jika disediakan, hanya kembalikan pemberitahuan yang terdeteksi dalam alur ini. <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua alur. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| ref | Jika disediakan, hanya sertakan pemberitahuan untuk ref ini. <br/>Jika tidak disediakan dan OnlyDefaultBranch benar, hanya sertakan pemberitahuan yang ditemukan di cabang default atau cabang eksekusi terakhir jika tidak ada konfigurasi analisis untuk cabang default. <br />Jika tidak, sertakan pemberitahuan dari semua cabang. <br />Tidak berlaku untuk pemberitahuan rahasia. |
| rule |
Jika disediakan, hanya kembalikan pemberitahuan untuk aturan ini. <br />Jika tidak, kembalikan pemberitahuan dari semua aturan. |
| rule |
Jika disediakan, hanya kembalikan pemberitahuan untuk aturan ini. <br />Jika tidak, kembalikan pemberitahuan untuk semua aturan. |
| severities | Jika disediakan, hanya kembalikan pemberitahuan pada tingkat keparahan ini. <br />Jika tidak, kembalikan pemberitahuan pada tingkat keparahan apa pun. |
| states | Jika disediakan, hanya kembalikan pemberitahuan di status ini. <br />Jika tidak, kembalikan pemberitahuan dalam status apa pun. |
| to |
Jika disediakan, hanya kembalikan pemberitahuan yang terakhir terlihat sebelum tanggal ini. <br />Jika tidak, kembalikan semua pemberitahuan. |
| tool |
Jika disediakan dengan toolName, hanya kembalikan pemberitahuan yang terdeteksi oleh alat ini. <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi oleh semua alat. |
| validity | Jika disediakan, hanya kembalikan pemberitahuan dengan validitas yang ditentukan di sini. Jika status validitas Tidak Diketahui, ambil pemberitahuan semua hasil validitas. <br />Hanya berlaku untuk pemberitahuan rahasia. <br />Pemfilteran berdasarkan status validitas dapat menyebabkan lebih sedikit peringatan yang dikembalikan daripada yang diminta dengan parameter TOP. <br />Karena perilaku ini, ContinuationToken(<![ CDATA[<nama>> header]]) dalam header respons harus diandalkan untuk memutuskan apakah batch lain perlu diambil. |
Detail Properti
alertIds
Jika disediakan, hanya kembalikan pemberitahuan dengan id yang ditentukan. <br />Jika tidak, kembalikan pemberitahuan apa pun.
alertIds: number[]
Nilai Properti
number[]
alertType
Jika disediakan, hanya kembalikan pemberitahuan jenis ini. Jika tidak, kembalikan pemberitahuan dari semua jenis.
alertType: AlertType
Nilai Properti
confidenceLevels
Jika disediakan, hanya kembalikan pemberitahuan pada tingkat keyakinan ini. <br />Baik Tinggi maupun Lainnya perlu ditentukan untuk mengambil pemberitahuan dari semua tingkat keyakinan. <br />Jika tidak, kembalikan pemberitahuan dengan tingkat keyakinan tinggi. <br />Hanya berlaku untuk pemberitahuan rahasia.
confidenceLevels: Confidence[]
Nilai Properti
dependencyName
Jika disediakan, hanya pemberitahuan untuk dependensi ini yang dikembalikan. <br />Jika tidak, kembalikan pemberitahuan untuk semua dependensi. <br />Dalam pengiriman sarif, dependensi (atau komponen) ditentukan dalam hasil. RelatedLocations[].logicalLocation. <br />Tidak berlaku untuk pemberitahuan rahasia.
dependencyName: string
Nilai Properti
string
fromDate
Jika disediakan, hanya kembalikan pemberitahuan yang terakhir terlihat setelah tanggal ini. <br />Jika tidak, kembalikan semua pemberitahuan.
fromDate: Date
Nilai Properti
Date
hasLinkedWorkItems
Jika disediakan, memfilter pemberitahuan berdasarkan apakah mereka memiliki item kerja yang ditautkan. <br />Set ke "true" untuk hanya mengembalikan pemberitahuan dengan item kerja tertaut. <br />Set ke "false" untuk hanya mengembalikan pemberitahuan tanpa item kerja tertaut. <br />Jika tidak disediakan, mengembalikan semua pemberitahuan terlepas dari item kerja yang ditautkan. <br />Tidak berlaku untuk pemberitahuan pemindaian rahasia dan dependensi.
hasLinkedWorkItems: boolean
Nilai Properti
boolean
keywords
Jika disediakan, hanya kembalikan pemberitahuan yang judulnya cocok dengan pola ini.
keywords: string
Nilai Properti
string
licenseName
Jika disediakan, hanya pemberitahuan yang dibuat untuk dependensi dengan lisensi ini yang dikembalikan. <br />Jika tidak, kembalikan pemberitahuan untuk semua lisensi. <br />Dalam pengiriman sarif, lisensi untuk dependensi (atau komponen) ditentukan dalam hasil. RelatedLocations[].logicalLocation.properties.license. <br />Tidak berlaku untuk pemberitahuan rahasia.
licenseName: string
Nilai Properti
string
modifiedSince
Jika disediakan, hanya kembalikan pemberitahuan yang dimodifikasi sejak tanggal ini. <br />Jika tidak, kembalikan semua pemberitahuan.
modifiedSince: Date
Nilai Properti
Date
onlyDefaultBranch
Jika benar atau tidak diatur, hanya kembalikan pemberitahuan yang ditemukan di cabang default repositori. <br />Jika belum ada eksekusi yang diselesaikan pada cabang default, eksekusi terakhir digunakan sebagai gantinya terlepas dari cabang yang digunakan untuk eksekusi tersebut. Jika false, kembalikan pemberitahuan dari semua cabang. <br />Opsi ini diabaikan jika ref disediakan. <br />Tidak berlaku untuk pemberitahuan rahasia.
onlyDefaultBranch: boolean
Nilai Properti
boolean
phaseId
Jika disediakan dengan pipelineName, hanya kembalikan pemberitahuan yang terdeteksi dalam fase alur ini <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua fase. <br />Tidak berlaku untuk pemberitahuan rahasia.
phaseId: string
Nilai Properti
string
phaseName
Jika disediakan dengan pipelineName, hanya kembalikan pemberitahuan yang terdeteksi dalam fase alur ini <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua fase. <br />Tidak berlaku untuk pemberitahuan rahasia.
phaseName: string
Nilai Properti
string
pipelineName
Jika disediakan, hanya kembalikan pemberitahuan yang terdeteksi dalam alur ini. <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua alur. <br />Tidak berlaku untuk pemberitahuan rahasia.
pipelineName: string
Nilai Properti
string
ref
Jika disediakan, hanya sertakan pemberitahuan untuk ref ini. <br/>Jika tidak disediakan dan OnlyDefaultBranch benar, hanya sertakan pemberitahuan yang ditemukan di cabang default atau cabang eksekusi terakhir jika tidak ada konfigurasi analisis untuk cabang default. <br />Jika tidak, sertakan pemberitahuan dari semua cabang. <br />Tidak berlaku untuk pemberitahuan rahasia.
ref: string
Nilai Properti
string
ruleId
Jika disediakan, hanya kembalikan pemberitahuan untuk aturan ini. <br />Jika tidak, kembalikan pemberitahuan dari semua aturan.
ruleId: string
Nilai Properti
string
ruleName
Jika disediakan, hanya kembalikan pemberitahuan untuk aturan ini. <br />Jika tidak, kembalikan pemberitahuan untuk semua aturan.
ruleName: string
Nilai Properti
string
severities
Jika disediakan, hanya kembalikan pemberitahuan pada tingkat keparahan ini. <br />Jika tidak, kembalikan pemberitahuan pada tingkat keparahan apa pun.
severities: Severity[]
Nilai Properti
Severity[]
states
Jika disediakan, hanya kembalikan pemberitahuan di status ini. <br />Jika tidak, kembalikan pemberitahuan dalam status apa pun.
states: State[]
Nilai Properti
State[]
toDate
Jika disediakan, hanya kembalikan pemberitahuan yang terakhir terlihat sebelum tanggal ini. <br />Jika tidak, kembalikan semua pemberitahuan.
toDate: Date
Nilai Properti
Date
toolName
Jika disediakan dengan toolName, hanya kembalikan pemberitahuan yang terdeteksi oleh alat ini. <br />Jika tidak, kembalikan pemberitahuan yang terdeteksi oleh semua alat.
toolName: string
Nilai Properti
string
validity
Jika disediakan, hanya kembalikan pemberitahuan dengan validitas yang ditentukan di sini. Jika status validitas Tidak Diketahui, ambil pemberitahuan semua hasil validitas. <br />Hanya berlaku untuk pemberitahuan rahasia. <br />Pemfilteran berdasarkan status validitas dapat menyebabkan lebih sedikit peringatan yang dikembalikan daripada yang diminta dengan parameter TOP. <br />Karena perilaku ini, ContinuationToken(<![ CDATA[<nama>> header]]) dalam header respons harus diandalkan untuk memutuskan apakah batch lain perlu diambil.
validity: AlertValidityStatus[]