Skip to main content

Schemas

Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDtoV2_2

{
  "id": 0,
  "teamId": 0,
  "name": "string",
  "isPublic": true,
  "customFields": [
    {
      "id": 0,
      "value": "string",
      "name": "string"
    }
  ],
  "links": [
    {
      "rel": "string",
      "uri": "string"
    }
  ],
  "owner": "string",
  "isDeprecated": true,
  "projectQueueSettings": {
    "queueKeepMode": "KeepAll",
    "scansType": "All",
    "includeScansInProcess": true,
    "identicalCodeOnly": true
  },
  "isBranched": true,
  "originalProjectId": "string",
  "branchedOnScanId": "string",
  "relatedProjects": [
    0
  ]
}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

read-only

none

teamId

integer(int32)

false

read-only

none

name

string

false

read-only

none

isPublic

boolean

false

read-only

none

customFields

[Cx.ProjectManagement.Domain.ValueObjects.ProjectCustomField]

false

read-only

none

links

[Cx.SuperTypes.API.Dtos.LinkDtoBase]

false

none

none

owner

string

false

none

none

isDeprecated

boolean

false

none

none

projectQueueSettings

Cx.ProjectManagement.Presentation.Dtos.ProjectQueueSettingsDto

false

none

none

isBranched

boolean

false

none

Indicates whether project was branched from another project

originalProjectId

string

false

none

Original project (in case IsBranched is false, this value is empty)

branchedOnScanId

string

false

none

The scan Id of original project used to branch (in case Is branched is false, this value is empty)

relatedProjects

[integer]

false

none

Where the project is the source of branched projects

Cx.ProjectManagement.Domain.ValueObjects.ProjectCustomField

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

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

value

string

false

none

none

name

string

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.ProjectManagement.Presentation.Dtos.ProjectQueueSettingsDto

{
  "queueKeepMode": "KeepAll",
  "scansType": "All",
  "includeScansInProcess": true,
  "identicalCodeOnly": true
}

Properties

Name

Type

Required

Restrictions

Description

queueKeepMode

string

false

none

none

scansType

string

false

none

none

includeScansInProcess

boolean

false

none

none

identicalCodeOnly

boolean

false

none

none

Enumerated Values

Property

Value

queueKeepMode

KeepAll

queueKeepMode

KeepOld

queueKeepMode

KeepNew

scansType

All

scansType

OnlyFull

scansType

OnlyIncremental

Cx.ProjectManagement.Presentation.Dtos.UpdateFullProjectDto

{
  "name": "string",
  "owningTeam": 0,
  "customFields": [
    {
      "id": 0,
      "value": "string"
    }
  ]
}

Properties

Name

Type

Required

Restrictions

Description

name

string

true

none

Specifies the name of the project

owningTeam

integer(int32)

true

none

Specifies the team id which owns the project

customFields

[Cx.ProjectManagement.Presentation.Dtos.UpdateCustomFieldDto]

true

none

Specifies the custom fields in a project

Cx.ProjectManagement.Presentation.Dtos.UpdateCustomFieldDto

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

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

value

string

false

none

none

Cx.ProjectManagement.Presentation.Dtos.UpdateProjectDto

{
  "name": "SomeProject",
  "owningTeam": 12345678
}

Properties

Name

Type

Required

Restrictions

Description

name

string

false

none

Specifies the name of the project

owningTeam

integer(int32)

false

none

Specifies the team id which owns the project

Cx.ProjectManagement.Presentation.Dtos.DeleteProjectDto

{
  "deleteRunningScans": true
}

Properties

Name

Type

Required

Restrictions

Description

deleteRunningScans

boolean

false

none

Specifies whether the running scans must be deleted

Cx.ProjectManagement.Presentation.Dtos.SaveProjectDto

{
  "name": "SomeProject",
  "owningTeam": "1",
  "isPublic": true
}

Properties

Name

Type

Required

Restrictions

Description

name

string

false

none

Specifies the name of the project

owningTeam

string

true

none

Specifies the team id which owns the project

isPublic

boolean

true

none

Specifies whether the project public or not

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