メインコンテンツへスキップ
GET
コードスキャン検出結果の一覧

権限

組織レベルで ViewCodeScans 権限を持つサービスユーザーまたはパーソナルアクセストークンが必要です。

承認

Authorization
string
header
必須

サービスユーザーの credential(プレフィックス: cog_)

パスパラメータ

org_id
string
必須

組織ID(プレフィックス: org-)

例:

"org-abc123def456"

クエリパラメータ

after
string | null
first
integer
デフォルト:100
必須範囲: 1 <= x <= 200
q
string | null

検出結果のタイトル、説明、ファイルパスを対象にテキスト検索を行います。repo_nameなどの他のフィルターと組み合わせて使用できます。空欄の場合は検索しません。組織で検索を利用できない場合は503を返します。

Maximum string length: 200
scan_id
string | null

このスキャンで生成された検出結果に絞り込みます。

repo_name
string | null

このリポジトリで報告された検出結果に絞り込みます。

severity
enum<string>[] | null

これらの重大度(critical、high、medium、low)のいずれかに該当する検出結果に絞り込みます。

利用可能なオプション:
critical,
high,
medium,
low
status
enum<string>[] | null

次のステータス(open, dismissed, resolved)のいずれかに該当する検出結果に絞り込みます。

利用可能なオプション:
open,
dismissed,
resolved
payoff
enum<string>[] | null

指定した費用対効果の象限(quick_win, big_fix, easy_fix, deprioritize)のいずれかに属する検出結果でフィルターします。未評価の検出事項(fix_effort が null)は、この条件には一致しません。

Maximum array length: 4
利用可能なオプション:
quick_win,
big_fix,
easy_fix,
deprioritize
created_after
integer | null

この Unix タイムスタンプ(秒)以降に作成された検出結果。

created_before
integer | null

この Unix タイムスタンプ(秒)以前に作成された検出結果。

updated_after
integer | null

この Unix タイムスタンプ(秒)以降に更新された検出結果。

updated_before
integer | null

この Unix タイムスタンプ(秒)以前に更新された検出結果。

レスポンス

成功レスポンス

items
CodeScanFindingResponse · object[]
必須
end_cursor
string | null

次のページを取得するためのカーソル。これが最後のページの場合はNone。

has_next_page
boolean
デフォルト:false

このページの後にさらにアイテムがあるかどうか。

total
integer | null

省略可能な合計件数(パフォーマンスのため省略できます)。