Skip to main content

Schemas

Cx.CrossCutting.WebAPIHost.ValueObjects.LicenseDetailsResponse

{
  "expirationDate": "string",
  "maxLOC": "string",
  "hid": "string",
  "maxConcurrentScans": "string",
  "supportedLanguages": [
    {
      "language": "string",
      "isSupported": true
    }
  ],
  "edition": "string",
  "isOsaEnabled": true,
  "osaExpirationDate": "string",
  "currentUsers": 0,
  "maxUsers": 0,
  "maxAuditUsers": 0,
  "currentAuditUsers": 0,
  "projectsAllowed": 0,
  "currentProjectsCount": 0
}

Properties

Name

Type

Required

Restrictions

Description

expirationDate

string

false

none

none

maxLOC

string

false

none

none

hid

string

false

none

none

maxConcurrentScans

string

false

none

none

supportedLanguages

[Checkmarx.ExtDataTypes.SupportedLanguage]

false

none

none

edition

string

false

none

none

isOsaEnabled

boolean

false

none

none

osaExpirationDate

string

false

none

none

currentUsers

integer(int32)

false

none

none

maxUsers

integer(int32)

false

none

none

maxAuditUsers

integer(int32)

false

none

none

currentAuditUsers

integer(int32)

false

none

none

projectsAllowed

integer(int64)

false

none

none

currentProjectsCount

integer(int64)

false

none

none

Checkmarx.ExtDataTypes.SupportedLanguage

{
  "language": "string",
  "isSupported": true
}

Properties

Name

Type

Required

Restrictions

Description

language

string

false

none

none

isSupported

boolean

false

none

none

Cx.ProjectManagement.Presentation.Dtos.ProjectBranchDto

{
  "id": 0,
  "originalProjectId": 0,
  "originalProjectName": "string",
  "branchedOnScanId": 0,
  "branchedProjectId": 0,
  "timestamp": "2019-08-24T14:15:22Z",
  "comment": "string",
  "status": "Started",
  "errorMessage": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

originalProjectId

integer(int64)

false

none

none

originalProjectName

string

false

none

none

branchedOnScanId

integer(int64)

false

none

none

branchedProjectId

integer(int64)

false

none

none

timestamp

string(date-time)

false

none

none

comment

string

false

none

none

status

string

false

none

none

errorMessage

string

false

none

none

Enumerated Values

Property

Value

status

Started

status

InProgress

status

Completed

status

Failed

Cx.QueryManagement.Presentation.Queries.Responses.QueryVersionCodeResponse

{
  "queryId": 0,
  "queryVersionCode": 0
}

Properties

Name

Type

Required

Restrictions

Description

queryId

integer(int64)

false

none

none

queryVersionCode

integer(int64)

false

none

none

Cx.Sast.Results.Presentation.Dtos.ResultStateOutputDto

{
  "id": 0,
  "names": [
    {
      "languageId": 0,
      "name": "string",
      "isConstant": true
    }
  ],
  "permission": "string"
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

true

none

none

names

[Cx.Sast.Results.Presentation.Dtos.TranslationOutputDto]

true

none

none

permission

string

true

none

none

Cx.Sast.Results.Presentation.Dtos.TranslationOutputDto

{
  "languageId": 0,
  "name": "string",
  "isConstant": true
}

Properties

Name

Type

Required

Restrictions

Description

languageId

integer(int32)

true

none

none

name

string

true

none

none

isConstant

boolean

true

none

none

Cx.Sast.Results.Presentation.Dtos.ResultStatePostInputDto

{
  "names": [
    {
      "languageId": 1033,
      "name": "To Verify"
    },
    {
      "languageId": 1034,
      "name": "Para verificar"
    }
  ],
  "permission": "set-result-state-toverify"
}

Properties

Name

Type

Required

Restrictions

Description

names

[Cx.Sast.Results.Presentation.Dtos.TranslationInputDto]

true

none

none

permission

string

true

none

none

Cx.Sast.Results.Presentation.Dtos.TranslationInputDto

{
  "languageId": 1,
  "name": "string"
}

Properties

Name

Type

Required

Restrictions

Description

languageId

integer(int32)

true

none

none

name

string

true

none

none

Cx.Sast.Results.Presentation.Dtos.PostResultStateOutputDto

{
  "id": 0
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

Scheduler.Api.Responses.ScheduledJobsResponse

{
  "projectId": 0,
  "projectName": "string",
  "scanDays": [
    "string"
  ],
  "scanTime": "string"
}

Properties

Name

Type

Required

Restrictions

Description

projectId

integer(int64)

false

none

none

projectName

string

false

none

none

scanDays

[string]

false

none

none

scanTime

string

false

none

none

Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDtoV4

{
  "project": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "preset": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "engineConfiguration": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "postScanActionData": "string",
  "postScanActionName": "string",
  "postScanAction": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "emailNotifications": {
    "failedScan": [
      "string"
    ],
    "beforeScan": [
      "string"
    ],
    "afterScan": [
      "string"
    ]
  },
  "postScanActionConditions": {
    "runOnlyWhenNewResults": true,
    "runOnlyWhenNewResultsMinSeverity": 3
  },
  "postScanActionArguments": "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

postScanActionData

string

false

read-only

none

postScanActionName

string

false

read-only

none

postScanAction

Cx.SuperTypes.API.Dtos.LinkedResource

false

none

none

emailNotifications

Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto

false

none

none

postScanActionConditions

Cx.Sast.ScanSettings.Presentation.Dtos.PostScanActionConditionsDto

false

none

none

postScanActionArguments

string

false

read-only

none

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

{
  "runOnlyWhenNewResults": true,
  "runOnlyWhenNewResultsMinSeverity": 3
}

Properties

Name

Type

Required

Restrictions

Description

runOnlyWhenNewResults

boolean

false

none

none

runOnlyWhenNewResultsMinSeverity

integer(int32)

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.Results.Presentation.Dtos.ResultPathCommentResponse

{
  "comments": [
    "string"
  ]
}

Properties

Name

Type

Required

Restrictions

Description

comments

[string]

false

none

none

Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDtoV4

{
  "projectId": 1,
  "presetId": 1,
  "engineConfigurationId": 1,
  "postScanActionId": 1,
  "emailNotifications": {
    "failedScan": [
      "string"
    ],
    "beforeScan": [
      "string"
    ],
    "afterScan": [
      "string"
    ]
  },
  "postScanActionConditions": {
    "runOnlyWhenNewResults": true,
    "runOnlyWhenNewResultsMinSeverity": 3
  },
  "postScanActionArguments": "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

postScanActionConditions

Cx.Sast.ScanSettings.Presentation.Dtos.PostScanActionConditionsDto

false

none

none

postScanActionArguments

string

false

none

none

Cx.ProjectManagement.Presentation.Dtos.ScanSettingsExtRequestV4Dto

{
  "projectId": 1,
  "overrideProjectSetting": true,
  "isIncremental": true,
  "isPublic": true,
  "forceScan": true,
  "comment": "string",
  "presetId": 0,
  "engineConfigurationId": 0,
  "customFields": "string",
  "postScanActionId": 0,
  "runPostScanOnlyWhenNewResults": true,
  "runPostScanMinSeverity": 3,
  "postScanActionArguments": "string"
}

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

customFields

string

false

none

Any custom fields used to tag the scan. Example: {“key1”:“val1”,“key2”:“val2”}

postScanActionId

integer(int64)

false

none

Specify post action to be executed after scan is completed

runPostScanOnlyWhenNewResults

boolean

false

none

Specify if the configured post scan action will be executed only if new results are found, compared to the previous scan. Used in conjunction with PostScanActionId.

runPostScanMinSeverity

integer(int32)

false

none

Specify the minimal severity value when evaluating new results compared to the previous scan. Used in conjunction with RunPostScanOnlyWhenNewResults.

postScanActionArguments

string

false

none

Specify the additional arguments to add to the post scan action. Used in conjunction with PostScanActionId.

Cx.Sast.Results.Presentation.Dtos.ResultStatePatchInputDto

{
  "names": [
    {
      "languageId": 1033,
      "name": "To Verify"
    },
    {
      "languageId": 1034,
      "name": "Para verificar"
    }
  ],
  "permission": "set-result-state-toverify"
}

Properties

Name

Type

Required

Restrictions

Description

names

[Cx.Sast.Results.Presentation.Dtos.TranslationInputDto]

false

none

none

permission

string

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