AIP Console - Interactive API documentation - Job Parameters

Created by James Hurrell on May 04, 2023

List of job endpoints and parameters :

Application Management

/api/jobs/create-application

Required parameters :

  • appName: The application's name

Optional parameters :

  • appGuid: The application guid created in console if applicable
  • appLicense: The application license, in the case of scoped license
  • domainName: The name of the domain to associate with the application
  • cssGuid: The guid of the CSS on which the triplet database will be created
  • inPlaceMode: Whether to enable or disable the inPlaceMode (*default: false*)

Example: The following example will start a "Create Application" job for application "My Application", in the domain "My Domain" using a specific CSS guid:

example
{
  "appName": "My Application",
  "cssGuid": "8f0e550c-e944-48b3-aa24-d650a98a56c5",
  "domainName": "My Domain"
}

/api/jobs/delete-application

Required parameters :

  • appGuid: The application guid to delete

Example:

example
{
    "appGuid": "8f0e550c-e944-48b3-aa24-d650a98a56c5"
}

/api/jobs/onboard-application

Required parameters :

  • appName: The application's name

Optional parameters :

  • appGuid: The application guid created in console if applicable
  • appLicense: The application license, for scoped license
  • domainName: The name of the domain to associate with the application

Example: The following example will start an "Onboard Application" job for application "My Application", in the domain "My Domain" using a specific CSS guid:

example
{
  "appName": "My Application",
  "cssGuid": "8f0e550c-e944-48b3-aa24-d650a98a56c5",
  "domainName": "My Domain"
}

Version Management

/api/jobs/add-version

Required parameters :

  • appGuid: The application guid where the version will be added
  • versionName: The name of the version to create

Optional parameters :

  • backupApplication: Option to enable the backup before adding a new version
  • deliveryConfigGuid: The delivery configuration guid
  • endStep: The last step of the job that will be run
  • extensionAutoConfigEnabled: Option to enable the extension auto configuration
  • moduleGenerationType: The type of module generation to use for this version. Valid values are {{one_per_techno}} and {{one_per_au}}
  • objectives: An array containing the objectives to add to the version. Valid values are {{global_risk}}, {{security}}, {{functional_points}}, {{blueprint}}, {{data_safety}}, {{data_safety_checks_gdpr}} and {{data_safety_checks_pci}}
  • processImaging: Option to enable sending application analysis data to Imaging
  • releaseDate: A formatted date time string for the version's release date
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • snapshotCaptureDate: A formatted date time string for the snapshot capture date (only applicable if "snapshot" is part of the job)
  • snapshotName: The name of the snapshot
  • sourcePath: The path to the sources for the version
  • startStep: The first step that will be run
  • uploadApplication: Option to enable the upload application to Dashboards and Imaging

Example: Adds a new version "v202304241100" for application with guid "201fca03-678a-476e-92fa-dc86d184727a", using the file "myapp.zip" uploaded to aip console :

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "backupApplication": true,
  "moduleGenerationType": "one_per_techno",
  "objectives": [
    "blueprint",
    "security",
    "global_risk"
  ],
  "releaseDate": "2023-04-24T07:44:36.414Z",
  "sourcePath": "upload:myapp.zip",
  "versionName": "v202304241100"
}

Each modules of this version will be defined by the technology, it will have 3 objectives enabled and it'll have a release date set to "24 Apr. 2023 at 7:44:36".

/api/jobs/clone-version

Required parameters :

  • appGuid: The application guid
  • versionName: The name of the new version

Optional parameters :

  • backupApplication: Option to enable the backup before adding a new version
  • deliveryConfigGuid: The delivery configuration guid
  • endStep: The last step of the job that will be run
  • extensionAutoConfigEnabled: Option to enable the extension autoconfiguration
  • moduleGenerationType: The type of module generation to use for this version. Valid values are {{one_per_techno}} and {{one_per_au}}
  • objectives: An array containing the objectives to add to the version. Valid values are {{global_risk}}, {{security}}, {{functional_points}}, {{blueprint}}, {{data_safety}}, {{data_safety_checks_gdpr}} and {{data_safety_checks_pci}}
  • processImaging: An option to enable processing to Imaging (ignored if Imaging is not configured or the imaging step would not be performed due to the provided end step)
  • releaseDate: A formatted date time string for the version's release date
  • saveSourceFolderZip: An option to enable saving the source folder as a zip file
  • snapshotCaptureDate: A formatted date time string for the snapshot capture date (only applicable if "snapshot" is part of the job)
  • snapshotName: The name of the snapshot (only applicable if "snapshot" is part of the job)
  • sourcePath: The path to the sources for the version
  • startStep: The first step that will be run
  • uploadApplication: An option to enable the upload to Dashboards

Example:

/api/jobs/delete-version

Required parameters :

  • appGuid
  • versionName

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "versionName": "v202304241100"
}

/api/jobs/edit-version

Required parameters :

  • appGuid: The application guid
  • versionName: The name of the version to edit

Optional parameters :

  • backupApplication: Option to enable the backup before adding a new version
  • deliveryConfigGuid: The delivery configuration guid
  • endStep: The last step of the job that will be run
  • extensionAutoConfigEnabled: Option to enable the extension autoconfiguration
  • moduleGenerationType: The type of module generation to use for this version. Valid values are {{one_per_techno}} and {{one_per_au}}
  • objectives: An array containing the objectives to add to the version. Valid values are {{global_risk}}, {{security}}, {{functional_points}}, {{blueprint}}, {{data_safety}}, {{data_safety_checks_gdpr}} and {{data_safety_checks_pci}}
  • processImaging: An option to enable processing to Imaging (ignored if Imaging is not configured or the imaging step would not be performed due to the provided end step)
  • releaseDate: A formatted date time string for the version's release date
  • saveSourceFolderZip: An option to enable saving the source folder as a zip file
  • snapshotCaptureDate: A formatted date time string for the snapshot capture date (only applicable if "snapshot" is part of the job)
  • snapshotName: The name of the snapshot (only applicable if "snapshot" is part of the job)
  • sourcePath: The path to the sources for the version
  • startStep: The first step that will be run
  • uploadApplication: An option to enable the upload to Dashboards

Example: Edits the version with name “v202304241100” to change its module generation type and release date :

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "moduleGenerationType": "one_per_techno",
  "releaseDate": "2023-04-24T07:44:36.414Z",
  "versionName": "v202304241100"
}

NOTE: this will remove the version and create a new one with the previous versions configuration as a baseline and the configuration in the request.

/api/jobs/purge-version

Required parameters :

  • appGuid
  • versionName

Example: Purges the version from the application

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "versionName": "v202304241100"
}

/api/jobs/reject-version

Required parameters :

  • appGuid: The application guid
  • versionName: The version name to reject

Example: Rejects version “v202304241100”

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "versionName": "v202304241100"
}

Application Analysis

/api/jobs/analyze

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backupApplication: Option to enable the backup before adding a new version
  • endStep: The last step of the job that will be run
  • moduleGenerationType: The type of module generation to use for this version. Only applicable if a new version is also created. Valid values are {{one_per_techno}} and {{one_per_au}}
  • processImaging: An option to enable processing to Imaging (ignored if Imaging is not configured or the imaging step would not be performed due to the provided end step)
  • snapshotCaptureDate: A formatted date time string for the snapshot capture date (only applicable if "snapshot" is part of the job)
  • snapshotName: The name of the snapshot (only applicable if "snapshot" is part of the job)
  • snapshotVersion: The snapshot target version
  • startStep: The first step that will be run
  • uploadApplication: An option to enable the upload to Dashboards
  • versionGuid: The version guid to be analyzed (defaults to latest version)
  • versionName: The version name to be analyzed

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "backupApplication": true,
  "processImaging": true,
  "snapshotCaptureDate": "2023-04-25T15:45:27.709Z",
  "snapshotName": "snapshot v1.2.34.RELEASE",
  "uploadApplication": true,
}

/api/jobs/analyze-exec-group

Required parameters :

  • appGuid: The application guid
  • analysisUnitGuid: The GUID of the analysis unit to analyse

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "analysisUnitGuid": "42e47a51-2158-4540-b2de-36b2e6d51516"
}

/api/jobs/analyze-security-dataflow

Required parameters :

  • appGuid

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/deep-analysis

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backup: Option to enable backup before creating a new version
  • cssGuid: The GUID of the css database to use to store the application data
  • deleteExcludedFiles: Option to delete the excluded files from the source folder
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • extensionAutoConfigEnabled: Option to enable the extension auto configuration
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • moduleGenerationType: The type of module generation to use for this version. Valid values are {{one_per_techno}} and {{one_per_au}}
  • objectives: An array containing the objectives to add to the version. Valid values are {{global_risk}}, {{security}}, {{functional_points}}, {{blueprint}}, {{data_safety}}, {{data_safety_checks_gdpr}} and {{data_safety_checks_pci}}
  • processImaging: Option to enable sending application analysis data to Imaging
  • publishToEngineering: Option to enable sending application analysis data to Engineering Dashboards
  • runAnalysis: Option to enable the analysis of the application
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • snapshotCaptureDate: The capture date of the snapshot
  • snapshotName: The name of the snapshot
  • sourcePath: The path to the sources for the version
  • uploadApplication: Option to enable the upload application to Dashboards and Imaging
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "backup": true,
  "deleteExcludedFiles": true,
  "deleteVersion": true,
  "exclusionRules": [
    {
      "enabled": true,
      "rule": "*Test.java"
    }
  ],
  "extensionAutoConfigEnabled": true,
  "ignorePatterns": [
    ".htaccess"
  ],
  "processImaging": true,
  "publishToEngineering": true,
  "runAnalysis": true,
  "saveSourceFolderZip": true,
  "snapshotCaptureDate": "2023-04-27T08:20:02.206Z",
  "snapshotName": "snapshot v1.34.9.RELEASE",
  "sourcePath": "latest",
  "uploadApplication": true,
  "versionName": "v1.34.9.RELEASE"
}

/api/jobs/discover-application

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backup: Option to enable backup before creating a new version
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • onboardingGuid: The onboarding guid of the application
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • sourcePath: The path to the sources for the version
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "deleteVersion": true,
  "onboardGuid": "64054d5e-3ca6-4d95-8a69-bb23aec2d9dc",
  "saveSourceFolderZip": true,
  "sourcePath": "newversionsources",
  "versionName": "latest version"
}

/api/jobs/fast-scan

Required parameters :

  • appGuid: The application guid to use for this job
  • sourcePath: The path to the sources for the version

Optional parameters :

  • backup: Option to enable the backup before adding a new version
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "backup": true,
  "deliveryConfigGuid": "64054d5e-3ca6-4d95-8a69-bb23aec2d9dc",
  "saveSourceFolderZip": true,
  "sourcePath": "v20230501/",
  "versionName": "v20230501"
}

/api/jobs/first-scan-application

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backup: Option to enable backup before creating a new version
  • cssGuid: The GUID of the css database to use to store the application data
  • deleteExcludedFiles: Option to delete the excluded files from the source folder
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • extensionAutoConfigEnabled: Option to enable the extension auto configuration
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • moduleGenerationType: The type of module generation to use for this version. Valid values are {{one_per_techno}} and {{one_per_au}}
  • objectives: An array containing the objectives to add to the version. Valid values are {{global_risk}}, {{security}}, {{functional_points}}, {{blueprint}}, {{data_safety}}, {{data_safety_checks_gdpr}} and {{data_safety_checks_pci}}
  • processImaging: Option to enable sending application analysis data to Imaging
  • publishToEngineering: Option to enable sending application analysis data to Engineering Dashboards
  • runAnalysis: Option to enable the analysis of the application
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • snapshotCaptureDate: The capture date of the snapshot
  • snapshotName: The name of the snapshot
  • sourcePath: The path to the sources for the version
  • uploadApplication: Option to enable the upload application to Dashboards and Imaging
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "cssGuid": "cc345900-bd61-41f7-8d1d-86d33808a6fd",
  "deleteExcludedFiles": true,
  "deleteVersion": true,
  "exclusionRules": [
    {
      "enabled": true,
      "rule": "*Test.java"
    }
  ],
  "extensionAutoConfigEnabled": true,
  "ignorePatterns": [
    ".htaccess"
  ],
  "runAnalysis": true,
  "snapshotCaptureDate": "2023-04-27T08:20:02.206Z",
  "snapshotName": "snapshot 20230421082002",
  "sourcePath": "pl1-app",
  "uploadApplication": true,
  "versionName": "build #78103"
}

/api/jobs/function-points

Required parameters :

  • appGuid

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/install-extensions

Required parameters :

  • appGuid
  • versionName

Optional parameters : Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "versionName": "v202304241100"
}

/api/jobs/rediscover-application

Required parameters :

  • appGuid: The application guid to use for this job
  • sourcePath: The path to the sources for the version

Optional parameters :

  • backup: Option to enable the backup before adding a new version
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "sourcePath": "v20230501/",
  "versionName": "v20230501"
}

/api/jobs/rescan-application

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backup: Option to enable backup before creating a new version
  • cssGuid: The GUID of the css database to use to store the application data
  • deleteExcludedFiles: Option to delete the excluded files from the source folder
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • extensionAutoConfigEnabled: Option to enable the extension auto configuration
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • moduleGenerationType: The type of module generation to use for this version. Valid values are {{one_per_techno}} and {{one_per_au}}
  • objectives: An array containing the objectives to add to the version. Valid values are {{global_risk}}, {{security}}, {{functional_points}}, {{blueprint}}, {{data_safety}}, {{data_safety_checks_gdpr}} and {{data_safety_checks_pci}}
  • processImaging: Option to enable sending application analysis data to Imaging
  • publishToEngineering: Option to enable sending application analysis data to Engineering Dashboards
  • runAnalysis: Option to enable the analysis of the application
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • snapshotCaptureDate: The capture date of the snapshot
  • snapshotName: The name of the snapshot
  • sourcePath: The path to the sources for the version
  • uploadApplication: Option to enable the upload application to Dashboards and Imaging
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "deleteExcludedFiles": true,
  "exclusionRules": [
    {
      "enabled": true,
      "rule": "*Test.java"
    }
  ],
  "extensionAutoConfigEnabled": true,
  "processImaging": true,
  "runAnalysis": true,
  "saveSourceFolderZip": true,
  "snapshotCaptureDate": "2023-04-27T08:20:02.206Z",
  "sourcePath": "latest",
  "uploadApplication": true,
  "versionName": "v1.34.9.RELEASE"
}

Sync with Dashboards/Imaging

/api/jobs/consolidate-snapshot

Required parameters :

  • appGuid: The application guid to use for this job
  • snapshotGuid: The snapshot GUID to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "snapshotGuid": "ce5ada52-2263-4207-b4f7-da5c5b9d4b63"
}

/api/jobs/publish

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backupApplication: Option to enable the backup before running the job
  • processImaging: Option to enable sending application analysis data to Imaging
  • uploadApplication: Option to enable the upload application to Dashboards and Imaging

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "backupApplication": true,
  "processImaging": true,
  "uploadApplication": true
}

/api/jobs/publish-all

Required parameters :

  • appGuid: The application guid to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/update-analysis-data

Required parameters :

  • appGuid: The application guid to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

Other jobs

/api/jobs/backup

Required parameters :

  • appGuid: The application guid to use for this job

Optional parameters :

  • backupName: Name of the backup
  • backupTriplet: Option to enable triplet backup
  • backupDeliveryFolder: Option to enable Delivery Folder backup

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "backupName": "backup_20230423",
  "backupTriplet": true,
  "backupDeliveryFolder": false
}

/api/jobs/backup-measurement

Required parameters :

  • backupName:

Example:

example
{
  "backupName": "pg_local_measurement_backup"
}

/api/jobs/cleanup-snapshots

Required parameters :

  • appGuid: The application guid to use for this job

Notes: Cleanup of snapshots will be done based on snapshot cleanup configuration in the Admin Space Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/cleanup-versions

Required parameters :

  • appGuid: The application guid to use for this job

Notes: Cleanup of versions will be done based on version cleanup configuration in the Admin Space Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/delete-selected-snapshots

Required parameters :

  • appGuid: The application guid to use for this job
  • snapshotGuid: String list of snapshot guids, separated by a comma

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
	"snapshotGuid": "bfd3b72f-d41a-484e-9404-2279b82f278f, 8b8e1207-1a2e-409f-a09a-1493295db2c4, 17ecbe37-64cc-4f48-88b4-c4626c88cb6a"
}

/api/jobs/delete-snapshot

Required parameters :

  • appGuid: The application guid to use for this job
  • snapshotGuid: The snapshot GUID to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
	"snapshotGuid": "bfd3b72f-d41a-484e-9404-2279b82f278f"
}

/api/jobs/optimize

Required parameters :

  • appGuid: The application guid to use for this job
  • cssOptimizeOperation: Type of optimization to perform. Valid values are ANALYZE, VACUUM VACUUM_ANALYZE, VACUUM_FULL or DISABLED

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
	"cssOptimizeOperation": "analyze"
}

/api/jobs/optimize-measurement

Required parameters :

  • cssOptimizeOperation: Type of optimization to perform. Valid values are ANALYZE, VACUUM VACUUM_ANALYZE, VACUUM_FULL or DISABLED

Example:

example
{
	"cssOptimizeOperation": "vacuum_analyzed"
}

/api/jobs/recompute-application-indicators

Required parameters :

  • appGuid: The application guid to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/recompute-checksums

Required parameters :

  • appGuid: The application guid to use for this job
  • snapshotId: the internal ID of the snapshot

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "snapshotId": 987203
}

/api/jobs/recompute-snapshot-indicators

Required parameters :

  • appGuid: The application guid to use for this job
  • snapshotGuid: The snapshot GUID to use for this job

Notes: Snapshot GUID must be the latest snapshot guid Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
	"snapshotGuid": "bfd3b72f-d41a-484e-9404-2279b82f278f"
}

/api/jobs/reference_finder

Required parameters :

  • appGuid: The application guid to use for this job
  • refFinderConfigGuid: The Reference Finder config guid to use during this job

Optional parameters :

  • saveLinks: Option to save the links found by the reference finder

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "refFinderConfigGuid": "64a9e701-00be-4cae-82c1-4bef12a1627f",
  "saveLinks": true,
}

/api/jobs/refresh-onboarding-delivery-configuration

Required parameters :

  • appGuid: The application guid to use for this job
  • sourcePath: The path to the sources for the version

Optional parameters :

  • backup: Option to enable the backup before adding a new version
  • deleteVersion: Option to delete the version before creating a new version to be analyzed
  • deliveryConfigGuid: The Delivery Config GUID for the application, defining ignored and excluded files
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • fromVersionGuid: A version guid to create the new version from, copying its configuration
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis
  • saveSourceFolderZip: Option to keep a copy of the provided source folder archive before starting the deep scan process
  • versionName: The name of the version

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "deliveryConfigGuid": "64054d5e-3ca6-4d95-8a69-bb23aec2d9dc",
  "sourcePath": "v20230501/",
  "versionName": "v20230501"
}

/api/jobs/rename-application

Required parameters :

  • appGuid: The application guid to use for this job
  • appNewName: The new application name

Optional parameters :

  • appLicense: The application scoped license to match the new application name if necessary

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "appNewName": "new application name",
  "appLicense": "<new application name license>",
}

/api/jobs/rename-snapshot

Required parameters :

  • appGuid: The application guid to use for this job
  • snapshotGuid: The snapshot GUID to use for this job
  • snapshotName: The new name for the snapshot

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
	"snapshotGuid": "bfd3b72f-d41a-484e-9404-2279b82f278f",
  "snapshotName": "New snapshot name"
}

/api/jobs/restore

Required parameters :

  • appGuid: The application guid to use for this job
  • backupName: The name of the backup to use for the restore

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
	"backupName": "20230104_triplet_restore.zip"
}

/api/jobs/resync-application

Required parameters :

  • appGuid: The application guid to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/sherlock-backup

Required parameters :

  • appGuid: The application guid to use for this job
  • exportName: The application guid to use for this job

Optional parameters :

  • exportSourceCode: Option to enable export of source code
  • exportLogs: Option to enable export of log files
  • exportTriplets: Option to enable export of triplet database

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a",
  "exportLogs": true,
  "exportName": "export-bug-ua",
  "exportSourceCode": true,
  "exportTriplets": true
}

/api/jobs/update-assessment-model

Required parameters :

  • appGuid: The application guid to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/upgrade-application

Required parameters :

  • appGuid: The application guid to use for this job

Example:

example
{
  "appGuid": "201fca03-678a-476e-92fa-dc86d184727a"
}

/api/jobs/upgrade-selected-applications

Required parameters :

  • guids: An array containing the GUIDs of applications to upgrade

Example:

example
{
  "guids": [
    "6c74c18e-9a22-49e0-a3e3-f6cc1db82e8f", 
    "04939e98-a0fd-495e-945d-8c5f7a4da8c8", 
    "67471979-2ace-4c0d-8f27-79d2f6b8fd18", 
    "ab52bff9-c1de-4687-957c-a87b91714666", 
    "9d05aa6e-05ff-448a-b469-aac66fc3108a"
  ]
}

Delivery Config

Before running an application job, you can create a delivery configuration request to prepare the exclusion and ignore rules. When adding a new version ( or doing an analysis starting with delivery, or during a new version onboarding), you can then reference this delivery config guid to apply the exclusion and ignore rules provided in the delivery config request. To manually create a delivery configuration, send a POST request to {{/api/applications/{appGuid}/delivery-configuration}} with the following content :

example
{
  "exclusionRules": [
    {
      "enabled": true,
      "rule": "string"
    }
  ],
  "ignorePatterns": [
    "string"
  ]
}
  • exclusionRules: An array of exclusion rules to apply to exclude files based on the provided glob patterns
  • ignorePatterns: A list of glob pattern to ignore during the discovery/analysis

This will return a JSON object containing the GUID of the delivery configuration that was created.