Skip to main content

Schemas

Cx.Osa.Application.DTOs.Responses.V3.ScannedLibraryDTO

{
  "id": "string",
  "name": "string",
  "version": "string",
  "releaseDate": "2019-08-24T14:15:22Z",
  "highUniqueVulnerabilityCount": 0,
  "mediumUniqueVulnerabilityCount": 0,
  "lowUniqueVulnerabilityCount": 0,
  "notExploitableVulnerabilityCount": 0,
  "newestVersion": "string",
  "newestVersionReleaseDate": "2019-08-24T14:15:22Z",
  "numberOfVersionsSinceLastUpdate": 0,
  "confidenceLevel": 0,
  "matchType": {
    "id": 0,
    "name": "string",
    "description": "string"
  },
  "licenses": [
    "string"
  ],
  "outdated": true,
  "severity": {
    "id": 0,
    "name": "string"
  },
  "riskScore": 0,
  "locations": [
    {
      "path": "string",
      "matchType": {}
    }
  ],
  "codeUsageStatus": "string",
  "codeReferenceCount": 0,
  "packageRepository": "string"
}

Library DTO

Properties

Name

Type

Required

Restrictions

Description

id

string

false

none

Library ID

name

string

false

none

Library Name

version

string

false

none

Library Version

releaseDate

string(date-time)

false

none

Library Release date of the current version

highUniqueVulnerabilityCount

integer(int32)

false

none

Number of high vulnerabilities

mediumUniqueVulnerabilityCount

integer(int32)

false

none

Number of medium vulnerabilities

lowUniqueVulnerabilityCount

integer(int32)

false

none

Number of low vulnerabilities

notExploitableVulnerabilityCount

integer(int32)

false

none

Number of not exploitable vulnerabilities

newestVersion

string

false

none

Newest version (if no newest version exists, then this field will remain empty)

newestVersionReleaseDate

string(date-time)

false

none

Release date of newest version (if no newest version exists, then this field will contain 1970/1/1)

numberOfVersionsSinceLastUpdate

integer(int32)

false

none

Number of newer versions (if no newest version exists, then this field will be 0)

confidenceLevel

integer(int32)

false

none

The confidence level about the provided result

matchType

Cx.Osa.Application.DTOs.MatchTypeDto

false

none

none

licenses

[string]

false

none

Collection of legal licenses id

outdated

boolean

false

none

Indicate whether this library outdated

severity

Cx.Osa.Application.DTOs.SeverityDTO

false

none

none

riskScore

number(double)

false

none

Library risk score based on highest vulnerability risk score

locations

[Cx.Osa.Application.DTOs.Responses.LibraryLocationDto]

false

none

Library locations and their match-type

codeUsageStatus

string

false

none

none

codeReferenceCount

integer(int64)

false

none

none

packageRepository

string

false

none

none

Cx.Osa.Application.DTOs.MatchTypeDto

{
  "id": 0,
  "name": "string",
  "description": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

read-only

none

name

string

false

read-only

none

description

string

false

read-only

none

Cx.Osa.Application.DTOs.SeverityDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string

false

none

none

Cx.Osa.Application.DTOs.Responses.LibraryLocationDto

{
  "path": "string",
  "matchType": {
    "id": 0,
    "name": "string",
    "description": "string"
  }
}

Properties

Name

Type

Required

Restrictions

Description

path

string

false

read-only

none

matchType

Cx.Osa.Application.DTOs.MatchTypeDto

false

none

none

ScanMetrics.Presentation.DTOs.Api.ScanStatisticsDTO

{
  "id": 0,
  "scanId": "00000000-0000-0000-0000-000000000000",
  "scanStatus": "Null",
  "productVersion": "string",
  "engineVersion": "string",
  "memoryPeakInMB": 0,
  "virtualMemoryPeakInMB": 0,
  "isIncrementalScan": true,
  "resultsCount": 0,
  "totalUnScannedFilesCount": 0,
  "fileCountOfDetectedButNotScannedLanguages": {
    "unknown": 0,
    "cSharp": 0,
    "java": 0,
    "cpp": 0,
    "javaScript": 0,
    "apex": 0,
    "vbNet": 0,
    "vbScript": 0,
    "asp": 0,
    "vB6": 0,
    "php": 0,
    "ruby": 0,
    "perl": 0,
    "objc": 0,
    "plsql": 0,
    "python": 0,
    "groovy": 0,
    "scala": 0,
    "go": 0,
    "kotlin": 0,
    "cobol": 0,
    "rpg": 0,
    "swift": 0,
    "dart": 0,
    "common": 0
  },
  "totalFilteredParsedLOC": 0,
  "totalUnFilteredParsedLOC": 0,
  "languageStatistics": {
    "unknown": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "cSharp": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "java": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "cpp": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "javaScript": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "apex": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "vbNet": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "vbScript": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "asp": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "vB6": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "php": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "ruby": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "perl": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "objc": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "plsql": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "python": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "groovy": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "scala": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "go": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "kotlin": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "cobol": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "rpg": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "swift": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "dart": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    },
    "common": {
      "parsedFiles": {},
      "scannedLOCPerLanguage": {},
      "countOfDomObjects": 0
    }
  },
  "exclusionFoldersPattern": "string",
  "exclusionFilesPattern": "string",
  "failedQueriesCount": 0,
  "generalQueries": {
    "succeededGeneralQueriesCount": 0,
    "failedGeneralQueriesCount": 0
  },
  "failedStages": "string",
  "engineOperatingSystem": "string",
  "enginePackVersion": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

scanId

string(uuid)

false

none

none

scanStatus

string

false

none

none

productVersion

string

false

none

none

engineVersion

string

false

none

none

memoryPeakInMB

integer(int32)

false

none

none

virtualMemoryPeakInMB

integer(int32)

false

none

none

isIncrementalScan

boolean

false

none

none

resultsCount

integer(int32)

false

none

none

totalUnScannedFilesCount

integer(int32)

false

none

none

fileCountOfDetectedButNotScannedLanguages

object

false

none

none

» unknown

integer(int32)

false

none

none

» cSharp

integer(int32)

false

none

none

» java

integer(int32)

false

none

none

» cpp

integer(int32)

false

none

none

» javaScript

integer(int32)

false

none

none

» apex

integer(int32)

false

none

none

» vbNet

integer(int32)

false

none

none

» vbScript

integer(int32)

false

none

none

» asp

integer(int32)

false

none

none

» vB6

integer(int32)

false

none

none

» php

integer(int32)

false

none

none

» ruby

integer(int32)

false

none

none

» perl

integer(int32)

false

none

none

» objc

integer(int32)

false

none

none

» plsql

integer(int32)

false

none

none

» python

integer(int32)

false

none

none

» groovy

integer(int32)

false

none

none

» scala

integer(int32)

false

none

none

» go

integer(int32)

false

none

none

» kotlin

integer(int32)

false

none

none

» cobol

integer(int32)

false

none

none

» rpg

integer(int32)

false

none

none

» swift

integer(int32)

false

none

none

» dart

integer(int32)

false

none

none

» common

integer(int32)

false

none

none

totalFilteredParsedLOC

integer(int64)

false

none

none

totalUnFilteredParsedLOC

integer(int64)

false

none

none

languageStatistics

object

false

none

none

» unknown

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» cSharp

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» java

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» cpp

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» javaScript

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» apex

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» vbNet

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» vbScript

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» asp

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» vB6

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» php

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» ruby

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» perl

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» objc

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» plsql

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» python

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» groovy

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» scala

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» go

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» kotlin

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» cobol

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» rpg

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» swift

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» dart

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

» common

ScanMetrics.Domain.Entities.LanguageStatistics

false

none

none

exclusionFoldersPattern

string

false

none

none

exclusionFilesPattern

string

false

none

none

failedQueriesCount

integer(int32)

false

none

none

generalQueries

ScanMetrics.Domain.Entities.GeneralQueries

false

none

none

failedStages

string

false

none

none

engineOperatingSystem

string

false

none

none

enginePackVersion

string

false

none

none

Enumerated Values

Property

Value

scanStatus

Null

scanStatus

Finished

scanStatus

Canceled

scanStatus

Failed

ScanMetrics.Domain.Entities.LanguageStatistics

{
  "parsedFiles": {
    "parsedSuccessfullyCount": 0,
    "parsedUnsuccessfullyCount": 0,
    "parsedPartiallyCount": 0
  },
  "scannedLOCPerLanguage": {
    "successfulLOC": 0,
    "unsuccessfulLOC": 0,
    "scannedSuccessfullyLOCPercentage": 0
  },
  "countOfDomObjects": 0
}

Properties

Name

Type

Required

Restrictions

Description

parsedFiles

ScanMetrics.Domain.Entities.ScanParsedFilesCount

false

none

none

scannedLOCPerLanguage

ScanMetrics.Domain.Entities.ScannedLOC

false

none

none

countOfDomObjects

integer(int32)

false

none

none

ScanMetrics.Domain.Entities.GeneralQueries

{
  "succeededGeneralQueriesCount": 0,
  "failedGeneralQueriesCount": 0
}

Properties

Name

Type

Required

Restrictions

Description

succeededGeneralQueriesCount

integer(int32)

false

none

none

failedGeneralQueriesCount

integer(int32)

false

none

none

ScanMetrics.Domain.Entities.ScanParsedFilesCount

{
  "parsedSuccessfullyCount": 0,
  "parsedUnsuccessfullyCount": 0,
  "parsedPartiallyCount": 0
}

Properties

Name

Type

Required

Restrictions

Description

parsedSuccessfullyCount

integer(int32)

false

none

none

parsedUnsuccessfullyCount

integer(int32)

false

none

none

parsedPartiallyCount

integer(int32)

false

none

none

ScanMetrics.Domain.Entities.ScannedLOC

{
  "successfulLOC": 0,
  "unsuccessfulLOC": 0,
  "scannedSuccessfullyLOCPercentage": 0
}

Properties

Name

Type

Required

Restrictions

Description

successfulLOC

integer(int64)

false

none

none

unsuccessfulLOC

integer(int64)

false

none

none

scannedSuccessfullyLOCPercentage

number(float)

false

none

none

ScanMetrics.Presentation.DTOs.Api.ScanParsedFilesDTO

{
  "id": 0,
  "scannedFilesPerLanguage": {
    "unknown": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "cSharp": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "java": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "cpp": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "javaScript": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "apex": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "vbNet": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "vbScript": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "asp": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "vB6": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "php": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "ruby": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "perl": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "objc": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "plsql": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "python": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "groovy": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "scala": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "go": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "kotlin": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "cobol": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "rpg": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "swift": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "dart": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    },
    "common": {
      "parsedSuccessfully": "string",
      "parsedUnsuccessfully": "string",
      "parsedPartially": "string"
    }
  }
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

scannedFilesPerLanguage

object

false

none

none

» unknown

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» cSharp

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» java

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» cpp

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» javaScript

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» apex

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» vbNet

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» vbScript

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» asp

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» vB6

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» php

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» ruby

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» perl

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» objc

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» plsql

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» python

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» groovy

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» scala

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» go

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» kotlin

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» cobol

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» rpg

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» swift

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» dart

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

» common

ScanMetrics.Domain.Entities.ScanParsedFiles

false

none

none

ScanMetrics.Domain.Entities.ScanParsedFiles

{
  "parsedSuccessfully": "string",
  "parsedUnsuccessfully": "string",
  "parsedPartially": "string"
}

Properties

Name

Type

Required

Restrictions

Description

parsedSuccessfully

string

false

none

none

parsedUnsuccessfully

string

false

none

none

parsedPartially

string

false

none

none

ScanMetrics.Presentation.DTOs.Api.ScanFailedQueriesDTO

{
  "id": 0,
  "failedQueries": [
    "string"
  ]
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

failedQueries

[string]

false

none

none

ScanMetrics.Presentation.DTOs.Api.ScanFailedGeneralQueriesDTO

{
  "id": 0,
  "failedGeneralQueries": [
    "string"
  ]
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

failedGeneralQueries

[string]

false

none

none

ScanMetrics.Presentation.DTOs.Api.ScanSucceededGeneralQueriesDTO

{
  "id": 0,
  "generalQueriesResultCount": {
    "property1": 0,
    "property2": 0
  }
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

generalQueriesResultCount

object

false

none

none

» additionalProperties

integer(int32)

false

none

none