List Defect Groups By Link

Request

GET

https://appsec.sourcecraft.tech/v1/defect-groups/by-link

Query parameters

Name	Description
gitRepo	Type: string Repository identifier. Accepts either internal repository ID (e.g., 88769874964302633) or public UUID (e.g., 0199140f-4343-7c06-a7e3-b835c305b629). These values can be obtained from the getRepo API (fields: id and uuid). Pattern: `\S` Example: `0199140f-4343-7c06-a7e3-b835c305b629`
identifier	Type: string Identifier of the link as it is stored: a platform ID for SOURCECRAFT_ISSUE and SOURCECRAFT_PR, an HTTPS URL for the other types Pattern: `\S` Example: `281474976710700`
linkType	Type: LinkType Link type to search by: EXTERNAL_URL, SOURCECRAFT_ISSUE, SOURCECRAFT_PR or YA_TRACKER Enum: `EXTERNAL_URL`, `SOURCECRAFT_ISSUE`, `SOURCECRAFT_PR`, `YA_TRACKER`
pageSize	Type: integer Pagination page size, maximum 250, default: 50 defect groups Default: `50` Min value: `1` Max value: `250`
pageToken	Type: string Page token for cursor-based pagination. Omit for first page, use nextPageToken (from the response) to request subsequent pages. Default: `` Example: `3f5d8c9a1e4afj4bv44b453jg`

LinkType

Type: string

Enum: EXTERNAL_URL, SOURCECRAFT_ISSUE, SOURCECRAFT_PR, YA_TRACKER

Responses

200 OK

Body

application/json

{
  "data": [
    {
      "id": 0,
      "ruleName": "example",
      "codeBlock": "example",
      "fileName": "example",
      "latestCommit": "example",
      "latestTimeFound": 0,
      "gitRepo": "example",
      "status": 0,
      "severity": 0,
      "cvssScore": 0.5,
      "engine": "example",
      "neuroTriageUuid": "123e4567-e89b-12d3-a456-426614174000",
      "neuroScore": 0,
      "firstCommit": "example",
      "firstTimeFound": 0,
      "uuid": null,
      "ruleId": "example",
      "findingsCount": 0,
      "publicId": 0,
      "fixOperationUuid": null,
      "engineType": 0,
      "startLine": 0,
      "endLine": 0,
      "startColumn": 0,
      "endColumn": 0,
      "links": [
        {
          "type": "EXTERNAL_URL",
          "url": "example"
        }
      ]
    }
  ],
  "nextPageToken": "example",
  "totalSize": 0,
  "listRevision": "example"
}

Name	Description
data	Type: DefectGroupDto[] Example [ { "id": 0, "ruleName": "example", "codeBlock": "example", "fileName": "example", "latestCommit": "example", "latestTimeFound": 0, "gitRepo": "example", "status": 0, "severity": 0, "cvssScore": 0.5, "engine": "example", "neuroTriageUuid": "123e4567-e89b-12d3-a456-426614174000", "neuroScore": 0, "firstCommit": "example", "firstTimeFound": 0, "uuid": null, "ruleId": "example", "findingsCount": 0, "publicId": 0, "fixOperationUuid": null, "engineType": 0, "startLine": 0, "endLine": 0, "startColumn": 0, "endColumn": 0, "links": [ { "type": "EXTERNAL_URL", "url": "example" } ] } ]
nextPageToken	Type: string Example: `example`
totalSize	Type: integer
listRevision	Type: string \| null Example: `example`

UUID

Type: string<uuid>

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Example: 123e4567-e89b-12d3-a456-426614174000

DefectGroupLinkDto

Name

Description

type

Type: LinkType

Enum: EXTERNAL_URL, SOURCECRAFT_ISSUE, SOURCECRAFT_PR, YA_TRACKER

url

Type: string

Example: example

Example

{
  "type": "EXTERNAL_URL",
  "url": "example"
}

DefectGroupDto

Name	Description
codeBlock	Type: string Example: `example`
cvssScore	Type: number
engine	Type: string Example: `example`
fileName	Type: string Example: `example`
firstCommit	Type: string Example: `example`
firstTimeFound	Type: integer
gitRepo	Type: string Example: `example`
id	Type: integer
latestCommit	Type: string Example: `example`
latestTimeFound	Type: integer
neuroScore	Type: integer
neuroTriageUuid	Any of 2 types Type: UUID Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}` Example: `123e4567-e89b-12d3-a456-426614174000` Type: null Example: `null` Example: `123e4567-e89b-12d3-a456-426614174000`
ruleId	Type: string Example: `example`
ruleName	Type: string Example: `example`
severity	Type: integer
status	Type: integer
uuid	Type: UUID Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}` Example: `123e4567-e89b-12d3-a456-426614174000`
endColumn	Type: integer
endLine	Type: integer
engineType	Type: integer
findingsCount	Type: integer
fixOperationUuid	Any of 2 types Type: UUID Pattern: `[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}` Example: `123e4567-e89b-12d3-a456-426614174000` Type: null Example: `null` Example: `123e4567-e89b-12d3-a456-426614174000`
links	Type: DefectGroupLinkDto[] Example `[ { "type": "EXTERNAL_URL", "url": "example" } ]`
publicId	Type: integer
startColumn	Type: integer
startLine	Type: integer

Example

{
  "id": 0,
  "ruleName": "example",
  "codeBlock": "example",
  "fileName": "example",
  "latestCommit": "example",
  "latestTimeFound": 0,
  "gitRepo": "example",
  "status": 0,
  "severity": 0,
  "cvssScore": 0.5,
  "engine": "example",
  "neuroTriageUuid": "123e4567-e89b-12d3-a456-426614174000",
  "neuroScore": 0,
  "firstCommit": "example",
  "firstTimeFound": 0,
  "uuid": null,
  "ruleId": "example",
  "findingsCount": 0,
  "publicId": 0,
  "fixOperationUuid": null,
  "engineType": 0,
  "startLine": 0,
  "endLine": 0,
  "startColumn": 0,
  "endColumn": 0,
  "links": [
    {
      "type": "EXTERNAL_URL",
      "url": "example"
    }
  ]
}

Was the article helpful?

List Defect Groups

List Engine Types