Schemas


AbsolutePathDto

Field Type Required Notes
data string Yes min length: 1, max length: 260

AicApplication

AicApplication resource representation

Field Type Required Notes
guid string No
createdDate string(date-time) No
modifiedDate string(date-time) No
name string No
title string No
currentVersionGuid string No
latestVersionGuid string No
managed boolean No
schemaPrefix string No
caipVersion string No
domain string No
imagingOnly boolean No
inPlaceMode boolean No
imagingTenant string No
analysisDuration integer(int64) No
targetNode string No
onboarded boolean No
missingDependencies boolean No
movingToFastScan boolean No
movingToFastScanAnalysisPending boolean No
snapshotDone boolean No
caipUpgradeAvailable string No
migrationStatus string No
unsupportedTechnos string No
recentMigrationChangeLogDate string(date-time) No
onboardedNotAnalyzed boolean No

AicApplicationDetailsDto

Field Type Required Notes
guid string No
createdDate string(date-time) No
modifiedDate string(date-time) No
name string No
title string No
currentVersionGuid string No
latestVersionGuid string No
managed boolean No
schemaPrefix string No
caipVersion string No
domain string No
imagingOnly boolean No
inPlaceMode boolean No
imagingTenant string No
analysisDuration integer(int64) No
targetNode string No
onboarded boolean No
missingDependencies boolean No
movingToFastScan boolean No
movingToFastScanAnalysisPending boolean No
snapshotDone boolean No
caipUpgradeAvailable string No
migrationStatus string No
unsupportedTechnos string No
recentMigrationChangeLogDate string(date-time) No
version VersionOverviewDto No
onboardedNotAnalyzed boolean No

AnalysisOverviewDto

Field Type Required Notes
versionName string No
versionTitle string No
duration integer(int64) No
dynamicLinkCount integer(int64) No
notReviewedDynamicLinkCount integer(int64) No

AnalysisReportItemDto

Field Type Required Notes
fileInfo SourceFileInfoDto No
nbProcessedFiles integer(int32) No
nbAnalyzedFiles integer(int32) No
nbUnanalyzedFiles integer(int32) No
nbFoundFiles integer(int32) No
nbExcludedFiles integer(int32) No
nbSkippedFiles integer(int32) No
nbPartiallyAnalyzedFiles integer(int32) No
nbUnresolvedFiles integer(int32) No

AnalysisUnitDto

Field Type Required Notes
guid string No read-only
name string No
active boolean No
type string No
technology string No
projectPath string No
executionUnit string No
analysisUnitType string No

ApplicationDetailsDto

Field Type Required Notes
guid string No
name string No
title string No
currentVersionGuid string No
latestVersionGuid string No
managed boolean No
schemaPrefix string No
caipVersion string No
domain string No
inPlaceMode boolean No
imagingTenant string No
targetNode string No
snapshotDone boolean No
imagingDone boolean No
onboarded boolean No
missingDependencies boolean No
movingToFastScan boolean No
movingToFastScanAnalysisPending boolean No
imagingOnly boolean No
analysisDuration integer(int64) No
versionName string No
versionTitle string No
versionGuid string No
versionStatus stringopened, purged, delivering, delivered, discovered, scanned, accepted, updating_extensions, analysis_ongoing, analysis_done, analysis_failed, preparing_analysis_data, analyzed, analysis_data_prepared, processing_imaging, imaging_processed, snapshot_ongoing, snapshot_done, fully_analyzed, validated, publishing No
lastActionDate string(date-time) No

ApplicationOnboardingDto

Field Type Required Notes
sourcePath string No
discoveryDone boolean No
configurationDone boolean No
profilerScanned boolean No
nbFiles integer(int64) No
applicationSize integer(int64) No
nbLoc integer(int64) No
totalNbFiles integer(int64) No
totalApplicationSize integer(int64) No
totalNbLoc integer(int64) No
status stringunknown, scanned, analyzed, fully_analyzed No
versionGuid string No
versionName string No
deliveryConfigGuid string No
guid string No
createdDate string(date-time) No
estimatedTime integer(int64) No
estimatedAnalysisTime integer(int64) No
estimatedSnapshotTime integer(int64) No
estimatedImagingTime integer(int64) No
estimatedWeight string No
targetNode string No
databaseName string No
caipVersion string No
objectives array of stringglobal_risk, security, functional_points, blueprint, data_safety, data_safety_checks_gdpr, data_safety_checks_pci No
alertsValidated boolean No

ApplicationOverviewDto

Field Type Required Notes
versionCount integer(int64) No
notAnalysedVersionCount integer(int64) No
snapshotCount integer(int64) No
lastAnalysis AnalysisOverviewDto No
lastSnapshot SnapshotOverviewDto No

ApplicationsDto

Field Type Required Notes
applications array of ApplicationDetailsDto No
versionStatusCounts object No
totalApplications integer(int64) No
legacyApplicationCount integer(int64) No
onboardedApplicationCount integer(int64) No

BaseDto

Field Type Required Notes
guid string No read-only

CreateAnalysisUnitRequest

Field Type Required Notes
languages array of string Yes
packageGuid string Yes min length: 1
name string Yes min length: 1, max length: 63

CreateDependencyRequest

Field Type Required Notes
Source technology name string Yes e.g. jee
Source AU guid string Yes
Target technology name string Yes e.g. mainframe
Target AU guid string Yes

D2GraphTechnoRoleDto

Field Type Required Notes
name string No
type string No
roles array of string No
technologyPaths array of string No
iconNames array of string No

D2GraphTechnoTreeDto

Field Type Required Notes
technoRoleMap array of D2GraphTechnoRoleDto No
technoPathIcon object No

DeliveryConfigurationDto

Field Type Required Notes
guid string No
ignorePatterns array of string No
exclusionRules array of ExclusionRuleDto No

Dependency

Dependency resource representation

Field Type Required Notes
guid string No read-only
origin stringdefault, discovered, custom No
source DependencyItemDto No
target DependencyItemDto No

DependencyItemDto

Field Type Required Notes
technology string No
name string No
type string No

DetailedFrameworkInfoDto

Field Type Required Notes
framework string No
status stringnot_supported, supported_by_cast, supported_by_uc No
available boolean No

DiscoverTechnoCountsDto

Field Type Required Notes
technology string No
includedCount integer(int64) No
excludedCount integer(int64) No

EstimationDto

Field Type Required Notes
analysis_estimate number(double) No
analyzeEstimation integer(int64) No
snapshotEstimation integer(int64) No
snapshot_estimate integer(int64) No
imaging_estimate number(double) No
imagingEstimation integer(int64) No

ExclusionRuleDto

Field Type Required Notes
rule string No
enabled boolean No

ExtendSettingsDto

Field Type Required Notes
extendUrl string Yes min length: 1
extendUsername string No
extendPassword string No
enableSendReport boolean No
extendApikey string No
extendMode stringextend_online, extend_proxy, extend_offline No
extendProxyMode stringauto, offline No
extendProxy boolean No
extendOffline boolean No
extendOnline boolean No

ExtensionConfigurationDtoExtensionFeedDetailsDto

Field Type Required Notes
autoConfigEnabled boolean No
extensions array of ExtensionFeedDetailsDto No

ExtensionFeedDetailsDto

Field Type Required Notes
id string Yes min length: 1
version string Yes min length: 1
origin stringshipped, discovered, force_install, custom, installed No
installed boolean No
installedVersion string No
available boolean No
supported boolean No
autoUpdateEnabled boolean No
serverSide boolean No
title string No
author string No
iconUrl string No
description string No
latestVersion boolean No
prerelease boolean No
updateAvailable boolean No
updateCandidate string No
minAipVersion string No
lockedVersion string No
forceInstalled boolean No
blacklisted boolean No
modifiedDate string(date-time) No

ExtensionFilterDto

Field Type Required Notes
author array of string No
latestVersion boolean No
stable boolean No
minAipVersion string No

J2EEClasspathDto

Field Type Required Notes
guid string No read-only
path string No
recursive boolean No
type string No
contribution string No
origin string No

J2EEConfigurationHolderDto

Field Type Required Notes
javaFileExtensions string No
jspFileExtensions string No
clientFileExtensions string No
xmlFileExtensions string No
javaVersion string No
enableWebAnalysisUsage string No
servletJspStandardVersion string No
hibernateUsage string No
strutsUsage string No
springUsage string No
ejbUsage string No
wbsUsage string No

JeeAnalysisOptionsDto

Field Type Required Notes
configuration J2EEConfigurationHolderDto No
classpaths array of J2EEClasspathDto No

JobExecutionDto

Field Type Required Notes
guid string No
createdDate string(date-time) No
modifiedDate string(date-time) No
jobType stringanalyze, update_analysis_data, prepare_analysis_data, reject_version, delete_version, purge_version, delete_snapshot, delete_selected_snapshots, rename_snapshot, publish_all, publish, upload_application, publish_application, consolidate_snapshot, create_application, declare_application, onboard_application, discover_application, rediscover_application, fast_scan, first_scan_application, rescan_application, deep_analysis, process_imaging, refresh_onboarding_delivery_configuration, delete_application, function_points, backup, backup_measurement, restore, upgrade_application, optimize, optimize_measurement, sherlock_backup, add_version, clone_version, edit_version, resync_application, sync_application, rename_application, analyze_security_dataflow, dataflow_security_analyze, analyze_exec_group, run_analyze_units, install_extensions, update_extensions, update_assessment_model, cleanup_snapshots, cleanup_versions, recompute_checksums, recompute_snapshot_indicators, recompute_application_indicators, reference_finder, import_application_to_imaging_viewer, delete_application_from_unified, rename_application_in_unified, run_measure_task No
jobActionLabelType array of string No
currentStep stringaccept, setcurrent, update_extensions, inject_analysis_options, analyze, run_analyze_units, prepare_analysis_data, process_imaging, snapshot, validate_snapshot, consolidate_snapshot, analysis_report, backup, backup_measurement, exclude_files, restore_files, restore, upgrade_application, css_optimize, css_optimize_measurement, sherlock_backup, dataflow_security_analyze, reload_application, refresh_onboarding_delivery_config, rename_application, create_delivery_folder, prepare_environment, create_triplet_schema, create_local_db, create_central_db, create_mngt_db, create_combined_db, import_preferences, manage_application, import_assessment_model, update_assessment_model, restore_triplet, application_cleanup_measure, unmanage_application, delete_triplet_schema, cleanup_database, remove_application_data, deregister_application, unzip_source, code_scanner, install_extensions, prepare_analysis_config, create_package, add_version, attach_package_to_version, copy_from_version, prepare_version, copy_and_attach_packages, update_package, deliver_version, add_package, delete_snapshot, delete_snapshots, delete_selected_snapshots, cleanup_snapshots, upload_application, snapshot_indicator, rename_snapshot, delete_version, purge_version, reject_version, cleanup_versions, function_points, recompute_checksums, recompute_snapshot_indicators, recompute_application_indicators, reference_finder, run_measure_sync, run_measure_delete_snapshot, run_measure_delete_application, import_application, delete_application_analysis_node, delete_application_imaging_viewer, delete_application_control_panel, rename_application_analysis_node, rename_application_imaging_viewer, rename_application_control_panel No
currentPhase stringdiscover, prepare, configure, analyze, publish, backup, compute, optimize, delete No
startedBy string No
startedOn string No
jobParameters object No
jobStepExecutions array of JobStepExecutionDto No
state stringcompleted, starting, started, stopped, failed, canceling, canceled No
startTime string(date-time) No
endTime string(date-time) No
jobPhaseExecutions array of JobPhaseExecutionDto No
duration integer(int64) No

JobPhaseExecutionDto

Field Type Required Notes
startTime string(date-time) No
endTime string(date-time) No
phaseType stringdiscover, prepare, configure, analyze, publish, backup, compute, optimize, delete No
jobStepExecutions array of JobStepExecutionDto No
duration integer(int64) No

JobStepExecutionDto

Field Type Required Notes
stepType stringaccept, setcurrent, update_extensions, inject_analysis_options, analyze, run_analyze_units, prepare_analysis_data, process_imaging, snapshot, validate_snapshot, consolidate_snapshot, analysis_report, backup, backup_measurement, exclude_files, restore_files, restore, upgrade_application, css_optimize, css_optimize_measurement, sherlock_backup, dataflow_security_analyze, reload_application, refresh_onboarding_delivery_config, rename_application, create_delivery_folder, prepare_environment, create_triplet_schema, create_local_db, create_central_db, create_mngt_db, create_combined_db, import_preferences, manage_application, import_assessment_model, update_assessment_model, restore_triplet, application_cleanup_measure, unmanage_application, delete_triplet_schema, cleanup_database, remove_application_data, deregister_application, unzip_source, code_scanner, install_extensions, prepare_analysis_config, create_package, add_version, attach_package_to_version, copy_from_version, prepare_version, copy_and_attach_packages, update_package, deliver_version, add_package, delete_snapshot, delete_snapshots, delete_selected_snapshots, cleanup_snapshots, upload_application, snapshot_indicator, rename_snapshot, delete_version, purge_version, reject_version, cleanup_versions, function_points, recompute_checksums, recompute_snapshot_indicators, recompute_application_indicators, reference_finder, run_measure_sync, run_measure_delete_snapshot, run_measure_delete_application, import_application, delete_application_analysis_node, delete_application_imaging_viewer, delete_application_control_panel, rename_application_analysis_node, rename_application_imaging_viewer, rename_application_control_panel No
startTime string(date-time) No
endTime string(date-time) No
phaseType stringdiscover, prepare, configure, analyze, publish, backup, compute, optimize, delete No
alreadyExecutedStep boolean No
logPath string No
duration integer(int64) No

JsonDtoBoolean

Field Type Required Notes
data boolean Yes

LanguageDto

Field Type Required Notes
guid string No read-only
name string No
internalName string No

LicenseInfoDto

Field Type Required Notes
license string No
licensedTo string No
licenceType stringunknown, aip, aip_efp, aip_sec, imaging, insight No
licenseKind stringUNKNOWN, LEGACY_AIP, SCOPE_CD, SCOPE_APP, NAMED_USER No
expirationDate string(date) No
imagingViewerAllowed boolean No
engineeringDashboardAllowed boolean No
securityDashboardAllowed boolean No
managementDashboardAllowed boolean No

ModuleBaseDto

Field Type Required Notes
guid string No read-only
name string Yes min length: 1
description string No min length: 0, max length: 255
generationType stringfull_content, one_per_au, unassigned_objects, user_defined, union_types No

ModuleOptionsDto

Field Type Required Notes
generationType stringnone, full_content, one_per_au, unassigned_objects No
emptyModulesIgnored boolean No
modules array of ModuleBaseDto No

OnboardedFileStatusDto

Field Type Required Notes
relativePath string No
excluded boolean No
exclusionPattern string No

ProfilerCompositionDto

Field Type Required Notes
language string No
color string No
extension string No
primaryExtension string No
subExtensions array of string No
type string No
isBinary boolean No
nbBytes integer(int64) No
nbLocs integer(int64) No
nbFiles integer(int64) No
nbNonUTF8Files integer(int64) No

ReportLogInfo

Field Type Required Notes
jobExecutionGuid string No
logTask string No
logType string No
subLogName string No
jobActionLabelType array of string No

RepositoryDto

Field Type Required Notes
guid string No read-only
name string No

SnapshotDto

Field Type Required Notes
guid string No
createdDate string(date-time) No
modifiedDate string(date-time) No
name string No
title string No
application AicApplication No
versionName string No
captureDate string(date-time) No

SnapshotOverviewDto

Field Type Required Notes
name string No
title string No
versionName string No
versionTitle string No
linesOfCode integer(int64) No
validTransactionCount integer(int32) No
invalidTransactionCount integer(int32) No
enhancementMeasure string No
afpCount integer(int32) No
aepCount integer(int32) No
efpCount integer(int32) No
architectureChecked boolean No
securityDataflowChecked boolean No

SourceFileInfoDto

Field Type Required Notes
primaryExtension string No
castExtension string No
technology string No
extensions array of string No
technoType string No

SystemAlertDto

Field Type Required Notes
type stringnode_css_server_disconnected, node_low_disc_free_space, no_nodes_available, license_has_invalid_kind, license_is_invalid, license_is_expiring, license_is_expired, license_not_compatible, license_without_imaging, scope_app_license_has_invalid_kind, scope_app_license_is_invalid, scope_app_license_is_expiring, scope_app_license_is_expired, scope_app_license_without_imaging, node_fails_extend_access, node_fails_imaging_access, imaging_missing_apikey, imaging_unavailable, extend_config_invalid, extend_maintenance_is_expired, extend_maintenance_is_expiring, highlight_token_invalid, highlight_about_to_expire, tenant_synchro_multi_tenancy_conflict No
arguments object No
group stringsettings, nodes, none No

TechnoSizeCountsDto

Field Type Required Notes
technology string No
nbFiles integer(int64) No
nbLocs integer(int64) No
nbBytes integer(int64) No
nbNonUtf8Files integer(int64) No
ratioFilesUtf8 number(double) No
status stringnot_supported, supported_by_cast, supported_by_uc No
available boolean No
color string No

UpdateLicenseRequest

Field Type Required Notes
license string Yes min length: 1

VersionOverviewDto

Field Type Required Notes
guid string No read-only
name string No
title string No
status stringopened, purged, delivering, delivered, discovered, scanned, accepted, updating_extensions, analysis_ongoing, analysis_done, analysis_failed, preparing_analysis_data, analyzed, analysis_data_prepared, processing_imaging, imaging_processed, snapshot_ongoing, snapshot_done, fully_analyzed, validated, publishing No
versionDate string(date-time) No
currentVersion boolean No
configurationChanged boolean No
acModelConfigurationChanged boolean No
dataConfigurationChanged boolean No
sourcesConfigurationChanged boolean No
analysisUnitStatusChanged boolean No
acModelsSynchronized boolean No
dmtIgnore string No
previousVersion string No
deliveryConfiguration DeliveryConfigurationDto No
extensionAutoConfigEnabled boolean No
sourcePath string No
objectives array of stringglobal_risk, security, functional_points, blueprint, data_safety, data_safety_checks_gdpr, data_safety_checks_pci No
imagingDone boolean No
analysisDataPrepared boolean No

VersionProcessHistoryDto

Field Type Required Notes
currentVersion boolean No
snapshotStartTime string(date-time) No
snapshotDuration integer(int64) No
analysisStartTime string(date-time) No
analysisDuration integer(int64) No

VersionTimeReportDto

Field Type Required Notes
estimationDto EstimationDto No
versionProcessHistoryDto VersionProcessHistoryDto No