Schemas

Cx.CrossCutting.WebAPIHost.ValueObjects.VersionResponseV1_1

{
  "version": "string",
  "hotFix": "string",
  "enginePackVersion": "string"
}

Properties

Name	Type	Required	Restrictions	Description
version	string	false	none	none
hotFix	string	false	none	none
enginePackVersion	string	false	none	none

Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV1_1

{
  "id": 0,
  "project": {
    "id": 0,
    "name": "string",
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "status": {
    "id": 0,
    "name": "string",
    "details": {
      "stage": "string",
      "step": "string"
    }
  },
  "scanType": "Unknown",
  "comment": "string",
  "dateAndTime": {
    "startedOn": "2019-08-24T14:15:22Z",
    "finishedOn": "2019-08-24T14:15:22Z",
    "engineStartedOn": "2019-08-24T14:15:22Z",
    "engineFinishedOn": "2019-08-24T14:15:22Z"
  },
  "resultsStatistics": {
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "scanState": {
    "path": "string",
    "sourceId": "string",
    "filesCount": 0,
    "linesOfCode": 0,
    "failedLinesOfCode": 0,
    "cxVersion": "string",
    "languageStateCollection": [
      {}
    ]
  },
  "owner": "string",
  "origin": "string",
  "originURL": "string",
  "initiatorName": "string",
  "owningTeamId": 0,
  "isPublic": true,
  "isLocked": true,
  "isIncremental": true,
  "scanRisk": 0,
  "scanRiskSeverity": 0,
  "engineServer": {
    "id": 0,
    "name": "string",
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "finishedScanStatus": "None",
  "partialScanReasons": [
    {
      "abortedMessage": "string",
      "abortedStatus": "None"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
project	Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto	false	none	none
status	Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto	false	none	none
scanType	string	false	none	none
comment	string	false	none	none
dateAndTime	Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto	false	none	none
resultsStatistics	Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink	false	none	none
scanState	Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto	false	none	none
owner	string	false	none	none
origin	string	false	none	none
originURL	string	false	none	none
initiatorName	string	false	none	none
owningTeamId	integer(int32)	false	none	none
isPublic	boolean	false	none	none
isLocked	boolean	false	none	none
isIncremental	boolean	false	none	none
scanRisk	integer(int64)	false	none	none
scanRiskSeverity	integer(int64)	false	none	none
engineServer	Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto	false	none	none
finishedScanStatus	string	false	none	none
partialScanReasons	[Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO]	false	none	none

Enumerated Values

Property	Value
scanType	Unknown
scanType	AllScans
scanType	Regular
scanType	Subset
scanType	Partial
scanType	Running
finishedScanStatus	None
finishedScanStatus	Completed
finishedScanStatus	Partial

Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	none
name	string	false	read-only	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto

{
  "id": 0,
  "name": "string",
  "details": {
    "stage": "string",
    "step": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	none
name	string	false	read-only	none
details	Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDetailsDto	false	none	none

Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto

{
  "startedOn": "2019-08-24T14:15:22Z",
  "finishedOn": "2019-08-24T14:15:22Z",
  "engineStartedOn": "2019-08-24T14:15:22Z",
  "engineFinishedOn": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
startedOn	string(date-time)	false	read-only	none
finishedOn	string(date-time)	false	read-only	none
engineStartedOn	string(date-time)	false	read-only	none
engineFinishedOn	string(date-time)	false	read-only	none

Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink

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

Properties

Name	Type	Required	Restrictions	Description
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto

{
  "path": "string",
  "sourceId": "string",
  "filesCount": 0,
  "linesOfCode": 0,
  "failedLinesOfCode": 0,
  "cxVersion": "string",
  "languageStateCollection": [
    {
      "languageID": 0,
      "languageName": "string",
      "languageHash": "string",
      "stateCreationDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
path	string	false	none	none
sourceId	string	false	none	none
filesCount	integer(int64)	false	none	none
linesOfCode	integer(int64)	false	none	none
failedLinesOfCode	integer(int64)	false	none	none
cxVersion	string	false	none	none
languageStateCollection	[Cx.Sast.ScanExecution.Domain.Entities.QueryLanguageState]	false	none	none

Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO

{
  "abortedMessage": "string",
  "abortedStatus": "None"
}

Properties

Name	Type	Required	Restrictions	Description
abortedMessage	string	false	none	none
abortedStatus	string	false	none	none

Enumerated Values

Property	Value
abortedStatus	None
abortedStatus	Queries
abortedStatus	Stages
abortedStatus	QueriesExceededResultThreshold

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.ScanStatusDetailsDto

{
  "stage": "string",
  "step": "string"
}

Properties

Name	Type	Required	Restrictions	Description
stage	string	false	read-only	none
step	string	false	read-only	none

Cx.Sast.ScanExecution.Domain.Entities.QueryLanguageState

{
  "languageID": 0,
  "languageName": "string",
  "languageHash": "string",
  "stateCreationDate": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
languageID	integer(int32)	false	none	none
languageName	string	false	none	none
languageHash	string	false	none	none
stateCreationDate	string(date-time)	false	none	none

Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse11Dto

{
  "id": 0,
  "name": "string",
  "uri": "string",
  "minLoc": 0,
  "maxLoc": 0,
  "maxScans": 0,
  "cxVersion": "string",
  "status": "Offline",
  "link": {
    "rel": "string",
    "uri": "string"
  },
  "offlineReasonCode": "Online",
  "offlineReasonMessage": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
uri	string	false	none	none
minLoc	integer(int32)	false	none	none
maxLoc	integer(int32)	false	none	none
maxScans	integer(int32)	false	none	none
cxVersion	string	false	none	none
status	string	false	none	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none
offlineReasonCode	string	false	none	none
offlineReasonMessage	string	false	none	none

Enumerated Values

Property	Value
status	Offline
status	Blocked
status	ScanningAndBlocked
status	Scanning
status	Idle
offlineReasonCode	Online
offlineReasonCode	CannotAccess
offlineReasonCode	EngineServerError
offlineReasonCode	MessageQueueConfigurationIssue
offlineReasonCode	OnlineButMessageQueueConfigurationValidatationError
offlineReasonCode	ActiveMQConnectionError
offlineReasonCode	EngineAndPackVersionMismtach
offlineReasonCode	EngineDiskSpaceError

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.Sast.EngineServers.Presentation.Dtos.CreateEngineServerDto

{
  "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.Sast.ScanExecution.Presentation.Dtos.PatchScansQueue

{
  "status": "Canceled"
}

Properties

Name	Type	Required	Restrictions	Description
status	string	true	none	none

Enumerated Values

Property	Value
status	Empty
status	Canceled
status	Postponed

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.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

DataRetention.Presentation.Dto.DataRetentionRequestViewModel

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	none
stage	string	false	read-only	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Enumerated Values

Property	Value
stage	New
stage	Processing
stage	DeletingZombies
stage	DeletingDeprecatedScans
stage	DeletingRetentionScans
stage	Stopping
stage	Stopped
stage	Failed
stage	Finished

Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDto

{
  "project": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "preset": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "engineConfiguration": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "postScanAction": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "emailNotifications": {
    "failedScan": [
      "string"
    ],
    "beforeScan": [
      "string"
    ],
    "afterScan": [
      "string"
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
project	Cx.SuperTypes.API.Dtos.LinkedResource	false	none	none
preset	Cx.SuperTypes.API.Dtos.LinkedResource	false	none	none
engineConfiguration	Cx.SuperTypes.API.Dtos.LinkedResource	false	none	none
postScanAction	Cx.SuperTypes.API.Dtos.LinkedResource	false	none	none
emailNotifications	Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto	false	none	none

Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto

{
  "failedScan": [
    "string"
  ],
  "beforeScan": [
    "string"
  ],
  "afterScan": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
failedScan	[string]	false	none	none
beforeScan	[string]	false	none	none
afterScan	[string]	false	none	none

Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDto

{
  "projectId": 1,
  "presetId": 1,
  "engineConfigurationId": 1,
  "postScanActionId": 1,
  "emailNotifications": {
    "failedScan": [
      "string"
    ],
    "beforeScan": [
      "string"
    ],
    "afterScan": [
      "string"
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
projectId	integer(int64)	true	none	none
presetId	integer(int64)	true	none	none
engineConfigurationId	integer(int64)	true	none	none
postScanActionId	integer(int64)	false	none	none
emailNotifications	Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto	false	none	none

Cx.ProjectManagement.Presentation.Dtos.ScanSettingsExtRequestDto1_1

{
  "projectId": 1,
  "overrideProjectSetting": true,
  "isIncremental": true,
  "isPublic": true,
  "forceScan": true,
  "comment": "string",
  "presetId": 0,
  "engineConfigurationId": 0,
  "postScanActionId": 0
}

Properties

Name	Type	Required	Restrictions	Description
projectId	integer(int64)	true	none	Specifies the Unique Id of the specific project to be scanned
overrideProjectSetting	boolean	false	none	Specifies whether to overwrite project settings to be the default for the next scans .If set to false or empty - do not overwrite project settings. If set to true - overwrite project settings
isIncremental	boolean	false	none	Specifies whether the scan is incremental of full
isPublic	boolean	false	none	Specifies whether the requested scan is public or private
forceScan	boolean	false	none	Specifies whether the code should be scanned regardless of unchanged code
comment	string	false	none	Specifies the scan comment
presetId	integer(int64)	false	none	Specify the preset id to use during the scan, 0 = use project’s default
engineConfigurationId	integer(int64)	false	none	Specify the engine-configuration to use during the scan, 0 = use project’s default
postScanActionId	integer(int64)	false	none	Specify post action to be executed after scan is completed

DataRetention.Presentation.Dto.DataRetentionByDatesDto

{
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "durationLimitInHours": 0
}

Properties

Name	Type	Required	Restrictions	Description
startDate	string(date)	true	none	none
endDate	string(date)	true	none	none
durationLimitInHours	integer(int64)	false	none	none

DataRetention.Presentation.Dto.DataRetentionByAmountDto

{
  "numOfSuccessfulScansToPreserve": 0,
  "durationLimitInHours": 0
}

Properties

Name	Type	Required	Restrictions	Description
numOfSuccessfulScansToPreserve	integer(int32)	true	none	none
durationLimitInHours	integer(int64)	false	none	none

Cx.CrossCutting.FileSystem.Files.CxFile_System.ByteArray_

{
  "name": "string",
  "content": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
content	string(byte)	false	none	none

In this section:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.

Schemas

Cx.CrossCutting.WebAPIHost.ValueObjects.VersionResponseV1_1

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV1_1

Properties

Enumerated Values

Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto

Properties

Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO

Properties

Enumerated Values

Cx.SuperTypes.API.Dtos.LinkDtoBase

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDetailsDto

Properties

Cx.Sast.ScanExecution.Domain.Entities.QueryLanguageState

Properties

Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse11Dto

Properties

Enumerated Values

Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDTO

Properties

Cx.Sast.EngineServers.Presentation.Dtos.CreateEngineServerDto

Properties

Cx.Sast.ScanExecution.Presentation.Dtos.PatchScansQueue

Properties

Enumerated Values

Cx.SuperTypes.API.Dtos.LinkedResource

Properties

Cx.Sast.EngineServers.ApplicationContracts.Models.EngineServerPatchModel

Properties

DataRetention.Presentation.Dto.DataRetentionRequestViewModel

Properties

Enumerated Values

Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDto

Properties

Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto

Properties

Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDto

Properties

Cx.ProjectManagement.Presentation.Dtos.ScanSettingsExtRequestDto1_1

Properties

DataRetention.Presentation.Dto.DataRetentionByDatesDto

Properties

DataRetention.Presentation.Dto.DataRetentionByAmountDto

Properties

Cx.CrossCutting.FileSystem.Files.CxFile_System.ByteArray_

Properties

Search results