Skip to main content

Schemas

Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse01Dto

{
  "id": 0,
  "name": "string",
  "uri": "string",
  "minLoc": 0,
  "maxLoc": 0,
  "isAlive": true,
  "maxScans": 0,
  "isBlocked": true,
  "cxVersion": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

name

string

false

read-only

none

uri

string

false

read-only

none

minLoc

integer(int32)

false

read-only

none

maxLoc

integer(int32)

false

read-only

none

isAlive

boolean

false

read-only

none

maxScans

integer(int32)

false

read-only

none

isBlocked

boolean

false

read-only

none

cxVersion

string

false

read-only

none

Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDTO

{
  "name": "string",
  "uri": "string",
  "minLoc": 0,
  "maxLoc": 0,
  "isBlocked": true,
  "maxScans": 0
}

Properties

Name

Type

Required

Restrictions

Description

name

string

true

none

none

uri

string

true

none

none

minLoc

integer(int32)

true

none

none

maxLoc

integer(int32)

true

none

none

isBlocked

boolean

true

none

none

maxScans

integer(int32)

false

none

none

Cx.SuperTypes.API.Responses.EntityCreatedResponse

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

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

self

string

false

none

none

Cx.Sast.EngineServers.ApplicationContracts.Models.EngineServerPatchModel

{
  "name": "string",
  "uri": "string",
  "minLoc": 0,
  "maxLoc": 0,
  "isBlocked": true,
  "maxScans": 0
}

Properties

Name

Type

Required

Restrictions

Description

name

string

false

none

Engine Server name

uri

string

false

none

Engine Server Uri

minLoc

integer(int32)

false

none

Minimum LinesOfCode for the server

maxLoc

integer(int32)

false

none

Maximum LinesOfCode for the server

isBlocked

boolean

false

none

Flag to determine if EngineServer is blocked

maxScans

integer(int32)

false

none

Max concurrent scans

Cx.SuperTypes.API.Dtos.LinkedResource

{
  "id": 0,
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

link

Cx.SuperTypes.API.Dtos.LinkDtoBase

false

none

none

Cx.SuperTypes.API.Dtos.LinkDtoBase

{
  "rel": "string",
  "uri": "string"
}

Properties

Name

Type

Required

Restrictions

Description

rel

string

false

read-only

none

uri

string

false

read-only

none

Cx.Sast.ScanExecution.Presentation.Dtos.SastScanRequestV01Dto

{
  "id": 0,
  "stage": "New",
  "teamId": "string",
  "project": {
    "id": 0,
    "name": "string"
  },
  "engineId": 0,
  "loc": 0,
  "languages": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "dateCreated": "2019-08-24T14:15:22Z",
  "queuedOn": "2019-08-24T14:15:22Z",
  "engineStartedOn": "2019-08-24T14:15:22Z",
  "isIncremental": true,
  "isPublic": true,
  "origin": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

stage

string

false

none

none

teamId

string

false

none

none

project

Cx.Sast.ScanExecution.Presentation.Dtos.SastProjectV01DTO

false

none

none

engineId

integer(int64)

false

none

none

loc

integer(int32)

false

none

none

languages

[Cx.Sast.ScanExecution.Domain.ValueObjects.ProgramLanguage]

false

none

none

dateCreated

string(date-time)

false

none

none

queuedOn

string(date-time)

false

none

none

engineStartedOn

string(date-time)

false

none

none

isIncremental

boolean

false

none

none

isPublic

boolean

false

none

none

origin

string

false

none

none

Enumerated Values

Property

Value

stage

New

stage

PreScan

stage

Queued

stage

Scanning

stage

PostScan

stage

Finished

stage

Canceled

stage

Failed

stage

SourcePullingAndDeployment

stage

None

Cx.Sast.ScanExecution.Presentation.Dtos.SastProjectV01DTO

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

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

read-only

none

name

string

false

read-only

none

Cx.Sast.ScanExecution.Domain.ValueObjects.ProgramLanguage

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

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

name

string

false

none

none