> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corgea.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Code-Quality-Detections eines Scans abrufen

> Ruft Code-Quality-Detections für einen bestimmten Scan ab. Standardmäßig werden Ergebnisse nach Erstellungszeit absteigend sortiert. Bei gleicher Erstellungszeit entscheidet die Detection-ID für eine stabile Paginierung.

Auch unter `/api/v1/scan/{scan_id}/issues/quality` erreichbar, dem früheren Namen dieses Endpunkts, der weiterhin mit denselben Parametern und derselben Antwort unterstützt wird.



## OpenAPI

````yaml /de/api-reference/openapi.json get /scan/{scan_id}/detections/quality
openapi: 3.0.0
info:
  title: Corgea API
  version: 1.0.0
  description: >-
    API für die Interaktion mit den Scan- und
    Schwachstellenmanagement-Funktionen von Corgea
servers:
  - url: https://www.corgea.app/api/v1
    description: Produktionsserver
  - url: https://eu.corgea.app/api/v1
    description: EU-Produktionsserver
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /scan/{scan_id}/detections/quality:
    get:
      tags:
        - Detections
      summary: Code-Quality-Detections eines Scans abrufen
      description: >-
        Ruft Code-Quality-Detections für einen bestimmten Scan ab. Standardmäßig
        werden Ergebnisse nach Erstellungszeit absteigend sortiert. Bei gleicher
        Erstellungszeit entscheidet die Detection-ID für eine stabile
        Paginierung.


        Auch unter `/api/v1/scan/{scan_id}/issues/quality` erreichbar, dem
        früheren Namen dieses Endpunkts, der weiterhin mit denselben Parametern
        und derselben Antwort unterstützt wird.
      operationId: getScanCodeQualityIssues
      parameters:
        - name: scan_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID des Scans
        - name: classification
          in: query
          schema:
            type: string
          description: >-
            Nach Code-Quality-Klassifizierungslabel filtern
            (Teilübereinstimmung)
          example: Maintainability
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          schema:
            type: integer
            default: 20
            maximum: 50
      responses:
        '200':
          description: Code-Quality-Issues erfolgreich abgerufen
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  page:
                    type: integer
                  total_pages:
                    type: integer
                  total_issues:
                    type: integer
                  issues:
                    type: array
                    items:
                      $ref: '#/components/schemas/Issue'
        '404':
          description: >-
            Scan nicht gefunden oder bei aktivierter Projektzugriffskontrolle
            ist der Aufrufer kein Unternehmensadmin und hat keinen Zugriff auf
            das Projekt des Scans.
components:
  schemas:
    Issue:
      type: object
      properties:
        finding_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID des Findings, von dem dieses Issue eine Detection ist: über
            Rescans hinweg dieselbe. Null bei einem Issue, das erfasst wurde,
            bevor es Findings gab.
        id:
          type: string
          format: uuid
        classification:
          type: object
          nullable: true
          description: >-
            Wenn die CWE unbekannt ist oder die Klassifizierung eine freie
            Bezeichnung ist, enthalten id und name die ursprüngliche
            Klassifizierungsbezeichnung und description ist null. Eine leere
            Klassifizierung wird als null zurückgegeben.
          properties:
            id:
              type: string
              example: CWE-123
            name:
              type: string
              example: Vulnerability Name
            description:
              type: string
              nullable: true
        urgency:
          type: string
          enum:
            - CR
            - HI
            - ME
            - LO
          description: >-
            Dringlichkeitscode: CR (kritisch), HI (hoch), ME (mittel) oder LO
            (niedrig).
        created_at:
          type: string
          format: date-time
        first_detection_date:
          type: string
          format: date-time
          description: >-
            Zeitpunkt, zu dem Corgea dieses Issue erstmals erkannt hat, über
            alle Scans hinweg, in denen es auftrat. Entspricht created_at, wenn
            dies die früheste Erkennung ist.
        status:
          type: string
          nullable: true
          enum:
            - open
            - fix_in_progress
            - fixed
            - false_positive
            - accepted_risk
            - duplicate
        sla_status:
          type: string
          nullable: true
          enum:
            - overdue
            - escalated
          description: >-
            SLA-Verletzungsstatus. null, wenn das Issue weder überfällig noch
            eskaliert ist.
        location:
          $ref: '#/components/schemas/IssueLocation'
        auto_triage:
          $ref: '#/components/schemas/AutoTriage'
        auto_fix_suggestion:
          $ref: '#/components/schemas/AutoFixSuggestion'
        assigned_to:
          $ref: '#/components/schemas/AssignedTo'
        reachability:
          $ref: '#/components/schemas/IssueReachabilitySummary'
    IssueLocation:
      type: object
      properties:
        file:
          type: object
          properties:
            name:
              type: string
            language:
              type: string
            path:
              type: string
            git_hash:
              type: string
              nullable: true
              description: >-
                Für die gescannte Datei erfasster Git-Hash. Wird nur von den
                Endpoints zurückgegeben, die Issues auflisten.
        project:
          type: object
          properties:
            name:
              type: string
            branch:
              type: string
            git_sha:
              type: string
        line_number:
          type: integer
        sink_line_number:
          type: integer
          nullable: true
          description: >-
            Zeile der Senke im Datenfluss, wenn sich die Senke in dieser Datei
            befindet, andernfalls null. Wird nur beim Abrufen eines einzelnen
            Issues zurückgegeben.
    AutoTriage:
      type: object
      properties:
        false_positive_detection:
          type: object
          properties:
            status:
              type: string
              enum:
                - valid
                - false_positive
                - pending
            reasoning:
              description: >-
                Begründung der False-Positive-Einstufung, sofern verfügbar, auch
                wenn kein Fix generiert wurde.
              type: string
              nullable: true
    AutoFixSuggestion:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - fix_available
            - no_fix
            - generating
            - false_positive
            - on_hold
            - unsupported
            - plan
          description: >-
            Aktuelle Fix-Verfügbarkeit. Beim Abrufen eines Issues wird
            standardmäßig ein geeigneter fehlender Fix im Hintergrund generiert.
            Während dieser Generierung lautet der Status generating; rufen Sie
            das Issue erneut ab, bis die Generierung abgeschlossen ist. Ist die
            Generierung deaktiviert oder wird kein Fix erzeugt, lautet der
            Status no_fix.
        patch:
          type: object
          properties:
            diff:
              type: string
              description: >-
                Patch im Unified-Diff-Format. Gibt eine leere Zeichenfolge
                zurück, wenn der Fix keinen Diff enthält.
            explanation:
              type: string
              description: Erläuterung, wie der Fix die Schwachstelle behebt
            full_code:
              type: string
              description: >-
                Vollständiger Quellcode der Datei mit angewendetem Fix. Wird nur
                zurückgegeben, wenn show_full_code true ist und ein Fix
                vorhanden ist.
    AssignedTo:
      type: object
      nullable: true
      description: >-
        Dem Issue zugewiesener Benutzer oder null, wenn das Issue nicht
        zugewiesen ist.
      properties:
        id:
          type: string
          description: ID des zugewiesenen Benutzers.
        email:
          type: string
          format: email
          description: E-Mail-Adresse des zugewiesenen Benutzers.
        name:
          type: string
          nullable: true
          description: >-
            Anzeigename des zugewiesenen Benutzers oder null, wenn nicht
            verfügbar.
    IssueReachabilitySummary:
      type: object
      description: >-
        Zusammenfassung der Endpoint-Erreichbarkeit, die zurückgegeben wird,
        wenn include_reachability true ist.
      properties:
        is_reachable:
          type: boolean
        endpoint_count:
          type: integer
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: >-
        API-Key für die Authentifizierung API-Tokens inaktiver Benutzer werden
        abgelehnt.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2-Access-Token (JWT) im Authorization-Header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.