Schemas

Cx.CustomTasks.Presentation.Dtos.GetCustomTaskDto

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none
type	string	false	none	none
data	string	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.CustomFields.Api.ViewModels.CustomFieldViewModel

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none

Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDto

{
  "id": 0,
  "teamId": 0,
  "name": "string",
  "isPublic": true,
  "sourceSettingsLink": {
    "type": "string",
    "rel": "string",
    "uri": "string"
  },
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

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	none	none
sourceSettingsLink	Cx.SuperTypes.API.Dtos.LinkDto	false	none	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.SuperTypes.API.Dtos.LinkDto

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

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
rel	string	false	read-only	none
uri	string	false	read-only	none

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.CrossCutting.WebAPIHost.ValueObjects.VersionResponse

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

Properties

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

Cx.IssueTrackingSystems.Presentation.Dtos.GetIssueTrackingSystemDto

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The specific Id of issue tracking system
name	string	false	read-only	The name of issue tracking system
type	string	false	read-only	The type of issue tracking system (Jira)
url	string	false	read-only	The URL of issue tracking system

Cx.ProjectManagement.Presentation.Dtos.PrecheckTeamDto

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
name	string	false	none	none
fullName	string	false	none	none
parentId	integer(int32)	false	none	none

Cx.CrossCutting.Configuration.DTOs.ComponentConfiguration

{
  "key": "string",
  "value": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
value	string	false	none	none
description	string	false	none	none

Cx.CrossCutting.Configuration.Swagger.ComponentConfigurationUpdate

{
  "key": "MAXIMUM_CONCURRENT_SCAN_EXECUTERS",
  "value": "5"
}

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
value	string	false	none	none

Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingSystemMetadata

{
  "projects": [
    {
      "id": "string",
      "name": "string",
      "issueTypes": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
projects	[Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingProjectMetadata]	false	read-only	none

Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingProjectMetadata

{
  "id": "string",
  "name": "string",
  "issueTypes": [
    {
      "subtask": true,
      "id": "string",
      "name": "string",
      "fields": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	none
name	string	false	read-only	none
issueTypes	[Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingIssueTypeMetadata]	false	read-only	none

Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingIssueTypeMetadata

{
  "subtask": true,
  "id": "string",
  "name": "string",
  "fields": [
    {
      "id": "string",
      "name": "string",
      "multiple": true,
      "required": true,
      "supported": true,
      "allowedValues": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
subtask	boolean	false	none	none
id	string	false	read-only	none
name	string	false	read-only	none
fields	[Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldMetadata]	false	read-only	none

Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldMetadata

{
  "id": "string",
  "name": "string",
  "multiple": true,
  "required": true,
  "supported": true,
  "allowedValues": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	none
name	string	false	read-only	none
multiple	boolean	false	none	none
required	boolean	false	none	none
supported	boolean	false	none	none
allowedValues	[Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldValue]	false	none	none

Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldValue

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

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	none
name	string	false	read-only	none

Cx.ProjectManagement.Presentation.Dtos.GetExcludeSettingsDto

{
  "projectId": 0,
  "excludeFoldersPattern": "string",
  "excludeFilesPattern": "string",
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
projectId	integer(int64)	false	none	none
excludeFoldersPattern	string	false	none	none
excludeFilesPattern	string	false	none	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.ProjectManagement.Presentation.Dtos.ExcludeSettingsDto

{
  "excludeFoldersPattern": "string",
  "excludeFilesPattern": "string"
}

Properties

Name	Type	Required	Restrictions	Description
excludeFoldersPattern	string	false	none	none
excludeFilesPattern	string	false	none	none

Cx.ProjectManagement.Presentation.Dtos.GetGitSourceSettingsDto

{
  "url": "string",
  "branch": "string",
  "useSsh": true,
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
url	string	false	read-only	The URL which is used to connect to GIT repository
branch	string	false	read-only	The branch of a GIT repository
useSsh	boolean	false	read-only	Specified whether a connection to GIT repository uses SSH protocol
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.ProjectManagement.Presentation.Dtos.GitSourceSettingsDto

{
  "url": "string",
  "branch": "string",
  "privateKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
url	string	true	none	The URL which is used to connect to GIT repository
branch	string	true	none	The branch of a GIT repository
privateKey	string	false	none	The private key which is used to connect to GIT repository using SSH protocol

Cx.ProjectManagement.Presentation.Dtos.GetSvnSourceSettingsDto

{
  "uri": {
    "absoluteUrl": "string",
    "port": 0
  },
  "paths": [
    "string"
  ],
  "useSsh": true,
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
uri	Cx.ProjectManagement.Presentation.Dtos.PartialUriDto	false	none	none
paths	[string]	false	read-only	Specifies the list of paths to scan at SVN repository
useSsh	boolean	false	read-only	Specified whether a connection to SVN repository uses SSH protocol
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.ProjectManagement.Presentation.Dtos.PartialUriDto

{
  "absoluteUrl": "string",
  "port": 0
}

Properties

Name	Type	Required	Restrictions	Description
absoluteUrl	string	false	none	Specifies the absolute url
port	integer(int32)	false	none	Specifies the port number of this Uri

Cx.ProjectManagement.Presentation.Dtos.SvnSourceSettingsDto

{
  "uri": {
    "absoluteUrl": "string",
    "port": 1
  },
  "paths": [
    "string"
  ],
  "credentials": {
    "userName": "string",
    "password": "string"
  },
  "privateKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
uri	Cx.ProjectManagement.Presentation.Dtos.UriDto	true	none	none
paths	[string]	true	none	Specifies the list of paths to scan at SVN repository
credentials	Cx.ProjectManagement.Presentation.Dtos.OptionalCredentialsDto	false	none	none
privateKey	string	false	none	The private key which is used to connect to SVN repository using SSH protocol

Cx.ProjectManagement.Presentation.Dtos.UriDto

{
  "absoluteUrl": "string",
  "port": 1
}

Properties

Name	Type	Required	Restrictions	Description
absoluteUrl	string	true	none	Specifies the absolute url
port	integer(int32)	true	none	Specifies the port number of this Uri

Cx.ProjectManagement.Presentation.Dtos.OptionalCredentialsDto

{
  "userName": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userName	string	false	none	none
password	string	false	none	none

Cx.ProjectManagement.Presentation.Dtos.GetTfsSourceSettingsDto

{
  "uri": {
    "absoluteUrl": "string",
    "port": 1
  },
  "paths": [
    "string"
  ],
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
uri	Cx.ProjectManagement.Presentation.Dtos.UriDto	false	none	none
paths	[string]	false	read-only	Specifies the list of paths to scan at TFS repository
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.ProjectManagement.Presentation.Dtos.TfsSourceSettingsDto

{
  "credentials": {
    "userName": "string",
    "password": "string"
  },
  "uri": {
    "absoluteUrl": "string",
    "port": 1
  },
  "paths": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
credentials	Cx.ProjectManagement.Presentation.Dtos.CredentialsDto	false	none	none
uri	Cx.ProjectManagement.Presentation.Dtos.UriDto	true	none	none
paths	[string]	true	none	Specifies the list of paths to scan at TFS repository

Cx.ProjectManagement.Presentation.Dtos.CredentialsDto

{
  "userName": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userName	string	true	none	none
password	string	true	none	none

Cx.ProjectManagement.Presentation.Dtos.GetCustomSourceSettingsDto

{
  "path": "string",
  "pullingCommandId": 0,
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

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

Cx.ProjectManagement.Presentation.Dtos.CustomSourceSettingsDto

{
  "path": "string",
  "preScanCommandId": 0,
  "credentials": {
    "userName": "string",
    "password": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
path	string	false	read-only	none
preScanCommandId	integer(int64)	false	read-only	none
credentials	Cx.ProjectManagement.Presentation.Dtos.CredentialsDto	true	none	none

Cx.ProjectManagement.Presentation.Dtos.GetSharedSourceSettingsDto

{
  "paths": [
    "string"
  ],
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
paths	[string]	false	read-only	none
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.ProjectManagement.Presentation.Dtos.SharedSourceSettingsDto

{
  "paths": [
    "string"
  ],
  "credentials": {
    "userName": "string",
    "password": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
paths	[string]	true	none	none
credentials	Cx.ProjectManagement.Presentation.Dtos.CredentialsDto	true	none	none

Cx.ProjectManagement.Presentation.Dtos.GetPerforceSourceSettingsDto

{
  "uri": {
    "absoluteUrl": "string",
    "port": 1
  },
  "paths": [
    "string"
  ],
  "browseMode": "string",
  "link": {
    "rel": "string",
    "uri": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
uri	Cx.ProjectManagement.Presentation.Dtos.UriDto	false	none	none
paths	[string]	false	read-only	Specifies the list of paths to scan at SVN repository
browseMode	string	false	read-only	Specifies the browse mode of Perforce repository
link	Cx.SuperTypes.API.Dtos.LinkDtoBase	false	none	none

Cx.ProjectManagement.Presentation.Dtos.PerforceSourceSettingDto

{
  "credentials": {
    "userName": "string",
    "password": "string"
  },
  "uri": {
    "absoluteUrl": "string",
    "port": 1
  },
  "paths": [
    "string"
  ],
  "browseMode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
credentials	Cx.ProjectManagement.Presentation.Dtos.CredentialsDto	false	none	none
uri	Cx.ProjectManagement.Presentation.Dtos.UriDto	false	none	none
paths	[string]	true	none	Specifies the list of paths to scan at Perforce repository
browseMode	string	true	none	Specifies the browse mode of Perforce repository

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

Cx.Reports.SastScan.Presentation.Dtos.SastReportRequestDTO

{
  "reportType": "string",
  "scanId": 0
}

Properties

Name	Type	Required	Restrictions	Description
reportType	string	true	none	none
scanId	integer(int64)	true	none	none

Cx.Reports.SastScan.Presentation.Dtos.CreateReportResponseDto

{
  "reportId": 0,
  "links": {
    "report": {
      "rel": "string",
      "uri": "string"
    },
    "status": {
      "rel": "string",
      "uri": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
reportId	integer(int64)	false	read-only	none
links	Cx.Reports.SastScan.Presentation.Dtos.ReportLinksDto	false	none	none

Cx.Reports.SastScan.Presentation.Dtos.ReportLinksDto

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

Properties

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

Cx.ProjectManagement.Presentation.Dtos.BranchProjectDto

{
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Specifies the name of the project

Cx.ProjectManagement.Presentation.Dtos.DataRetentionSettingsDto

{
  "scansToKeep": 10
}

Properties

Name	Type	Required	Restrictions	Description
scansToKeep	integer(int32)	false	none	The amount of scans to keep before they are deleted (set null back to default)

Cx.ProjectManagement.Presentation.Dtos.JiraIssueTrackingSettingsDto

{
  "issueTrackingSystemId": 1,
  "jiraProjectId": "12901",
  "issueType": {
    "id": "123",
    "fields": [
      {
        "id": "priority",
        "values": [
          "1"
        ]
      },
      {
        "id": "customfield_1",
        "values": [
          "c1",
          "c2"
        ]
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
issueTrackingSystemId	integer(int64)	false	none	The issue tracking system Id
jiraProjectId	string	true	none	The specific Id of JIRA project
issueType	Cx.ProjectManagement.Presentation.Dtos.JiraIssueType	true	none	none

Cx.ProjectManagement.Presentation.Dtos.JiraIssueType

{
  "id": "string",
  "fields": [
    {
      "id": "string",
      "values": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	Specifies the Id of issue type
fields	[Cx.ProjectManagement.Presentation.Dtos.JiraField]	false	none	Specifies the list of fields associated with issue type

Cx.ProjectManagement.Presentation.Dtos.JiraField

{
  "id": "string",
  "values": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	Specifies the Id of field
values	[string]	false	none	Specifies the list of values or single value

Cx.ProjectManagement.Presentation.Dtos.GitSourceSettingsBaseDto

{
  "url": "string",
  "branch": "string"
}

Properties

Name	Type	Required	Restrictions	Description
url	string	true	none	The URL which is used to connect to GIT repository
branch	string	true	none	The branch of a GIT repository

Cx.ProjectManagement.Presentation.Dtos.SvnSshSourceSettingsDto

{
  "absoluteUrl": "string",
  "port": 0,
  "paths": "string"
}

Properties

Name	Type	Required	Restrictions	Description
absoluteUrl	string	true	none	The URL which is used to connect to SVN repository
port	integer(int32)	true	none	The port number of SVN repository Url
paths	string	true	none	The paths of a SVN repository, seperated by “;”

Cx.Osa.Application.DTOs.BasicScanDTO

{
  "id": "00000000-0000-0000-0000-000000000000",
  "startAnalyzeTime": "2019-08-24T14:15:22Z",
  "endAnalyzeTime": "2019-08-24T14:15:22Z",
  "origin": "string",
  "sourceCodeOrigin": "string",
  "state": {
    "id": 0,
    "name": "string",
    "failureReason": "string"
  },
  "sharedSourceLocationPaths": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
startAnalyzeTime	string(date-time)	false	none	none
endAnalyzeTime	string(date-time)	false	none	none
origin	string	false	none	none
sourceCodeOrigin	string	false	none	none
state	Cx.Osa.Application.DTOs.StateDTO	false	none	none
sharedSourceLocationPaths	[string]	false	none	none

Cx.Osa.Application.DTOs.StateDTO

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
name	string	false	none	none
failureReason	string	false	none	none

System.Net.Http.ByteArrayContent

{
  "headers": [
    {
      "key": "string",
      "value": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
headers	[System.Collections.Generic.KeyValuePair_System.String_System.Collections.Generic.IEnumerable_System.String_]	false	read-only	none

Cx.Osa.Application.DTOs.OsaLicenseDto

{
  "id": "string",
  "name": "string",
  "riskLevel": "string",
  "copyrightRiskScore": 0,
  "patentRiskScore": 0,
  "copyLeft": "string",
  "linking": "string",
  "royalityFree": "string",
  "referenceType": "string",
  "reference": "string",
  "url": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	read-only	The Id of the open source license
name	string	false	read-only	License name
riskLevel	string	false	read-only	License risk level (Low, Medium, High, Unknown)
copyrightRiskScore	integer(int32)	false	read-only	The risk of infringing the license copyrights
patentRiskScore	integer(int32)	false	read-only	The risk of infringing patents
copyLeft	string	false	read-only	Status of copy-left licensing
linking	string	false	read-only	The influent of the license on linked code
royalityFree	string	false	read-only	Whether or not this license is royality-free
referenceType	string	false	read-only	License description url
reference	string	false	read-only	none
url	string	false	read-only	none

Cx.Osa.Application.DTOs.Responses.VulnerabilityCommentDto

{
  "userName": "string",
  "timeStamp": 0,
  "content": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userName	string	false	read-only	none
timeStamp	integer(int64)	false	read-only	none
content	string	false	read-only	none

Cx.Osa.Application.DTOs.Responses.V1.ScannedLibraryDTO

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

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

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.Presentation.DTOs.NewDTOs.ScanRequestInfo

{
  "projectId": 1,
  "origin": "string",
  "hashedFilesList": [
    {
      "sha1": "string",
      "filename": "string"
    }
  ]
}

Scan request details

Properties

Name	Type	Required	Restrictions	Description
projectId	integer(int64)	false	none	The Project Id associated with requested scan
origin	string	false	none	The location from which scan was requested (if not specified (Portal) will be selected)
hashedFilesList	[Cx.Osa.Presentation.DTOs.NewDTOs.HashedFileDTO]	false	none	none

Cx.Osa.Presentation.DTOs.NewDTOs.HashedFileDTO

{
  "sha1": "string",
  "filename": "string"
}

Properties

Name	Type	Required	Restrictions	Description
sha1	string	false	none	none
filename	string	false	none	none

Cx.Osa.Presentation.DTOs.NewDTOs.NewScanResponseDTO

{
  "scanId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name	Type	Required	Restrictions	Description
scanId	string(uuid)	true	none	none

Cx.Osa.Application.DTOs.Responses.V1.VulnerabilityDTO

{
  "id": "string",
  "cveName": "string",
  "score": 0,
  "severity": {
    "id": 0,
    "name": "string"
  },
  "publishDate": "2019-08-24T14:15:22Z",
  "url": "string",
  "description": "string",
  "recommendations": "string",
  "sourceFileName": "string",
  "libraryId": "string",
  "state": {
    "id": 0,
    "actionType": "string",
    "name": "string"
  },
  "commentsAmount": 0,
  "similarityId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
cveName	string	false	none	none
score	number(float)	false	none	none
severity	Cx.Osa.Application.DTOs.SeverityDTO	false	none	none
publishDate	string(date-time)	false	none	none
url	string	false	none	none
description	string	false	none	none
recommendations	string	false	none	none
sourceFileName	string	false	none	none
libraryId	string	false	none	none
state	Cx.Osa.Application.DTOs.Responses.VulnerabilityStateDto	false	none	none
commentsAmount	integer(int32)	false	none	none
similarityId	string	false	none	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.VulnerabilityStateDto

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

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	none
actionType	string	false	read-only	none
name	string	false	read-only	none

Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDto

{
  "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",
  "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
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.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.ScanExecution.Presentation.Dtos.SaveScanCommentDto

{
  "comment": "Some comment"
}

Properties

Name	Type	Required	Restrictions	Description
comment	string	true	none	Specifies the scan comment

Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse10Dto

{
  "id": 0,
  "name": "string",
  "uri": "string",
  "minLoc": 0,
  "maxLoc": 0,
  "maxScans": 0,
  "cxVersion": "string",
  "status": "Offline",
  "link": {
    "rel": "string",
    "uri": "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

Enumerated Values

Property	Value
status	Offline
status	Blocked
status	ScanningAndBlocked
status	Scanning
status	Idle

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.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.Sast.ScanSettings.Application.Dtos.EngineConfigurationDto

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

{
  "highSeverity": 0,
  "mediumSeverity": 0,
  "lowSeverity": 0,
  "infoSeverity": 0,
  "statisticsCalculationDate": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
highSeverity	integer(int64)	false	none	none
mediumSeverity	integer(int64)	false	none	none
lowSeverity	integer(int64)	false	none	none
infoSeverity	integer(int64)	false	none	none
statisticsCalculationDate	string(date-time)	false	none	none

Cx.Sast.Results.Presentation.Models.ResultLabelGetModel

{
  "state": 0,
  "severity": 0,
  "userAssignment": "string",
  "comment": "string"
}

Labels are changes made on the results’ properties by the user. If no changes were made to the result’s properties by the user - the state is “null”

Properties

Name	Type	Required	Restrictions	Description
state	integer(int32)	false	none	none
severity	integer(int32)	false	none	none
userAssignment	string	false	none	none
comment	string	false	none	none

Cx.Sast.Results.Presentation.Models.ResultLabelPatchModel

{
  "state": 0,
  "severity": 0,
  "userAssignment": "string",
  "comment": "string"
}

Properties

Name	Type	Required	Restrictions	Description
state	integer(int32)	false	none	none
severity	integer(int32)	false	none	none
userAssignment	string	false	none	none
comment	string	false	none	none

Cx.Sast.Results.Presentation.Models.GetResultShortDescriptionModel

{
  "shortDescription": "string"
}

Properties

Name	Type	Required	Restrictions	Description
shortDescription	string	false	none	none

Cx.ResultsPublisher.Presentation.DTOs.StatusDto

{
  "project": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "scan": {
    "id": 0,
    "link": {
      "rel": "string",
      "uri": "string"
    }
  },
  "status": "string",
  "lastSync": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
project	Cx.SuperTypes.API.Dtos.LinkedResource	false	none	none
scan	Cx.SuperTypes.API.Dtos.LinkedResource	false	none	none
status	string	false	none	none
lastSync	string(date-time)	false	none	none

Cx.Sast.ScanExecution.ApplicationContracts.DTOs.SastScanRequestWriteDTO

{
  "projectId": 1,
  "isIncremental": false,
  "isPublic": true,
  "forceScan": true,
  "comment": ""
}

Properties

Name	Type	Required	Restrictions	Description
projectId	integer(int64)	true	none	Specifies the Unique Id of the specific project to be scanned
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
customFields	object	false	none	none
» additionalProperties	string	false	none	none

Cx.Sast.Results.Presentation.Models.GetAttackVectorsModel

{
  "attackVectors": [
    {
      "resultId": "string",
      "bestFixLocationNode": 0,
      "nodes": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
attackVectors	[Cx.Sast.Results.Presentation.Dtos.AttackVectorDto]	false	read-only	none

Cx.Sast.Results.Presentation.Dtos.AttackVectorDto

{
  "resultId": "string",
  "bestFixLocationNode": 0,
  "nodes": [
    {
      "id": 0,
      "order": 0,
      "shortName": "string",
      "fullName": "string",
      "fileName": "string",
      "folder": "string",
      "line": 0,
      "column": 0,
      "length": 0,
      "methodLine": 0,
      "sourceUrl": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
resultId	string	false	none	none
bestFixLocationNode	integer(int64)	false	none	none
nodes	[Cx.Sast.Results.Presentation.Dtos.NodeDto]	false	none	none

Cx.Sast.Results.Presentation.Dtos.NodeDto

{
  "id": 0,
  "order": 0,
  "shortName": "string",
  "fullName": "string",
  "fileName": "string",
  "folder": "string",
  "line": 0,
  "column": 0,
  "length": 0,
  "methodLine": 0,
  "sourceUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
order	integer(int64)	false	none	none
shortName	string	false	none	none
fullName	string	false	none	none
fileName	string	false	none	none
folder	string	false	none	none
line	integer(int32)	false	none	none
column	integer(int32)	false	none	none
length	integer(int32)	false	none	none
methodLine	integer(int32)	false	none	none
sourceUrl	string	false	none	none

Cx.Sast.Results.Presentation.Models.GetAttackVectorsByBFLModel

{
  "attackVectorsByBFL": [
    {
      "scanId": 0,
      "queryVersion": 0,
      "bestFixLocationNode": {},
      "attackVectors": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
attackVectorsByBFL	[Cx.Sast.Results.Presentation.Dtos.AttackVectorBFLDto]	false	read-only	none

Cx.Sast.Results.Presentation.Dtos.AttackVectorBFLDto

{
  "scanId": 0,
  "queryVersion": 0,
  "bestFixLocationNode": {
    "id": 0,
    "order": 0,
    "shortName": "string",
    "fullName": "string",
    "fileName": "string",
    "folder": "string",
    "line": 0,
    "column": 0,
    "length": 0,
    "methodLine": 0,
    "sourceUrl": "string"
  },
  "attackVectors": [
    {
      "resultId": "string",
      "bestFixLocationNode": 0,
      "nodes": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
scanId	integer(int64)	false	none	none
queryVersion	integer(int64)	false	none	none
bestFixLocationNode	Cx.Sast.Results.Presentation.Dtos.NodeDto	false	none	none
attackVectors	[Cx.Sast.Results.Presentation.Dtos.AttackVectorDto]	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

Scheduler.Api.ViewModels.ProjectScansSchedulingViewModel

{
  "scheduleType": "string",
  "scheduledDays": [
    "string"
  ],
  "scheduleTime": "string"
}

Properties

Name	Type	Required	Restrictions	Description
scheduleType	string	false	none	The Schedule type. Allowed values are: “None”, “Weekly”.
scheduledDays	[string]	false	none	The Schedule days, relevant just in case ScheduleType is “Weekly”.type, allowed values are: “None”, “Weekly”. Allowed Values: “Sunday”,“Monday”,“Tuesday”,“Wednesday”,“Thursday”,“Friday”,“Saturday”.
scheduleTime	string	false	none	The Schedule time in each scheduled days format {HH:MM}.

Cx.Sast.Results.Presentation.Dtos.SaveResultsTicketDto

{
  "resultsId": [
    "string"
  ],
  "ticketId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
resultsId	[string]	true	none	none
ticketId	string	true	none	none

Cx.ProjectManagement.Presentation.Dtos.ScanSettingsExtRequestDto

{
  "projectId": 1,
  "overrideProjectSetting": true,
  "isIncremental": true,
  "isPublic": true,
  "forceScan": true,
  "comment": "string",
  "presetId": 0,
  "engineConfigurationId": 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

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

System.Collections.Generic.KeyValuePair_System.String_System.Collections.Generic.IEnumerable_System.String_

{
  "key": "string",
  "value": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
key	string	false	read-only	none
value	[string]	false	read-only	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.