From 15bf19f497320ea115a006b17d5c037af97b8233 Mon Sep 17 00:00:00 2001 From: "sven-dmlr (via github-actions)" <sven.dolderer@mercedes-benz.com> Date: Wed, 27 Nov 2024 09:51:15 +0000 Subject: [PATCH] docs update by SecHub release job @github-actions --- docs/latest/client-download.html | 2 +- ...dmin_disables_scheduler_job_processing.svg | 2 +- ...admin_enables_scheduler_job_processing.svg | 2 +- docs/latest/sechub-architecture.html | 925 +++++++++------ docs/latest/sechub-client.html | 12 +- .../sechub-developer-quickstart-guide.html | 6 +- docs/latest/sechub-getting-started.html | 6 +- docs/latest/sechub-operations.html | 143 ++- .../sechub-product-delegation-server.html | 62 +- docs/latest/sechub-restapi.html | 1004 ++++++++++------ docs/latest/sechub-techdoc.html | 1022 +++++++++++------ docs/latest/sechub-tutorials.html | 6 +- 12 files changed, 2021 insertions(+), 1171 deletions(-) diff --git a/docs/latest/client-download.html b/docs/latest/client-download.html index df08451cbe..e2661d8a38 100644 --- a/docs/latest/client-download.html +++ b/docs/latest/client-download.html @@ -1,7 +1,7 @@ <!DOCTYPE html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <meta http-equiv="refresh" content="0; URL=https://github.com/mercedes-benz/sechub/releases/download/v1.8.1-client/sechub-cli-1.8.1.zip"> + <meta http-equiv="refresh" content="0; URL=https://github.com/mercedes-benz/sechub/releases/download/v1.9.0-client/sechub-cli-1.9.0.zip"> <title>Main Page</title> </head> <body></body> diff --git a/docs/latest/images/event_overview_uc_admin_disables_scheduler_job_processing.svg b/docs/latest/images/event_overview_uc_admin_disables_scheduler_job_processing.svg index 19a62e4915..8da21b2f24 100644 --- a/docs/latest/images/event_overview_uc_admin_disables_scheduler_job_processing.svg +++ b/docs/latest/images/event_overview_uc_admin_disables_scheduler_job_processing.svg @@ -1 +1 @@ -<?xml version='1.0' encoding='UTF-8' standalone='no'?><svg contentScriptType='application/ecmascript' contentStyleType='text/css' height='314px' preserveAspectRatio='none' style='width:907px;height:314px;background:#FFFFFF;' version='1.1' viewBox='0 0 907 314' width='907px' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns='http://www.w3.org/2000/svg' zoomAndPan='magnify'><defs/><g><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='191' x2='191' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='445' x2='445' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='559' x2='559' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='854.5' x2='854.5' y1='84.2969' y2='307.0938'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='367' x='5' y='80.9951'>UC_ADMIN_DISABLES_SCHEDULER_JOB_PROCESSING</text><ellipse cx='191.5' cy='15' fill='#FEFECE' rx='8' ry='8' style='stroke:#A80036;stroke-width:2.0;'/><path d='M191.5,23 L191.5,50 M178.5,31 L204.5,31 M191.5,50 L178.5,65 M191.5,50 L204.5,65 ' fill='none' style='stroke:#A80036;stroke-width:2.0;'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='392' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='388' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='97' x='395' y='72.9951'>administration</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='517' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='513' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='75' x='520' y='72.9951'>notification</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='817.5' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='813.5' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='64' x='820.5' y='72.9951'>schedule</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='900.5' x='0' y='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='114.8633' y2='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='117.8633' y2='117.8633'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='436.25' y='104.2969'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='442.25' y='120.3638'>0</text><polygon fill='#A80036' points='433.5,154.5625,443.5,158.5625,433.5,162.5625' style='stroke:#A80036;stroke-width:1.0;'/><line style='stroke:#A80036;stroke-width:1.0;' x1='191.5' x2='439.5' y1='158.5625' y2='158.5625'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='59' x='198.5' y='153.4966'>executed</text><line style='stroke:#A80036;stroke-width:1.0;' x1='852.5' x2='842.5' y1='187.6953' y2='183.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='852.5' x2='842.5' y1='187.6953' y2='191.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='853.5' y1='187.6953' y2='187.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='328' x='452.5' y='182.6294'>REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='900.5' x='0' y='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='216.2617' y2='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='219.2617' y2='219.2617'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='436.25' y='205.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='442.25' y='221.7622'>1</text><line style='stroke:#A80036;stroke-width:1.0;' x1='559.5' x2='569.5' y1='259.9609' y2='255.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='559.5' x2='569.5' y1='259.9609' y2='263.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='559.5' x2='853.5' y1='259.9609' y2='259.9609'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='271' x='576.5' y='254.895'>SCHEDULER_JOB_PROCESSING_DISABLED</text><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='455.5' y1='289.0938' y2='285.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='455.5' y1='289.0938' y2='293.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='853.5' y1='289.0938' y2='289.0938'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='271' x='462.5' y='284.0278'>SCHEDULER_JOB_PROCESSING_DISABLED</text></g></svg> \ No newline at end of file +<?xml version='1.0' encoding='UTF-8' standalone='no'?><svg contentScriptType='application/ecmascript' contentStyleType='text/css' height='314px' preserveAspectRatio='none' style='width:907px;height:314px;background:#FFFFFF;' version='1.1' viewBox='0 0 907 314' width='907px' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns='http://www.w3.org/2000/svg' zoomAndPan='magnify'><defs/><g><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='191' x2='191' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='445' x2='445' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='559' x2='559' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='854.5' x2='854.5' y1='84.2969' y2='307.0938'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='367' x='5' y='80.9951'>UC_ADMIN_DISABLES_SCHEDULER_JOB_PROCESSING</text><ellipse cx='191.5' cy='15' fill='#FEFECE' rx='8' ry='8' style='stroke:#A80036;stroke-width:2.0;'/><path d='M191.5,23 L191.5,50 M178.5,31 L204.5,31 M191.5,50 L178.5,65 M191.5,50 L204.5,65 ' fill='none' style='stroke:#A80036;stroke-width:2.0;'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='392' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='388' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='97' x='395' y='72.9951'>administration</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='517' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='513' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='75' x='520' y='72.9951'>notification</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='817.5' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='813.5' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='64' x='820.5' y='72.9951'>schedule</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='900.5' x='0' y='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='114.8633' y2='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='117.8633' y2='117.8633'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='436.25' y='104.2969'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='442.25' y='120.3638'>0</text><polygon fill='#A80036' points='433.5,154.5625,443.5,158.5625,433.5,162.5625' style='stroke:#A80036;stroke-width:1.0;'/><line style='stroke:#A80036;stroke-width:1.0;' x1='191.5' x2='439.5' y1='158.5625' y2='158.5625'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='59' x='198.5' y='153.4966'>executed</text><line style='stroke:#A80036;stroke-width:1.0;' x1='852.5' x2='842.5' y1='187.6953' y2='183.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='852.5' x2='842.5' y1='187.6953' y2='191.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='853.5' y1='187.6953' y2='187.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='328' x='452.5' y='182.6294'>REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='900.5' x='0' y='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='216.2617' y2='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='900.5' y1='219.2617' y2='219.2617'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='436.25' y='205.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='442.25' y='221.7622'>1</text><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='455.5' y1='259.9609' y2='255.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='455.5' y1='259.9609' y2='263.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='445.5' x2='853.5' y1='259.9609' y2='259.9609'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='271' x='462.5' y='254.895'>SCHEDULER_JOB_PROCESSING_DISABLED</text><line style='stroke:#A80036;stroke-width:1.0;' x1='559.5' x2='569.5' y1='289.0938' y2='285.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='559.5' x2='569.5' y1='289.0938' y2='293.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='559.5' x2='853.5' y1='289.0938' y2='289.0938'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='271' x='576.5' y='284.0278'>SCHEDULER_JOB_PROCESSING_DISABLED</text></g></svg> \ No newline at end of file diff --git a/docs/latest/images/event_overview_uc_admin_enables_scheduler_job_processing.svg b/docs/latest/images/event_overview_uc_admin_enables_scheduler_job_processing.svg index 104018dda4..eae359746b 100644 --- a/docs/latest/images/event_overview_uc_admin_enables_scheduler_job_processing.svg +++ b/docs/latest/images/event_overview_uc_admin_enables_scheduler_job_processing.svg @@ -1 +1 @@ -<?xml version='1.0' encoding='UTF-8' standalone='no'?><svg contentScriptType='application/ecmascript' contentStyleType='text/css' height='314px' preserveAspectRatio='none' style='width:899px;height:314px;background:#FFFFFF;' version='1.1' viewBox='0 0 899 314' width='899px' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns='http://www.w3.org/2000/svg' zoomAndPan='magnify'><defs/><g><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='189' x2='189' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='441' x2='441' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='555' x2='555' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='846.5' x2='846.5' y1='84.2969' y2='307.0938'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='363' x='5' y='80.9951'>UC_ADMIN_ENABLES_SCHEDULER_JOB_PROCESSING</text><ellipse cx='189.5' cy='15' fill='#FEFECE' rx='8' ry='8' style='stroke:#A80036;stroke-width:2.0;'/><path d='M189.5,23 L189.5,50 M176.5,31 L202.5,31 M189.5,50 L176.5,65 M189.5,50 L202.5,65 ' fill='none' style='stroke:#A80036;stroke-width:2.0;'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='388' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='384' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='97' x='391' y='72.9951'>administration</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='513' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='509' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='75' x='516' y='72.9951'>notification</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='809.5' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='805.5' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='64' x='812.5' y='72.9951'>schedule</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='892.5' x='0' y='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='114.8633' y2='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='117.8633' y2='117.8633'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='432.25' y='104.2969'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='438.25' y='120.3638'>0</text><polygon fill='#A80036' points='429.5,154.5625,439.5,158.5625,429.5,162.5625' style='stroke:#A80036;stroke-width:1.0;'/><line style='stroke:#A80036;stroke-width:1.0;' x1='189.5' x2='435.5' y1='158.5625' y2='158.5625'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='59' x='196.5' y='153.4966'>executed</text><line style='stroke:#A80036;stroke-width:1.0;' x1='844.5' x2='834.5' y1='187.6953' y2='183.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='844.5' x2='834.5' y1='187.6953' y2='191.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='845.5' y1='187.6953' y2='187.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='324' x='448.5' y='182.6294'>REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='892.5' x='0' y='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='216.2617' y2='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='219.2617' y2='219.2617'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='432.25' y='205.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='438.25' y='221.7622'>1</text><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='451.5' y1='259.9609' y2='255.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='451.5' y1='259.9609' y2='263.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='845.5' y1='259.9609' y2='259.9609'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='267' x='458.5' y='254.895'>SCHEDULER_JOB_PROCESSING_ENABLED</text><line style='stroke:#A80036;stroke-width:1.0;' x1='555.5' x2='565.5' y1='289.0938' y2='285.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='555.5' x2='565.5' y1='289.0938' y2='293.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='555.5' x2='845.5' y1='289.0938' y2='289.0938'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='267' x='572.5' y='284.0278'>SCHEDULER_JOB_PROCESSING_ENABLED</text></g></svg> \ No newline at end of file +<?xml version='1.0' encoding='UTF-8' standalone='no'?><svg contentScriptType='application/ecmascript' contentStyleType='text/css' height='314px' preserveAspectRatio='none' style='width:899px;height:314px;background:#FFFFFF;' version='1.1' viewBox='0 0 899 314' width='899px' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns='http://www.w3.org/2000/svg' zoomAndPan='magnify'><defs/><g><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='189' x2='189' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='441' x2='441' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='555' x2='555' y1='84.2969' y2='307.0938'/><line style='stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;' x1='846.5' x2='846.5' y1='84.2969' y2='307.0938'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='363' x='5' y='80.9951'>UC_ADMIN_ENABLES_SCHEDULER_JOB_PROCESSING</text><ellipse cx='189.5' cy='15' fill='#FEFECE' rx='8' ry='8' style='stroke:#A80036;stroke-width:2.0;'/><path d='M189.5,23 L189.5,50 M176.5,31 L202.5,31 M189.5,50 L176.5,65 M189.5,50 L202.5,65 ' fill='none' style='stroke:#A80036;stroke-width:2.0;'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='388' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='111' x='384' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='97' x='391' y='72.9951'>administration</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='513' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='89' x='509' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='75' x='516' y='72.9951'>notification</text><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='809.5' y='49'/><rect fill='#FEFECE' height='30.2969' style='stroke:#A80036;stroke-width:1.5;' width='78' x='805.5' y='53'/><text fill='#000000' font-family='sans-serif' font-size='14' lengthAdjust='spacing' textLength='64' x='812.5' y='72.9951'>schedule</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='892.5' x='0' y='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='114.8633' y2='114.8633'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='117.8633' y2='117.8633'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='432.25' y='104.2969'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='438.25' y='120.3638'>0</text><polygon fill='#A80036' points='429.5,154.5625,439.5,158.5625,429.5,162.5625' style='stroke:#A80036;stroke-width:1.0;'/><line style='stroke:#A80036;stroke-width:1.0;' x1='189.5' x2='435.5' y1='158.5625' y2='158.5625'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='59' x='196.5' y='153.4966'>executed</text><line style='stroke:#A80036;stroke-width:1.0;' x1='844.5' x2='834.5' y1='187.6953' y2='183.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='844.5' x2='834.5' y1='187.6953' y2='191.6953'/><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='845.5' y1='187.6953' y2='187.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='324' x='448.5' y='182.6294'>REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING</text><rect fill='#EEEEEE' height='3' style='stroke:#EEEEEE;stroke-width:1.0;' width='892.5' x='0' y='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='216.2617' y2='216.2617'/><line style='stroke:#000000;stroke-width:1.0;' x1='0' x2='892.5' y1='219.2617' y2='219.2617'/><rect fill='#EEEEEE' height='23.1328' style='stroke:#000000;stroke-width:2.0;' width='28' x='432.25' y='205.6953'/><text fill='#000000' font-family='sans-serif' font-size='13' font-weight='bold' lengthAdjust='spacing' textLength='9' x='438.25' y='221.7622'>1</text><line style='stroke:#A80036;stroke-width:1.0;' x1='555.5' x2='565.5' y1='259.9609' y2='255.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='555.5' x2='565.5' y1='259.9609' y2='263.9609'/><line style='stroke:#A80036;stroke-width:1.0;' x1='555.5' x2='845.5' y1='259.9609' y2='259.9609'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='267' x='572.5' y='254.895'>SCHEDULER_JOB_PROCESSING_ENABLED</text><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='451.5' y1='289.0938' y2='285.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='451.5' y1='289.0938' y2='293.0938'/><line style='stroke:#A80036;stroke-width:1.0;' x1='441.5' x2='845.5' y1='289.0938' y2='289.0938'/><text fill='#000000' font-family='sans-serif' font-size='13' lengthAdjust='spacing' textLength='267' x='458.5' y='284.0278'>SCHEDULER_JOB_PROCESSING_ENABLED</text></g></svg> \ No newline at end of file diff --git a/docs/latest/sechub-architecture.html b/docs/latest/sechub-architecture.html index 36bd4490e9..a8e829c821 100644 --- a/docs/latest/sechub-architecture.html +++ b/docs/latest/sechub-architecture.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub Architecture</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -735,6 +735,7 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#section-usecase-UC_078">7.5.79. UC_078-User unmarks existing false positive project data definitons</a></li> <li><a href="#section-usecase-UC_079">7.5.80. UC_079-System suspends running jobs on SIGTERM</a></li> <li><a href="#section-usecase-UC_080">7.5.81. UC_080-System resumes suspended jobs</a></li> +<li><a href="#section-usecase-UC_081">7.5.82. UC_081-get assigned project data</a></li> </ul> </li> <li><a href="#section-ucrestdoc">7.6. Rest API documentation</a> @@ -781,72 +782,73 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#update-project-metadata">7.6.21. Update project metadata</a></li> <li><a href="#admin-changes-project-description">7.6.22. Admin changes project description</a></li> <li><a href="#admin-changes-project-access-level">7.6.23. Admin changes project access level</a></li> -<li><a href="#user-clicks-link-to-get-new-api-token">7.6.24. User clicks link to get new api token</a></li> -<li><a href="#user-creates-a-new-sechub-job">7.6.25. User creates a new sechub job</a> +<li><a href="#get-assigned-project-data">7.6.24. get assigned project data</a></li> +<li><a href="#user-clicks-link-to-get-new-api-token">7.6.25. User clicks link to get new api token</a></li> +<li><a href="#user-creates-a-new-sechub-job">7.6.26. User creates a new sechub job</a> <ul class="sectlevel4"> -<li><a href="#section-ucrestdoc-UC_005-code-scan">7.6.25.1. Code Scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-code-scan-using-data-section">7.6.25.2. Code Scan using data section variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-secret-scan">7.6.25.3. Secret scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-license-scan">7.6.25.4. License scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-infrastructure-scan">7.6.25.5. Infrastructure scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-anonymous">7.6.25.6. Web scan anonymous variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-with-api-definition">7.6.25.7. Web scan with api definition variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">7.6.25.8. Web scan with client certificate definition variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-login-basic">7.6.25.9. Web Scan login basic variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-login-form-scripted">7.6.25.10. Web Scan login form scripted variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-headers">7.6.25.11. Web Scan headers variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-code-scan">7.6.26.1. Code Scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-code-scan-using-data-section">7.6.26.2. Code Scan using data section variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-secret-scan">7.6.26.3. Secret scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-license-scan">7.6.26.4. License scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-infrastructure-scan">7.6.26.5. Infrastructure scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-anonymous">7.6.26.6. Web scan anonymous variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-with-api-definition">7.6.26.7. Web scan with api definition variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">7.6.26.8. Web scan with client certificate definition variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-login-basic">7.6.26.9. Web Scan login basic variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-login-form-scripted">7.6.26.10. Web Scan login form scripted variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-headers">7.6.26.11. Web Scan headers variant</a></li> </ul> </li> -<li><a href="#user-uploads-source-code">7.6.26. User uploads source code</a></li> -<li><a href="#user-approves-sechub-job">7.6.27. User approves sechub job</a></li> -<li><a href="#user-checks-sechub-job-state">7.6.28. User checks sechub job state</a></li> -<li><a href="#user-downloads-sechub-job-report">7.6.29. User downloads sechub job report</a> +<li><a href="#user-uploads-source-code">7.6.27. User uploads source code</a></li> +<li><a href="#user-approves-sechub-job">7.6.28. User approves sechub job</a></li> +<li><a href="#user-checks-sechub-job-state">7.6.29. User checks sechub job state</a></li> +<li><a href="#user-downloads-sechub-job-report">7.6.30. User downloads sechub job report</a> <ul class="sectlevel4"> -<li><a href="#section-ucrestdoc-UC_010-json">7.6.29.1. JSON variant</a></li> -<li><a href="#section-ucrestdoc-UC_010-html">7.6.29.2. HTML variant</a></li> +<li><a href="#section-ucrestdoc-UC_010-json">7.6.30.1. JSON variant</a></li> +<li><a href="#section-ucrestdoc-UC_010-html">7.6.30.2. HTML variant</a></li> </ul> </li> -<li><a href="#user-marks-false-positives">7.6.30. User marks false positives</a></li> -<li><a href="#user-unmarks-existing-false-positive-definitons">7.6.31. User unmarks existing false positive definitons</a></li> -<li><a href="#user-fetches-false-positive-configuration-of-project">7.6.32. User fetches false positive configuration of project</a></li> -<li><a href="#user-uploads-binaries">7.6.33. User uploads binaries</a></li> -<li><a href="#user-downloads-job-report-in-spdx-format">7.6.34. User downloads job report in SPDX format</a></li> -<li><a href="#user-unmarks-existing-false-positive-project-data-definitons">7.6.35. User unmarks existing false positive project data definitons</a></li> -<li><a href="#user-self-registration">7.6.36. User self registration</a></li> -<li><a href="#admin-lists-open-user-signups">7.6.37. Admin lists open user signups</a></li> -<li><a href="#admin-applies-self-registration">7.6.38. Admin applies self registration</a></li> -<li><a href="#admin-deletes-user-signup">7.6.39. Admin deletes user signup</a></li> -<li><a href="#user-requests-new-api-token">7.6.40. User requests new API token</a></li> -<li><a href="#admin-lists-all-running-jobs">7.6.41. Admin lists all running jobs</a></li> -<li><a href="#admin-cancels-a-job">7.6.42. Admin cancels a job</a></li> -<li><a href="#admin-restarts-a-job">7.6.43. Admin restarts a job</a></li> -<li><a href="#admin-restarts-a-job-hard">7.6.44. Admin restarts a job (hard)</a></li> -<li><a href="#user-defines-mock-data-configuration-for-project">7.6.45. User defines mock data configuration for project</a></li> -<li><a href="#user-retrieves-mock-data-configuration-for-project">7.6.46. User retrieves mock data configuration for project</a></li> -<li><a href="#admin-updates-mapping-configuration">7.6.47. Admin updates mapping configuration</a></li> -<li><a href="#admin-fetches-mapping-configuration">7.6.48. Admin fetches mapping configuration</a></li> -<li><a href="#admin-creates-an-executor-configuration">7.6.49. Admin creates an executor configuration</a></li> -<li><a href="#admin-deletes-executor-configuration">7.6.50. Admin deletes executor configuration</a></li> -<li><a href="#admin-fetches-executor-configuration-list">7.6.51. Admin fetches executor configuration list</a></li> -<li><a href="#admin-fetches-executor-configuration">7.6.52. Admin fetches executor configuration</a></li> -<li><a href="#admin-updates-executor-configuration-setup">7.6.53. Admin updates executor configuration setup</a></li> -<li><a href="#admin-creates-an-execution-profile">7.6.54. Admin creates an execution profile</a></li> -<li><a href="#admin-deletes-execution-profile">7.6.55. Admin deletes execution profile</a></li> -<li><a href="#admin-updates-execution-profile">7.6.56. Admin updates execution profile</a></li> -<li><a href="#admin-fetches-execution-profile">7.6.57. Admin fetches execution profile</a></li> -<li><a href="#admin-fetches-execution-profile-list">7.6.58. Admin fetches execution profile list</a></li> -<li><a href="#admin-assigns-execution-profile-to-project">7.6.59. Admin assigns execution profile to project</a></li> -<li><a href="#admin-unassigns-execution-profile-from-project">7.6.60. Admin unassigns execution profile from project</a></li> -<li><a href="#admin-fetches-auto-cleanup-configuration">7.6.61. Admin fetches auto cleanup configuration</a></li> -<li><a href="#admin-updates-auto-cleanup-configuration">7.6.62. Admin updates auto cleanup configuration</a></li> -<li><a href="#admin-starts-encryption-rotation">7.6.63. Admin starts encryption rotation</a></li> -<li><a href="#admin-fetches-encryption-status">7.6.64. Admin fetches encryption status</a></li> -<li><a href="#admin-disables-job-processing-in-scheduler">7.6.65. Admin disables job processing in scheduler</a></li> -<li><a href="#admin-enables-scheduler-job-processing">7.6.66. Admin enables scheduler job processing</a></li> -<li><a href="#admin-get-scheduler-status">7.6.67. Admin get scheduler status</a></li> -<li><a href="#admin-lists-status-information">7.6.68. Admin lists status information</a></li> -<li><a href="#admin-fetches-server-runtime-data">7.6.69. Admin fetches server runtime data</a></li> -<li><a href="#user-lists-jobs-for-project">7.6.70. User lists jobs for project</a></li> +<li><a href="#user-marks-false-positives">7.6.31. User marks false positives</a></li> +<li><a href="#user-unmarks-existing-false-positive-definitons">7.6.32. User unmarks existing false positive definitons</a></li> +<li><a href="#user-fetches-false-positive-configuration-of-project">7.6.33. User fetches false positive configuration of project</a></li> +<li><a href="#user-uploads-binaries">7.6.34. User uploads binaries</a></li> +<li><a href="#user-downloads-job-report-in-spdx-format">7.6.35. User downloads job report in SPDX format</a></li> +<li><a href="#user-unmarks-existing-false-positive-project-data-definitons">7.6.36. User unmarks existing false positive project data definitons</a></li> +<li><a href="#user-self-registration">7.6.37. User self registration</a></li> +<li><a href="#admin-lists-open-user-signups">7.6.38. Admin lists open user signups</a></li> +<li><a href="#admin-applies-self-registration">7.6.39. Admin applies self registration</a></li> +<li><a href="#admin-deletes-user-signup">7.6.40. Admin deletes user signup</a></li> +<li><a href="#user-requests-new-api-token">7.6.41. User requests new API token</a></li> +<li><a href="#admin-lists-all-running-jobs">7.6.42. Admin lists all running jobs</a></li> +<li><a href="#admin-cancels-a-job">7.6.43. Admin cancels a job</a></li> +<li><a href="#admin-restarts-a-job">7.6.44. Admin restarts a job</a></li> +<li><a href="#admin-restarts-a-job-hard">7.6.45. Admin restarts a job (hard)</a></li> +<li><a href="#user-defines-mock-data-configuration-for-project">7.6.46. User defines mock data configuration for project</a></li> +<li><a href="#user-retrieves-mock-data-configuration-for-project">7.6.47. User retrieves mock data configuration for project</a></li> +<li><a href="#admin-updates-mapping-configuration">7.6.48. Admin updates mapping configuration</a></li> +<li><a href="#admin-fetches-mapping-configuration">7.6.49. Admin fetches mapping configuration</a></li> +<li><a href="#admin-creates-an-executor-configuration">7.6.50. Admin creates an executor configuration</a></li> +<li><a href="#admin-deletes-executor-configuration">7.6.51. Admin deletes executor configuration</a></li> +<li><a href="#admin-fetches-executor-configuration-list">7.6.52. Admin fetches executor configuration list</a></li> +<li><a href="#admin-fetches-executor-configuration">7.6.53. Admin fetches executor configuration</a></li> +<li><a href="#admin-updates-executor-configuration-setup">7.6.54. Admin updates executor configuration setup</a></li> +<li><a href="#admin-creates-an-execution-profile">7.6.55. Admin creates an execution profile</a></li> +<li><a href="#admin-deletes-execution-profile">7.6.56. Admin deletes execution profile</a></li> +<li><a href="#admin-updates-execution-profile">7.6.57. Admin updates execution profile</a></li> +<li><a href="#admin-fetches-execution-profile">7.6.58. Admin fetches execution profile</a></li> +<li><a href="#admin-fetches-execution-profile-list">7.6.59. Admin fetches execution profile list</a></li> +<li><a href="#admin-assigns-execution-profile-to-project">7.6.60. Admin assigns execution profile to project</a></li> +<li><a href="#admin-unassigns-execution-profile-from-project">7.6.61. Admin unassigns execution profile from project</a></li> +<li><a href="#admin-fetches-auto-cleanup-configuration">7.6.62. Admin fetches auto cleanup configuration</a></li> +<li><a href="#admin-updates-auto-cleanup-configuration">7.6.63. Admin updates auto cleanup configuration</a></li> +<li><a href="#admin-starts-encryption-rotation">7.6.64. Admin starts encryption rotation</a></li> +<li><a href="#admin-fetches-encryption-status">7.6.65. Admin fetches encryption status</a></li> +<li><a href="#admin-disables-job-processing-in-scheduler">7.6.66. Admin disables job processing in scheduler</a></li> +<li><a href="#admin-enables-scheduler-job-processing">7.6.67. Admin enables scheduler job processing</a></li> +<li><a href="#admin-get-scheduler-status">7.6.68. Admin get scheduler status</a></li> +<li><a href="#admin-lists-status-information">7.6.69. Admin lists status information</a></li> +<li><a href="#admin-fetches-server-runtime-data">7.6.70. Admin fetches server runtime data</a></li> +<li><a href="#user-lists-jobs-for-project">7.6.71. User lists jobs for project</a></li> </ul> </li> <li><a href="#domain-driven-design">7.7. Domain Driven Design</a> @@ -1302,7 +1304,7 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <div class="paragraph"> <p>This architecture documentation is based on arc42 template.</p> @@ -2126,6 +2128,9 @@ <h5 id="project-administration">7.5.1.3. Project administration</h5> <li> <p><a href="#section-usecase-UC_062">UC_062-Admin changes project access level</a></p> </li> +<li> +<p><a href="#section-usecase-UC_081">UC_081-get assigned project data</a></p> +</li> </ul> </div> </div> @@ -7230,6 +7235,66 @@ <h4 id="section-usecase-UC_080">7.5.81. UC_080-System resumes suspended jobs</h4 </tbody> </table> </div> +<div class="sect3"> +<h4 id="section-usecase-UC_081">7.5.82. UC_081-get assigned project data</h4> +<div class="paragraph"> +<p>User, Owner or Admin fetches a list containing information about assigned and/ or owned projects.</p> +</div> +<div class="paragraph"> +<p>The Project data contains the following information:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>Project ID</p> +</li> +<li> +<p>Owner</p> +</li> +<li> +<p>is owned</p> +</li> +<li> +<p>assigned users (can only be viewed by owner or admin)</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>A project user can see only projects he is assigned to. +A project owner can see all projects he owns and the assigned users. +A project admin can see assigned or owned projects and all assigned users.</p> +</div> +<div class="paragraph"> +<p><strong>Steps</strong></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 5%;"> +<col style="width: 20%;"> +<col style="width: 20%;"> +<col style="width: 5%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Nr</th> +<th class="tableblock halign-left valign-top">Title</th> +<th class="tableblock halign-left valign-top">Role(s)</th> +<th class="tableblock halign-left valign-top">Next</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Rest API call to get Projects with information</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">OWNER, SUPERADMIN, USER</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Rest api call to get projects with details</p></td> +</tr> +</tbody> +</table> +</div> </div> <div class="sect2"> <h3 id="section-ucrestdoc">7.6. Rest API documentation</h3> @@ -7331,6 +7396,9 @@ <h5 id="project-administration-2">7.6.1.3. Project administration</h5> <li> <p><a href="#section-ucrestdoc-uc-UC_062">REST API for UC_062-Admin changes project access level </a></p> </li> +<li> +<p><a href="#section-ucrestdoc-uc-UC_081">REST API for UC_081-get assigned project data </a></p> +</li> </ul> </div> </div> @@ -8364,7 +8432,7 @@ <h4 id="admin-downloads-all-details-about-a-scan-job">7.6.9. Admin downloads all </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/scan/download/b3d0fadc-5631-48fe-ad3b-d1d2856e4158' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/scan/download/d997d479-f12b-4b26-9005-beb905c60f86' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -9529,7 +9597,7 @@ <h4 id="admin-shows-scan-logs-for-project">7.6.20. Admin shows scan logs for pro </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">sechubJobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">236cbc48-7499-4aed-9de2-8646de4bf48d</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">spartakus</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-20T16:59:24.353716812</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:24.353740156</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>}]</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">sechubJobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">b2a0f621-cbed-431f-816d-f8f5a655e8bc</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">spartakus</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-26T09:48:46.447108027</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:46.447126853</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>}]</code></pre> </div> </div> </div> @@ -9906,7 +9974,133 @@ <h4 id="admin-changes-project-access-level">7.6.23. Admin changes project access </div> </div> <div class="sect3"> -<h4 id="user-clicks-link-to-get-new-api-token">7.6.24. User clicks link to get new api token</h4> +<h4 id="get-assigned-project-data">7.6.24. get assigned project data</h4> +<div id="section-ucrestdoc-uc-UC_081" class="paragraph"> +<p>REST API for usecase <a href="#section-usecase-UC_081">UC_081-get assigned project data </a></p> +</div> +<div id="section-ucrestdoc-UC_081-" class="paragraph"> +<p><strong class="big">Definition</strong></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 41. General request information</caption> +<colgroup> +<col style="width: 14.2857%;"> +<col style="width: 85.7143%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top"></th> +<th class="tableblock halign-left valign-top">Value</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Path</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">/api/projects</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Method</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Status code</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">200 OK</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><strong>Path parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 42. https://localhost:8081/api/projects</caption> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +</table> +<div class="paragraph"> +<p><strong>Request headers</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +</table> +<div class="paragraph"> +<p><strong>Response fields</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Path</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].projectId</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Project ID</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].owner</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Name of owner of the Project</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].isOwned</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">If caller is owner of the project</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].assignedUsers</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional: Assigned users (only viewable by owner or admin)</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><strong class="big">Example</strong></p> +</div> +<div class="paragraph"> +<p><strong>Curl request</strong> <br></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/projects' -i -u 'user:secret' -X GET \ + -H 'Content-Type: application/json;charset=UTF-8'</code></pre> +</div> +</div> +<div class="paragraph"> +<p><strong>Response body</strong> <br></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">assignedUsers</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">user2</span><span class="delimiter">"</span></span>],<span class="key"><span class="delimiter">"</span><span class="content">isOwned</span><span class="delimiter">"</span></span>:<span class="value">true</span>}]</code></pre> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="user-clicks-link-to-get-new-api-token">7.6.25. User clicks link to get new api token</h4> <div id="section-ucrestdoc-uc-UC_012" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_012">UC_012-User clicks link to get new api token </a></p> </div> @@ -9914,7 +10108,7 @@ <h4 id="user-clicks-link-to-get-new-api-token">7.6.24. User clicks link to get n <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 41. General request information</caption> +<caption class="title">Table 43. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9944,7 +10138,7 @@ <h4 id="user-clicks-link-to-get-new-api-token">7.6.24. User clicks link to get n <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 42. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}</caption> +<caption class="title">Table 44. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9980,17 +10174,17 @@ <h4 id="user-clicks-link-to-get-new-api-token">7.6.24. User clicks link to get n </div> </div> <div class="sect3"> -<h4 id="user-creates-a-new-sechub-job">7.6.25. User creates a new sechub job</h4> +<h4 id="user-creates-a-new-sechub-job">7.6.26. User creates a new sechub job</h4> <div id="section-ucrestdoc-uc-UC_005" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_005">UC_005-User creates a new sechub job </a></p> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-code-scan">7.6.25.1. Code Scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-code-scan">7.6.26.1. Code Scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 43. General request information</caption> +<caption class="title">Table 45. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10020,7 +10214,7 @@ <h5 id="section-ucrestdoc-UC_005-code-scan">7.6.25.1. Code Scan variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 44. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 46. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10139,17 +10333,17 @@ <h5 id="section-ucrestdoc-UC_005-code-scan">7.6.25.1. Code Scan variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">e985a705-ffb7-49b1-99e6-1407d27226e4</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">7786c4a7-042f-4d2b-8bcf-6c23aabf6e7b</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">7.6.25.2. Code Scan using data section variant</h5> +<h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">7.6.26.2. Code Scan using data section variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 45. General request information</caption> +<caption class="title">Table 47. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10179,7 +10373,7 @@ <h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">7.6.25.2. Code Sc <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 46. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 48. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10318,17 +10512,17 @@ <h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">7.6.25.2. Code Sc </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2210eb32-7fd0-4299-b75b-0d87a5db26a0</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">35ea98be-9e36-4cc6-8c8a-3a157d24ead7</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-secret-scan">7.6.25.3. Secret scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-secret-scan">7.6.26.3. Secret scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 47. General request information</caption> +<caption class="title">Table 49. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10358,7 +10552,7 @@ <h5 id="section-ucrestdoc-UC_005-secret-scan">7.6.25.3. Secret scan variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 48. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 50. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10477,17 +10671,17 @@ <h5 id="section-ucrestdoc-UC_005-secret-scan">7.6.25.3. Secret scan variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a0e2dc56-54fa-4b25-b1e6-688dd47baaf4</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">dc364126-fdc7-40a8-b8e7-ff087eb22bf2</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-license-scan">7.6.25.4. License scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-license-scan">7.6.26.4. License scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 49. General request information</caption> +<caption class="title">Table 51. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10517,7 +10711,7 @@ <h5 id="section-ucrestdoc-UC_005-license-scan">7.6.25.4. License scan variant</h <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 50. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 52. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10636,17 +10830,17 @@ <h5 id="section-ucrestdoc-UC_005-license-scan">7.6.25.4. License scan variant</h </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">e7c1d895-bc81-4c70-92ad-7ca117bab44a</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">7ff1f27b-bae9-4593-b4ee-5a5df3e52604</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-infrastructure-scan">7.6.25.5. Infrastructure scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-infrastructure-scan">7.6.26.5. Infrastructure scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 51. General request information</caption> +<caption class="title">Table 53. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10676,7 +10870,7 @@ <h5 id="section-ucrestdoc-UC_005-infrastructure-scan">7.6.25.5. Infrastructure s <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 52. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 54. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10790,17 +10984,17 @@ <h5 id="section-ucrestdoc-UC_005-infrastructure-scan">7.6.25.5. Infrastructure s </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">953dff35-71f1-4983-b360-0762a95ca7c0</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">fcf8cb7f-4f7c-413a-9978-ce8a085fbc7f</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">7.6.25.6. Web scan anonymous variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">7.6.26.6. Web scan anonymous variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 53. General request information</caption> +<caption class="title">Table 55. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10830,7 +11024,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">7.6.25.6. Web scan anonymou <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 54. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 56. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10959,17 +11153,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">7.6.25.6. Web scan anonymou </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">9bb88784-b24d-436e-898a-40e9e9c9d42b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">42566c19-7464-4f4a-95e6-79e722ae39b7</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">7.6.25.7. Web scan with api definition variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">7.6.26.7. Web scan with api definition variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 55. General request information</caption> +<caption class="title">Table 57. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10999,7 +11193,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">7.6.25.7. Web sca <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 56. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 58. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11123,17 +11317,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">7.6.25.7. Web sca </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">39b31e69-97ca-4543-99a6-50c4f6cc075b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">1ad5cd3b-5a1e-4a7e-8b07-8d5bd87dd515</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">7.6.25.8. Web scan with client certificate definition variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">7.6.26.8. Web scan with client certificate definition variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 57. General request information</caption> +<caption class="title">Table 59. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11163,7 +11357,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">7. <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 58. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 60. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11282,17 +11476,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">7. </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">df9ee013-ee60-45bb-929a-1f2bb410f153</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">019ef25e-a21a-4c9e-9412-2ec55887f291</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">7.6.25.9. Web Scan login basic variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">7.6.26.9. Web Scan login basic variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 59. General request information</caption> +<caption class="title">Table 61. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11322,7 +11516,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">7.6.25.9. Web Scan login <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 60. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 62. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11456,17 +11650,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">7.6.25.9. Web Scan login </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">57628d15-8dd2-4b28-b9fa-42e0c6037c43</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">b7960f36-3dcd-4030-a4d1-fa8ba4f99462</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">7.6.25.10. Web Scan login form scripted variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">7.6.26.10. Web Scan login form scripted variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 61. General request information</caption> +<caption class="title">Table 63. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11496,7 +11690,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">7.6.25.10. Web Sc <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 62. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 64. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11675,17 +11869,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">7.6.25.10. Web Sc </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d47f3a92-0951-4447-8300-fad04567f65b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d70e8d78-f3c9-4d16-a57f-9f4957e4723a</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-headers">7.6.25.11. Web Scan headers variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-headers">7.6.26.11. Web Scan headers variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 63. General request information</caption> +<caption class="title">Table 65. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11715,7 +11909,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-headers">7.6.25.11. Web Scan headers v <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 64. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 66. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11839,13 +12033,13 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-headers">7.6.25.11. Web Scan headers v </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">37527d26-9792-44ae-a2c8-36dfb67fe36c</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">67515a5b-1f33-4d6b-b432-1ed5ba525ee0</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> </div> <div class="sect3"> -<h4 id="user-uploads-source-code">7.6.26. User uploads source code</h4> +<h4 id="user-uploads-source-code">7.6.27. User uploads source code</h4> <div id="section-ucrestdoc-uc-UC_006" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_006">UC_006-User uploads source code </a></p> </div> @@ -11853,7 +12047,7 @@ <h4 id="user-uploads-source-code">7.6.26. User uploads source code</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 65. General request information</caption> +<caption class="title">Table 67. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11883,7 +12077,7 @@ <h4 id="user-uploads-source-code">7.6.26. User uploads source code</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 66. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode</caption> +<caption class="title">Table 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11906,6 +12100,27 @@ <h4 id="user-uploads-source-code">7.6.26. User uploads source code</h4> </tbody> </table> <div class="paragraph"> +<p><strong>Query parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>checkSum</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">A sha256 checksum for file upload validation</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> <p><strong>Request headers</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> @@ -11928,7 +12143,7 @@ <h4 id="user-uploads-source-code">7.6.26. User uploads source code</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/dc48eaff-3a7d-414f-82f6-f242dcd9bf74/sourcecode?checkSum=checkSumValue' -i -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/24722135-2100-465e-bcef-4b1dfdae5ffd/sourcecode?checkSum=checkSumValue' -i -X POST \ -H 'Content-Type: multipart/form-data;charset=UTF-8' \ -F 'file=PK �<M test1.txtPK ? @@ -11942,7 +12157,7 @@ <h4 id="user-uploads-source-code">7.6.26. User uploads source code</h4> </div> </div> <div class="sect3"> -<h4 id="user-approves-sechub-job">7.6.27. User approves sechub job</h4> +<h4 id="user-approves-sechub-job">7.6.28. User approves sechub job</h4> <div id="section-ucrestdoc-uc-UC_007" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_007">UC_007-User approves sechub job </a></p> </div> @@ -11950,7 +12165,7 @@ <h4 id="user-approves-sechub-job">7.6.27. User approves sechub job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 67. General request information</caption> +<caption class="title">Table 69. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11980,7 +12195,7 @@ <h4 id="user-approves-sechub-job">7.6.27. User approves sechub job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve</caption> +<caption class="title">Table 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12025,7 +12240,7 @@ <h4 id="user-approves-sechub-job">7.6.27. User approves sechub job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/bb20198d-8bb8-4ff5-961c-4fc6ecddd80d/approve' -i -X PUT \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/64b78b45-b45e-4c2c-8719-bd74688a0e63/approve' -i -X PUT \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -12035,7 +12250,7 @@ <h4 id="user-approves-sechub-job">7.6.27. User approves sechub job</h4> </div> </div> <div class="sect3"> -<h4 id="user-checks-sechub-job-state">7.6.28. User checks sechub job state</h4> +<h4 id="user-checks-sechub-job-state">7.6.29. User checks sechub job state</h4> <div id="section-ucrestdoc-uc-UC_009" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_009">UC_009-User checks sechub job state </a></p> </div> @@ -12043,7 +12258,7 @@ <h4 id="user-checks-sechub-job-state">7.6.28. User checks sechub job state</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 69. General request information</caption> +<caption class="title">Table 71. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12073,7 +12288,7 @@ <h4 id="user-checks-sechub-job-state">7.6.28. User checks sechub job state</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}</caption> +<caption class="title">Table 72. https://localhost:8081/api/project/{projectId}/job/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12177,7 +12392,7 @@ <h4 id="user-checks-sechub-job-state">7.6.28. User checks sechub job state</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/abb3751f-2ca5-4f0c-bae1-04a0e1788550' -i -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/92179639-e089-4894-a4df-14f1e40e453d' -i -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -12186,22 +12401,22 @@ <h4 id="user-checks-sechub-job-state">7.6.28. User checks sechub job state</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">abb3751f-2ca5-4f0c-bae1-04a0e1788550</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">CREATOR1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:44:22.764797265</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:22.764824576</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">result</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">92179639-e089-4894-a4df-14f1e40e453d</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">CREATOR1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:33:44.986322732</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:44.986349833</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">result</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="user-downloads-sechub-job-report">7.6.29. User downloads sechub job report</h4> +<h4 id="user-downloads-sechub-job-report">7.6.30. User downloads sechub job report</h4> <div id="section-ucrestdoc-uc-UC_010" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_010">UC_010-User downloads sechub job report </a></p> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_010-json">7.6.29.1. JSON variant</h5> +<h5 id="section-ucrestdoc-UC_010-json">7.6.30.1. JSON variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 71. General request information</caption> +<caption class="title">Table 73. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12231,7 +12446,7 @@ <h5 id="section-ucrestdoc-UC_010-json">7.6.29.1. JSON variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 72. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> +<caption class="title">Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12261,19 +12476,19 @@ <h5 id="section-ucrestdoc-UC_010-json">7.6.29.1. JSON variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/7a8b89cc-f4dd-44ac-bae6-212bc2dd01d0' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/9df5834d-4dc1-4a96-8995-926fcae88f9d' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/json'</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_010-html">7.6.29.2. HTML variant</h5> +<h5 id="section-ucrestdoc-UC_010-html">7.6.30.2. HTML variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 73. General request information</caption> +<caption class="title">Table 75. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12303,7 +12518,7 @@ <h5 id="section-ucrestdoc-UC_010-html">7.6.29.2. HTML variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> +<caption class="title">Table 76. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12333,7 +12548,7 @@ <h5 id="section-ucrestdoc-UC_010-html">7.6.29.2. HTML variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/6f4f16d2-8e58-4ed3-b41c-110b74370d7c' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/72362f49-ecbd-4ad6-9961-cacc3a8e11fa' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/xhtml+xml'</code></pre> </div> @@ -12341,7 +12556,7 @@ <h5 id="section-ucrestdoc-UC_010-html">7.6.29.2. HTML variant</h5> </div> </div> <div class="sect3"> -<h4 id="user-marks-false-positives">7.6.30. User marks false positives</h4> +<h4 id="user-marks-false-positives">7.6.31. User marks false positives</h4> <div id="section-ucrestdoc-uc-UC_044" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_044">UC_044-User marks false positives </a></p> </div> @@ -12349,7 +12564,7 @@ <h4 id="user-marks-false-positives">7.6.30. User marks false positives</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 75. General request information</caption> +<caption class="title">Table 77. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12379,7 +12594,7 @@ <h4 id="user-marks-false-positives">7.6.30. User marks false positives</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 76. https://localhost:8081/api/project/{projectId}/false-positives</caption> +<caption class="title">Table 78. https://localhost:8081/api/project/{projectId}/false-positives</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12515,7 +12730,7 @@ <h4 id="user-marks-false-positives">7.6.30. User marks false positives</h4> </div> </div> <div class="sect3"> -<h4 id="user-unmarks-existing-false-positive-definitons">7.6.31. User unmarks existing false positive definitons</h4> +<h4 id="user-unmarks-existing-false-positive-definitons">7.6.32. User unmarks existing false positive definitons</h4> <div id="section-ucrestdoc-uc-UC_045" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_045">UC_045-User unmarks existing false positive definitons </a></p> </div> @@ -12523,7 +12738,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">7.6.31. User unmarks ex <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 77. General request information</caption> +<caption class="title">Table 79. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12553,7 +12768,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">7.6.31. User unmarks ex <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 78. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}</caption> +<caption class="title">Table 80. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12611,7 +12826,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">7.6.31. User unmarks ex </div> </div> <div class="sect3"> -<h4 id="user-fetches-false-positive-configuration-of-project">7.6.32. User fetches false positive configuration of project</h4> +<h4 id="user-fetches-false-positive-configuration-of-project">7.6.33. User fetches false positive configuration of project</h4> <div id="section-ucrestdoc-uc-UC_046" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_046">UC_046-User fetches false positive configuration of project </a></p> </div> @@ -12619,7 +12834,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">7.6.32. User fetch <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 79. General request information</caption> +<caption class="title">Table 81. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12649,7 +12864,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">7.6.32. User fetch <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 80. https://localhost:8081/api/project/{projectId}/false-positives</caption> +<caption class="title">Table 82. https://localhost:8081/api/project/{projectId}/false-positives</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12872,7 +13087,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">7.6.32. User fetch </div> </div> <div class="sect3"> -<h4 id="user-uploads-binaries">7.6.33. User uploads binaries</h4> +<h4 id="user-uploads-binaries">7.6.34. User uploads binaries</h4> <div id="section-ucrestdoc-uc-UC_069" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_069">UC_069-User uploads binaries </a></p> </div> @@ -12880,7 +13095,7 @@ <h4 id="user-uploads-binaries">7.6.33. User uploads binaries</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 81. General request information</caption> +<caption class="title">Table 83. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12910,7 +13125,7 @@ <h4 id="user-uploads-binaries">7.6.33. User uploads binaries</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 82. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries</caption> +<caption class="title">Table 84. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12961,7 +13176,7 @@ <h4 id="user-uploads-binaries">7.6.33. User uploads binaries</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/b8b8b952-dadf-44b7-9480-c0276657f991/binaries' -i -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/0fd0197f-f865-4068-90ac-fb4a8db4aa30/binaries' -i -X POST \ -H 'Content-Type: multipart/form-data;charset=UTF-8' \ -H 'x-file-size: 10240' \ -F 'file=test1.txt 0000664 0001750 0001750 00000000000 13353454574 012170 0 ustar albert albert ' \ @@ -12974,7 +13189,7 @@ <h4 id="user-uploads-binaries">7.6.33. User uploads binaries</h4> </div> </div> <div class="sect3"> -<h4 id="user-downloads-job-report-in-spdx-format">7.6.34. User downloads job report in SPDX format</h4> +<h4 id="user-downloads-job-report-in-spdx-format">7.6.35. User downloads job report in SPDX format</h4> <div id="section-ucrestdoc-uc-UC_070" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_070">UC_070-User downloads job report in SPDX format </a></p> </div> @@ -12982,7 +13197,7 @@ <h4 id="user-downloads-job-report-in-spdx-format">7.6.34. User downloads job rep <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 83. General request information</caption> +<caption class="title">Table 85. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13012,7 +13227,7 @@ <h4 id="user-downloads-job-report-in-spdx-format">7.6.34. User downloads job rep <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 84. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}</caption> +<caption class="title">Table 86. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13042,14 +13257,14 @@ <h4 id="user-downloads-job-report-in-spdx-format">7.6.34. User downloads job rep </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/spdx/4f730441-ec48-4a4f-ad1d-e57932c4d802' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/spdx/4500d9f1-4df9-413b-bf2f-dd2bc8c9ee09' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/json'</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="user-unmarks-existing-false-positive-project-data-definitons">7.6.35. User unmarks existing false positive project data definitons</h4> +<h4 id="user-unmarks-existing-false-positive-project-data-definitons">7.6.36. User unmarks existing false positive project data definitons</h4> <div id="section-ucrestdoc-uc-UC_078" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_078">UC_078-User unmarks existing false positive project data definitons </a></p> </div> @@ -13057,7 +13272,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">7.6.35. Us <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 85. General request information</caption> +<caption class="title">Table 87. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13087,7 +13302,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">7.6.35. Us <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 86. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}</caption> +<caption class="title">Table 88. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13141,7 +13356,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">7.6.35. Us </div> </div> <div class="sect3"> -<h4 id="user-self-registration">7.6.36. User self registration</h4> +<h4 id="user-self-registration">7.6.37. User self registration</h4> <div id="section-ucrestdoc-uc-UC_001" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_001">UC_001-User self registration </a></p> </div> @@ -13149,7 +13364,7 @@ <h4 id="user-self-registration">7.6.36. User self registration</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 87. General request information</caption> +<caption class="title">Table 89. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13228,7 +13443,7 @@ <h4 id="user-self-registration">7.6.36. User self registration</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-open-user-signups">7.6.37. Admin lists open user signups</h4> +<h4 id="admin-lists-open-user-signups">7.6.38. Admin lists open user signups</h4> <div id="section-ucrestdoc-uc-UC_002" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_002">UC_002-Admin lists open user signups </a></p> </div> @@ -13236,7 +13451,7 @@ <h4 id="admin-lists-open-user-signups">7.6.37. Admin lists open user signups</h4 <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 88. General request information</caption> +<caption class="title">Table 90. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13332,7 +13547,7 @@ <h4 id="admin-lists-open-user-signups">7.6.37. Admin lists open user signups</h4 </div> </div> <div class="sect3"> -<h4 id="admin-applies-self-registration">7.6.38. Admin applies self registration</h4> +<h4 id="admin-applies-self-registration">7.6.39. Admin applies self registration</h4> <div id="section-ucrestdoc-uc-UC_003" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_003">UC_003-Admin applies self registration </a></p> </div> @@ -13340,7 +13555,7 @@ <h4 id="admin-applies-self-registration">7.6.38. Admin applies self registration <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 89. General request information</caption> +<caption class="title">Table 91. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13370,7 +13585,7 @@ <h4 id="admin-applies-self-registration">7.6.38. Admin applies self registration <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 90. https://localhost:8081/api/admin/signup/accept/{userId}</caption> +<caption class="title">Table 92. https://localhost:8081/api/admin/signup/accept/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13420,7 +13635,7 @@ <h4 id="admin-applies-self-registration">7.6.38. Admin applies self registration </div> </div> <div class="sect3"> -<h4 id="admin-deletes-user-signup">7.6.39. Admin deletes user signup</h4> +<h4 id="admin-deletes-user-signup">7.6.40. Admin deletes user signup</h4> <div id="section-ucrestdoc-uc-UC_019" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_019">UC_019-Admin deletes user signup </a></p> </div> @@ -13428,7 +13643,7 @@ <h4 id="admin-deletes-user-signup">7.6.39. Admin deletes user signup</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 91. General request information</caption> +<caption class="title">Table 93. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13458,7 +13673,7 @@ <h4 id="admin-deletes-user-signup">7.6.39. Admin deletes user signup</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 92. https://localhost:8081/api/admin/signup/{userId}</caption> +<caption class="title">Table 94. https://localhost:8081/api/admin/signup/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13508,7 +13723,7 @@ <h4 id="admin-deletes-user-signup">7.6.39. Admin deletes user signup</h4> </div> </div> <div class="sect3"> -<h4 id="user-requests-new-api-token">7.6.40. User requests new API token</h4> +<h4 id="user-requests-new-api-token">7.6.41. User requests new API token</h4> <div id="section-ucrestdoc-uc-UC_024" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_024">UC_024-User requests new API token </a></p> </div> @@ -13516,7 +13731,7 @@ <h4 id="user-requests-new-api-token">7.6.40. User requests new API token</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 93. General request information</caption> +<caption class="title">Table 95. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13546,7 +13761,7 @@ <h4 id="user-requests-new-api-token">7.6.40. User requests new API token</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 94. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}</caption> +<caption class="title">Table 96. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13582,7 +13797,7 @@ <h4 id="user-requests-new-api-token">7.6.40. User requests new API token</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-all-running-jobs">7.6.41. Admin lists all running jobs</h4> +<h4 id="admin-lists-all-running-jobs">7.6.42. Admin lists all running jobs</h4> <div id="section-ucrestdoc-uc-UC_023" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_023">UC_023-Admin lists all running jobs </a></p> </div> @@ -13590,7 +13805,7 @@ <h4 id="admin-lists-all-running-jobs">7.6.41. Admin lists all running jobs</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 95. General request information</caption> +<caption class="title">Table 97. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13692,12 +13907,12 @@ <h4 id="admin-lists-all-running-jobs">7.6.41. Admin lists all running jobs</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">aa8cee6d-756f-414d-8134-3159bdd75f44</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project-name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">owner-userid</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">RUNNING</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">since</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:27.703658282</span><span class="delimiter">"</span></span>}]</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a8503241-c02c-4722-afce-7a54eb0e7ea0</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project-name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">owner-userid</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">RUNNING</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">since</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:49.769371918</span><span class="delimiter">"</span></span>}]</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-cancels-a-job">7.6.42. Admin cancels a job</h4> +<h4 id="admin-cancels-a-job">7.6.43. Admin cancels a job</h4> <div id="section-ucrestdoc-uc-UC_034" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_034">UC_034-Admin cancels a job </a></p> </div> @@ -13705,7 +13920,7 @@ <h4 id="admin-cancels-a-job">7.6.42. Admin cancels a job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 96. General request information</caption> +<caption class="title">Table 98. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13735,7 +13950,7 @@ <h4 id="admin-cancels-a-job">7.6.42. Admin cancels a job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 97. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}</caption> +<caption class="title">Table 99. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13776,7 +13991,7 @@ <h4 id="admin-cancels-a-job">7.6.42. Admin cancels a job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/cancel/92f9bfd4-051b-455b-b7b8-ffc1f6db45f6' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/cancel/e520e1f5-60b5-45d0-abeb-d9267c54474b' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -13786,7 +14001,7 @@ <h4 id="admin-cancels-a-job">7.6.42. Admin cancels a job</h4> </div> </div> <div class="sect3"> -<h4 id="admin-restarts-a-job">7.6.43. Admin restarts a job</h4> +<h4 id="admin-restarts-a-job">7.6.44. Admin restarts a job</h4> <div id="section-ucrestdoc-uc-UC_041" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_041">UC_041-Admin restarts a job </a></p> </div> @@ -13794,7 +14009,7 @@ <h4 id="admin-restarts-a-job">7.6.43. Admin restarts a job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 98. General request information</caption> +<caption class="title">Table 100. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13824,7 +14039,7 @@ <h4 id="admin-restarts-a-job">7.6.43. Admin restarts a job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 99. https://localhost:8081/api/admin/jobs/restart/{jobUUID}</caption> +<caption class="title">Table 101. https://localhost:8081/api/admin/jobs/restart/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13865,7 +14080,7 @@ <h4 id="admin-restarts-a-job">7.6.43. Admin restarts a job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart/be57747a-0731-4a35-ab3a-722e4f454077' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart/3c1f4235-016f-4246-bcfd-21531b315fe6' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -13875,7 +14090,7 @@ <h4 id="admin-restarts-a-job">7.6.43. Admin restarts a job</h4> </div> </div> <div class="sect3"> -<h4 id="admin-restarts-a-job-hard">7.6.44. Admin restarts a job (hard)</h4> +<h4 id="admin-restarts-a-job-hard">7.6.45. Admin restarts a job (hard)</h4> <div id="section-ucrestdoc-uc-UC_042" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_042">UC_042-Admin restarts a job (hard) </a></p> </div> @@ -13883,7 +14098,7 @@ <h4 id="admin-restarts-a-job-hard">7.6.44. Admin restarts a job (hard)</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 100. General request information</caption> +<caption class="title">Table 102. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -13913,7 +14128,7 @@ <h4 id="admin-restarts-a-job-hard">7.6.44. Admin restarts a job (hard)</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 101. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}</caption> +<caption class="title">Table 103. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -13954,7 +14169,7 @@ <h4 id="admin-restarts-a-job-hard">7.6.44. Admin restarts a job (hard)</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/c9aea17c-1fe0-4c11-b1c5-fe21aa3ec9bb' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/e2e059a8-c340-4c1d-b68e-921fc0bd5c9c' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -13964,7 +14179,7 @@ <h4 id="admin-restarts-a-job-hard">7.6.44. Admin restarts a job (hard)</h4> </div> </div> <div class="sect3"> -<h4 id="user-defines-mock-data-configuration-for-project">7.6.45. User defines mock data configuration for project</h4> +<h4 id="user-defines-mock-data-configuration-for-project">7.6.46. User defines mock data configuration for project</h4> <div id="section-ucrestdoc-uc-UC_035" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_035">UC_035-User defines mock data configuration for project </a></p> </div> @@ -13972,7 +14187,7 @@ <h4 id="user-defines-mock-data-configuration-for-project">7.6.45. User defines m <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 102. General request information</caption> +<caption class="title">Table 104. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14033,7 +14248,7 @@ <h4 id="user-defines-mock-data-configuration-for-project">7.6.45. User defines m </div> </div> <div class="sect3"> -<h4 id="user-retrieves-mock-data-configuration-for-project">7.6.46. User retrieves mock data configuration for project</h4> +<h4 id="user-retrieves-mock-data-configuration-for-project">7.6.47. User retrieves mock data configuration for project</h4> <div id="section-ucrestdoc-uc-UC_036" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_036">UC_036-User retrieves mock data configuration for project </a></p> </div> @@ -14041,7 +14256,7 @@ <h4 id="user-retrieves-mock-data-configuration-for-project">7.6.46. User retriev <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 103. General request information</caption> +<caption class="title">Table 105. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14105,7 +14320,7 @@ <h4 id="user-retrieves-mock-data-configuration-for-project">7.6.46. User retriev </div> </div> <div class="sect3"> -<h4 id="admin-updates-mapping-configuration">7.6.47. Admin updates mapping configuration</h4> +<h4 id="admin-updates-mapping-configuration">7.6.48. Admin updates mapping configuration</h4> <div id="section-ucrestdoc-uc-UC_037" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_037">UC_037-Admin updates mapping configuration </a></p> </div> @@ -14113,7 +14328,7 @@ <h4 id="admin-updates-mapping-configuration">7.6.47. Admin updates mapping confi <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 104. General request information</caption> +<caption class="title">Table 106. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14143,7 +14358,7 @@ <h4 id="admin-updates-mapping-configuration">7.6.47. Admin updates mapping confi <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 105. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> +<caption class="title">Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -14229,7 +14444,7 @@ <h4 id="admin-updates-mapping-configuration">7.6.47. Admin updates mapping confi </div> </div> <div class="sect3"> -<h4 id="admin-fetches-mapping-configuration">7.6.48. Admin fetches mapping configuration</h4> +<h4 id="admin-fetches-mapping-configuration">7.6.49. Admin fetches mapping configuration</h4> <div id="section-ucrestdoc-uc-UC_038" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_038">UC_038-Admin fetches mapping configuration </a></p> </div> @@ -14237,7 +14452,7 @@ <h4 id="admin-fetches-mapping-configuration">7.6.48. Admin fetches mapping confi <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 106. General request information</caption> +<caption class="title">Table 108. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14267,7 +14482,7 @@ <h4 id="admin-fetches-mapping-configuration">7.6.48. Admin fetches mapping confi <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> +<caption class="title">Table 109. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -14356,7 +14571,7 @@ <h4 id="admin-fetches-mapping-configuration">7.6.48. Admin fetches mapping confi </div> </div> <div class="sect3"> -<h4 id="admin-creates-an-executor-configuration">7.6.49. Admin creates an executor configuration</h4> +<h4 id="admin-creates-an-executor-configuration">7.6.50. Admin creates an executor configuration</h4> <div id="section-ucrestdoc-uc-UC_047" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_047">UC_047-Admin creates an executor configuration </a></p> </div> @@ -14364,7 +14579,7 @@ <h4 id="admin-creates-an-executor-configuration">7.6.49. Admin creates an execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 108. General request information</caption> +<caption class="title">Table 110. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14487,12 +14702,12 @@ <h4 id="admin-creates-an-executor-configuration">7.6.49. Admin creates an execut </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="plain">85aa1ed2-4c62-41e0-90b8-5aaccda85f11</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="plain">b922b3e7-3416-4d74-8b1a-81fbe61a3f63</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-deletes-executor-configuration">7.6.50. Admin deletes executor configuration</h4> +<h4 id="admin-deletes-executor-configuration">7.6.51. Admin deletes executor configuration</h4> <div id="section-ucrestdoc-uc-UC_048" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_048">UC_048-Admin deletes executor configuration </a></p> </div> @@ -14500,7 +14715,7 @@ <h4 id="admin-deletes-executor-configuration">7.6.50. Admin deletes executor con <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 109. General request information</caption> +<caption class="title">Table 111. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14530,7 +14745,7 @@ <h4 id="admin-deletes-executor-configuration">7.6.50. Admin deletes executor con <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 110. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 112. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -14571,7 +14786,7 @@ <h4 id="admin-deletes-executor-configuration">7.6.50. Admin deletes executor con </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/01252350-78be-4eed-8103-d4c8dadcb1d5' -i -u 'user:secret' -X DELETE \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/4cfe54a8-c2ce-4bef-b96b-a047a5c4c38f' -i -u 'user:secret' -X DELETE \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -14581,7 +14796,7 @@ <h4 id="admin-deletes-executor-configuration">7.6.50. Admin deletes executor con </div> </div> <div class="sect3"> -<h4 id="admin-fetches-executor-configuration-list">7.6.51. Admin fetches executor configuration list</h4> +<h4 id="admin-fetches-executor-configuration-list">7.6.52. Admin fetches executor configuration list</h4> <div id="section-ucrestdoc-uc-UC_049" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_049">UC_049-Admin fetches executor configuration list </a></p> </div> @@ -14589,7 +14804,7 @@ <h4 id="admin-fetches-executor-configuration-list">7.6.51. Admin fetches executo <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 111. General request information</caption> +<caption class="title">Table 113. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14686,12 +14901,12 @@ <h4 id="admin-fetches-executor-configuration-list">7.6.51. Admin fetches executo </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">executorConfigurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">decbe618-fb22-42fd-ad28-9a98d629f981</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example configuration</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>}],<span class="key"><span class="delimiter">"</span><span class="content">type</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">executorConfigurationList</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">executorConfigurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">fd85ad57-94c1-4671-a1ea-100fcb679201</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example configuration</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>}],<span class="key"><span class="delimiter">"</span><span class="content">type</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">executorConfigurationList</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-fetches-executor-configuration">7.6.52. Admin fetches executor configuration</h4> +<h4 id="admin-fetches-executor-configuration">7.6.53. Admin fetches executor configuration</h4> <div id="section-ucrestdoc-uc-UC_050" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_050">UC_050-Admin fetches executor configuration </a></p> </div> @@ -14699,7 +14914,7 @@ <h4 id="admin-fetches-executor-configuration">7.6.52. Admin fetches executor con <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 112. General request information</caption> +<caption class="title">Table 114. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14729,7 +14944,7 @@ <h4 id="admin-fetches-executor-configuration">7.6.52. Admin fetches executor con <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 113. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 115. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -14839,7 +15054,7 @@ <h4 id="admin-fetches-executor-configuration">7.6.52. Admin fetches executor con </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/d3da4fff-26ac-424d-a207-4653dbff9ca8' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/cf306d66-846b-4bc2-a66e-5b60055aaa70' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -14848,12 +15063,12 @@ <h4 id="admin-fetches-executor-configuration">7.6.52. Admin fetches executor con </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d3da4fff-26ac-424d-a207-4653dbff9ca8</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">cf306d66-846b-4bc2-a66e-5b60055aaa70</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-updates-executor-configuration-setup">7.6.53. Admin updates executor configuration setup</h4> +<h4 id="admin-updates-executor-configuration-setup">7.6.54. Admin updates executor configuration setup</h4> <div id="section-ucrestdoc-uc-UC_051" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_051">UC_051-Admin updates executor configuration setup </a></p> </div> @@ -14861,7 +15076,7 @@ <h4 id="admin-updates-executor-configuration-setup">7.6.53. Admin updates execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 114. General request information</caption> +<caption class="title">Table 116. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -14891,7 +15106,7 @@ <h4 id="admin-updates-executor-configuration-setup">7.6.53. Admin updates execut <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 115. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 117. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -14996,7 +15211,7 @@ <h4 id="admin-updates-executor-configuration-setup">7.6.53. Admin updates execut </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/150289d5-3831-4eac-80ed-337c2ff30949' -i -u 'user:secret' -X PUT \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/35803fed-b7b0-4bd8-9387-4773ab128a43' -i -u 'user:secret' -X PUT \ -H 'Content-Type: application/json;charset=UTF-8' \ -d '{"name":"New name","productIdentifier":"PDS_CODESCAN","executorVersion":1,"enabled":false,"setup":{"baseURL":"https://productNew.example.com","credentials":{"user":"env:EXAMPLE_NEW_USENAME","password":"env:EXAMPLE_NEW_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]}}'</code></pre> </div> @@ -15007,7 +15222,7 @@ <h4 id="admin-updates-executor-configuration-setup">7.6.53. Admin updates execut </div> </div> <div class="sect3"> -<h4 id="admin-creates-an-execution-profile">7.6.54. Admin creates an execution profile</h4> +<h4 id="admin-creates-an-execution-profile">7.6.55. Admin creates an execution profile</h4> <div id="section-ucrestdoc-uc-UC_052" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_052">UC_052-Admin creates an execution profile </a></p> </div> @@ -15015,7 +15230,7 @@ <h4 id="admin-creates-an-execution-profile">7.6.54. Admin creates an execution p <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 116. General request information</caption> +<caption class="title">Table 118. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15045,7 +15260,7 @@ <h4 id="admin-creates-an-execution-profile">7.6.54. Admin creates an execution p <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 117. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -15136,7 +15351,7 @@ <h4 id="admin-creates-an-execution-profile">7.6.54. Admin creates an execution p </div> </div> <div class="sect3"> -<h4 id="admin-deletes-execution-profile">7.6.55. Admin deletes execution profile</h4> +<h4 id="admin-deletes-execution-profile">7.6.56. Admin deletes execution profile</h4> <div id="section-ucrestdoc-uc-UC_053" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_053">UC_053-Admin deletes execution profile </a></p> </div> @@ -15144,7 +15359,7 @@ <h4 id="admin-deletes-execution-profile">7.6.55. Admin deletes execution profile <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 118. General request information</caption> +<caption class="title">Table 120. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15174,7 +15389,7 @@ <h4 id="admin-deletes-execution-profile">7.6.55. Admin deletes execution profile <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -15225,7 +15440,7 @@ <h4 id="admin-deletes-execution-profile">7.6.55. Admin deletes execution profile </div> </div> <div class="sect3"> -<h4 id="admin-updates-execution-profile">7.6.56. Admin updates execution profile</h4> +<h4 id="admin-updates-execution-profile">7.6.57. Admin updates execution profile</h4> <div id="section-ucrestdoc-uc-UC_054" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_054">UC_054-Admin updates execution profile </a></p> </div> @@ -15233,7 +15448,7 @@ <h4 id="admin-updates-execution-profile">7.6.56. Admin updates execution profile <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 120. General request information</caption> +<caption class="title">Table 122. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15263,7 +15478,7 @@ <h4 id="admin-updates-execution-profile">7.6.56. Admin updates execution profile <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -15340,7 +15555,7 @@ <h4 id="admin-updates-execution-profile">7.6.56. Admin updates execution profile <div class="content"> <pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/execution/profile/existing-profile-1' -i -u 'user:secret' -X PUT \ -H 'Content-Type: application/json;charset=UTF-8' \ - -d '{"description":"changed description","configurations":[{"uuid":"c0948480-f711-4330-93c3-8167dc71b564","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'</code></pre> + -d '{"description":"changed description","configurations":[{"uuid":"5a8e548a-169d-4642-8d2d-00bed1357847","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'</code></pre> </div> </div> <div class="paragraph"> @@ -15349,7 +15564,7 @@ <h4 id="admin-updates-execution-profile">7.6.56. Admin updates execution profile </div> </div> <div class="sect3"> -<h4 id="admin-fetches-execution-profile">7.6.57. Admin fetches execution profile</h4> +<h4 id="admin-fetches-execution-profile">7.6.58. Admin fetches execution profile</h4> <div id="section-ucrestdoc-uc-UC_055" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_055">UC_055-Admin fetches execution profile </a></p> </div> @@ -15357,7 +15572,7 @@ <h4 id="admin-fetches-execution-profile">7.6.57. Admin fetches execution profile <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 122. General request information</caption> +<caption class="title">Table 124. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15387,7 +15602,7 @@ <h4 id="admin-fetches-execution-profile">7.6.57. Admin fetches execution profile <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 125. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -15496,12 +15711,12 @@ <h4 id="admin-fetches-execution-profile">7.6.57. Admin fetches execution profile </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a description</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>,<span class="key"><span class="delimiter">"</span><span class="content">configurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">f8dd3854-ae30-450a-828a-1b715bcd57d3</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value but changed. Remark: the other parameter (example.key2) has been removed by this call</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}],<span class="key"><span class="delimiter">"</span><span class="content">projectIds</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">project-1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">project-2</span><span class="delimiter">"</span></span>]}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a description</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>,<span class="key"><span class="delimiter">"</span><span class="content">configurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">006a3f33-85f6-4586-a509-5ef17c40004b</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value but changed. Remark: the other parameter (example.key2) has been removed by this call</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}],<span class="key"><span class="delimiter">"</span><span class="content">projectIds</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">project-1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">project-2</span><span class="delimiter">"</span></span>]}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-fetches-execution-profile-list">7.6.58. Admin fetches execution profile list</h4> +<h4 id="admin-fetches-execution-profile-list">7.6.59. Admin fetches execution profile list</h4> <div id="section-ucrestdoc-uc-UC_056" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_056">UC_056-Admin fetches execution profile list </a></p> </div> @@ -15509,7 +15724,7 @@ <h4 id="admin-fetches-execution-profile-list">7.6.58. Admin fetches execution pr <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 124. General request information</caption> +<caption class="title">Table 126. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15611,7 +15826,7 @@ <h4 id="admin-fetches-execution-profile-list">7.6.58. Admin fetches execution pr </div> </div> <div class="sect3"> -<h4 id="admin-assigns-execution-profile-to-project">7.6.59. Admin assigns execution profile to project</h4> +<h4 id="admin-assigns-execution-profile-to-project">7.6.60. Admin assigns execution profile to project</h4> <div id="section-ucrestdoc-uc-UC_057" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_057">UC_057-Admin assigns execution profile to project </a></p> </div> @@ -15619,7 +15834,7 @@ <h4 id="admin-assigns-execution-profile-to-project">7.6.59. Admin assigns execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 125. General request information</caption> +<caption class="title">Table 127. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15649,7 +15864,7 @@ <h4 id="admin-assigns-execution-profile-to-project">7.6.59. Admin assigns execut <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 126. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> +<caption class="title">Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -15704,7 +15919,7 @@ <h4 id="admin-assigns-execution-profile-to-project">7.6.59. Admin assigns execut </div> </div> <div class="sect3"> -<h4 id="admin-unassigns-execution-profile-from-project">7.6.60. Admin unassigns execution profile from project</h4> +<h4 id="admin-unassigns-execution-profile-from-project">7.6.61. Admin unassigns execution profile from project</h4> <div id="section-ucrestdoc-uc-UC_058" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_058">UC_058-Admin unassigns execution profile from project </a></p> </div> @@ -15712,7 +15927,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">7.6.60. Admin unassigns <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 127. General request information</caption> +<caption class="title">Table 129. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15742,7 +15957,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">7.6.60. Admin unassigns <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> +<caption class="title">Table 130. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -15797,7 +16012,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">7.6.60. Admin unassigns </div> </div> <div class="sect3"> -<h4 id="admin-fetches-auto-cleanup-configuration">7.6.61. Admin fetches auto cleanup configuration</h4> +<h4 id="admin-fetches-auto-cleanup-configuration">7.6.62. Admin fetches auto cleanup configuration</h4> <div id="section-ucrestdoc-uc-UC_064" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_064">UC_064-Admin fetches auto cleanup configuration </a></p> </div> @@ -15805,7 +16020,7 @@ <h4 id="admin-fetches-auto-cleanup-configuration">7.6.61. Admin fetches auto cle <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 129. General request information</caption> +<caption class="title">Table 131. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15868,7 +16083,7 @@ <h4 id="admin-fetches-auto-cleanup-configuration">7.6.61. Admin fetches auto cle </div> </div> <div class="sect3"> -<h4 id="admin-updates-auto-cleanup-configuration">7.6.62. Admin updates auto cleanup configuration</h4> +<h4 id="admin-updates-auto-cleanup-configuration">7.6.63. Admin updates auto cleanup configuration</h4> <div id="section-ucrestdoc-uc-UC_065" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_065">UC_065-Admin updates auto cleanup configuration </a></p> </div> @@ -15876,7 +16091,7 @@ <h4 id="admin-updates-auto-cleanup-configuration">7.6.62. Admin updates auto cle <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 130. General request information</caption> +<caption class="title">Table 132. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -15936,7 +16151,7 @@ <h4 id="admin-updates-auto-cleanup-configuration">7.6.62. Admin updates auto cle </div> </div> <div class="sect3"> -<h4 id="admin-starts-encryption-rotation">7.6.63. Admin starts encryption rotation</h4> +<h4 id="admin-starts-encryption-rotation">7.6.64. Admin starts encryption rotation</h4> <div id="section-ucrestdoc-uc-UC_073" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_073">UC_073-Admin starts encryption rotation </a></p> </div> @@ -15944,7 +16159,7 @@ <h4 id="admin-starts-encryption-rotation">7.6.63. Admin starts encryption rotati <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 131. General request information</caption> +<caption class="title">Table 133. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16008,7 +16223,7 @@ <h4 id="admin-starts-encryption-rotation">7.6.63. Admin starts encryption rotati </div> </div> <div class="sect3"> -<h4 id="admin-fetches-encryption-status">7.6.64. Admin fetches encryption status</h4> +<h4 id="admin-fetches-encryption-status">7.6.65. Admin fetches encryption status</h4> <div id="section-ucrestdoc-uc-UC_076" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_076">UC_076-Admin fetches encryption status </a></p> </div> @@ -16016,7 +16231,7 @@ <h4 id="admin-fetches-encryption-status">7.6.64. Admin fetches encryption status <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 132. General request information</caption> +<caption class="title">Table 134. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16148,7 +16363,7 @@ <h4 id="admin-fetches-encryption-status">7.6.64. Admin fetches encryption status </div> </div> <div class="sect3"> -<h4 id="admin-disables-job-processing-in-scheduler">7.6.65. Admin disables job processing in scheduler</h4> +<h4 id="admin-disables-job-processing-in-scheduler">7.6.66. Admin disables job processing in scheduler</h4> <div id="section-ucrestdoc-uc-UC_030" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_030">UC_030-Admin disables job processing in scheduler </a></p> </div> @@ -16156,7 +16371,7 @@ <h4 id="admin-disables-job-processing-in-scheduler">7.6.65. Admin disables job p <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 133. General request information</caption> +<caption class="title">Table 135. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16215,7 +16430,7 @@ <h4 id="admin-disables-job-processing-in-scheduler">7.6.65. Admin disables job p </div> </div> <div class="sect3"> -<h4 id="admin-enables-scheduler-job-processing">7.6.66. Admin enables scheduler job processing</h4> +<h4 id="admin-enables-scheduler-job-processing">7.6.67. Admin enables scheduler job processing</h4> <div id="section-ucrestdoc-uc-UC_031" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_031">UC_031-Admin enables scheduler job processing </a></p> </div> @@ -16223,7 +16438,7 @@ <h4 id="admin-enables-scheduler-job-processing">7.6.66. Admin enables scheduler <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 134. General request information</caption> +<caption class="title">Table 136. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16282,7 +16497,7 @@ <h4 id="admin-enables-scheduler-job-processing">7.6.66. Admin enables scheduler </div> </div> <div class="sect3"> -<h4 id="admin-get-scheduler-status">7.6.67. Admin get scheduler status</h4> +<h4 id="admin-get-scheduler-status">7.6.68. Admin get scheduler status</h4> <div id="section-ucrestdoc-uc-UC_032" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_032">UC_032-Admin get scheduler status </a></p> </div> @@ -16290,7 +16505,7 @@ <h4 id="admin-get-scheduler-status">7.6.67. Admin get scheduler status</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 135. General request information</caption> +<caption class="title">Table 137. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16349,7 +16564,7 @@ <h4 id="admin-get-scheduler-status">7.6.67. Admin get scheduler status</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-status-information">7.6.68. Admin lists status information</h4> +<h4 id="admin-lists-status-information">7.6.69. Admin lists status information</h4> <div id="section-ucrestdoc-uc-UC_033" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_033">UC_033-Admin lists status information </a></p> </div> @@ -16357,7 +16572,7 @@ <h4 id="admin-lists-status-information">7.6.68. Admin lists status information</ <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 136. General request information</caption> +<caption class="title">Table 138. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16449,7 +16664,7 @@ <h4 id="admin-lists-status-information">7.6.68. Admin lists status information</ </div> </div> <div class="sect3"> -<h4 id="admin-fetches-server-runtime-data">7.6.69. Admin fetches server runtime data</h4> +<h4 id="admin-fetches-server-runtime-data">7.6.70. Admin fetches server runtime data</h4> <div id="section-ucrestdoc-uc-UC_040" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_040">UC_040-Admin fetches server runtime data </a></p> </div> @@ -16457,7 +16672,7 @@ <h4 id="admin-fetches-server-runtime-data">7.6.69. Admin fetches server runtime <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 137. General request information</caption> +<caption class="title">Table 139. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16529,7 +16744,7 @@ <h4 id="admin-fetches-server-runtime-data">7.6.69. Admin fetches server runtime </div> </div> <div class="sect3"> -<h4 id="user-lists-jobs-for-project">7.6.70. User lists jobs for project</h4> +<h4 id="user-lists-jobs-for-project">7.6.71. User lists jobs for project</h4> <div id="section-ucrestdoc-uc-UC_071" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_071">UC_071-User lists jobs for project </a></p> </div> @@ -16537,7 +16752,7 @@ <h4 id="user-lists-jobs-for-project">7.6.70. User lists jobs for project</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 138. General request information</caption> +<caption class="title">Table 140. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16567,7 +16782,7 @@ <h4 id="user-lists-jobs-for-project">7.6.70. User lists jobs for project</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 139. https://localhost:8081/api/project/{projectId}/jobs</caption> +<caption class="title">Table 141. https://localhost:8081/api/project/{projectId}/jobs</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -16586,6 +16801,41 @@ <h4 id="user-lists-jobs-for-project">7.6.70. User lists jobs for project</h4> </tbody> </table> <div class="paragraph"> +<p><strong>Query parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The wanted (maximum) size for the result set. When not defined, the default will be 1.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>page</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The wanted page number. When not defined, the default will be 0.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.labels.*</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An optional dynamic query parameter to filter jobs by labels. The syntax is 'metadata.labels.${labelKey}=${labelValue}'.</p> +<p class="tableblock">It is possible to query for multiple labels (up to 10 ). +The filter works as an AND combination: Only jobs having all wanted label key value combinations are returned.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>withMetaData</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An optional parameter to define if meta data shall be fetched as well. When not defined, the default will be false.</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> <p><strong>Request headers</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> @@ -16691,7 +16941,7 @@ <h4 id="user-lists-jobs-for-project">7.6.70. User lists jobs for project</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">page</span><span class="delimiter">"</span></span>:<span class="integer">0</span>,<span class="key"><span class="delimiter">"</span><span class="content">totalPages</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">4fc54538-9eab-4eb5-9da4-9d1cc0897760</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">User1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:42:22.956477277</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:44:22.956508736</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:22.956525658</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionState</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionResult</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">metaData</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">labels</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">stage</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}}}]}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">page</span><span class="delimiter">"</span></span>:<span class="integer">0</span>,<span class="key"><span class="delimiter">"</span><span class="content">totalPages</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">8d080df1-24cd-470f-b8bd-845baf4b7d60</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">User1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:31:45.196835109</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:33:45.196866799</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:45.19687809</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionState</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionResult</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">metaData</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">labels</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">stage</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}}}]}</code></pre> </div> </div> </div> @@ -18220,7 +18470,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> <p>The next text blocks describe the keys available on SecHub:</p> </div> <table id="section-gen-configuration-scope-administration" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 140. Scope 'administration'</caption> +<caption class="title">Table 142. Scope 'administration'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18248,7 +18498,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-anonymous" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 141. Scope 'anonymous'</caption> +<caption class="title">Table 143. Scope 'anonymous'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18270,7 +18520,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-checkmarx" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 142. Scope 'checkmarx'</caption> +<caption class="title">Table 144. Scope 'checkmarx'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18302,7 +18552,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-initial" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 143. Scope 'initial'</caption> +<caption class="title">Table 145. Scope 'initial'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18334,7 +18584,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-migration" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 144. Scope 'migration'</caption> +<caption class="title">Table 146. Scope 'migration'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18356,7 +18606,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-mock" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 145. Scope 'mock'</caption> +<caption class="title">Table 147. Scope 'mock'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18378,7 +18628,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-nessus" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 146. Scope 'nessus'</caption> +<caption class="title">Table 148. Scope 'nessus'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18455,7 +18705,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-netsparker" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 147. Scope 'netsparker'</caption> +<caption class="title">Table 149. Scope 'netsparker'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18527,7 +18777,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-new" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 148. Scope 'new'</caption> +<caption class="title">Table 150. Scope 'new'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18549,7 +18799,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-notification" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 149. Scope 'notification'</caption> +<caption class="title">Table 151. Scope 'notification'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18580,8 +18830,8 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tr> </tbody> </table> -<table id="section-gen-configuration-scope-p" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 150. Scope 'p'</caption> +<table id="section-gen-configuration-scope-pdsinstall" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 152. Scope 'pdsinstall'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18596,26 +18846,6 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 400 bad request happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 400 bad request happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 500 server internal error happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 500 server internal error happened on Checkmarx server</p></td> -</tr> -<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.default.check.timetowait.milliseconds</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Time in milliseconds when adapter check operation is called next. When -1 value is 60000 minutes</p></td> @@ -18625,20 +18855,10 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> <td class="tableblock halign-left valign-top"><p class="tableblock">240</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Time in minutes when adapter result check will automatically time out and adapter stops execution automatically. When -1 timeout is 7200 minutes</p></td> </tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a PDS encryption out of sync problem happens</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a PDS encryption out of sync problem happens</p></td> -</tr> </tbody> </table> -<table id="section-gen-configuration-scope-s" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 151. Scope 's'</caption> +<table id="section-gen-configuration-scope-pdsresilience" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 153. Scope 'pdsresilience'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18653,34 +18873,39 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.config</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">mail.smtp.auth=false,mail.transport.protocol=smtp</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: <code>mail.smtp.auth=false,mail.smtp.timeout=4000</code>. See <a href="https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html" class="bare">https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html</a> for configuration mapping</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 400 bad request happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.password</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Password on SMPTP server, empty value means no password</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 400 bad request happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.username</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Username on SMPTP server, empty value means no username</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 500 server internal error happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.hostname</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname of SMPTP server</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 500 server internal error happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.port</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Port of SMPTP server, per default:25</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a PDS encryption out of sync problem happens</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a PDS encryption out of sync problem happens</p></td> </tr> </tbody> </table> <table id="section-gen-configuration-scope-scan" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 152. Scope 'scan'</caption> +<caption class="title">Table 154. Scope 'scan'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18717,7 +18942,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-schedule" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 153. Scope 'schedule'</caption> +<caption class="title">Table 155. Scope 'schedule'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18745,7 +18970,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-scheduler" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 154. Scope 'scheduler'</caption> +<caption class="title">Table 156. Scope 'scheduler'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18807,7 +19032,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-sec" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 155. Scope 'sec'</caption> +<caption class="title">Table 157. Scope 'sec'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18874,7 +19099,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-security" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 156. Scope 'security'</caption> +<caption class="title">Table 158. Scope 'security'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18896,7 +19121,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-server" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 157. Scope 'server'</caption> +<caption class="title">Table 159. Scope 'server'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -18917,8 +19142,50 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tr> </tbody> </table> +<table id="section-gen-configuration-scope-smtpserver" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 160. Scope 'smtpserver'</caption> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Key or variable name</th> +<th class="tableblock halign-left valign-top">Default</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.config</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">mail.smtp.auth=false,mail.transport.protocol=smtp</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: <code>mail.smtp.auth=false,mail.smtp.timeout=4000</code>. See <a href="https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html" class="bare">https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html</a> for configuration mapping</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.password</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Password on SMPTP server, empty value means no password</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.username</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Username on SMPTP server, empty value means no username</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.hostname</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname of SMPTP server</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.port</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Port of SMPTP server, per default:25</p></td> +</tr> +</tbody> +</table> <table id="section-gen-configuration-scope-storage" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 158. Scope 'storage'</caption> +<caption class="title">Table 161. Scope 'storage'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -19005,7 +19272,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-system" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 159. Scope 'system'</caption> +<caption class="title">Table 162. Scope 'system'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -19037,7 +19304,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-target" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 160. Scope 'target'</caption> +<caption class="title">Table 163. Scope 'target'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -19069,7 +19336,7 @@ <h4 id="section-general-configuration">8.2.3. General configuration</h4> <div class="sect3"> <h4 id="scheduling-definitions">8.2.4. Scheduling definitions</h4> <table id="link-gen-scheduling" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 161. Scope 'administration'</caption> +<caption class="title">Table 164. Scope 'administration'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -19091,7 +19358,7 @@ <h4 id="scheduling-definitions">8.2.4. Scheduling definitions</h4> </tbody> </table> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 162. Scope 'scan'</caption> +<caption class="title">Table 165. Scope 'scan'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -19113,7 +19380,7 @@ <h4 id="scheduling-definitions">8.2.4. Scheduling definitions</h4> </tbody> </table> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 163. Scope 'schedule'</caption> +<caption class="title">Table 166. Scope 'schedule'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -19148,7 +19415,7 @@ <h4 id="scheduling-definitions">8.2.4. Scheduling definitions</h4> <div class="sect3"> <h4 id="sechub-mock-options">8.2.5. Configuration properties for mocked adapters</h4> <table id="section-gen-configuration-scope-abstract" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 164. Scope 'abstract'</caption> +<caption class="title">Table 167. Scope 'abstract'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -19170,7 +19437,7 @@ <h4 id="sechub-mock-options">8.2.5. Configuration properties for mocked adapters </tbody> </table> <table id="section-gen-configuration-scope-mocked" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 165. Scope 'mocked'</caption> +<caption class="title">Table 168. Scope 'mocked'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -21821,7 +22088,7 @@ <h2 id="section-glossary">13. Glossary</h2> </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-client.html b/docs/latest/sechub-client.html index 1567d0606d..1a348e80d5 100644 --- a/docs/latest/sechub-client.html +++ b/docs/latest/sechub-client.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub Client Documentation</h1> <div class="details"> -<span id="revnumber"> Client 1.8.1 modified (commit c39468e)</span> +<span id="revnumber"> Client 1.9.0</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -773,7 +773,7 @@ <h2 id="about">1. About</h2> </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Client 1.8.1 modified (commit c39468e) - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Client 1.9.0 - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <hr> <div style="page-break-after: always;"></div> @@ -1137,7 +1137,11 @@ <h5 id="getstatus">2.4.3.3. getStatus</h5> <div class="sect4"> <h5 id="getreport">2.4.3.4. getReport</h5> <div class="paragraph"> -<p>Will fetch the report as json. (result will only exist when job is done)</p> +<p>Download the SecHub report. (A result will only exist when the SecHub job has finished)</p> +</div> +<div class="paragraph"> +<p>You can choose the format with <code>-reportformat <format></code>. Default is <code>json</code>.<br> +Currently supported: <code>json</code>, <code>html</code>, <code>spdx-json</code>(only for license scans). If an unsupported format is provided then <code>json</code> will always be the fallback.</p> </div> <div class="paragraph"> <p><strong>Minimum call syntax</strong></p> @@ -4507,7 +4511,7 @@ <h5 id="example-code-scan-report-with-yellow-traffic-light">3.1.2.1. Example cod </div> <div id="footer"> <div id="footer-text"> - Client 1.8.1 modified (commit c39468e)<br> + Client 1.9.0<br> </div> </div> </body> diff --git a/docs/latest/sechub-developer-quickstart-guide.html b/docs/latest/sechub-developer-quickstart-guide.html index 43a0c72612..3df11e2197 100644 --- a/docs/latest/sechub-developer-quickstart-guide.html +++ b/docs/latest/sechub-developer-quickstart-guide.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub Developer Quickstart Guide</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -695,7 +695,7 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> </div> </div> @@ -2153,7 +2153,7 @@ <h5 id="run-a-sechub-pds-integration-test-2">5.2.2.3. Run a SecHub + PDS integra </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-getting-started.html b/docs/latest/sechub-getting-started.html index a9cf341afd..768f31c4cc 100644 --- a/docs/latest/sechub-getting-started.html +++ b/docs/latest/sechub-getting-started.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><img src="images/sechub-logo.png" alt="sechub"></span> SecHub Getting Started Guide</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -640,7 +640,7 @@ <h1><span class="image"><img src="images/sechub-logo.png" alt="sechub"></span> S </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> </div> </div> @@ -991,7 +991,7 @@ <h3 id="install-sechubs-vscodium-plugin-optional">5.1. Install SecHub’s VS </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-operations.html b/docs/latest/sechub-operations.html index ec7366d5bf..bddf67e90c 100644 --- a/docs/latest/sechub-operations.html +++ b/docs/latest/sechub-operations.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub Operations</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -791,7 +791,7 @@ <h2 id="about">1. About</h2> </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <div class="paragraph"> <p>Target audience for this document are <strong>SecHub Operators/Administrators</strong>.</p> @@ -1233,8 +1233,8 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> </tr> </tbody> </table> -<table id="section-gen-configuration-scope-p" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 11. Scope 'p'</caption> +<table id="section-gen-configuration-scope-pdsinstall" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 11. Scope 'pdsinstall'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -1249,26 +1249,6 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 400 bad request happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 400 bad request happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 500 server internal error happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 500 server internal error happened on Checkmarx server</p></td> -</tr> -<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.default.check.timetowait.milliseconds</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Time in milliseconds when adapter check operation is called next. When -1 value is 60000 minutes</p></td> @@ -1278,20 +1258,10 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> <td class="tableblock halign-left valign-top"><p class="tableblock">240</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Time in minutes when adapter result check will automatically time out and adapter stops execution automatically. When -1 timeout is 7200 minutes</p></td> </tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a PDS encryption out of sync problem happens</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a PDS encryption out of sync problem happens</p></td> -</tr> </tbody> </table> -<table id="section-gen-configuration-scope-s" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 12. Scope 's'</caption> +<table id="section-gen-configuration-scope-pdsresilience" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 12. Scope 'pdsresilience'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -1306,29 +1276,34 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.config</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">mail.smtp.auth=false,mail.transport.protocol=smtp</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: <code>mail.smtp.auth=false,mail.smtp.timeout=4000</code>. See <a href="https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html" class="bare">https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html</a> for configuration mapping</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 400 bad request happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.password</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Password on SMPTP server, empty value means no password</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 400 bad request happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.username</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Username on SMPTP server, empty value means no username</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 500 server internal error happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.hostname</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname of SMPTP server</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 500 server internal error happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.port</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Port of SMPTP server, per default:25</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a PDS encryption out of sync problem happens</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a PDS encryption out of sync problem happens</p></td> </tr> </tbody> </table> @@ -1570,8 +1545,50 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> </tr> </tbody> </table> +<table id="section-gen-configuration-scope-smtpserver" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 19. Scope 'smtpserver'</caption> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Key or variable name</th> +<th class="tableblock halign-left valign-top">Default</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.config</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">mail.smtp.auth=false,mail.transport.protocol=smtp</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: <code>mail.smtp.auth=false,mail.smtp.timeout=4000</code>. See <a href="https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html" class="bare">https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html</a> for configuration mapping</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.password</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Password on SMPTP server, empty value means no password</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.username</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Username on SMPTP server, empty value means no username</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.hostname</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname of SMPTP server</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.port</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Port of SMPTP server, per default:25</p></td> +</tr> +</tbody> +</table> <table id="section-gen-configuration-scope-storage" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 19. Scope 'storage'</caption> +<caption class="title">Table 20. Scope 'storage'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -1658,7 +1675,7 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-system" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 20. Scope 'system'</caption> +<caption class="title">Table 21. Scope 'system'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -1690,7 +1707,7 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-target" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 21. Scope 'target'</caption> +<caption class="title">Table 22. Scope 'target'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -1722,7 +1739,7 @@ <h4 id="section-general-configuration">2.2.2. General configuration</h4> <div class="sect3"> <h4 id="scheduling-definitions">2.2.3. Scheduling definitions</h4> <table id="link-gen-scheduling" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 22. Scope 'administration'</caption> +<caption class="title">Table 23. Scope 'administration'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -1744,7 +1761,7 @@ <h4 id="scheduling-definitions">2.2.3. Scheduling definitions</h4> </tbody> </table> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 23. Scope 'scan'</caption> +<caption class="title">Table 24. Scope 'scan'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -1766,7 +1783,7 @@ <h4 id="scheduling-definitions">2.2.3. Scheduling definitions</h4> </tbody> </table> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 24. Scope 'schedule'</caption> +<caption class="title">Table 25. Scope 'schedule'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -1939,9 +1956,9 @@ <h5 id="mandatory-configuration">2.3.3.1. Mandatory configuration</h5> -Dsechub.initialadmin.userid=value -Dsechub.notification.email.administrators=value -Dsechub.notification.email.from=value --Dsechub.notification.smtp.hostname=value -Dsechub.server.baseurl=value --Dsechub.security.diffiehellman.length=value</pre> +-Dsechub.security.diffiehellman.length=value +-Dsechub.notification.smtp.hostname=value</pre> </div> </div> <div class="admonitionblock tip"> @@ -1964,9 +1981,9 @@ <h5 id="mandatory-configuration">2.3.3.1. Mandatory configuration</h5> export SECHUB_INITIALADMIN_USERID=value export SECHUB_NOTIFICATION_EMAIL_ADMINISTRATORS=value export SECHUB_NOTIFICATION_EMAIL_FROM=value -export SECHUB_NOTIFICATION_SMTP_HOSTNAME=value export SECHUB_SERVER_BASEURL=value -export SECHUB_SECURITY_DIFFIEHELLMAN_LENGTH=value</pre> +export SECHUB_SECURITY_DIFFIEHELLMAN_LENGTH=value +export SECHUB_NOTIFICATION_SMTP_HOSTNAME=value</pre> </div> </div> <div class="admonitionblock important"> @@ -2413,7 +2430,7 @@ <h5 id="pds">2.6.2.1. PDS</h5> are listed here for the sake of completeness.</p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 25. PDS executor configuration parameters</caption> +<caption class="title">Table 26. PDS executor configuration parameters</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3692,7 +3709,7 @@ <h3 id="what-must-be-done-when-a-user-wants-to-have-access-to-a-sechub-project"> </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-product-delegation-server.html b/docs/latest/sechub-product-delegation-server.html index 128146ed7c..0c52a9185a 100644 --- a/docs/latest/sechub-product-delegation-server.html +++ b/docs/latest/sechub-product-delegation-server.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub PDS Documentation</h1> <div class="details"> -<span id="revnumber"> PDS 2.0.0 modified (commit c39468e)</span> +<span id="revnumber"> PDS 2.0.0 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -815,7 +815,7 @@ <h2 id="about">1. About</h2> </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>PDS 2.0.0 modified (commit c39468e) - Build date: 20241021165905</code></p> +<p>Documentation version: <code>PDS 2.0.0 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <div class="paragraph"> <p><strong>About PDS (Product Delegation Server)</strong></p> @@ -2686,8 +2686,8 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> </tr> </tbody> </table> -<table id="section-gen-configuration-scope-p" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 8. Scope 'p'</caption> +<table id="section-gen-configuration-scope-pdscancel" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 8. Scope 'pdscancel'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2706,11 +2706,23 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> <td class="tableblock halign-left valign-top"><p class="tableblock">60</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The time in minutes after which a cancel job request is treated as orphaned.</p></td> </tr> +</tbody> +</table> +<table id="section-gen-configuration-scope-pdsget" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 9. Scope 'pdsget'</caption> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">pds.config.job.stream.cachetime</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">PDS job stream data caching time in milliseconds. This defines the maximum period of time between an update time stamp and the request timestamp in database where current data is handled as still valid</p></td> +<th class="tableblock halign-left valign-top">Key or variable name</th> +<th class="tableblock halign-left valign-top">Default</th> +<th class="tableblock halign-left valign-top">Description</th> </tr> +</thead> +<tbody> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">pds.config.job.stream.check.retries</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td> @@ -2728,8 +2740,30 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> </tr> </tbody> </table> +<table id="section-gen-configuration-scope-pdsstream" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 10. Scope 'pdsstream'</caption> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Key or variable name</th> +<th class="tableblock halign-left valign-top">Default</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">pds.config.job.stream.cachetime</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">PDS job stream data caching time in milliseconds. This defines the maximum period of time between an update time stamp and the request timestamp in database where current data is handled as still valid</p></td> +</tr> +</tbody> +</table> <table id="section-gen-configuration-scope-scheduler" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 9. Scope 'scheduler'</caption> +<caption class="title">Table 11. Scope 'scheduler'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2761,7 +2795,7 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-security" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 10. Scope 'security'</caption> +<caption class="title">Table 12. Scope 'security'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2783,7 +2817,7 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-startup" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 11. Scope 'startup'</caption> +<caption class="title">Table 13. Scope 'startup'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2810,7 +2844,7 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-storage" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 12. Scope 'storage'</caption> +<caption class="title">Table 14. Scope 'storage'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2897,7 +2931,7 @@ <h4 id="section-general-configuration">4.1.4. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-upload" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 13. Scope 'upload'</caption> +<caption class="title">Table 15. Scope 'upload'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3421,7 +3455,7 @@ <h4 id="parameter-variables">4.6.2. Parameter variables</h4> <p>We have following standard parameters:</p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 14. PDS executor configuration parameters</caption> +<caption class="title">Table 16. PDS executor configuration parameters</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -5216,7 +5250,7 @@ <h4 id="get-monitoring-status">4.8.8. Get monitoring status</h4> </div> <div id="footer"> <div id="footer-text"> - PDS 2.0.0 modified (commit c39468e)<br> + PDS 2.0.0 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-restapi.html b/docs/latest/sechub-restapi.html index a0724b7d2d..ed6d267df0 100644 --- a/docs/latest/sechub-restapi.html +++ b/docs/latest/sechub-restapi.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub Server Rest API Documentation</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -666,72 +666,73 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#update-project-metadata">2.2.21. Update project metadata</a></li> <li><a href="#admin-changes-project-description">2.2.22. Admin changes project description</a></li> <li><a href="#admin-changes-project-access-level">2.2.23. Admin changes project access level</a></li> -<li><a href="#user-clicks-link-to-get-new-api-token">2.2.24. User clicks link to get new api token</a></li> -<li><a href="#user-creates-a-new-sechub-job">2.2.25. User creates a new sechub job</a> +<li><a href="#get-assigned-project-data">2.2.24. get assigned project data</a></li> +<li><a href="#user-clicks-link-to-get-new-api-token">2.2.25. User clicks link to get new api token</a></li> +<li><a href="#user-creates-a-new-sechub-job">2.2.26. User creates a new sechub job</a> <ul class="sectlevel4"> -<li><a href="#section-ucrestdoc-UC_005-code-scan">2.2.25.1. Code Scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-code-scan-using-data-section">2.2.25.2. Code Scan using data section variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-secret-scan">2.2.25.3. Secret scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-license-scan">2.2.25.4. License scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-infrastructure-scan">2.2.25.5. Infrastructure scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-anonymous">2.2.25.6. Web scan anonymous variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-with-api-definition">2.2.25.7. Web scan with api definition variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">2.2.25.8. Web scan with client certificate definition variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-login-basic">2.2.25.9. Web Scan login basic variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-login-form-scripted">2.2.25.10. Web Scan login form scripted variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-headers">2.2.25.11. Web Scan headers variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-code-scan">2.2.26.1. Code Scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-code-scan-using-data-section">2.2.26.2. Code Scan using data section variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-secret-scan">2.2.26.3. Secret scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-license-scan">2.2.26.4. License scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-infrastructure-scan">2.2.26.5. Infrastructure scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-anonymous">2.2.26.6. Web scan anonymous variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-with-api-definition">2.2.26.7. Web scan with api definition variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">2.2.26.8. Web scan with client certificate definition variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-login-basic">2.2.26.9. Web Scan login basic variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-login-form-scripted">2.2.26.10. Web Scan login form scripted variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-headers">2.2.26.11. Web Scan headers variant</a></li> </ul> </li> -<li><a href="#user-uploads-source-code">2.2.26. User uploads source code</a></li> -<li><a href="#user-approves-sechub-job">2.2.27. User approves sechub job</a></li> -<li><a href="#user-checks-sechub-job-state">2.2.28. User checks sechub job state</a></li> -<li><a href="#user-downloads-sechub-job-report">2.2.29. User downloads sechub job report</a> +<li><a href="#user-uploads-source-code">2.2.27. User uploads source code</a></li> +<li><a href="#user-approves-sechub-job">2.2.28. User approves sechub job</a></li> +<li><a href="#user-checks-sechub-job-state">2.2.29. User checks sechub job state</a></li> +<li><a href="#user-downloads-sechub-job-report">2.2.30. User downloads sechub job report</a> <ul class="sectlevel4"> -<li><a href="#section-ucrestdoc-UC_010-json">2.2.29.1. JSON variant</a></li> -<li><a href="#section-ucrestdoc-UC_010-html">2.2.29.2. HTML variant</a></li> +<li><a href="#section-ucrestdoc-UC_010-json">2.2.30.1. JSON variant</a></li> +<li><a href="#section-ucrestdoc-UC_010-html">2.2.30.2. HTML variant</a></li> </ul> </li> -<li><a href="#user-marks-false-positives">2.2.30. User marks false positives</a></li> -<li><a href="#user-unmarks-existing-false-positive-definitons">2.2.31. User unmarks existing false positive definitons</a></li> -<li><a href="#user-fetches-false-positive-configuration-of-project">2.2.32. User fetches false positive configuration of project</a></li> -<li><a href="#user-uploads-binaries">2.2.33. User uploads binaries</a></li> -<li><a href="#user-downloads-job-report-in-spdx-format">2.2.34. User downloads job report in SPDX format</a></li> -<li><a href="#user-unmarks-existing-false-positive-project-data-definitons">2.2.35. User unmarks existing false positive project data definitons</a></li> -<li><a href="#user-self-registration">2.2.36. User self registration</a></li> -<li><a href="#admin-lists-open-user-signups">2.2.37. Admin lists open user signups</a></li> -<li><a href="#admin-applies-self-registration">2.2.38. Admin applies self registration</a></li> -<li><a href="#admin-deletes-user-signup">2.2.39. Admin deletes user signup</a></li> -<li><a href="#user-requests-new-api-token">2.2.40. User requests new API token</a></li> -<li><a href="#admin-lists-all-running-jobs">2.2.41. Admin lists all running jobs</a></li> -<li><a href="#admin-cancels-a-job">2.2.42. Admin cancels a job</a></li> -<li><a href="#admin-restarts-a-job">2.2.43. Admin restarts a job</a></li> -<li><a href="#admin-restarts-a-job-hard">2.2.44. Admin restarts a job (hard)</a></li> -<li><a href="#user-defines-mock-data-configuration-for-project">2.2.45. User defines mock data configuration for project</a></li> -<li><a href="#user-retrieves-mock-data-configuration-for-project">2.2.46. User retrieves mock data configuration for project</a></li> -<li><a href="#admin-updates-mapping-configuration">2.2.47. Admin updates mapping configuration</a></li> -<li><a href="#admin-fetches-mapping-configuration">2.2.48. Admin fetches mapping configuration</a></li> -<li><a href="#admin-creates-an-executor-configuration">2.2.49. Admin creates an executor configuration</a></li> -<li><a href="#admin-deletes-executor-configuration">2.2.50. Admin deletes executor configuration</a></li> -<li><a href="#admin-fetches-executor-configuration-list">2.2.51. Admin fetches executor configuration list</a></li> -<li><a href="#admin-fetches-executor-configuration">2.2.52. Admin fetches executor configuration</a></li> -<li><a href="#admin-updates-executor-configuration-setup">2.2.53. Admin updates executor configuration setup</a></li> -<li><a href="#admin-creates-an-execution-profile">2.2.54. Admin creates an execution profile</a></li> -<li><a href="#admin-deletes-execution-profile">2.2.55. Admin deletes execution profile</a></li> -<li><a href="#admin-updates-execution-profile">2.2.56. Admin updates execution profile</a></li> -<li><a href="#admin-fetches-execution-profile">2.2.57. Admin fetches execution profile</a></li> -<li><a href="#admin-fetches-execution-profile-list">2.2.58. Admin fetches execution profile list</a></li> -<li><a href="#admin-assigns-execution-profile-to-project">2.2.59. Admin assigns execution profile to project</a></li> -<li><a href="#admin-unassigns-execution-profile-from-project">2.2.60. Admin unassigns execution profile from project</a></li> -<li><a href="#admin-fetches-auto-cleanup-configuration">2.2.61. Admin fetches auto cleanup configuration</a></li> -<li><a href="#admin-updates-auto-cleanup-configuration">2.2.62. Admin updates auto cleanup configuration</a></li> -<li><a href="#admin-starts-encryption-rotation">2.2.63. Admin starts encryption rotation</a></li> -<li><a href="#admin-fetches-encryption-status">2.2.64. Admin fetches encryption status</a></li> -<li><a href="#admin-disables-job-processing-in-scheduler">2.2.65. Admin disables job processing in scheduler</a></li> -<li><a href="#admin-enables-scheduler-job-processing">2.2.66. Admin enables scheduler job processing</a></li> -<li><a href="#admin-get-scheduler-status">2.2.67. Admin get scheduler status</a></li> -<li><a href="#admin-lists-status-information">2.2.68. Admin lists status information</a></li> -<li><a href="#admin-fetches-server-runtime-data">2.2.69. Admin fetches server runtime data</a></li> -<li><a href="#user-lists-jobs-for-project">2.2.70. User lists jobs for project</a></li> +<li><a href="#user-marks-false-positives">2.2.31. User marks false positives</a></li> +<li><a href="#user-unmarks-existing-false-positive-definitons">2.2.32. User unmarks existing false positive definitons</a></li> +<li><a href="#user-fetches-false-positive-configuration-of-project">2.2.33. User fetches false positive configuration of project</a></li> +<li><a href="#user-uploads-binaries">2.2.34. User uploads binaries</a></li> +<li><a href="#user-downloads-job-report-in-spdx-format">2.2.35. User downloads job report in SPDX format</a></li> +<li><a href="#user-unmarks-existing-false-positive-project-data-definitons">2.2.36. User unmarks existing false positive project data definitons</a></li> +<li><a href="#user-self-registration">2.2.37. User self registration</a></li> +<li><a href="#admin-lists-open-user-signups">2.2.38. Admin lists open user signups</a></li> +<li><a href="#admin-applies-self-registration">2.2.39. Admin applies self registration</a></li> +<li><a href="#admin-deletes-user-signup">2.2.40. Admin deletes user signup</a></li> +<li><a href="#user-requests-new-api-token">2.2.41. User requests new API token</a></li> +<li><a href="#admin-lists-all-running-jobs">2.2.42. Admin lists all running jobs</a></li> +<li><a href="#admin-cancels-a-job">2.2.43. Admin cancels a job</a></li> +<li><a href="#admin-restarts-a-job">2.2.44. Admin restarts a job</a></li> +<li><a href="#admin-restarts-a-job-hard">2.2.45. Admin restarts a job (hard)</a></li> +<li><a href="#user-defines-mock-data-configuration-for-project">2.2.46. User defines mock data configuration for project</a></li> +<li><a href="#user-retrieves-mock-data-configuration-for-project">2.2.47. User retrieves mock data configuration for project</a></li> +<li><a href="#admin-updates-mapping-configuration">2.2.48. Admin updates mapping configuration</a></li> +<li><a href="#admin-fetches-mapping-configuration">2.2.49. Admin fetches mapping configuration</a></li> +<li><a href="#admin-creates-an-executor-configuration">2.2.50. Admin creates an executor configuration</a></li> +<li><a href="#admin-deletes-executor-configuration">2.2.51. Admin deletes executor configuration</a></li> +<li><a href="#admin-fetches-executor-configuration-list">2.2.52. Admin fetches executor configuration list</a></li> +<li><a href="#admin-fetches-executor-configuration">2.2.53. Admin fetches executor configuration</a></li> +<li><a href="#admin-updates-executor-configuration-setup">2.2.54. Admin updates executor configuration setup</a></li> +<li><a href="#admin-creates-an-execution-profile">2.2.55. Admin creates an execution profile</a></li> +<li><a href="#admin-deletes-execution-profile">2.2.56. Admin deletes execution profile</a></li> +<li><a href="#admin-updates-execution-profile">2.2.57. Admin updates execution profile</a></li> +<li><a href="#admin-fetches-execution-profile">2.2.58. Admin fetches execution profile</a></li> +<li><a href="#admin-fetches-execution-profile-list">2.2.59. Admin fetches execution profile list</a></li> +<li><a href="#admin-assigns-execution-profile-to-project">2.2.60. Admin assigns execution profile to project</a></li> +<li><a href="#admin-unassigns-execution-profile-from-project">2.2.61. Admin unassigns execution profile from project</a></li> +<li><a href="#admin-fetches-auto-cleanup-configuration">2.2.62. Admin fetches auto cleanup configuration</a></li> +<li><a href="#admin-updates-auto-cleanup-configuration">2.2.63. Admin updates auto cleanup configuration</a></li> +<li><a href="#admin-starts-encryption-rotation">2.2.64. Admin starts encryption rotation</a></li> +<li><a href="#admin-fetches-encryption-status">2.2.65. Admin fetches encryption status</a></li> +<li><a href="#admin-disables-job-processing-in-scheduler">2.2.66. Admin disables job processing in scheduler</a></li> +<li><a href="#admin-enables-scheduler-job-processing">2.2.67. Admin enables scheduler job processing</a></li> +<li><a href="#admin-get-scheduler-status">2.2.68. Admin get scheduler status</a></li> +<li><a href="#admin-lists-status-information">2.2.69. Admin lists status information</a></li> +<li><a href="#admin-fetches-server-runtime-data">2.2.70. Admin fetches server runtime data</a></li> +<li><a href="#user-lists-jobs-for-project">2.2.71. User lists jobs for project</a></li> </ul> </li> </ul> @@ -860,71 +861,72 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#section-usecase-UC_077">4.1.78. UC_077-SecHub does cleanup encryption</a></li> <li><a href="#section-usecase-UC_078">4.1.79. UC_078-User unmarks existing false positive project data definitons</a></li> <li><a href="#section-usecase-UC_079">4.1.80. UC_079-System suspends running jobs on SIGTERM</a></li> -<li><a href="#section-usecase-UC_080">4.1.81. UC_080-System resumes suspended jobs</a> +<li><a href="#section-usecase-UC_080">4.1.81. UC_080-System resumes suspended jobs</a></li> +<li><a href="#section-usecase-UC_081">4.1.82. UC_081-get assigned project data</a> <ul class="sectlevel4"> -<li><a href="#section-gen-messaging-overview">4.1.81.1. Overview</a> +<li><a href="#section-gen-messaging-overview">4.1.82.1. Overview</a> <ul class="sectlevel5"> -<li><a href="#diagram">4.1.81.1.1. Diagram</a></li> -<li><a href="#section-gen-messaging-overview-linklist">4.1.81.1.2. List of all messages</a></li> +<li><a href="#diagram">4.1.82.1.1. Diagram</a></li> +<li><a href="#section-gen-messaging-overview-linklist">4.1.82.1.2. List of all messages</a></li> </ul> </li> -<li><a href="#section-gen-messaging-analyze_scan_results_available">4.1.81.2. Message ANALYZE_SCAN_RESULTS_AVAILABLE</a></li> -<li><a href="#section-gen-messaging-auto_cleanup_configuration_changed">4.1.81.3. Message AUTO_CLEANUP_CONFIGURATION_CHANGED</a></li> -<li><a href="#section-gen-messaging-binary_upload_done">4.1.81.4. Message BINARY_UPLOAD_DONE</a></li> -<li><a href="#section-gen-messaging-get_encryption_status_schedule_domain">4.1.81.5. Message GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</a></li> -<li><a href="#section-gen-messaging-job_cancellation_running">4.1.81.6. Message JOB_CANCELLATION_RUNNING</a></li> -<li><a href="#section-gen-messaging-job_created">4.1.81.7. Message JOB_CREATED</a></li> -<li><a href="#section-gen-messaging-job_done">4.1.81.8. Message JOB_DONE</a></li> -<li><a href="#section-gen-messaging-job_execution_starting">4.1.81.9. Message JOB_EXECUTION_STARTING</a></li> -<li><a href="#section-gen-messaging-job_failed">4.1.81.10. Message JOB_FAILED</a></li> -<li><a href="#section-gen-messaging-job_restart_canceled">4.1.81.11. Message JOB_RESTART_CANCELED</a></li> -<li><a href="#section-gen-messaging-job_restart_triggered">4.1.81.12. Message JOB_RESTART_TRIGGERED</a></li> -<li><a href="#section-gen-messaging-job_results_purged">4.1.81.13. Message JOB_RESULTS_PURGED</a></li> -<li><a href="#section-gen-messaging-job_result_purge_done">4.1.81.14. Message JOB_RESULT_PURGE_DONE</a></li> -<li><a href="#section-gen-messaging-job_result_purge_failed">4.1.81.15. Message JOB_RESULT_PURGE_FAILED</a></li> -<li><a href="#section-gen-messaging-job_started">4.1.81.16. Message JOB_STARTED</a></li> -<li><a href="#section-gen-messaging-job_suspended">4.1.81.17. Message JOB_SUSPENDED</a></li> -<li><a href="#section-gen-messaging-mapping_configuration_changed">4.1.81.18. Message MAPPING_CONFIGURATION_CHANGED</a></li> -<li><a href="#section-gen-messaging-product_executor_cancel_operations_done">4.1.81.19. Message PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE</a></li> -<li><a href="#section-gen-messaging-project_access_level_changed">4.1.81.20. Message PROJECT_ACCESS_LEVEL_CHANGED</a></li> -<li><a href="#section-gen-messaging-project_created">4.1.81.21. Message PROJECT_CREATED</a></li> -<li><a href="#section-gen-messaging-project_deleted">4.1.81.22. Message PROJECT_DELETED</a></li> -<li><a href="#section-gen-messaging-project_owner_changed">4.1.81.23. Message PROJECT_OWNER_CHANGED</a></li> -<li><a href="#section-gen-messaging-project_whitelist_updated">4.1.81.24. Message PROJECT_WHITELIST_UPDATED</a></li> -<li><a href="#section-gen-messaging-request_job_cancellation">4.1.81.25. Message REQUEST_JOB_CANCELLATION</a></li> -<li><a href="#section-gen-messaging-request_job_restart">4.1.81.26. Message REQUEST_JOB_RESTART</a></li> -<li><a href="#section-gen-messaging-request_job_restart_hard">4.1.81.27. Message REQUEST_JOB_RESTART_HARD</a></li> -<li><a href="#section-gen-messaging-request_purge_job_results">4.1.81.28. Message REQUEST_PURGE_JOB_RESULTS</a></li> -<li><a href="#section-gen-messaging-request_scheduler_disable_job_processing">4.1.81.29. Message REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING</a></li> -<li><a href="#section-gen-messaging-request_scheduler_enable_job_processing">4.1.81.30. Message REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING</a></li> -<li><a href="#section-gen-messaging-request_scheduler_job_status">4.1.81.31. Message REQUEST_SCHEDULER_JOB_STATUS</a></li> -<li><a href="#section-gen-messaging-request_scheduler_status_update">4.1.81.32. Message REQUEST_SCHEDULER_STATUS_UPDATE</a></li> -<li><a href="#section-gen-messaging-request_user_role_recalculation">4.1.81.33. Message REQUEST_USER_ROLE_RECALCULATION</a></li> -<li><a href="#section-gen-messaging-result_encryption_status_schedule_domain">4.1.81.34. Message RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</a></li> -<li><a href="#section-gen-messaging-scan_done">4.1.81.35. Message SCAN_DONE</a></li> -<li><a href="#section-gen-messaging-scan_failed">4.1.81.36. Message SCAN_FAILED</a></li> -<li><a href="#section-gen-messaging-scan_suspended">4.1.81.37. Message SCAN_SUSPENDED</a></li> -<li><a href="#section-gen-messaging-scheduler_job_processing_disabled">4.1.81.38. Message SCHEDULER_JOB_PROCESSING_DISABLED</a></li> -<li><a href="#section-gen-messaging-scheduler_job_processing_enabled">4.1.81.39. Message SCHEDULER_JOB_PROCESSING_ENABLED</a></li> -<li><a href="#section-gen-messaging-scheduler_job_status">4.1.81.40. Message SCHEDULER_JOB_STATUS</a></li> -<li><a href="#section-gen-messaging-scheduler_started">4.1.81.41. Message SCHEDULER_STARTED</a></li> -<li><a href="#section-gen-messaging-scheduler_status_update">4.1.81.42. Message SCHEDULER_STATUS_UPDATE</a></li> -<li><a href="#section-gen-messaging-schedule_encryption_pool_initialized">4.1.81.43. Message SCHEDULE_ENCRYPTION_POOL_INITIALIZED</a></li> -<li><a href="#section-gen-messaging-source_upload_done">4.1.81.44. Message SOURCE_UPLOAD_DONE</a></li> -<li><a href="#section-gen-messaging-start_encryption_rotation">4.1.81.45. Message START_ENCRYPTION_ROTATION</a></li> -<li><a href="#section-gen-messaging-start_scan">4.1.81.46. Message START_SCAN</a></li> -<li><a href="#section-gen-messaging-unsupported_operation">4.1.81.47. Message UNSUPPORTED_OPERATION</a></li> -<li><a href="#section-gen-messaging-user_added_to_project">4.1.81.48. Message USER_ADDED_TO_PROJECT</a></li> -<li><a href="#section-gen-messaging-user_api_token_changed">4.1.81.49. Message USER_API_TOKEN_CHANGED</a></li> -<li><a href="#section-gen-messaging-user_becomes_superadmin">4.1.81.50. Message USER_BECOMES_SUPERADMIN</a></li> -<li><a href="#section-gen-messaging-user_created">4.1.81.51. Message USER_CREATED</a></li> -<li><a href="#section-gen-messaging-user_deleted">4.1.81.52. Message USER_DELETED</a></li> -<li><a href="#section-gen-messaging-user_email_address_changed">4.1.81.53. Message USER_EMAIL_ADDRESS_CHANGED</a></li> -<li><a href="#section-gen-messaging-user_new_api_token_requested">4.1.81.54. Message USER_NEW_API_TOKEN_REQUESTED</a></li> -<li><a href="#section-gen-messaging-user_no_longer_superadmin">4.1.81.55. Message USER_NO_LONGER_SUPERADMIN</a></li> -<li><a href="#section-gen-messaging-user_removed_from_project">4.1.81.56. Message USER_REMOVED_FROM_PROJECT</a></li> -<li><a href="#section-gen-messaging-user_roles_changed">4.1.81.57. Message USER_ROLES_CHANGED</a></li> -<li><a href="#section-gen-messaging-user_signup_requested">4.1.81.58. Message USER_SIGNUP_REQUESTED</a></li> +<li><a href="#section-gen-messaging-analyze_scan_results_available">4.1.82.2. Message ANALYZE_SCAN_RESULTS_AVAILABLE</a></li> +<li><a href="#section-gen-messaging-auto_cleanup_configuration_changed">4.1.82.3. Message AUTO_CLEANUP_CONFIGURATION_CHANGED</a></li> +<li><a href="#section-gen-messaging-binary_upload_done">4.1.82.4. Message BINARY_UPLOAD_DONE</a></li> +<li><a href="#section-gen-messaging-get_encryption_status_schedule_domain">4.1.82.5. Message GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</a></li> +<li><a href="#section-gen-messaging-job_cancellation_running">4.1.82.6. Message JOB_CANCELLATION_RUNNING</a></li> +<li><a href="#section-gen-messaging-job_created">4.1.82.7. Message JOB_CREATED</a></li> +<li><a href="#section-gen-messaging-job_done">4.1.82.8. Message JOB_DONE</a></li> +<li><a href="#section-gen-messaging-job_execution_starting">4.1.82.9. Message JOB_EXECUTION_STARTING</a></li> +<li><a href="#section-gen-messaging-job_failed">4.1.82.10. Message JOB_FAILED</a></li> +<li><a href="#section-gen-messaging-job_restart_canceled">4.1.82.11. Message JOB_RESTART_CANCELED</a></li> +<li><a href="#section-gen-messaging-job_restart_triggered">4.1.82.12. Message JOB_RESTART_TRIGGERED</a></li> +<li><a href="#section-gen-messaging-job_results_purged">4.1.82.13. Message JOB_RESULTS_PURGED</a></li> +<li><a href="#section-gen-messaging-job_result_purge_done">4.1.82.14. Message JOB_RESULT_PURGE_DONE</a></li> +<li><a href="#section-gen-messaging-job_result_purge_failed">4.1.82.15. Message JOB_RESULT_PURGE_FAILED</a></li> +<li><a href="#section-gen-messaging-job_started">4.1.82.16. Message JOB_STARTED</a></li> +<li><a href="#section-gen-messaging-job_suspended">4.1.82.17. Message JOB_SUSPENDED</a></li> +<li><a href="#section-gen-messaging-mapping_configuration_changed">4.1.82.18. Message MAPPING_CONFIGURATION_CHANGED</a></li> +<li><a href="#section-gen-messaging-product_executor_cancel_operations_done">4.1.82.19. Message PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE</a></li> +<li><a href="#section-gen-messaging-project_access_level_changed">4.1.82.20. Message PROJECT_ACCESS_LEVEL_CHANGED</a></li> +<li><a href="#section-gen-messaging-project_created">4.1.82.21. Message PROJECT_CREATED</a></li> +<li><a href="#section-gen-messaging-project_deleted">4.1.82.22. Message PROJECT_DELETED</a></li> +<li><a href="#section-gen-messaging-project_owner_changed">4.1.82.23. Message PROJECT_OWNER_CHANGED</a></li> +<li><a href="#section-gen-messaging-project_whitelist_updated">4.1.82.24. Message PROJECT_WHITELIST_UPDATED</a></li> +<li><a href="#section-gen-messaging-request_job_cancellation">4.1.82.25. Message REQUEST_JOB_CANCELLATION</a></li> +<li><a href="#section-gen-messaging-request_job_restart">4.1.82.26. Message REQUEST_JOB_RESTART</a></li> +<li><a href="#section-gen-messaging-request_job_restart_hard">4.1.82.27. Message REQUEST_JOB_RESTART_HARD</a></li> +<li><a href="#section-gen-messaging-request_purge_job_results">4.1.82.28. Message REQUEST_PURGE_JOB_RESULTS</a></li> +<li><a href="#section-gen-messaging-request_scheduler_disable_job_processing">4.1.82.29. Message REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING</a></li> +<li><a href="#section-gen-messaging-request_scheduler_enable_job_processing">4.1.82.30. Message REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING</a></li> +<li><a href="#section-gen-messaging-request_scheduler_job_status">4.1.82.31. Message REQUEST_SCHEDULER_JOB_STATUS</a></li> +<li><a href="#section-gen-messaging-request_scheduler_status_update">4.1.82.32. Message REQUEST_SCHEDULER_STATUS_UPDATE</a></li> +<li><a href="#section-gen-messaging-request_user_role_recalculation">4.1.82.33. Message REQUEST_USER_ROLE_RECALCULATION</a></li> +<li><a href="#section-gen-messaging-result_encryption_status_schedule_domain">4.1.82.34. Message RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</a></li> +<li><a href="#section-gen-messaging-scan_done">4.1.82.35. Message SCAN_DONE</a></li> +<li><a href="#section-gen-messaging-scan_failed">4.1.82.36. Message SCAN_FAILED</a></li> +<li><a href="#section-gen-messaging-scan_suspended">4.1.82.37. Message SCAN_SUSPENDED</a></li> +<li><a href="#section-gen-messaging-scheduler_job_processing_disabled">4.1.82.38. Message SCHEDULER_JOB_PROCESSING_DISABLED</a></li> +<li><a href="#section-gen-messaging-scheduler_job_processing_enabled">4.1.82.39. Message SCHEDULER_JOB_PROCESSING_ENABLED</a></li> +<li><a href="#section-gen-messaging-scheduler_job_status">4.1.82.40. Message SCHEDULER_JOB_STATUS</a></li> +<li><a href="#section-gen-messaging-scheduler_started">4.1.82.41. Message SCHEDULER_STARTED</a></li> +<li><a href="#section-gen-messaging-scheduler_status_update">4.1.82.42. Message SCHEDULER_STATUS_UPDATE</a></li> +<li><a href="#section-gen-messaging-schedule_encryption_pool_initialized">4.1.82.43. Message SCHEDULE_ENCRYPTION_POOL_INITIALIZED</a></li> +<li><a href="#section-gen-messaging-source_upload_done">4.1.82.44. Message SOURCE_UPLOAD_DONE</a></li> +<li><a href="#section-gen-messaging-start_encryption_rotation">4.1.82.45. Message START_ENCRYPTION_ROTATION</a></li> +<li><a href="#section-gen-messaging-start_scan">4.1.82.46. Message START_SCAN</a></li> +<li><a href="#section-gen-messaging-unsupported_operation">4.1.82.47. Message UNSUPPORTED_OPERATION</a></li> +<li><a href="#section-gen-messaging-user_added_to_project">4.1.82.48. Message USER_ADDED_TO_PROJECT</a></li> +<li><a href="#section-gen-messaging-user_api_token_changed">4.1.82.49. Message USER_API_TOKEN_CHANGED</a></li> +<li><a href="#section-gen-messaging-user_becomes_superadmin">4.1.82.50. Message USER_BECOMES_SUPERADMIN</a></li> +<li><a href="#section-gen-messaging-user_created">4.1.82.51. Message USER_CREATED</a></li> +<li><a href="#section-gen-messaging-user_deleted">4.1.82.52. Message USER_DELETED</a></li> +<li><a href="#section-gen-messaging-user_email_address_changed">4.1.82.53. Message USER_EMAIL_ADDRESS_CHANGED</a></li> +<li><a href="#section-gen-messaging-user_new_api_token_requested">4.1.82.54. Message USER_NEW_API_TOKEN_REQUESTED</a></li> +<li><a href="#section-gen-messaging-user_no_longer_superadmin">4.1.82.55. Message USER_NO_LONGER_SUPERADMIN</a></li> +<li><a href="#section-gen-messaging-user_removed_from_project">4.1.82.56. Message USER_REMOVED_FROM_PROJECT</a></li> +<li><a href="#section-gen-messaging-user_roles_changed">4.1.82.57. Message USER_ROLES_CHANGED</a></li> +<li><a href="#section-gen-messaging-user_signup_requested">4.1.82.58. Message USER_SIGNUP_REQUESTED</a></li> </ul> </li> </ul> @@ -1015,7 +1017,7 @@ <h2 id="about">1. About</h2> </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <hr> </div> @@ -2890,6 +2892,9 @@ <h5 id="project-administration">2.2.1.3. Project administration</h5> <li> <p><a href="#section-ucrestdoc-uc-UC_062">REST API for UC_062-Admin changes project access level </a></p> </li> +<li> +<p><a href="#section-ucrestdoc-uc-UC_081">REST API for UC_081-get assigned project data </a></p> +</li> </ul> </div> </div> @@ -3923,7 +3928,7 @@ <h4 id="admin-downloads-all-details-about-a-scan-job">2.2.9. Admin downloads all </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/scan/download/b3d0fadc-5631-48fe-ad3b-d1d2856e4158' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/scan/download/d997d479-f12b-4b26-9005-beb905c60f86' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -5088,7 +5093,7 @@ <h4 id="admin-shows-scan-logs-for-project">2.2.20. Admin shows scan logs for pro </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">sechubJobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">236cbc48-7499-4aed-9de2-8646de4bf48d</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">spartakus</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-20T16:59:24.353716812</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:24.353740156</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>}]</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">sechubJobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">b2a0f621-cbed-431f-816d-f8f5a655e8bc</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">spartakus</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-26T09:48:46.447108027</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:46.447126853</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>}]</code></pre> </div> </div> </div> @@ -5465,7 +5470,133 @@ <h4 id="admin-changes-project-access-level">2.2.23. Admin changes project access </div> </div> <div class="sect3"> -<h4 id="user-clicks-link-to-get-new-api-token">2.2.24. User clicks link to get new api token</h4> +<h4 id="get-assigned-project-data">2.2.24. get assigned project data</h4> +<div id="section-ucrestdoc-uc-UC_081" class="paragraph"> +<p>REST API for usecase <a href="#section-usecase-UC_081">UC_081-get assigned project data </a></p> +</div> +<div id="section-ucrestdoc-UC_081-" class="paragraph"> +<p><strong class="big">Definition</strong></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 41. General request information</caption> +<colgroup> +<col style="width: 14.2857%;"> +<col style="width: 85.7143%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top"></th> +<th class="tableblock halign-left valign-top">Value</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Path</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">/api/projects</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Method</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Status code</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">200 OK</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><strong>Path parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 42. https://localhost:8081/api/projects</caption> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +</table> +<div class="paragraph"> +<p><strong>Request headers</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +</table> +<div class="paragraph"> +<p><strong>Response fields</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Path</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].projectId</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Project ID</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].owner</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Name of owner of the Project</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].isOwned</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">If caller is owner of the project</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].assignedUsers</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional: Assigned users (only viewable by owner or admin)</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><strong class="big">Example</strong></p> +</div> +<div class="paragraph"> +<p><strong>Curl request</strong> <br></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/projects' -i -u 'user:secret' -X GET \ + -H 'Content-Type: application/json;charset=UTF-8'</code></pre> +</div> +</div> +<div class="paragraph"> +<p><strong>Response body</strong> <br></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">assignedUsers</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">user2</span><span class="delimiter">"</span></span>],<span class="key"><span class="delimiter">"</span><span class="content">isOwned</span><span class="delimiter">"</span></span>:<span class="value">true</span>}]</code></pre> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="user-clicks-link-to-get-new-api-token">2.2.25. User clicks link to get new api token</h4> <div id="section-ucrestdoc-uc-UC_012" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_012">UC_012-User clicks link to get new api token </a></p> </div> @@ -5473,7 +5604,7 @@ <h4 id="user-clicks-link-to-get-new-api-token">2.2.24. User clicks link to get n <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 41. General request information</caption> +<caption class="title">Table 43. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -5503,7 +5634,7 @@ <h4 id="user-clicks-link-to-get-new-api-token">2.2.24. User clicks link to get n <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 42. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}</caption> +<caption class="title">Table 44. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -5539,17 +5670,17 @@ <h4 id="user-clicks-link-to-get-new-api-token">2.2.24. User clicks link to get n </div> </div> <div class="sect3"> -<h4 id="user-creates-a-new-sechub-job">2.2.25. User creates a new sechub job</h4> +<h4 id="user-creates-a-new-sechub-job">2.2.26. User creates a new sechub job</h4> <div id="section-ucrestdoc-uc-UC_005" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_005">UC_005-User creates a new sechub job </a></p> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-code-scan">2.2.25.1. Code Scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-code-scan">2.2.26.1. Code Scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 43. General request information</caption> +<caption class="title">Table 45. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -5579,7 +5710,7 @@ <h5 id="section-ucrestdoc-UC_005-code-scan">2.2.25.1. Code Scan variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 44. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 46. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -5698,17 +5829,17 @@ <h5 id="section-ucrestdoc-UC_005-code-scan">2.2.25.1. Code Scan variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">e985a705-ffb7-49b1-99e6-1407d27226e4</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">7786c4a7-042f-4d2b-8bcf-6c23aabf6e7b</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">2.2.25.2. Code Scan using data section variant</h5> +<h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">2.2.26.2. Code Scan using data section variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 45. General request information</caption> +<caption class="title">Table 47. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -5738,7 +5869,7 @@ <h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">2.2.25.2. Code Sc <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 46. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 48. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -5877,17 +6008,17 @@ <h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">2.2.25.2. Code Sc </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2210eb32-7fd0-4299-b75b-0d87a5db26a0</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">35ea98be-9e36-4cc6-8c8a-3a157d24ead7</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-secret-scan">2.2.25.3. Secret scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-secret-scan">2.2.26.3. Secret scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 47. General request information</caption> +<caption class="title">Table 49. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -5917,7 +6048,7 @@ <h5 id="section-ucrestdoc-UC_005-secret-scan">2.2.25.3. Secret scan variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 48. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 50. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -6036,17 +6167,17 @@ <h5 id="section-ucrestdoc-UC_005-secret-scan">2.2.25.3. Secret scan variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a0e2dc56-54fa-4b25-b1e6-688dd47baaf4</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">dc364126-fdc7-40a8-b8e7-ff087eb22bf2</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-license-scan">2.2.25.4. License scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-license-scan">2.2.26.4. License scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 49. General request information</caption> +<caption class="title">Table 51. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -6076,7 +6207,7 @@ <h5 id="section-ucrestdoc-UC_005-license-scan">2.2.25.4. License scan variant</h <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 50. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 52. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -6195,17 +6326,17 @@ <h5 id="section-ucrestdoc-UC_005-license-scan">2.2.25.4. License scan variant</h </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">e7c1d895-bc81-4c70-92ad-7ca117bab44a</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">7ff1f27b-bae9-4593-b4ee-5a5df3e52604</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-infrastructure-scan">2.2.25.5. Infrastructure scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-infrastructure-scan">2.2.26.5. Infrastructure scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 51. General request information</caption> +<caption class="title">Table 53. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -6235,7 +6366,7 @@ <h5 id="section-ucrestdoc-UC_005-infrastructure-scan">2.2.25.5. Infrastructure s <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 52. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 54. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -6349,17 +6480,17 @@ <h5 id="section-ucrestdoc-UC_005-infrastructure-scan">2.2.25.5. Infrastructure s </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">953dff35-71f1-4983-b360-0762a95ca7c0</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">fcf8cb7f-4f7c-413a-9978-ce8a085fbc7f</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">2.2.25.6. Web scan anonymous variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">2.2.26.6. Web scan anonymous variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 53. General request information</caption> +<caption class="title">Table 55. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -6389,7 +6520,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">2.2.25.6. Web scan anonymou <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 54. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 56. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -6518,17 +6649,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">2.2.25.6. Web scan anonymou </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">9bb88784-b24d-436e-898a-40e9e9c9d42b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">42566c19-7464-4f4a-95e6-79e722ae39b7</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">2.2.25.7. Web scan with api definition variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">2.2.26.7. Web scan with api definition variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 55. General request information</caption> +<caption class="title">Table 57. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -6558,7 +6689,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">2.2.25.7. Web sca <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 56. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 58. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -6682,17 +6813,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">2.2.25.7. Web sca </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">39b31e69-97ca-4543-99a6-50c4f6cc075b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">1ad5cd3b-5a1e-4a7e-8b07-8d5bd87dd515</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">2.2.25.8. Web scan with client certificate definition variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">2.2.26.8. Web scan with client certificate definition variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 57. General request information</caption> +<caption class="title">Table 59. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -6722,7 +6853,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">2. <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 58. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 60. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -6841,17 +6972,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">2. </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">df9ee013-ee60-45bb-929a-1f2bb410f153</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">019ef25e-a21a-4c9e-9412-2ec55887f291</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">2.2.25.9. Web Scan login basic variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">2.2.26.9. Web Scan login basic variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 59. General request information</caption> +<caption class="title">Table 61. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -6881,7 +7012,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">2.2.25.9. Web Scan login <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 60. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 62. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7015,17 +7146,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">2.2.25.9. Web Scan login </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">57628d15-8dd2-4b28-b9fa-42e0c6037c43</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">b7960f36-3dcd-4030-a4d1-fa8ba4f99462</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">2.2.25.10. Web Scan login form scripted variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">2.2.26.10. Web Scan login form scripted variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 61. General request information</caption> +<caption class="title">Table 63. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7055,7 +7186,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">2.2.25.10. Web Sc <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 62. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 64. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7234,17 +7365,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">2.2.25.10. Web Sc </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d47f3a92-0951-4447-8300-fad04567f65b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d70e8d78-f3c9-4d16-a57f-9f4957e4723a</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-headers">2.2.25.11. Web Scan headers variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-headers">2.2.26.11. Web Scan headers variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 63. General request information</caption> +<caption class="title">Table 65. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7274,7 +7405,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-headers">2.2.25.11. Web Scan headers v <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 64. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 66. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7398,13 +7529,13 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-headers">2.2.25.11. Web Scan headers v </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">37527d26-9792-44ae-a2c8-36dfb67fe36c</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">67515a5b-1f33-4d6b-b432-1ed5ba525ee0</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> </div> <div class="sect3"> -<h4 id="user-uploads-source-code">2.2.26. User uploads source code</h4> +<h4 id="user-uploads-source-code">2.2.27. User uploads source code</h4> <div id="section-ucrestdoc-uc-UC_006" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_006">UC_006-User uploads source code </a></p> </div> @@ -7412,7 +7543,7 @@ <h4 id="user-uploads-source-code">2.2.26. User uploads source code</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 65. General request information</caption> +<caption class="title">Table 67. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7442,7 +7573,7 @@ <h4 id="user-uploads-source-code">2.2.26. User uploads source code</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 66. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode</caption> +<caption class="title">Table 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7465,6 +7596,27 @@ <h4 id="user-uploads-source-code">2.2.26. User uploads source code</h4> </tbody> </table> <div class="paragraph"> +<p><strong>Query parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>checkSum</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">A sha256 checksum for file upload validation</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> <p><strong>Request headers</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> @@ -7487,7 +7639,7 @@ <h4 id="user-uploads-source-code">2.2.26. User uploads source code</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/dc48eaff-3a7d-414f-82f6-f242dcd9bf74/sourcecode?checkSum=checkSumValue' -i -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/24722135-2100-465e-bcef-4b1dfdae5ffd/sourcecode?checkSum=checkSumValue' -i -X POST \ -H 'Content-Type: multipart/form-data;charset=UTF-8' \ -F 'file=PK �<M test1.txtPK ? @@ -7501,7 +7653,7 @@ <h4 id="user-uploads-source-code">2.2.26. User uploads source code</h4> </div> </div> <div class="sect3"> -<h4 id="user-approves-sechub-job">2.2.27. User approves sechub job</h4> +<h4 id="user-approves-sechub-job">2.2.28. User approves sechub job</h4> <div id="section-ucrestdoc-uc-UC_007" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_007">UC_007-User approves sechub job </a></p> </div> @@ -7509,7 +7661,7 @@ <h4 id="user-approves-sechub-job">2.2.27. User approves sechub job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 67. General request information</caption> +<caption class="title">Table 69. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7539,7 +7691,7 @@ <h4 id="user-approves-sechub-job">2.2.27. User approves sechub job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve</caption> +<caption class="title">Table 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7584,7 +7736,7 @@ <h4 id="user-approves-sechub-job">2.2.27. User approves sechub job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/bb20198d-8bb8-4ff5-961c-4fc6ecddd80d/approve' -i -X PUT \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/64b78b45-b45e-4c2c-8719-bd74688a0e63/approve' -i -X PUT \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -7594,7 +7746,7 @@ <h4 id="user-approves-sechub-job">2.2.27. User approves sechub job</h4> </div> </div> <div class="sect3"> -<h4 id="user-checks-sechub-job-state">2.2.28. User checks sechub job state</h4> +<h4 id="user-checks-sechub-job-state">2.2.29. User checks sechub job state</h4> <div id="section-ucrestdoc-uc-UC_009" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_009">UC_009-User checks sechub job state </a></p> </div> @@ -7602,7 +7754,7 @@ <h4 id="user-checks-sechub-job-state">2.2.28. User checks sechub job state</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 69. General request information</caption> +<caption class="title">Table 71. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7632,7 +7784,7 @@ <h4 id="user-checks-sechub-job-state">2.2.28. User checks sechub job state</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}</caption> +<caption class="title">Table 72. https://localhost:8081/api/project/{projectId}/job/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7736,7 +7888,7 @@ <h4 id="user-checks-sechub-job-state">2.2.28. User checks sechub job state</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/abb3751f-2ca5-4f0c-bae1-04a0e1788550' -i -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/92179639-e089-4894-a4df-14f1e40e453d' -i -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -7745,22 +7897,22 @@ <h4 id="user-checks-sechub-job-state">2.2.28. User checks sechub job state</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">abb3751f-2ca5-4f0c-bae1-04a0e1788550</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">CREATOR1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:44:22.764797265</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:22.764824576</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">result</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">92179639-e089-4894-a4df-14f1e40e453d</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">CREATOR1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:33:44.986322732</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:44.986349833</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">result</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="user-downloads-sechub-job-report">2.2.29. User downloads sechub job report</h4> +<h4 id="user-downloads-sechub-job-report">2.2.30. User downloads sechub job report</h4> <div id="section-ucrestdoc-uc-UC_010" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_010">UC_010-User downloads sechub job report </a></p> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_010-json">2.2.29.1. JSON variant</h5> +<h5 id="section-ucrestdoc-UC_010-json">2.2.30.1. JSON variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 71. General request information</caption> +<caption class="title">Table 73. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7790,7 +7942,7 @@ <h5 id="section-ucrestdoc-UC_010-json">2.2.29.1. JSON variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 72. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> +<caption class="title">Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7820,19 +7972,19 @@ <h5 id="section-ucrestdoc-UC_010-json">2.2.29.1. JSON variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/7a8b89cc-f4dd-44ac-bae6-212bc2dd01d0' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/9df5834d-4dc1-4a96-8995-926fcae88f9d' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/json'</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_010-html">2.2.29.2. HTML variant</h5> +<h5 id="section-ucrestdoc-UC_010-html">2.2.30.2. HTML variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 73. General request information</caption> +<caption class="title">Table 75. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7862,7 +8014,7 @@ <h5 id="section-ucrestdoc-UC_010-html">2.2.29.2. HTML variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> +<caption class="title">Table 76. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -7892,7 +8044,7 @@ <h5 id="section-ucrestdoc-UC_010-html">2.2.29.2. HTML variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/6f4f16d2-8e58-4ed3-b41c-110b74370d7c' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/72362f49-ecbd-4ad6-9961-cacc3a8e11fa' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/xhtml+xml'</code></pre> </div> @@ -7900,7 +8052,7 @@ <h5 id="section-ucrestdoc-UC_010-html">2.2.29.2. HTML variant</h5> </div> </div> <div class="sect3"> -<h4 id="user-marks-false-positives">2.2.30. User marks false positives</h4> +<h4 id="user-marks-false-positives">2.2.31. User marks false positives</h4> <div id="section-ucrestdoc-uc-UC_044" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_044">UC_044-User marks false positives </a></p> </div> @@ -7908,7 +8060,7 @@ <h4 id="user-marks-false-positives">2.2.30. User marks false positives</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 75. General request information</caption> +<caption class="title">Table 77. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -7938,7 +8090,7 @@ <h4 id="user-marks-false-positives">2.2.30. User marks false positives</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 76. https://localhost:8081/api/project/{projectId}/false-positives</caption> +<caption class="title">Table 78. https://localhost:8081/api/project/{projectId}/false-positives</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8074,7 +8226,7 @@ <h4 id="user-marks-false-positives">2.2.30. User marks false positives</h4> </div> </div> <div class="sect3"> -<h4 id="user-unmarks-existing-false-positive-definitons">2.2.31. User unmarks existing false positive definitons</h4> +<h4 id="user-unmarks-existing-false-positive-definitons">2.2.32. User unmarks existing false positive definitons</h4> <div id="section-ucrestdoc-uc-UC_045" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_045">UC_045-User unmarks existing false positive definitons </a></p> </div> @@ -8082,7 +8234,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">2.2.31. User unmarks ex <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 77. General request information</caption> +<caption class="title">Table 79. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8112,7 +8264,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">2.2.31. User unmarks ex <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 78. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}</caption> +<caption class="title">Table 80. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8170,7 +8322,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">2.2.31. User unmarks ex </div> </div> <div class="sect3"> -<h4 id="user-fetches-false-positive-configuration-of-project">2.2.32. User fetches false positive configuration of project</h4> +<h4 id="user-fetches-false-positive-configuration-of-project">2.2.33. User fetches false positive configuration of project</h4> <div id="section-ucrestdoc-uc-UC_046" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_046">UC_046-User fetches false positive configuration of project </a></p> </div> @@ -8178,7 +8330,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">2.2.32. User fetch <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 79. General request information</caption> +<caption class="title">Table 81. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8208,7 +8360,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">2.2.32. User fetch <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 80. https://localhost:8081/api/project/{projectId}/false-positives</caption> +<caption class="title">Table 82. https://localhost:8081/api/project/{projectId}/false-positives</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8431,7 +8583,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">2.2.32. User fetch </div> </div> <div class="sect3"> -<h4 id="user-uploads-binaries">2.2.33. User uploads binaries</h4> +<h4 id="user-uploads-binaries">2.2.34. User uploads binaries</h4> <div id="section-ucrestdoc-uc-UC_069" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_069">UC_069-User uploads binaries </a></p> </div> @@ -8439,7 +8591,7 @@ <h4 id="user-uploads-binaries">2.2.33. User uploads binaries</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 81. General request information</caption> +<caption class="title">Table 83. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8469,7 +8621,7 @@ <h4 id="user-uploads-binaries">2.2.33. User uploads binaries</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 82. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries</caption> +<caption class="title">Table 84. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8520,7 +8672,7 @@ <h4 id="user-uploads-binaries">2.2.33. User uploads binaries</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/b8b8b952-dadf-44b7-9480-c0276657f991/binaries' -i -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/0fd0197f-f865-4068-90ac-fb4a8db4aa30/binaries' -i -X POST \ -H 'Content-Type: multipart/form-data;charset=UTF-8' \ -H 'x-file-size: 10240' \ -F 'file=test1.txt 0000664 0001750 0001750 00000000000 13353454574 012170 0 ustar albert albert ' \ @@ -8533,7 +8685,7 @@ <h4 id="user-uploads-binaries">2.2.33. User uploads binaries</h4> </div> </div> <div class="sect3"> -<h4 id="user-downloads-job-report-in-spdx-format">2.2.34. User downloads job report in SPDX format</h4> +<h4 id="user-downloads-job-report-in-spdx-format">2.2.35. User downloads job report in SPDX format</h4> <div id="section-ucrestdoc-uc-UC_070" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_070">UC_070-User downloads job report in SPDX format </a></p> </div> @@ -8541,7 +8693,7 @@ <h4 id="user-downloads-job-report-in-spdx-format">2.2.34. User downloads job rep <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 83. General request information</caption> +<caption class="title">Table 85. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8571,7 +8723,7 @@ <h4 id="user-downloads-job-report-in-spdx-format">2.2.34. User downloads job rep <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 84. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}</caption> +<caption class="title">Table 86. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8601,14 +8753,14 @@ <h4 id="user-downloads-job-report-in-spdx-format">2.2.34. User downloads job rep </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/spdx/4f730441-ec48-4a4f-ad1d-e57932c4d802' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/spdx/4500d9f1-4df9-413b-bf2f-dd2bc8c9ee09' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/json'</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="user-unmarks-existing-false-positive-project-data-definitons">2.2.35. User unmarks existing false positive project data definitons</h4> +<h4 id="user-unmarks-existing-false-positive-project-data-definitons">2.2.36. User unmarks existing false positive project data definitons</h4> <div id="section-ucrestdoc-uc-UC_078" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_078">UC_078-User unmarks existing false positive project data definitons </a></p> </div> @@ -8616,7 +8768,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">2.2.35. Us <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 85. General request information</caption> +<caption class="title">Table 87. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8646,7 +8798,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">2.2.35. Us <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 86. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}</caption> +<caption class="title">Table 88. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8700,7 +8852,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">2.2.35. Us </div> </div> <div class="sect3"> -<h4 id="user-self-registration">2.2.36. User self registration</h4> +<h4 id="user-self-registration">2.2.37. User self registration</h4> <div id="section-ucrestdoc-uc-UC_001" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_001">UC_001-User self registration </a></p> </div> @@ -8708,7 +8860,7 @@ <h4 id="user-self-registration">2.2.36. User self registration</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 87. General request information</caption> +<caption class="title">Table 89. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8787,7 +8939,7 @@ <h4 id="user-self-registration">2.2.36. User self registration</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-open-user-signups">2.2.37. Admin lists open user signups</h4> +<h4 id="admin-lists-open-user-signups">2.2.38. Admin lists open user signups</h4> <div id="section-ucrestdoc-uc-UC_002" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_002">UC_002-Admin lists open user signups </a></p> </div> @@ -8795,7 +8947,7 @@ <h4 id="admin-lists-open-user-signups">2.2.37. Admin lists open user signups</h4 <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 88. General request information</caption> +<caption class="title">Table 90. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8891,7 +9043,7 @@ <h4 id="admin-lists-open-user-signups">2.2.37. Admin lists open user signups</h4 </div> </div> <div class="sect3"> -<h4 id="admin-applies-self-registration">2.2.38. Admin applies self registration</h4> +<h4 id="admin-applies-self-registration">2.2.39. Admin applies self registration</h4> <div id="section-ucrestdoc-uc-UC_003" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_003">UC_003-Admin applies self registration </a></p> </div> @@ -8899,7 +9051,7 @@ <h4 id="admin-applies-self-registration">2.2.38. Admin applies self registration <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 89. General request information</caption> +<caption class="title">Table 91. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -8929,7 +9081,7 @@ <h4 id="admin-applies-self-registration">2.2.38. Admin applies self registration <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 90. https://localhost:8081/api/admin/signup/accept/{userId}</caption> +<caption class="title">Table 92. https://localhost:8081/api/admin/signup/accept/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -8979,7 +9131,7 @@ <h4 id="admin-applies-self-registration">2.2.38. Admin applies self registration </div> </div> <div class="sect3"> -<h4 id="admin-deletes-user-signup">2.2.39. Admin deletes user signup</h4> +<h4 id="admin-deletes-user-signup">2.2.40. Admin deletes user signup</h4> <div id="section-ucrestdoc-uc-UC_019" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_019">UC_019-Admin deletes user signup </a></p> </div> @@ -8987,7 +9139,7 @@ <h4 id="admin-deletes-user-signup">2.2.39. Admin deletes user signup</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 91. General request information</caption> +<caption class="title">Table 93. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9017,7 +9169,7 @@ <h4 id="admin-deletes-user-signup">2.2.39. Admin deletes user signup</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 92. https://localhost:8081/api/admin/signup/{userId}</caption> +<caption class="title">Table 94. https://localhost:8081/api/admin/signup/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9067,7 +9219,7 @@ <h4 id="admin-deletes-user-signup">2.2.39. Admin deletes user signup</h4> </div> </div> <div class="sect3"> -<h4 id="user-requests-new-api-token">2.2.40. User requests new API token</h4> +<h4 id="user-requests-new-api-token">2.2.41. User requests new API token</h4> <div id="section-ucrestdoc-uc-UC_024" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_024">UC_024-User requests new API token </a></p> </div> @@ -9075,7 +9227,7 @@ <h4 id="user-requests-new-api-token">2.2.40. User requests new API token</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 93. General request information</caption> +<caption class="title">Table 95. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9105,7 +9257,7 @@ <h4 id="user-requests-new-api-token">2.2.40. User requests new API token</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 94. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}</caption> +<caption class="title">Table 96. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9141,7 +9293,7 @@ <h4 id="user-requests-new-api-token">2.2.40. User requests new API token</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-all-running-jobs">2.2.41. Admin lists all running jobs</h4> +<h4 id="admin-lists-all-running-jobs">2.2.42. Admin lists all running jobs</h4> <div id="section-ucrestdoc-uc-UC_023" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_023">UC_023-Admin lists all running jobs </a></p> </div> @@ -9149,7 +9301,7 @@ <h4 id="admin-lists-all-running-jobs">2.2.41. Admin lists all running jobs</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 95. General request information</caption> +<caption class="title">Table 97. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9251,12 +9403,12 @@ <h4 id="admin-lists-all-running-jobs">2.2.41. Admin lists all running jobs</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">aa8cee6d-756f-414d-8134-3159bdd75f44</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project-name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">owner-userid</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">RUNNING</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">since</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:27.703658282</span><span class="delimiter">"</span></span>}]</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a8503241-c02c-4722-afce-7a54eb0e7ea0</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project-name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">owner-userid</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">RUNNING</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">since</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:49.769371918</span><span class="delimiter">"</span></span>}]</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-cancels-a-job">2.2.42. Admin cancels a job</h4> +<h4 id="admin-cancels-a-job">2.2.43. Admin cancels a job</h4> <div id="section-ucrestdoc-uc-UC_034" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_034">UC_034-Admin cancels a job </a></p> </div> @@ -9264,7 +9416,7 @@ <h4 id="admin-cancels-a-job">2.2.42. Admin cancels a job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 96. General request information</caption> +<caption class="title">Table 98. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9294,7 +9446,7 @@ <h4 id="admin-cancels-a-job">2.2.42. Admin cancels a job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 97. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}</caption> +<caption class="title">Table 99. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9335,7 +9487,7 @@ <h4 id="admin-cancels-a-job">2.2.42. Admin cancels a job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/cancel/92f9bfd4-051b-455b-b7b8-ffc1f6db45f6' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/cancel/e520e1f5-60b5-45d0-abeb-d9267c54474b' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -9345,7 +9497,7 @@ <h4 id="admin-cancels-a-job">2.2.42. Admin cancels a job</h4> </div> </div> <div class="sect3"> -<h4 id="admin-restarts-a-job">2.2.43. Admin restarts a job</h4> +<h4 id="admin-restarts-a-job">2.2.44. Admin restarts a job</h4> <div id="section-ucrestdoc-uc-UC_041" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_041">UC_041-Admin restarts a job </a></p> </div> @@ -9353,7 +9505,7 @@ <h4 id="admin-restarts-a-job">2.2.43. Admin restarts a job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 98. General request information</caption> +<caption class="title">Table 100. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9383,7 +9535,7 @@ <h4 id="admin-restarts-a-job">2.2.43. Admin restarts a job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 99. https://localhost:8081/api/admin/jobs/restart/{jobUUID}</caption> +<caption class="title">Table 101. https://localhost:8081/api/admin/jobs/restart/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9424,7 +9576,7 @@ <h4 id="admin-restarts-a-job">2.2.43. Admin restarts a job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart/be57747a-0731-4a35-ab3a-722e4f454077' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart/3c1f4235-016f-4246-bcfd-21531b315fe6' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -9434,7 +9586,7 @@ <h4 id="admin-restarts-a-job">2.2.43. Admin restarts a job</h4> </div> </div> <div class="sect3"> -<h4 id="admin-restarts-a-job-hard">2.2.44. Admin restarts a job (hard)</h4> +<h4 id="admin-restarts-a-job-hard">2.2.45. Admin restarts a job (hard)</h4> <div id="section-ucrestdoc-uc-UC_042" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_042">UC_042-Admin restarts a job (hard) </a></p> </div> @@ -9442,7 +9594,7 @@ <h4 id="admin-restarts-a-job-hard">2.2.44. Admin restarts a job (hard)</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 100. General request information</caption> +<caption class="title">Table 102. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9472,7 +9624,7 @@ <h4 id="admin-restarts-a-job-hard">2.2.44. Admin restarts a job (hard)</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 101. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}</caption> +<caption class="title">Table 103. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9513,7 +9665,7 @@ <h4 id="admin-restarts-a-job-hard">2.2.44. Admin restarts a job (hard)</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/c9aea17c-1fe0-4c11-b1c5-fe21aa3ec9bb' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/e2e059a8-c340-4c1d-b68e-921fc0bd5c9c' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -9523,7 +9675,7 @@ <h4 id="admin-restarts-a-job-hard">2.2.44. Admin restarts a job (hard)</h4> </div> </div> <div class="sect3"> -<h4 id="user-defines-mock-data-configuration-for-project">2.2.45. User defines mock data configuration for project</h4> +<h4 id="user-defines-mock-data-configuration-for-project">2.2.46. User defines mock data configuration for project</h4> <div id="section-ucrestdoc-uc-UC_035" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_035">UC_035-User defines mock data configuration for project </a></p> </div> @@ -9531,7 +9683,7 @@ <h4 id="user-defines-mock-data-configuration-for-project">2.2.45. User defines m <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 102. General request information</caption> +<caption class="title">Table 104. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9592,7 +9744,7 @@ <h4 id="user-defines-mock-data-configuration-for-project">2.2.45. User defines m </div> </div> <div class="sect3"> -<h4 id="user-retrieves-mock-data-configuration-for-project">2.2.46. User retrieves mock data configuration for project</h4> +<h4 id="user-retrieves-mock-data-configuration-for-project">2.2.47. User retrieves mock data configuration for project</h4> <div id="section-ucrestdoc-uc-UC_036" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_036">UC_036-User retrieves mock data configuration for project </a></p> </div> @@ -9600,7 +9752,7 @@ <h4 id="user-retrieves-mock-data-configuration-for-project">2.2.46. User retriev <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 103. General request information</caption> +<caption class="title">Table 105. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9664,7 +9816,7 @@ <h4 id="user-retrieves-mock-data-configuration-for-project">2.2.46. User retriev </div> </div> <div class="sect3"> -<h4 id="admin-updates-mapping-configuration">2.2.47. Admin updates mapping configuration</h4> +<h4 id="admin-updates-mapping-configuration">2.2.48. Admin updates mapping configuration</h4> <div id="section-ucrestdoc-uc-UC_037" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_037">UC_037-Admin updates mapping configuration </a></p> </div> @@ -9672,7 +9824,7 @@ <h4 id="admin-updates-mapping-configuration">2.2.47. Admin updates mapping confi <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 104. General request information</caption> +<caption class="title">Table 106. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9702,7 +9854,7 @@ <h4 id="admin-updates-mapping-configuration">2.2.47. Admin updates mapping confi <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 105. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> +<caption class="title">Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9788,7 +9940,7 @@ <h4 id="admin-updates-mapping-configuration">2.2.47. Admin updates mapping confi </div> </div> <div class="sect3"> -<h4 id="admin-fetches-mapping-configuration">2.2.48. Admin fetches mapping configuration</h4> +<h4 id="admin-fetches-mapping-configuration">2.2.49. Admin fetches mapping configuration</h4> <div id="section-ucrestdoc-uc-UC_038" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_038">UC_038-Admin fetches mapping configuration </a></p> </div> @@ -9796,7 +9948,7 @@ <h4 id="admin-fetches-mapping-configuration">2.2.48. Admin fetches mapping confi <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 106. General request information</caption> +<caption class="title">Table 108. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -9826,7 +9978,7 @@ <h4 id="admin-fetches-mapping-configuration">2.2.48. Admin fetches mapping confi <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> +<caption class="title">Table 109. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -9915,7 +10067,7 @@ <h4 id="admin-fetches-mapping-configuration">2.2.48. Admin fetches mapping confi </div> </div> <div class="sect3"> -<h4 id="admin-creates-an-executor-configuration">2.2.49. Admin creates an executor configuration</h4> +<h4 id="admin-creates-an-executor-configuration">2.2.50. Admin creates an executor configuration</h4> <div id="section-ucrestdoc-uc-UC_047" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_047">UC_047-Admin creates an executor configuration </a></p> </div> @@ -9923,7 +10075,7 @@ <h4 id="admin-creates-an-executor-configuration">2.2.49. Admin creates an execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 108. General request information</caption> +<caption class="title">Table 110. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10046,12 +10198,12 @@ <h4 id="admin-creates-an-executor-configuration">2.2.49. Admin creates an execut </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="plain">85aa1ed2-4c62-41e0-90b8-5aaccda85f11</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="plain">b922b3e7-3416-4d74-8b1a-81fbe61a3f63</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-deletes-executor-configuration">2.2.50. Admin deletes executor configuration</h4> +<h4 id="admin-deletes-executor-configuration">2.2.51. Admin deletes executor configuration</h4> <div id="section-ucrestdoc-uc-UC_048" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_048">UC_048-Admin deletes executor configuration </a></p> </div> @@ -10059,7 +10211,7 @@ <h4 id="admin-deletes-executor-configuration">2.2.50. Admin deletes executor con <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 109. General request information</caption> +<caption class="title">Table 111. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10089,7 +10241,7 @@ <h4 id="admin-deletes-executor-configuration">2.2.50. Admin deletes executor con <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 110. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 112. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10130,7 +10282,7 @@ <h4 id="admin-deletes-executor-configuration">2.2.50. Admin deletes executor con </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/01252350-78be-4eed-8103-d4c8dadcb1d5' -i -u 'user:secret' -X DELETE \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/4cfe54a8-c2ce-4bef-b96b-a047a5c4c38f' -i -u 'user:secret' -X DELETE \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -10140,7 +10292,7 @@ <h4 id="admin-deletes-executor-configuration">2.2.50. Admin deletes executor con </div> </div> <div class="sect3"> -<h4 id="admin-fetches-executor-configuration-list">2.2.51. Admin fetches executor configuration list</h4> +<h4 id="admin-fetches-executor-configuration-list">2.2.52. Admin fetches executor configuration list</h4> <div id="section-ucrestdoc-uc-UC_049" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_049">UC_049-Admin fetches executor configuration list </a></p> </div> @@ -10148,7 +10300,7 @@ <h4 id="admin-fetches-executor-configuration-list">2.2.51. Admin fetches executo <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 111. General request information</caption> +<caption class="title">Table 113. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10245,12 +10397,12 @@ <h4 id="admin-fetches-executor-configuration-list">2.2.51. Admin fetches executo </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">executorConfigurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">decbe618-fb22-42fd-ad28-9a98d629f981</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example configuration</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>}],<span class="key"><span class="delimiter">"</span><span class="content">type</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">executorConfigurationList</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">executorConfigurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">fd85ad57-94c1-4671-a1ea-100fcb679201</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example configuration</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>}],<span class="key"><span class="delimiter">"</span><span class="content">type</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">executorConfigurationList</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-fetches-executor-configuration">2.2.52. Admin fetches executor configuration</h4> +<h4 id="admin-fetches-executor-configuration">2.2.53. Admin fetches executor configuration</h4> <div id="section-ucrestdoc-uc-UC_050" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_050">UC_050-Admin fetches executor configuration </a></p> </div> @@ -10258,7 +10410,7 @@ <h4 id="admin-fetches-executor-configuration">2.2.52. Admin fetches executor con <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 112. General request information</caption> +<caption class="title">Table 114. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10288,7 +10440,7 @@ <h4 id="admin-fetches-executor-configuration">2.2.52. Admin fetches executor con <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 113. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 115. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10398,7 +10550,7 @@ <h4 id="admin-fetches-executor-configuration">2.2.52. Admin fetches executor con </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/d3da4fff-26ac-424d-a207-4653dbff9ca8' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/cf306d66-846b-4bc2-a66e-5b60055aaa70' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -10407,12 +10559,12 @@ <h4 id="admin-fetches-executor-configuration">2.2.52. Admin fetches executor con </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d3da4fff-26ac-424d-a207-4653dbff9ca8</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">cf306d66-846b-4bc2-a66e-5b60055aaa70</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-updates-executor-configuration-setup">2.2.53. Admin updates executor configuration setup</h4> +<h4 id="admin-updates-executor-configuration-setup">2.2.54. Admin updates executor configuration setup</h4> <div id="section-ucrestdoc-uc-UC_051" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_051">UC_051-Admin updates executor configuration setup </a></p> </div> @@ -10420,7 +10572,7 @@ <h4 id="admin-updates-executor-configuration-setup">2.2.53. Admin updates execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 114. General request information</caption> +<caption class="title">Table 116. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10450,7 +10602,7 @@ <h4 id="admin-updates-executor-configuration-setup">2.2.53. Admin updates execut <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 115. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 117. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10555,7 +10707,7 @@ <h4 id="admin-updates-executor-configuration-setup">2.2.53. Admin updates execut </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/150289d5-3831-4eac-80ed-337c2ff30949' -i -u 'user:secret' -X PUT \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/35803fed-b7b0-4bd8-9387-4773ab128a43' -i -u 'user:secret' -X PUT \ -H 'Content-Type: application/json;charset=UTF-8' \ -d '{"name":"New name","productIdentifier":"PDS_CODESCAN","executorVersion":1,"enabled":false,"setup":{"baseURL":"https://productNew.example.com","credentials":{"user":"env:EXAMPLE_NEW_USENAME","password":"env:EXAMPLE_NEW_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]}}'</code></pre> </div> @@ -10566,7 +10718,7 @@ <h4 id="admin-updates-executor-configuration-setup">2.2.53. Admin updates execut </div> </div> <div class="sect3"> -<h4 id="admin-creates-an-execution-profile">2.2.54. Admin creates an execution profile</h4> +<h4 id="admin-creates-an-execution-profile">2.2.55. Admin creates an execution profile</h4> <div id="section-ucrestdoc-uc-UC_052" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_052">UC_052-Admin creates an execution profile </a></p> </div> @@ -10574,7 +10726,7 @@ <h4 id="admin-creates-an-execution-profile">2.2.54. Admin creates an execution p <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 116. General request information</caption> +<caption class="title">Table 118. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10604,7 +10756,7 @@ <h4 id="admin-creates-an-execution-profile">2.2.54. Admin creates an execution p <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 117. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10695,7 +10847,7 @@ <h4 id="admin-creates-an-execution-profile">2.2.54. Admin creates an execution p </div> </div> <div class="sect3"> -<h4 id="admin-deletes-execution-profile">2.2.55. Admin deletes execution profile</h4> +<h4 id="admin-deletes-execution-profile">2.2.56. Admin deletes execution profile</h4> <div id="section-ucrestdoc-uc-UC_053" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_053">UC_053-Admin deletes execution profile </a></p> </div> @@ -10703,7 +10855,7 @@ <h4 id="admin-deletes-execution-profile">2.2.55. Admin deletes execution profile <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 118. General request information</caption> +<caption class="title">Table 120. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10733,7 +10885,7 @@ <h4 id="admin-deletes-execution-profile">2.2.55. Admin deletes execution profile <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10784,7 +10936,7 @@ <h4 id="admin-deletes-execution-profile">2.2.55. Admin deletes execution profile </div> </div> <div class="sect3"> -<h4 id="admin-updates-execution-profile">2.2.56. Admin updates execution profile</h4> +<h4 id="admin-updates-execution-profile">2.2.57. Admin updates execution profile</h4> <div id="section-ucrestdoc-uc-UC_054" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_054">UC_054-Admin updates execution profile </a></p> </div> @@ -10792,7 +10944,7 @@ <h4 id="admin-updates-execution-profile">2.2.56. Admin updates execution profile <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 120. General request information</caption> +<caption class="title">Table 122. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10822,7 +10974,7 @@ <h4 id="admin-updates-execution-profile">2.2.56. Admin updates execution profile <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -10899,7 +11051,7 @@ <h4 id="admin-updates-execution-profile">2.2.56. Admin updates execution profile <div class="content"> <pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/execution/profile/existing-profile-1' -i -u 'user:secret' -X PUT \ -H 'Content-Type: application/json;charset=UTF-8' \ - -d '{"description":"changed description","configurations":[{"uuid":"c0948480-f711-4330-93c3-8167dc71b564","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'</code></pre> + -d '{"description":"changed description","configurations":[{"uuid":"5a8e548a-169d-4642-8d2d-00bed1357847","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'</code></pre> </div> </div> <div class="paragraph"> @@ -10908,7 +11060,7 @@ <h4 id="admin-updates-execution-profile">2.2.56. Admin updates execution profile </div> </div> <div class="sect3"> -<h4 id="admin-fetches-execution-profile">2.2.57. Admin fetches execution profile</h4> +<h4 id="admin-fetches-execution-profile">2.2.58. Admin fetches execution profile</h4> <div id="section-ucrestdoc-uc-UC_055" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_055">UC_055-Admin fetches execution profile </a></p> </div> @@ -10916,7 +11068,7 @@ <h4 id="admin-fetches-execution-profile">2.2.57. Admin fetches execution profile <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 122. General request information</caption> +<caption class="title">Table 124. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -10946,7 +11098,7 @@ <h4 id="admin-fetches-execution-profile">2.2.57. Admin fetches execution profile <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 125. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11055,12 +11207,12 @@ <h4 id="admin-fetches-execution-profile">2.2.57. Admin fetches execution profile </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a description</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>,<span class="key"><span class="delimiter">"</span><span class="content">configurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">f8dd3854-ae30-450a-828a-1b715bcd57d3</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value but changed. Remark: the other parameter (example.key2) has been removed by this call</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}],<span class="key"><span class="delimiter">"</span><span class="content">projectIds</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">project-1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">project-2</span><span class="delimiter">"</span></span>]}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a description</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>,<span class="key"><span class="delimiter">"</span><span class="content">configurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">006a3f33-85f6-4586-a509-5ef17c40004b</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value but changed. Remark: the other parameter (example.key2) has been removed by this call</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}],<span class="key"><span class="delimiter">"</span><span class="content">projectIds</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">project-1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">project-2</span><span class="delimiter">"</span></span>]}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-fetches-execution-profile-list">2.2.58. Admin fetches execution profile list</h4> +<h4 id="admin-fetches-execution-profile-list">2.2.59. Admin fetches execution profile list</h4> <div id="section-ucrestdoc-uc-UC_056" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_056">UC_056-Admin fetches execution profile list </a></p> </div> @@ -11068,7 +11220,7 @@ <h4 id="admin-fetches-execution-profile-list">2.2.58. Admin fetches execution pr <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 124. General request information</caption> +<caption class="title">Table 126. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11170,7 +11322,7 @@ <h4 id="admin-fetches-execution-profile-list">2.2.58. Admin fetches execution pr </div> </div> <div class="sect3"> -<h4 id="admin-assigns-execution-profile-to-project">2.2.59. Admin assigns execution profile to project</h4> +<h4 id="admin-assigns-execution-profile-to-project">2.2.60. Admin assigns execution profile to project</h4> <div id="section-ucrestdoc-uc-UC_057" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_057">UC_057-Admin assigns execution profile to project </a></p> </div> @@ -11178,7 +11330,7 @@ <h4 id="admin-assigns-execution-profile-to-project">2.2.59. Admin assigns execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 125. General request information</caption> +<caption class="title">Table 127. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11208,7 +11360,7 @@ <h4 id="admin-assigns-execution-profile-to-project">2.2.59. Admin assigns execut <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 126. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> +<caption class="title">Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11263,7 +11415,7 @@ <h4 id="admin-assigns-execution-profile-to-project">2.2.59. Admin assigns execut </div> </div> <div class="sect3"> -<h4 id="admin-unassigns-execution-profile-from-project">2.2.60. Admin unassigns execution profile from project</h4> +<h4 id="admin-unassigns-execution-profile-from-project">2.2.61. Admin unassigns execution profile from project</h4> <div id="section-ucrestdoc-uc-UC_058" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_058">UC_058-Admin unassigns execution profile from project </a></p> </div> @@ -11271,7 +11423,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">2.2.60. Admin unassigns <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 127. General request information</caption> +<caption class="title">Table 129. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11301,7 +11453,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">2.2.60. Admin unassigns <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> +<caption class="title">Table 130. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -11356,7 +11508,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">2.2.60. Admin unassigns </div> </div> <div class="sect3"> -<h4 id="admin-fetches-auto-cleanup-configuration">2.2.61. Admin fetches auto cleanup configuration</h4> +<h4 id="admin-fetches-auto-cleanup-configuration">2.2.62. Admin fetches auto cleanup configuration</h4> <div id="section-ucrestdoc-uc-UC_064" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_064">UC_064-Admin fetches auto cleanup configuration </a></p> </div> @@ -11364,7 +11516,7 @@ <h4 id="admin-fetches-auto-cleanup-configuration">2.2.61. Admin fetches auto cle <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 129. General request information</caption> +<caption class="title">Table 131. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11427,7 +11579,7 @@ <h4 id="admin-fetches-auto-cleanup-configuration">2.2.61. Admin fetches auto cle </div> </div> <div class="sect3"> -<h4 id="admin-updates-auto-cleanup-configuration">2.2.62. Admin updates auto cleanup configuration</h4> +<h4 id="admin-updates-auto-cleanup-configuration">2.2.63. Admin updates auto cleanup configuration</h4> <div id="section-ucrestdoc-uc-UC_065" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_065">UC_065-Admin updates auto cleanup configuration </a></p> </div> @@ -11435,7 +11587,7 @@ <h4 id="admin-updates-auto-cleanup-configuration">2.2.62. Admin updates auto cle <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 130. General request information</caption> +<caption class="title">Table 132. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11495,7 +11647,7 @@ <h4 id="admin-updates-auto-cleanup-configuration">2.2.62. Admin updates auto cle </div> </div> <div class="sect3"> -<h4 id="admin-starts-encryption-rotation">2.2.63. Admin starts encryption rotation</h4> +<h4 id="admin-starts-encryption-rotation">2.2.64. Admin starts encryption rotation</h4> <div id="section-ucrestdoc-uc-UC_073" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_073">UC_073-Admin starts encryption rotation </a></p> </div> @@ -11503,7 +11655,7 @@ <h4 id="admin-starts-encryption-rotation">2.2.63. Admin starts encryption rotati <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 131. General request information</caption> +<caption class="title">Table 133. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11567,7 +11719,7 @@ <h4 id="admin-starts-encryption-rotation">2.2.63. Admin starts encryption rotati </div> </div> <div class="sect3"> -<h4 id="admin-fetches-encryption-status">2.2.64. Admin fetches encryption status</h4> +<h4 id="admin-fetches-encryption-status">2.2.65. Admin fetches encryption status</h4> <div id="section-ucrestdoc-uc-UC_076" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_076">UC_076-Admin fetches encryption status </a></p> </div> @@ -11575,7 +11727,7 @@ <h4 id="admin-fetches-encryption-status">2.2.64. Admin fetches encryption status <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 132. General request information</caption> +<caption class="title">Table 134. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11707,7 +11859,7 @@ <h4 id="admin-fetches-encryption-status">2.2.64. Admin fetches encryption status </div> </div> <div class="sect3"> -<h4 id="admin-disables-job-processing-in-scheduler">2.2.65. Admin disables job processing in scheduler</h4> +<h4 id="admin-disables-job-processing-in-scheduler">2.2.66. Admin disables job processing in scheduler</h4> <div id="section-ucrestdoc-uc-UC_030" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_030">UC_030-Admin disables job processing in scheduler </a></p> </div> @@ -11715,7 +11867,7 @@ <h4 id="admin-disables-job-processing-in-scheduler">2.2.65. Admin disables job p <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 133. General request information</caption> +<caption class="title">Table 135. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11774,7 +11926,7 @@ <h4 id="admin-disables-job-processing-in-scheduler">2.2.65. Admin disables job p </div> </div> <div class="sect3"> -<h4 id="admin-enables-scheduler-job-processing">2.2.66. Admin enables scheduler job processing</h4> +<h4 id="admin-enables-scheduler-job-processing">2.2.67. Admin enables scheduler job processing</h4> <div id="section-ucrestdoc-uc-UC_031" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_031">UC_031-Admin enables scheduler job processing </a></p> </div> @@ -11782,7 +11934,7 @@ <h4 id="admin-enables-scheduler-job-processing">2.2.66. Admin enables scheduler <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 134. General request information</caption> +<caption class="title">Table 136. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11841,7 +11993,7 @@ <h4 id="admin-enables-scheduler-job-processing">2.2.66. Admin enables scheduler </div> </div> <div class="sect3"> -<h4 id="admin-get-scheduler-status">2.2.67. Admin get scheduler status</h4> +<h4 id="admin-get-scheduler-status">2.2.68. Admin get scheduler status</h4> <div id="section-ucrestdoc-uc-UC_032" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_032">UC_032-Admin get scheduler status </a></p> </div> @@ -11849,7 +12001,7 @@ <h4 id="admin-get-scheduler-status">2.2.67. Admin get scheduler status</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 135. General request information</caption> +<caption class="title">Table 137. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -11908,7 +12060,7 @@ <h4 id="admin-get-scheduler-status">2.2.67. Admin get scheduler status</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-status-information">2.2.68. Admin lists status information</h4> +<h4 id="admin-lists-status-information">2.2.69. Admin lists status information</h4> <div id="section-ucrestdoc-uc-UC_033" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_033">UC_033-Admin lists status information </a></p> </div> @@ -11916,7 +12068,7 @@ <h4 id="admin-lists-status-information">2.2.68. Admin lists status information</ <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 136. General request information</caption> +<caption class="title">Table 138. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12008,7 +12160,7 @@ <h4 id="admin-lists-status-information">2.2.68. Admin lists status information</ </div> </div> <div class="sect3"> -<h4 id="admin-fetches-server-runtime-data">2.2.69. Admin fetches server runtime data</h4> +<h4 id="admin-fetches-server-runtime-data">2.2.70. Admin fetches server runtime data</h4> <div id="section-ucrestdoc-uc-UC_040" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_040">UC_040-Admin fetches server runtime data </a></p> </div> @@ -12016,7 +12168,7 @@ <h4 id="admin-fetches-server-runtime-data">2.2.69. Admin fetches server runtime <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 137. General request information</caption> +<caption class="title">Table 139. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12088,7 +12240,7 @@ <h4 id="admin-fetches-server-runtime-data">2.2.69. Admin fetches server runtime </div> </div> <div class="sect3"> -<h4 id="user-lists-jobs-for-project">2.2.70. User lists jobs for project</h4> +<h4 id="user-lists-jobs-for-project">2.2.71. User lists jobs for project</h4> <div id="section-ucrestdoc-uc-UC_071" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_071">UC_071-User lists jobs for project </a></p> </div> @@ -12096,7 +12248,7 @@ <h4 id="user-lists-jobs-for-project">2.2.70. User lists jobs for project</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 138. General request information</caption> +<caption class="title">Table 140. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -12126,7 +12278,7 @@ <h4 id="user-lists-jobs-for-project">2.2.70. User lists jobs for project</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 139. https://localhost:8081/api/project/{projectId}/jobs</caption> +<caption class="title">Table 141. https://localhost:8081/api/project/{projectId}/jobs</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -12145,6 +12297,41 @@ <h4 id="user-lists-jobs-for-project">2.2.70. User lists jobs for project</h4> </tbody> </table> <div class="paragraph"> +<p><strong>Query parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The wanted (maximum) size for the result set. When not defined, the default will be 1.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>page</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The wanted page number. When not defined, the default will be 0.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.labels.*</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An optional dynamic query parameter to filter jobs by labels. The syntax is 'metadata.labels.${labelKey}=${labelValue}'.</p> +<p class="tableblock">It is possible to query for multiple labels (up to 10 ). +The filter works as an AND combination: Only jobs having all wanted label key value combinations are returned.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>withMetaData</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An optional parameter to define if meta data shall be fetched as well. When not defined, the default will be false.</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> <p><strong>Request headers</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> @@ -12250,7 +12437,7 @@ <h4 id="user-lists-jobs-for-project">2.2.70. User lists jobs for project</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">page</span><span class="delimiter">"</span></span>:<span class="integer">0</span>,<span class="key"><span class="delimiter">"</span><span class="content">totalPages</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">4fc54538-9eab-4eb5-9da4-9d1cc0897760</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">User1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:42:22.956477277</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:44:22.956508736</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:22.956525658</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionState</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionResult</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">metaData</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">labels</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">stage</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}}}]}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">page</span><span class="delimiter">"</span></span>:<span class="integer">0</span>,<span class="key"><span class="delimiter">"</span><span class="content">totalPages</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">8d080df1-24cd-470f-b8bd-845baf4b7d60</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">User1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:31:45.196835109</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:33:45.196866799</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:45.19687809</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionState</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionResult</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">metaData</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">labels</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">stage</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}}}]}</code></pre> </div> </div> <div style="page-break-after: always;"></div> @@ -12603,6 +12790,9 @@ <h5 id="project-administration-2">4.1.1.3. Project administration</h5> <li> <p><a href="#section-usecase-UC_062">UC_062-Admin changes project access level</a></p> </li> +<li> +<p><a href="#section-usecase-UC_081">UC_081-get assigned project data</a></p> +</li> </ul> </div> </div> @@ -17706,10 +17896,70 @@ <h4 id="section-usecase-UC_080">4.1.81. UC_080-System resumes suspended jobs</h4 </tr> </tbody> </table> +</div> +<div class="sect3"> +<h4 id="section-usecase-UC_081">4.1.82. UC_081-get assigned project data</h4> +<div class="paragraph"> +<p>User, Owner or Admin fetches a list containing information about assigned and/ or owned projects.</p> +</div> +<div class="paragraph"> +<p>The Project data contains the following information:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>Project ID</p> +</li> +<li> +<p>Owner</p> +</li> +<li> +<p>is owned</p> +</li> +<li> +<p>assigned users (can only be viewed by owner or admin)</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>A project user can see only projects he is assigned to. +A project owner can see all projects he owns and the assigned users. +A project admin can see assigned or owned projects and all assigned users.</p> +</div> +<div class="paragraph"> +<p><strong>Steps</strong></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 5%;"> +<col style="width: 20%;"> +<col style="width: 20%;"> +<col style="width: 5%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Nr</th> +<th class="tableblock halign-left valign-top">Title</th> +<th class="tableblock halign-left valign-top">Role(s)</th> +<th class="tableblock halign-left valign-top">Next</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Rest API call to get Projects with information</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">OWNER, SUPERADMIN, USER</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Rest api call to get projects with details</p></td> +</tr> +</tbody> +</table> <div class="sect4"> -<h5 id="section-gen-messaging-overview">4.1.81.1. Overview</h5> +<h5 id="section-gen-messaging-overview">4.1.82.1. Overview</h5> <div class="sect5"> -<h6 id="diagram">4.1.81.1.1. Diagram</h6> +<h6 id="diagram">4.1.82.1.1. Diagram</h6> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_overview.svg" alt="Sequence diagram of messaging overview" width="955" height="4231"> @@ -17717,7 +17967,7 @@ <h6 id="diagram">4.1.81.1.1. Diagram</h6> </div> </div> <div class="sect5"> -<h6 id="section-gen-messaging-overview-linklist">4.1.81.1.2. List of all messages</h6> +<h6 id="section-gen-messaging-overview-linklist">4.1.82.1.2. List of all messages</h6> <div class="ulist"> <ul> <li> @@ -17896,7 +18146,7 @@ <h6 id="section-gen-messaging-overview-linklist">4.1.81.1.2. List of all message </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-analyze_scan_results_available">4.1.81.2. Message ANALYZE_SCAN_RESULTS_AVAILABLE</h5> +<h5 id="section-gen-messaging-analyze_scan_results_available">4.1.82.2. Message ANALYZE_SCAN_RESULTS_AVAILABLE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_analyze_scan_results_available.svg" alt="Sequence diagram of messaging ANALYZE_SCAN_RESULTS_AVAILABLE" width="732" height="176"> @@ -17904,7 +18154,7 @@ <h5 id="section-gen-messaging-analyze_scan_results_available">4.1.81.2. Message </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-auto_cleanup_configuration_changed">4.1.81.3. Message AUTO_CLEANUP_CONFIGURATION_CHANGED</h5> +<h5 id="section-gen-messaging-auto_cleanup_configuration_changed">4.1.82.3. Message AUTO_CLEANUP_CONFIGURATION_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_auto_cleanup_configuration_changed.svg" alt="Sequence diagram of messaging AUTO_CLEANUP_CONFIGURATION_CHANGED" width="1140" height="234"> @@ -17933,7 +18183,7 @@ <h5 id="section-gen-messaging-auto_cleanup_configuration_changed">4.1.81.3. Mess </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-binary_upload_done">4.1.81.4. Message BINARY_UPLOAD_DONE</h5> +<h5 id="section-gen-messaging-binary_upload_done">4.1.82.4. Message BINARY_UPLOAD_DONE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_binary_upload_done.svg" alt="Sequence diagram of messaging BINARY_UPLOAD_DONE" width="592" height="176"> @@ -17941,7 +18191,7 @@ <h5 id="section-gen-messaging-binary_upload_done">4.1.81.4. Message BINARY_UPLOA </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-get_encryption_status_schedule_domain">4.1.81.5. Message GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</h5> +<h5 id="section-gen-messaging-get_encryption_status_schedule_domain">4.1.82.5. Message GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_get_encryption_status_schedule_domain.svg" alt="Sequence diagram of messaging GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN" width="833" height="234"> @@ -17949,7 +18199,7 @@ <h5 id="section-gen-messaging-get_encryption_status_schedule_domain">4.1.81.5. M </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_cancellation_running">4.1.81.6. Message JOB_CANCELLATION_RUNNING</h5> +<h5 id="section-gen-messaging-job_cancellation_running">4.1.82.6. Message JOB_CANCELLATION_RUNNING</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_cancellation_running.svg" alt="Sequence diagram of messaging JOB_CANCELLATION_RUNNING" width="859" height="205"> @@ -17957,7 +18207,7 @@ <h5 id="section-gen-messaging-job_cancellation_running">4.1.81.6. Message JOB_CA </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_created">4.1.81.7. Message JOB_CREATED</h5> +<h5 id="section-gen-messaging-job_created">4.1.82.7. Message JOB_CREATED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_created.svg" alt="Sequence diagram of messaging JOB_CREATED" width="493" height="176"> @@ -17965,7 +18215,7 @@ <h5 id="section-gen-messaging-job_created">4.1.81.7. Message JOB_CREATED</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_done">4.1.81.8. Message JOB_DONE</h5> +<h5 id="section-gen-messaging-job_done">4.1.82.8. Message JOB_DONE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_done.svg" alt="Sequence diagram of messaging JOB_DONE" width="765" height="205"> @@ -17997,7 +18247,7 @@ <h5 id="section-gen-messaging-job_done">4.1.81.8. Message JOB_DONE</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_execution_starting">4.1.81.9. Message JOB_EXECUTION_STARTING</h5> +<h5 id="section-gen-messaging-job_execution_starting">4.1.82.9. Message JOB_EXECUTION_STARTING</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_execution_starting.svg" alt="Sequence diagram of messaging JOB_EXECUTION_STARTING" width="628" height="176"> @@ -18029,7 +18279,7 @@ <h5 id="section-gen-messaging-job_execution_starting">4.1.81.9. Message JOB_EXEC </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_failed">4.1.81.10. Message JOB_FAILED</h5> +<h5 id="section-gen-messaging-job_failed">4.1.82.10. Message JOB_FAILED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_failed.svg" alt="Sequence diagram of messaging JOB_FAILED" width="765" height="205"> @@ -18037,7 +18287,7 @@ <h5 id="section-gen-messaging-job_failed">4.1.81.10. Message JOB_FAILED</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_restart_canceled">4.1.81.11. Message JOB_RESTART_CANCELED</h5> +<h5 id="section-gen-messaging-job_restart_canceled">4.1.82.11. Message JOB_RESTART_CANCELED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_restart_canceled.svg" alt="Sequence diagram of messaging JOB_RESTART_CANCELED" width="606" height="176"> @@ -18069,7 +18319,7 @@ <h5 id="section-gen-messaging-job_restart_canceled">4.1.81.11. Message JOB_RESTA </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_restart_triggered">4.1.81.12. Message JOB_RESTART_TRIGGERED</h5> +<h5 id="section-gen-messaging-job_restart_triggered">4.1.82.12. Message JOB_RESTART_TRIGGERED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_restart_triggered.svg" alt="Sequence diagram of messaging JOB_RESTART_TRIGGERED" width="617" height="176"> @@ -18101,7 +18351,7 @@ <h5 id="section-gen-messaging-job_restart_triggered">4.1.81.12. Message JOB_REST </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_results_purged">4.1.81.13. Message JOB_RESULTS_PURGED</h5> +<h5 id="section-gen-messaging-job_results_purged">4.1.82.13. Message JOB_RESULTS_PURGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_results_purged.svg" alt="Sequence diagram of messaging JOB_RESULTS_PURGED" width="586" height="176"> @@ -18130,7 +18380,7 @@ <h5 id="section-gen-messaging-job_results_purged">4.1.81.13. Message JOB_RESULTS </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_result_purge_done">4.1.81.14. Message JOB_RESULT_PURGE_DONE</h5> +<h5 id="section-gen-messaging-job_result_purge_done">4.1.82.14. Message JOB_RESULT_PURGE_DONE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_result_purge_done.svg" alt="Sequence diagram of messaging JOB_RESULT_PURGE_DONE" width="624" height="118"> @@ -18138,7 +18388,7 @@ <h5 id="section-gen-messaging-job_result_purge_done">4.1.81.14. Message JOB_RESU </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_result_purge_failed">4.1.81.15. Message JOB_RESULT_PURGE_FAILED</h5> +<h5 id="section-gen-messaging-job_result_purge_failed">4.1.82.15. Message JOB_RESULT_PURGE_FAILED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_result_purge_failed.svg" alt="Sequence diagram of messaging JOB_RESULT_PURGE_FAILED" width="638" height="118"> @@ -18146,7 +18396,7 @@ <h5 id="section-gen-messaging-job_result_purge_failed">4.1.81.15. Message JOB_RE </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_started">4.1.81.16. Message JOB_STARTED</h5> +<h5 id="section-gen-messaging-job_started">4.1.82.16. Message JOB_STARTED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_started.svg" alt="Sequence diagram of messaging JOB_STARTED" width="570" height="176"> @@ -18178,7 +18428,7 @@ <h5 id="section-gen-messaging-job_started">4.1.81.16. Message JOB_STARTED</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-job_suspended">4.1.81.17. Message JOB_SUSPENDED</h5> +<h5 id="section-gen-messaging-job_suspended">4.1.82.17. Message JOB_SUSPENDED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_job_suspended.svg" alt="Sequence diagram of messaging JOB_SUSPENDED" width="571" height="176"> @@ -18186,7 +18436,7 @@ <h5 id="section-gen-messaging-job_suspended">4.1.81.17. Message JOB_SUSPENDED</h </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-mapping_configuration_changed">4.1.81.18. Message MAPPING_CONFIGURATION_CHANGED</h5> +<h5 id="section-gen-messaging-mapping_configuration_changed">4.1.82.18. Message MAPPING_CONFIGURATION_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_mapping_configuration_changed.svg" alt="Sequence diagram of messaging MAPPING_CONFIGURATION_CHANGED" width="739" height="176"> @@ -18194,7 +18444,7 @@ <h5 id="section-gen-messaging-mapping_configuration_changed">4.1.81.18. Message </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-product_executor_cancel_operations_done">4.1.81.19. Message PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE</h5> +<h5 id="section-gen-messaging-product_executor_cancel_operations_done">4.1.82.19. Message PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_product_executor_cancel_operations_done.svg" alt="Sequence diagram of messaging PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE" width="863" height="176"> @@ -18202,7 +18452,7 @@ <h5 id="section-gen-messaging-product_executor_cancel_operations_done">4.1.81.19 </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-project_access_level_changed">4.1.81.20. Message PROJECT_ACCESS_LEVEL_CHANGED</h5> +<h5 id="section-gen-messaging-project_access_level_changed">4.1.82.20. Message PROJECT_ACCESS_LEVEL_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_project_access_level_changed.svg" alt="Sequence diagram of messaging PROJECT_ACCESS_LEVEL_CHANGED" width="868" height="205"> @@ -18210,7 +18460,7 @@ <h5 id="section-gen-messaging-project_access_level_changed">4.1.81.20. Message P </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-project_created">4.1.81.21. Message PROJECT_CREATED</h5> +<h5 id="section-gen-messaging-project_created">4.1.82.21. Message PROJECT_CREATED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_project_created.svg" alt="Sequence diagram of messaging PROJECT_CREATED" width="543" height="176"> @@ -18218,7 +18468,7 @@ <h5 id="section-gen-messaging-project_created">4.1.81.21. Message PROJECT_CREATE </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-project_deleted">4.1.81.22. Message PROJECT_DELETED</h5> +<h5 id="section-gen-messaging-project_deleted">4.1.82.22. Message PROJECT_DELETED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_project_deleted.svg" alt="Sequence diagram of messaging PROJECT_DELETED" width="877" height="234"> @@ -18226,7 +18476,7 @@ <h5 id="section-gen-messaging-project_deleted">4.1.81.22. Message PROJECT_DELETE </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-project_owner_changed">4.1.81.23. Message PROJECT_OWNER_CHANGED</h5> +<h5 id="section-gen-messaging-project_owner_changed">4.1.82.23. Message PROJECT_OWNER_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_project_owner_changed.svg" alt="Sequence diagram of messaging PROJECT_OWNER_CHANGED" width="636" height="176"> @@ -18234,7 +18484,7 @@ <h5 id="section-gen-messaging-project_owner_changed">4.1.81.23. Message PROJECT_ </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-project_whitelist_updated">4.1.81.24. Message PROJECT_WHITELIST_UPDATED</h5> +<h5 id="section-gen-messaging-project_whitelist_updated">4.1.82.24. Message PROJECT_WHITELIST_UPDATED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_project_whitelist_updated.svg" alt="Sequence diagram of messaging PROJECT_WHITELIST_UPDATED" width="667" height="176"> @@ -18242,7 +18492,7 @@ <h5 id="section-gen-messaging-project_whitelist_updated">4.1.81.24. Message PROJ </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_job_cancellation">4.1.81.25. Message REQUEST_JOB_CANCELLATION</h5> +<h5 id="section-gen-messaging-request_job_cancellation">4.1.82.25. Message REQUEST_JOB_CANCELLATION</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_job_cancellation.svg" alt="Sequence diagram of messaging REQUEST_JOB_CANCELLATION" width="656" height="176"> @@ -18250,7 +18500,7 @@ <h5 id="section-gen-messaging-request_job_cancellation">4.1.81.25. Message REQUE </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_job_restart">4.1.81.26. Message REQUEST_JOB_RESTART</h5> +<h5 id="section-gen-messaging-request_job_restart">4.1.82.26. Message REQUEST_JOB_RESTART</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_job_restart.svg" alt="Sequence diagram of messaging REQUEST_JOB_RESTART" width="753" height="205"> @@ -18279,7 +18529,7 @@ <h5 id="section-gen-messaging-request_job_restart">4.1.81.26. Message REQUEST_JO </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_job_restart_hard">4.1.81.27. Message REQUEST_JOB_RESTART_HARD</h5> +<h5 id="section-gen-messaging-request_job_restart_hard">4.1.82.27. Message REQUEST_JOB_RESTART_HARD</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_job_restart_hard.svg" alt="Sequence diagram of messaging REQUEST_JOB_RESTART_HARD" width="663" height="176"> @@ -18308,7 +18558,7 @@ <h5 id="section-gen-messaging-request_job_restart_hard">4.1.81.27. Message REQUE </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_purge_job_results">4.1.81.28. Message REQUEST_PURGE_JOB_RESULTS</h5> +<h5 id="section-gen-messaging-request_purge_job_results">4.1.82.28. Message REQUEST_PURGE_JOB_RESULTS</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_purge_job_results.svg" alt="Sequence diagram of messaging REQUEST_PURGE_JOB_RESULTS" width="674" height="309"> @@ -18337,7 +18587,7 @@ <h5 id="section-gen-messaging-request_purge_job_results">4.1.81.28. Message REQU </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_scheduler_disable_job_processing">4.1.81.29. Message REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING</h5> +<h5 id="section-gen-messaging-request_scheduler_disable_job_processing">4.1.82.29. Message REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_scheduler_disable_job_processing.svg" alt="Sequence diagram of messaging REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING" width="860" height="176"> @@ -18366,7 +18616,7 @@ <h5 id="section-gen-messaging-request_scheduler_disable_job_processing">4.1.81.2 </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_scheduler_enable_job_processing">4.1.81.30. Message REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING</h5> +<h5 id="section-gen-messaging-request_scheduler_enable_job_processing">4.1.82.30. Message REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_scheduler_enable_job_processing.svg" alt="Sequence diagram of messaging REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING" width="852" height="176"> @@ -18395,7 +18645,7 @@ <h5 id="section-gen-messaging-request_scheduler_enable_job_processing">4.1.81.30 </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_scheduler_job_status">4.1.81.31. Message REQUEST_SCHEDULER_JOB_STATUS</h5> +<h5 id="section-gen-messaging-request_scheduler_job_status">4.1.82.31. Message REQUEST_SCHEDULER_JOB_STATUS</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_scheduler_job_status.svg" alt="Sequence diagram of messaging REQUEST_SCHEDULER_JOB_STATUS" width="715" height="234"> @@ -18427,7 +18677,7 @@ <h5 id="section-gen-messaging-request_scheduler_job_status">4.1.81.31. Message R </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_scheduler_status_update">4.1.81.32. Message REQUEST_SCHEDULER_STATUS_UPDATE</h5> +<h5 id="section-gen-messaging-request_scheduler_status_update">4.1.82.32. Message REQUEST_SCHEDULER_STATUS_UPDATE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_scheduler_status_update.svg" alt="Sequence diagram of messaging REQUEST_SCHEDULER_STATUS_UPDATE" width="761" height="176"> @@ -18435,7 +18685,7 @@ <h5 id="section-gen-messaging-request_scheduler_status_update">4.1.81.32. Messag </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-request_user_role_recalculation">4.1.81.33. Message REQUEST_USER_ROLE_RECALCULATION</h5> +<h5 id="section-gen-messaging-request_user_role_recalculation">4.1.82.33. Message REQUEST_USER_ROLE_RECALCULATION</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_request_user_role_recalculation.svg" alt="Sequence diagram of messaging REQUEST_USER_ROLE_RECALCULATION" width="2237" height="380"> @@ -18470,7 +18720,7 @@ <h5 id="section-gen-messaging-request_user_role_recalculation">4.1.81.33. Messag </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-result_encryption_status_schedule_domain">4.1.81.34. Message RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</h5> +<h5 id="section-gen-messaging-result_encryption_status_schedule_domain">4.1.82.34. Message RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_result_encryption_status_schedule_domain.svg" alt="Sequence diagram of messaging RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN" width="871" height="118"> @@ -18478,7 +18728,7 @@ <h5 id="section-gen-messaging-result_encryption_status_schedule_domain">4.1.81.3 </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scan_done">4.1.81.35. Message SCAN_DONE</h5> +<h5 id="section-gen-messaging-scan_done">4.1.82.35. Message SCAN_DONE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scan_done.svg" alt="Sequence diagram of messaging SCAN_DONE" width="477" height="118"> @@ -18486,7 +18736,7 @@ <h5 id="section-gen-messaging-scan_done">4.1.81.35. Message SCAN_DONE</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scan_failed">4.1.81.36. Message SCAN_FAILED</h5> +<h5 id="section-gen-messaging-scan_failed">4.1.82.36. Message SCAN_FAILED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scan_failed.svg" alt="Sequence diagram of messaging SCAN_FAILED" width="491" height="118"> @@ -18494,7 +18744,7 @@ <h5 id="section-gen-messaging-scan_failed">4.1.81.36. Message SCAN_FAILED</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scan_suspended">4.1.81.37. Message SCAN_SUSPENDED</h5> +<h5 id="section-gen-messaging-scan_suspended">4.1.82.37. Message SCAN_SUSPENDED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scan_suspended.svg" alt="Sequence diagram of messaging SCAN_SUSPENDED" width="544" height="118"> @@ -18502,7 +18752,7 @@ <h5 id="section-gen-messaging-scan_suspended">4.1.81.37. Message SCAN_SUSPENDED< </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scheduler_job_processing_disabled">4.1.81.38. Message SCHEDULER_JOB_PROCESSING_DISABLED</h5> +<h5 id="section-gen-messaging-scheduler_job_processing_disabled">4.1.82.38. Message SCHEDULER_JOB_PROCESSING_DISABLED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scheduler_job_processing_disabled.svg" alt="Sequence diagram of messaging SCHEDULER_JOB_PROCESSING_DISABLED" width="972" height="205"> @@ -18531,7 +18781,7 @@ <h5 id="section-gen-messaging-scheduler_job_processing_disabled">4.1.81.38. Mess </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scheduler_job_processing_enabled">4.1.81.39. Message SCHEDULER_JOB_PROCESSING_ENABLED</h5> +<h5 id="section-gen-messaging-scheduler_job_processing_enabled">4.1.82.39. Message SCHEDULER_JOB_PROCESSING_ENABLED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scheduler_job_processing_enabled.svg" alt="Sequence diagram of messaging SCHEDULER_JOB_PROCESSING_ENABLED" width="968" height="205"> @@ -18560,7 +18810,7 @@ <h5 id="section-gen-messaging-scheduler_job_processing_enabled">4.1.81.39. Messa </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scheduler_job_status">4.1.81.40. Message SCHEDULER_JOB_STATUS</h5> +<h5 id="section-gen-messaging-scheduler_job_status">4.1.82.40. Message SCHEDULER_JOB_STATUS</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scheduler_job_status.svg" alt="Sequence diagram of messaging SCHEDULER_JOB_STATUS" width="612" height="118"> @@ -18568,7 +18818,7 @@ <h5 id="section-gen-messaging-scheduler_job_status">4.1.81.40. Message SCHEDULER </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scheduler_started">4.1.81.41. Message SCHEDULER_STARTED</h5> +<h5 id="section-gen-messaging-scheduler_started">4.1.82.41. Message SCHEDULER_STARTED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scheduler_started.svg" alt="Sequence diagram of messaging SCHEDULER_STARTED" width="579" height="176"> @@ -18576,7 +18826,7 @@ <h5 id="section-gen-messaging-scheduler_started">4.1.81.41. Message SCHEDULER_ST </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-scheduler_status_update">4.1.81.42. Message SCHEDULER_STATUS_UPDATE</h5> +<h5 id="section-gen-messaging-scheduler_status_update">4.1.82.42. Message SCHEDULER_STATUS_UPDATE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_scheduler_status_update.svg" alt="Sequence diagram of messaging SCHEDULER_STATUS_UPDATE" width="681" height="176"> @@ -18584,7 +18834,7 @@ <h5 id="section-gen-messaging-scheduler_status_update">4.1.81.42. Message SCHEDU </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-schedule_encryption_pool_initialized">4.1.81.43. Message SCHEDULE_ENCRYPTION_POOL_INITIALIZED</h5> +<h5 id="section-gen-messaging-schedule_encryption_pool_initialized">4.1.82.43. Message SCHEDULE_ENCRYPTION_POOL_INITIALIZED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_schedule_encryption_pool_initialized.svg" alt="Sequence diagram of messaging SCHEDULE_ENCRYPTION_POOL_INITIALIZED" width="794" height="176"> @@ -18592,7 +18842,7 @@ <h5 id="section-gen-messaging-schedule_encryption_pool_initialized">4.1.81.43. M </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-source_upload_done">4.1.81.44. Message SOURCE_UPLOAD_DONE</h5> +<h5 id="section-gen-messaging-source_upload_done">4.1.82.44. Message SOURCE_UPLOAD_DONE</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_source_upload_done.svg" alt="Sequence diagram of messaging SOURCE_UPLOAD_DONE" width="598" height="176"> @@ -18600,7 +18850,7 @@ <h5 id="section-gen-messaging-source_upload_done">4.1.81.44. Message SOURCE_UPLO </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-start_encryption_rotation">4.1.81.45. Message START_ENCRYPTION_ROTATION</h5> +<h5 id="section-gen-messaging-start_encryption_rotation">4.1.82.45. Message START_ENCRYPTION_ROTATION</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_start_encryption_rotation.svg" alt="Sequence diagram of messaging START_ENCRYPTION_ROTATION" width="686" height="176"> @@ -18608,7 +18858,7 @@ <h5 id="section-gen-messaging-start_encryption_rotation">4.1.81.45. Message STAR </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-start_scan">4.1.81.46. Message START_SCAN</h5> +<h5 id="section-gen-messaging-start_scan">4.1.82.46. Message START_SCAN</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_start_scan.svg" alt="Sequence diagram of messaging START_SCAN" width="555" height="397"> @@ -18640,7 +18890,7 @@ <h5 id="section-gen-messaging-start_scan">4.1.81.46. Message START_SCAN</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-unsupported_operation">4.1.81.47. Message UNSUPPORTED_OPERATION</h5> +<h5 id="section-gen-messaging-unsupported_operation">4.1.82.47. Message UNSUPPORTED_OPERATION</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_unsupported_operation.svg" alt="Sequence diagram of messaging UNSUPPORTED_OPERATION" width="636" height="118"> @@ -18648,7 +18898,7 @@ <h5 id="section-gen-messaging-unsupported_operation">4.1.81.47. Message UNSUPPOR </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_added_to_project">4.1.81.48. Message USER_ADDED_TO_PROJECT</h5> +<h5 id="section-gen-messaging-user_added_to_project">4.1.82.48. Message USER_ADDED_TO_PROJECT</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_added_to_project.svg" alt="Sequence diagram of messaging USER_ADDED_TO_PROJECT" width="748" height="205"> @@ -18677,7 +18927,7 @@ <h5 id="section-gen-messaging-user_added_to_project">4.1.81.48. Message USER_ADD </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_api_token_changed">4.1.81.49. Message USER_API_TOKEN_CHANGED</h5> +<h5 id="section-gen-messaging-user_api_token_changed">4.1.82.49. Message USER_API_TOKEN_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_api_token_changed.svg" alt="Sequence diagram of messaging USER_API_TOKEN_CHANGED" width="1153" height="234"> @@ -18685,7 +18935,7 @@ <h5 id="section-gen-messaging-user_api_token_changed">4.1.81.49. Message USER_AP </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_becomes_superadmin">4.1.81.50. Message USER_BECOMES_SUPERADMIN</h5> +<h5 id="section-gen-messaging-user_becomes_superadmin">4.1.82.50. Message USER_BECOMES_SUPERADMIN</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_becomes_superadmin.svg" alt="Sequence diagram of messaging USER_BECOMES_SUPERADMIN" width="663" height="176"> @@ -18693,7 +18943,7 @@ <h5 id="section-gen-messaging-user_becomes_superadmin">4.1.81.50. Message USER_B </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_created">4.1.81.51. Message USER_CREATED</h5> +<h5 id="section-gen-messaging-user_created">4.1.82.51. Message USER_CREATED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_created.svg" alt="Sequence diagram of messaging USER_CREATED" width="615" height="205"> @@ -18722,7 +18972,7 @@ <h5 id="section-gen-messaging-user_created">4.1.81.51. Message USER_CREATED</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_deleted">4.1.81.52. Message USER_DELETED</h5> +<h5 id="section-gen-messaging-user_deleted">4.1.82.52. Message USER_DELETED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_deleted.svg" alt="Sequence diagram of messaging USER_DELETED" width="1015" height="264"> @@ -18730,7 +18980,7 @@ <h5 id="section-gen-messaging-user_deleted">4.1.81.52. Message USER_DELETED</h5> </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_email_address_changed">4.1.81.53. Message USER_EMAIL_ADDRESS_CHANGED</h5> +<h5 id="section-gen-messaging-user_email_address_changed">4.1.82.53. Message USER_EMAIL_ADDRESS_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_email_address_changed.svg" alt="Sequence diagram of messaging USER_EMAIL_ADDRESS_CHANGED" width="696" height="176"> @@ -18738,7 +18988,7 @@ <h5 id="section-gen-messaging-user_email_address_changed">4.1.81.53. Message USE </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_new_api_token_requested">4.1.81.54. Message USER_NEW_API_TOKEN_REQUESTED</h5> +<h5 id="section-gen-messaging-user_new_api_token_requested">4.1.82.54. Message USER_NEW_API_TOKEN_REQUESTED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_new_api_token_requested.svg" alt="Sequence diagram of messaging USER_NEW_API_TOKEN_REQUESTED" width="964" height="205"> @@ -18767,7 +19017,7 @@ <h5 id="section-gen-messaging-user_new_api_token_requested">4.1.81.54. Message U </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_no_longer_superadmin">4.1.81.55. Message USER_NO_LONGER_SUPERADMIN</h5> +<h5 id="section-gen-messaging-user_no_longer_superadmin">4.1.82.55. Message USER_NO_LONGER_SUPERADMIN</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_no_longer_superadmin.svg" alt="Sequence diagram of messaging USER_NO_LONGER_SUPERADMIN" width="687" height="176"> @@ -18775,7 +19025,7 @@ <h5 id="section-gen-messaging-user_no_longer_superadmin">4.1.81.55. Message USER </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_removed_from_project">4.1.81.56. Message USER_REMOVED_FROM_PROJECT</h5> +<h5 id="section-gen-messaging-user_removed_from_project">4.1.82.56. Message USER_REMOVED_FROM_PROJECT</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_removed_from_project.svg" alt="Sequence diagram of messaging USER_REMOVED_FROM_PROJECT" width="802" height="205"> @@ -18804,7 +19054,7 @@ <h5 id="section-gen-messaging-user_removed_from_project">4.1.81.56. Message USER </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_roles_changed">4.1.81.57. Message USER_ROLES_CHANGED</h5> +<h5 id="section-gen-messaging-user_roles_changed">4.1.82.57. Message USER_ROLES_CHANGED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_roles_changed.svg" alt="Sequence diagram of messaging USER_ROLES_CHANGED" width="594" height="176"> @@ -18839,7 +19089,7 @@ <h5 id="section-gen-messaging-user_roles_changed">4.1.81.57. Message USER_ROLES_ </div> </div> <div class="sect4"> -<h5 id="section-gen-messaging-user_signup_requested">4.1.81.58. Message USER_SIGNUP_REQUESTED</h5> +<h5 id="section-gen-messaging-user_signup_requested">4.1.82.58. Message USER_SIGNUP_REQUESTED</h5> <div class="imageblock"> <div class="content"> <img src="images/gen_domain_messaging_user_signup_requested.svg" alt="Sequence diagram of messaging USER_SIGNUP_REQUESTED" width="629" height="176"> @@ -18874,7 +19124,7 @@ <h5 id="section-gen-messaging-user_signup_requested">4.1.81.58. Message USER_SIG </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-techdoc.html b/docs/latest/sechub-techdoc.html index ce0ec9d5af..1be57292f5 100644 --- a/docs/latest/sechub-techdoc.html +++ b/docs/latest/sechub-techdoc.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub TechDoc</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -860,9 +860,9 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#build-client">9.4.2. Build Client</a></li> <li><a href="#execute-integration-tests">9.4.3. Execute integration tests</a></li> <li><a href="#build-documentation">9.4.4. Build Documentation</a></li> -<li><a href="#publish-artefacts">9.4.5. Publish artefacts</a></li> </ul> </li> +<li><a href="#publishing-artifacts-development-naming-convention">9.5. Publishing artifacts / development naming convention</a></li> </ul> </li> <li><a href="#concepts">10. Concepts</a> @@ -1184,6 +1184,7 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#section-usecase-UC_078">10.19.79. UC_078-User unmarks existing false positive project data definitons</a></li> <li><a href="#section-usecase-UC_079">10.19.80. UC_079-System suspends running jobs on SIGTERM</a></li> <li><a href="#section-usecase-UC_080">10.19.81. UC_080-System resumes suspended jobs</a></li> +<li><a href="#section-usecase-UC_081">10.19.82. UC_081-get assigned project data</a></li> </ul> </li> <li><a href="#domain-driven-design-2">10.20. Domain driven design</a> @@ -1372,72 +1373,73 @@ <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/s <li><a href="#update-project-metadata">12.1.21. Update project metadata</a></li> <li><a href="#admin-changes-project-description">12.1.22. Admin changes project description</a></li> <li><a href="#admin-changes-project-access-level">12.1.23. Admin changes project access level</a></li> -<li><a href="#user-clicks-link-to-get-new-api-token">12.1.24. User clicks link to get new api token</a></li> -<li><a href="#user-creates-a-new-sechub-job">12.1.25. User creates a new sechub job</a> +<li><a href="#get-assigned-project-data">12.1.24. get assigned project data</a></li> +<li><a href="#user-clicks-link-to-get-new-api-token">12.1.25. User clicks link to get new api token</a></li> +<li><a href="#user-creates-a-new-sechub-job">12.1.26. User creates a new sechub job</a> <ul class="sectlevel4"> -<li><a href="#section-ucrestdoc-UC_005-code-scan">12.1.25.1. Code Scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-code-scan-using-data-section">12.1.25.2. Code Scan using data section variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-secret-scan">12.1.25.3. Secret scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-license-scan">12.1.25.4. License scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-infrastructure-scan">12.1.25.5. Infrastructure scan variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-anonymous">12.1.25.6. Web scan anonymous variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-with-api-definition">12.1.25.7. Web scan with api definition variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">12.1.25.8. Web scan with client certificate definition variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-login-basic">12.1.25.9. Web Scan login basic variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-login-form-scripted">12.1.25.10. Web Scan login form scripted variant</a></li> -<li><a href="#section-ucrestdoc-UC_005-web-scan-headers">12.1.25.11. Web Scan headers variant</a></li> -</ul> -</li> -<li><a href="#user-uploads-source-code">12.1.26. User uploads source code</a></li> -<li><a href="#user-approves-sechub-job">12.1.27. User approves sechub job</a></li> -<li><a href="#user-checks-sechub-job-state">12.1.28. User checks sechub job state</a></li> -<li><a href="#user-downloads-sechub-job-report">12.1.29. User downloads sechub job report</a> +<li><a href="#section-ucrestdoc-UC_005-code-scan">12.1.26.1. Code Scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-code-scan-using-data-section">12.1.26.2. Code Scan using data section variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-secret-scan">12.1.26.3. Secret scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-license-scan">12.1.26.4. License scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-infrastructure-scan">12.1.26.5. Infrastructure scan variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-anonymous">12.1.26.6. Web scan anonymous variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-with-api-definition">12.1.26.7. Web scan with api definition variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">12.1.26.8. Web scan with client certificate definition variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-login-basic">12.1.26.9. Web Scan login basic variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-login-form-scripted">12.1.26.10. Web Scan login form scripted variant</a></li> +<li><a href="#section-ucrestdoc-UC_005-web-scan-headers">12.1.26.11. Web Scan headers variant</a></li> +</ul> +</li> +<li><a href="#user-uploads-source-code">12.1.27. User uploads source code</a></li> +<li><a href="#user-approves-sechub-job">12.1.28. User approves sechub job</a></li> +<li><a href="#user-checks-sechub-job-state">12.1.29. User checks sechub job state</a></li> +<li><a href="#user-downloads-sechub-job-report">12.1.30. User downloads sechub job report</a> <ul class="sectlevel4"> -<li><a href="#section-ucrestdoc-UC_010-json">12.1.29.1. JSON variant</a></li> -<li><a href="#section-ucrestdoc-UC_010-html">12.1.29.2. HTML variant</a></li> -</ul> -</li> -<li><a href="#user-marks-false-positives">12.1.30. User marks false positives</a></li> -<li><a href="#user-unmarks-existing-false-positive-definitons">12.1.31. User unmarks existing false positive definitons</a></li> -<li><a href="#user-fetches-false-positive-configuration-of-project">12.1.32. User fetches false positive configuration of project</a></li> -<li><a href="#user-uploads-binaries">12.1.33. User uploads binaries</a></li> -<li><a href="#user-downloads-job-report-in-spdx-format">12.1.34. User downloads job report in SPDX format</a></li> -<li><a href="#user-unmarks-existing-false-positive-project-data-definitons">12.1.35. User unmarks existing false positive project data definitons</a></li> -<li><a href="#user-self-registration">12.1.36. User self registration</a></li> -<li><a href="#admin-lists-open-user-signups">12.1.37. Admin lists open user signups</a></li> -<li><a href="#admin-applies-self-registration">12.1.38. Admin applies self registration</a></li> -<li><a href="#admin-deletes-user-signup">12.1.39. Admin deletes user signup</a></li> -<li><a href="#user-requests-new-api-token">12.1.40. User requests new API token</a></li> -<li><a href="#admin-lists-all-running-jobs">12.1.41. Admin lists all running jobs</a></li> -<li><a href="#admin-cancels-a-job">12.1.42. Admin cancels a job</a></li> -<li><a href="#admin-restarts-a-job">12.1.43. Admin restarts a job</a></li> -<li><a href="#admin-restarts-a-job-hard">12.1.44. Admin restarts a job (hard)</a></li> -<li><a href="#user-defines-mock-data-configuration-for-project">12.1.45. User defines mock data configuration for project</a></li> -<li><a href="#user-retrieves-mock-data-configuration-for-project">12.1.46. User retrieves mock data configuration for project</a></li> -<li><a href="#admin-updates-mapping-configuration">12.1.47. Admin updates mapping configuration</a></li> -<li><a href="#admin-fetches-mapping-configuration">12.1.48. Admin fetches mapping configuration</a></li> -<li><a href="#admin-creates-an-executor-configuration">12.1.49. Admin creates an executor configuration</a></li> -<li><a href="#admin-deletes-executor-configuration">12.1.50. Admin deletes executor configuration</a></li> -<li><a href="#admin-fetches-executor-configuration-list">12.1.51. Admin fetches executor configuration list</a></li> -<li><a href="#admin-fetches-executor-configuration">12.1.52. Admin fetches executor configuration</a></li> -<li><a href="#admin-updates-executor-configuration-setup">12.1.53. Admin updates executor configuration setup</a></li> -<li><a href="#admin-creates-an-execution-profile">12.1.54. Admin creates an execution profile</a></li> -<li><a href="#admin-deletes-execution-profile">12.1.55. Admin deletes execution profile</a></li> -<li><a href="#admin-updates-execution-profile">12.1.56. Admin updates execution profile</a></li> -<li><a href="#admin-fetches-execution-profile">12.1.57. Admin fetches execution profile</a></li> -<li><a href="#admin-fetches-execution-profile-list">12.1.58. Admin fetches execution profile list</a></li> -<li><a href="#admin-assigns-execution-profile-to-project">12.1.59. Admin assigns execution profile to project</a></li> -<li><a href="#admin-unassigns-execution-profile-from-project">12.1.60. Admin unassigns execution profile from project</a></li> -<li><a href="#admin-fetches-auto-cleanup-configuration">12.1.61. Admin fetches auto cleanup configuration</a></li> -<li><a href="#admin-updates-auto-cleanup-configuration">12.1.62. Admin updates auto cleanup configuration</a></li> -<li><a href="#admin-starts-encryption-rotation">12.1.63. Admin starts encryption rotation</a></li> -<li><a href="#admin-fetches-encryption-status">12.1.64. Admin fetches encryption status</a></li> -<li><a href="#admin-disables-job-processing-in-scheduler">12.1.65. Admin disables job processing in scheduler</a></li> -<li><a href="#admin-enables-scheduler-job-processing">12.1.66. Admin enables scheduler job processing</a></li> -<li><a href="#admin-get-scheduler-status">12.1.67. Admin get scheduler status</a></li> -<li><a href="#admin-lists-status-information">12.1.68. Admin lists status information</a></li> -<li><a href="#admin-fetches-server-runtime-data">12.1.69. Admin fetches server runtime data</a></li> -<li><a href="#user-lists-jobs-for-project">12.1.70. User lists jobs for project</a></li> +<li><a href="#section-ucrestdoc-UC_010-json">12.1.30.1. JSON variant</a></li> +<li><a href="#section-ucrestdoc-UC_010-html">12.1.30.2. HTML variant</a></li> +</ul> +</li> +<li><a href="#user-marks-false-positives">12.1.31. User marks false positives</a></li> +<li><a href="#user-unmarks-existing-false-positive-definitons">12.1.32. User unmarks existing false positive definitons</a></li> +<li><a href="#user-fetches-false-positive-configuration-of-project">12.1.33. User fetches false positive configuration of project</a></li> +<li><a href="#user-uploads-binaries">12.1.34. User uploads binaries</a></li> +<li><a href="#user-downloads-job-report-in-spdx-format">12.1.35. User downloads job report in SPDX format</a></li> +<li><a href="#user-unmarks-existing-false-positive-project-data-definitons">12.1.36. User unmarks existing false positive project data definitons</a></li> +<li><a href="#user-self-registration">12.1.37. User self registration</a></li> +<li><a href="#admin-lists-open-user-signups">12.1.38. Admin lists open user signups</a></li> +<li><a href="#admin-applies-self-registration">12.1.39. Admin applies self registration</a></li> +<li><a href="#admin-deletes-user-signup">12.1.40. Admin deletes user signup</a></li> +<li><a href="#user-requests-new-api-token">12.1.41. User requests new API token</a></li> +<li><a href="#admin-lists-all-running-jobs">12.1.42. Admin lists all running jobs</a></li> +<li><a href="#admin-cancels-a-job">12.1.43. Admin cancels a job</a></li> +<li><a href="#admin-restarts-a-job">12.1.44. Admin restarts a job</a></li> +<li><a href="#admin-restarts-a-job-hard">12.1.45. Admin restarts a job (hard)</a></li> +<li><a href="#user-defines-mock-data-configuration-for-project">12.1.46. User defines mock data configuration for project</a></li> +<li><a href="#user-retrieves-mock-data-configuration-for-project">12.1.47. User retrieves mock data configuration for project</a></li> +<li><a href="#admin-updates-mapping-configuration">12.1.48. Admin updates mapping configuration</a></li> +<li><a href="#admin-fetches-mapping-configuration">12.1.49. Admin fetches mapping configuration</a></li> +<li><a href="#admin-creates-an-executor-configuration">12.1.50. Admin creates an executor configuration</a></li> +<li><a href="#admin-deletes-executor-configuration">12.1.51. Admin deletes executor configuration</a></li> +<li><a href="#admin-fetches-executor-configuration-list">12.1.52. Admin fetches executor configuration list</a></li> +<li><a href="#admin-fetches-executor-configuration">12.1.53. Admin fetches executor configuration</a></li> +<li><a href="#admin-updates-executor-configuration-setup">12.1.54. Admin updates executor configuration setup</a></li> +<li><a href="#admin-creates-an-execution-profile">12.1.55. Admin creates an execution profile</a></li> +<li><a href="#admin-deletes-execution-profile">12.1.56. Admin deletes execution profile</a></li> +<li><a href="#admin-updates-execution-profile">12.1.57. Admin updates execution profile</a></li> +<li><a href="#admin-fetches-execution-profile">12.1.58. Admin fetches execution profile</a></li> +<li><a href="#admin-fetches-execution-profile-list">12.1.59. Admin fetches execution profile list</a></li> +<li><a href="#admin-assigns-execution-profile-to-project">12.1.60. Admin assigns execution profile to project</a></li> +<li><a href="#admin-unassigns-execution-profile-from-project">12.1.61. Admin unassigns execution profile from project</a></li> +<li><a href="#admin-fetches-auto-cleanup-configuration">12.1.62. Admin fetches auto cleanup configuration</a></li> +<li><a href="#admin-updates-auto-cleanup-configuration">12.1.63. Admin updates auto cleanup configuration</a></li> +<li><a href="#admin-starts-encryption-rotation">12.1.64. Admin starts encryption rotation</a></li> +<li><a href="#admin-fetches-encryption-status">12.1.65. Admin fetches encryption status</a></li> +<li><a href="#admin-disables-job-processing-in-scheduler">12.1.66. Admin disables job processing in scheduler</a></li> +<li><a href="#admin-enables-scheduler-job-processing">12.1.67. Admin enables scheduler job processing</a></li> +<li><a href="#admin-get-scheduler-status">12.1.68. Admin get scheduler status</a></li> +<li><a href="#admin-lists-status-information">12.1.69. Admin lists status information</a></li> +<li><a href="#admin-fetches-server-runtime-data">12.1.70. Admin fetches server runtime data</a></li> +<li><a href="#user-lists-jobs-for-project">12.1.71. User lists jobs for project</a></li> </ul> </li> </ul> @@ -1665,7 +1667,7 @@ <h2 id="about">1. About</h2> </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <div class="paragraph"> <p>Target audience for this document are <strong>SecHub Developers</strong> only!</p> @@ -2809,8 +2811,8 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> </tr> </tbody> </table> -<table id="section-gen-configuration-scope-p" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 11. Scope 'p'</caption> +<table id="section-gen-configuration-scope-pdsinstall" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 11. Scope 'pdsinstall'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2825,26 +2827,6 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 400 bad request happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 400 bad request happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 500 server internal error happened on Checkmarx server</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 500 server internal error happened on Checkmarx server</p></td> -</tr> -<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.default.check.timetowait.milliseconds</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Time in milliseconds when adapter check operation is called next. When -1 value is 60000 minutes</p></td> @@ -2854,20 +2836,10 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> <td class="tableblock halign-left valign-top"><p class="tableblock">240</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Time in minutes when adapter result check will automatically time out and adapter stops execution automatically. When -1 timeout is 7200 minutes</p></td> </tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a PDS encryption out of sync problem happens</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a PDS encryption out of sync problem happens</p></td> -</tr> </tbody> </table> -<table id="section-gen-configuration-scope-s" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 12. Scope 's'</caption> +<table id="section-gen-configuration-scope-pdsresilience" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 12. Scope 'pdsresilience'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -2882,29 +2854,34 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.config</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">mail.smtp.auth=false,mail.transport.protocol=smtp</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: <code>mail.smtp.auth=false,mail.smtp.timeout=4000</code>. See <a href="https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html" class="bare">https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html</a> for configuration mapping</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 400 bad request happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.password</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Password on SMPTP server, empty value means no password</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.badrequest.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 400 bad request happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.username</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Username on SMPTP server, empty value means no username</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a 500 server internal error happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.hostname</p></td> -<td class="tableblock halign-left valign-top"></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname of SMPTP server</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.checkmarx.resilience.servererror.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a 500 server internal error happened on Checkmarx server</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.port</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Port of SMPTP server, per default:25</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Amount of retries done when a PDS encryption out of sync problem happens</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait until retry is done when a PDS encryption out of sync problem happens</p></td> </tr> </tbody> </table> @@ -3146,8 +3123,50 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> </tr> </tbody> </table> +<table id="section-gen-configuration-scope-smtpserver" class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 19. Scope 'smtpserver'</caption> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Key or variable name</th> +<th class="tableblock halign-left valign-top">Default</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.config</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">mail.smtp.auth=false,mail.transport.protocol=smtp</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: <code>mail.smtp.auth=false,mail.smtp.timeout=4000</code>. See <a href="https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html" class="bare">https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html</a> for configuration mapping</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.password</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Password on SMPTP server, empty value means no password</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.credential.username</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Username on SMPTP server, empty value means no username</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.hostname</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname of SMPTP server</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">sechub.notification.smtp.port</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Port of SMPTP server, per default:25</p></td> +</tr> +</tbody> +</table> <table id="section-gen-configuration-scope-storage" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 19. Scope 'storage'</caption> +<caption class="title">Table 20. Scope 'storage'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3234,7 +3253,7 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-system" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 20. Scope 'system'</caption> +<caption class="title">Table 21. Scope 'system'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3266,7 +3285,7 @@ <h4 id="section-general-configuration">3.1.3. General configuration</h4> </tbody> </table> <table id="section-gen-configuration-scope-target" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 21. Scope 'target'</caption> +<caption class="title">Table 22. Scope 'target'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3312,7 +3331,7 @@ <h4 id="scheduling-definitions">3.1.4. Scheduling definitions</h4> </table> </div> <table id="link-gen-scheduling" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 22. Scope 'administration'</caption> +<caption class="title">Table 23. Scope 'administration'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -3334,7 +3353,7 @@ <h4 id="scheduling-definitions">3.1.4. Scheduling definitions</h4> </tbody> </table> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 23. Scope 'scan'</caption> +<caption class="title">Table 24. Scope 'scan'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -3356,7 +3375,7 @@ <h4 id="scheduling-definitions">3.1.4. Scheduling definitions</h4> </tbody> </table> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 24. Scope 'schedule'</caption> +<caption class="title">Table 25. Scope 'schedule'</caption> <colgroup> <col style="width: 7.6923%;"> <col style="width: 46.1538%;"> @@ -3407,7 +3426,7 @@ <h4 id="sechub-mock-options">3.1.5. Configuration properties for mocked adapters </table> </div> <table id="section-gen-configuration-scope-abstract" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 25. Scope 'abstract'</caption> +<caption class="title">Table 26. Scope 'abstract'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3429,7 +3448,7 @@ <h4 id="sechub-mock-options">3.1.5. Configuration properties for mocked adapters </tbody> </table> <table id="section-gen-configuration-scope-mocked" class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 26. Scope 'mocked'</caption> +<caption class="title">Table 27. Scope 'mocked'</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -3994,9 +4013,9 @@ <h3 id="mandatory-configuration">4.1. Mandatory configuration</h3> -Dsechub.initialadmin.userid=value -Dsechub.notification.email.administrators=value -Dsechub.notification.email.from=value --Dsechub.notification.smtp.hostname=value -Dsechub.server.baseurl=value --Dsechub.security.diffiehellman.length=value</pre> +-Dsechub.security.diffiehellman.length=value +-Dsechub.notification.smtp.hostname=value</pre> </div> </div> <div class="admonitionblock tip"> @@ -4019,9 +4038,9 @@ <h3 id="mandatory-configuration">4.1. Mandatory configuration</h3> export SECHUB_INITIALADMIN_USERID=value export SECHUB_NOTIFICATION_EMAIL_ADMINISTRATORS=value export SECHUB_NOTIFICATION_EMAIL_FROM=value -export SECHUB_NOTIFICATION_SMTP_HOSTNAME=value export SECHUB_SERVER_BASEURL=value -export SECHUB_SECURITY_DIFFIEHELLMAN_LENGTH=value</pre> +export SECHUB_SECURITY_DIFFIEHELLMAN_LENGTH=value +export SECHUB_NOTIFICATION_SMTP_HOSTNAME=value</pre> </div> </div> <div class="admonitionblock important"> @@ -5941,24 +5960,25 @@ <h4 id="build-documentation">9.4.4. Build Documentation</h4> </div> </div> </div> -<div class="sect3"> -<h4 id="publish-artefacts">9.4.5. Publish artefacts</h4> -<div class="paragraph"> -<p>Just call</p> </div> -<div class="listingblock"> -<div class="content"> -<pre>./gradlew publish</pre> +<div class="sect2"> +<h3 id="publishing-artifacts-development-naming-convention">9.5. Publishing artifacts / development naming convention</h3> +<div class="paragraph"> +<p><a href="https://github.com/mercedes-benz/sechub/packages">Artifacts</a> are being published automatically when a <a href="https://github.com/mercedes-benz/sechub/actions?query=workflow%3A%22Release*%22">release workflow</a> runs on github.com.</p> </div> +<div class="paragraph"> +<p>If you publish artifacts while developing and testing then make sure that the versioning tag contains "-SNAPSHOT" behind the product version.</p> </div> <div class="paragraph"> -<p><em>(if not already builds done this will be triggered automatically)</em></p> +<p>Examples (SecHub server 1.10.0 development):<br> +- <code>1.10.0_alpine-SNAPSHOT</code><br> +- <code>1.10.0_alpine-SNAPSHOT1</code><br> +- <code>1.10.0_alpine-SNAPSHOT-2024-11-30</code></p> </div> <div style="page-break-after: always;"></div> </div> </div> </div> -</div> <div class="sect1"> <h2 id="concepts">10. Concepts</h2> <div class="sectionbody"> @@ -8270,6 +8290,9 @@ <h5 id="project-administration">10.19.1.3. Project administration</h5> <li> <p><a href="#section-usecase-UC_062">UC_062-Admin changes project access level</a></p> </li> +<li> +<p><a href="#section-usecase-UC_081">UC_081-get assigned project data</a></p> +</li> </ul> </div> </div> @@ -14218,6 +14241,76 @@ <h4 id="section-usecase-UC_080">10.19.81. UC_080-System resumes suspended jobs</ </tbody> </table> </div> +<div class="sect3"> +<h4 id="section-usecase-UC_081">10.19.82. UC_081-get assigned project data</h4> +<div class="paragraph"> +<p>User, Owner or Admin fetches a list containing information about assigned and/ or owned projects.</p> +</div> +<div class="paragraph"> +<p>The Project data contains the following information:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>Project ID</p> +</li> +<li> +<p>Owner</p> +</li> +<li> +<p>is owned</p> +</li> +<li> +<p>assigned users (can only be viewed by owner or admin)</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>A project user can see only projects he is assigned to. +A project owner can see all projects he owns and the assigned users. +A project admin can see assigned or owned projects and all assigned users.</p> +</div> +<div class="paragraph"> +<p><strong>Technical information</strong></p> +</div> +<div class="paragraph"> +<p>You will find relevant code parts by searching for references of <code>@com.mercedesbenz.sechub.sharedkernel.project.UseCaseGetAssignedProjectDataList</code></p> +</div> +<div class="paragraph"> +<p><strong>Steps</strong></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 5%;"> +<col style="width: 20%;"> +<col style="width: 20%;"> +<col style="width: 5%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Nr</th> +<th class="tableblock halign-left valign-top">Title</th> +<th class="tableblock halign-left valign-top">Role(s)</th> +<th class="tableblock halign-left valign-top">Next</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Rest API call to get Projects with information</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">OWNER, SUPERADMIN, USER</p></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Rest api call to get projects with details</p> +<p class="tableblock"><em>This step is defined at method <code>getAssignedProjectDataList</code> in class `com.mercedesbenz.sechub.domain.administration.project.ProjectRestController`</em></p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><a href="#section-ucrestdoc-uc-UC_081">REST API documentation for usecase UC_081-get assigned project data </a></p> +</div> +</div> </div> <div class="sect2"> <h3 id="domain-driven-design-2">10.20. Domain driven design</h3> @@ -15744,7 +15837,7 @@ <h5 id="pds">11.2.3.1. PDS</h5> are listed here for the sake of completeness.</p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 27. PDS executor configuration parameters</caption> +<caption class="title">Table 28. PDS executor configuration parameters</caption> <colgroup> <col style="width: 33.3333%;"> <col style="width: 33.3333%;"> @@ -16668,6 +16761,9 @@ <h5 id="project-administration-2">12.1.1.3. Project administration</h5> <li> <p><a href="#section-ucrestdoc-uc-UC_062">REST API for UC_062-Admin changes project access level </a></p> </li> +<li> +<p><a href="#section-ucrestdoc-uc-UC_081">REST API for UC_081-get assigned project data </a></p> +</li> </ul> </div> </div> @@ -16904,7 +17000,7 @@ <h5 id="section-ucrestdoc-UC_039-head">12.1.2.1. HEAD variant</h5> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 28. General request information</caption> +<caption class="title">Table 29. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -16952,7 +17048,7 @@ <h5 id="section-ucrestdoc-UC_039-get">12.1.2.2. GET variant</h5> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 29. General request information</caption> +<caption class="title">Table 30. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17004,7 +17100,7 @@ <h4 id="admin-lists-all-users">12.1.3. Admin lists all users</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 30. General request information</caption> +<caption class="title">Table 31. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17083,7 +17179,7 @@ <h4 id="admin-assigns-user-to-project">12.1.4. Admin assigns user to project</h4 <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 31. General request information</caption> +<caption class="title">Table 32. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17113,7 +17209,7 @@ <h4 id="admin-assigns-user-to-project">12.1.4. Admin assigns user to project</h4 <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 32. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}</caption> +<caption class="title">Table 33. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17176,7 +17272,7 @@ <h4 id="admin-unassigns-user-from-project">12.1.5. Admin unassigns user from pro <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 33. General request information</caption> +<caption class="title">Table 34. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17206,7 +17302,7 @@ <h4 id="admin-unassigns-user-from-project">12.1.5. Admin unassigns user from pro <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 34. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}</caption> +<caption class="title">Table 35. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17269,7 +17365,7 @@ <h4 id="admin-shows-user-details">12.1.6. Admin shows user details</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 35. General request information</caption> +<caption class="title">Table 36. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17299,7 +17395,7 @@ <h4 id="admin-shows-user-details">12.1.6. Admin shows user details</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 36. https://localhost:8081/api/admin/user/{userId}</caption> +<caption class="title">Table 37. https://localhost:8081/api/admin/user/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17405,7 +17501,7 @@ <h4 id="admin-deletes-a-user">12.1.7. Admin deletes a user</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 37. General request information</caption> +<caption class="title">Table 38. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17435,7 +17531,7 @@ <h4 id="admin-deletes-a-user">12.1.7. Admin deletes a user</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 38. https://localhost:8081/api/admin/user/{userId}</caption> +<caption class="title">Table 39. https://localhost:8081/api/admin/user/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17493,7 +17589,7 @@ <h4 id="admin-shows-project-details">12.1.8. Admin shows project details</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 39. General request information</caption> +<caption class="title">Table 40. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17523,7 +17619,7 @@ <h4 id="admin-shows-project-details">12.1.8. Admin shows project details</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 40. https://localhost:8081/api/admin/project/{projectId}</caption> +<caption class="title">Table 41. https://localhost:8081/api/admin/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17645,7 +17741,7 @@ <h4 id="admin-downloads-all-details-about-a-scan-job">12.1.9. Admin downloads al <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 41. General request information</caption> +<caption class="title">Table 42. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17675,7 +17771,7 @@ <h4 id="admin-downloads-all-details-about-a-scan-job">12.1.9. Admin downloads al <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 42. https://localhost:8081/api/admin/scan/download/{jobUUID}</caption> +<caption class="title">Table 43. https://localhost:8081/api/admin/scan/download/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17701,7 +17797,7 @@ <h4 id="admin-downloads-all-details-about-a-scan-job">12.1.9. Admin downloads al </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/scan/download/b3d0fadc-5631-48fe-ad3b-d1d2856e4158' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/scan/download/d997d479-f12b-4b26-9005-beb905c60f86' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -17715,7 +17811,7 @@ <h4 id="admin-grants-admin-rights-to-user">12.1.10. Admin grants admin rights to <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 43. General request information</caption> +<caption class="title">Table 44. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17745,7 +17841,7 @@ <h4 id="admin-grants-admin-rights-to-user">12.1.10. Admin grants admin rights to <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 44. https://localhost:8081/api/admin/user/{userId}/grant/superadmin</caption> +<caption class="title">Table 45. https://localhost:8081/api/admin/user/{userId}/grant/superadmin</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17803,7 +17899,7 @@ <h4 id="admin-revokes-admin-rights-from-an-admin">12.1.11. Admin revokes admin r <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 45. General request information</caption> +<caption class="title">Table 46. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17833,7 +17929,7 @@ <h4 id="admin-revokes-admin-rights-from-an-admin">12.1.11. Admin revokes admin r <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 46. https://localhost:8081/api/admin/user/{userId}/revoke/superadmin</caption> +<caption class="title">Table 47. https://localhost:8081/api/admin/user/{userId}/revoke/superadmin</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -17891,7 +17987,7 @@ <h4 id="admin-lists-all-admins">12.1.12. Admin lists all admins</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 47. General request information</caption> +<caption class="title">Table 48. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -17985,7 +18081,7 @@ <h4 id="admin-changes-owner-of-a-project">12.1.13. Admin changes owner of a proj <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 48. General request information</caption> +<caption class="title">Table 49. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18015,7 +18111,7 @@ <h4 id="admin-changes-owner-of-a-project">12.1.13. Admin changes owner of a proj <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 49. https://localhost:8081/api/admin/project/{projectId}/owner/{userId}</caption> +<caption class="title">Table 50. https://localhost:8081/api/admin/project/{projectId}/owner/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -18078,7 +18174,7 @@ <h4 id="admin-updates-user-email-address">12.1.14. Admin updates user email addr <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 50. General request information</caption> +<caption class="title">Table 51. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18108,7 +18204,7 @@ <h4 id="admin-updates-user-email-address">12.1.14. Admin updates user email addr <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 51. https://localhost:8081/api/admin/user/{userId}/email/{emailAddress}</caption> +<caption class="title">Table 52. https://localhost:8081/api/admin/user/{userId}/email/{emailAddress}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -18170,7 +18266,7 @@ <h4 id="admin-shows-user-details-for-email-address">12.1.15. Admin shows user de <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 52. General request information</caption> +<caption class="title">Table 53. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18200,7 +18296,7 @@ <h4 id="admin-shows-user-details-for-email-address">12.1.15. Admin shows user de <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 53. https://localhost:8081/api/admin/user-by-email/{emailAddress}</caption> +<caption class="title">Table 54. https://localhost:8081/api/admin/user-by-email/{emailAddress}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -18312,7 +18408,7 @@ <h4 id="admin-creates-a-project">12.1.16. Admin creates a project</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 54. General request information</caption> +<caption class="title">Table 55. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18434,7 +18530,7 @@ <h4 id="admin-lists-all-projects">12.1.17. Admin lists all projects</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 55. General request information</caption> +<caption class="title">Table 56. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18529,7 +18625,7 @@ <h4 id="admin-deletes-a-project">12.1.18. Admin deletes a project</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 56. General request information</caption> +<caption class="title">Table 57. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18559,7 +18655,7 @@ <h4 id="admin-deletes-a-project">12.1.18. Admin deletes a project</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 57. https://localhost:8081/api/admin/project/{projectId}</caption> +<caption class="title">Table 58. https://localhost:8081/api/admin/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -18618,7 +18714,7 @@ <h4 id="update-project-whitelist">12.1.19. Update project whitelist</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 58. General request information</caption> +<caption class="title">Table 59. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18648,7 +18744,7 @@ <h4 id="update-project-whitelist">12.1.19. Update project whitelist</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 59. https://localhost:8081/api/admin/project/{projectId}/whitelist</caption> +<caption class="title">Table 60. https://localhost:8081/api/admin/project/{projectId}/whitelist</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -18737,7 +18833,7 @@ <h4 id="admin-shows-scan-logs-for-project">12.1.20. Admin shows scan logs for pr <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 60. General request information</caption> +<caption class="title">Table 61. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18767,7 +18863,7 @@ <h4 id="admin-shows-scan-logs-for-project">12.1.20. Admin shows scan logs for pr <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 61. https://localhost:8081/api/admin/project/{projectId}/scan/logs</caption> +<caption class="title">Table 62. https://localhost:8081/api/admin/project/{projectId}/scan/logs</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -18866,7 +18962,7 @@ <h4 id="admin-shows-scan-logs-for-project">12.1.20. Admin shows scan logs for pr </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">sechubJobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">236cbc48-7499-4aed-9de2-8646de4bf48d</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">spartakus</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-20T16:59:24.353716812</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:24.353740156</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>}]</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">sechubJobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">b2a0f621-cbed-431f-816d-f8f5a655e8bc</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">spartakus</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-26T09:48:46.447108027</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:46.447126853</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>}]</code></pre> </div> </div> </div> @@ -18879,7 +18975,7 @@ <h4 id="update-project-metadata">12.1.21. Update project metadata</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 62. General request information</caption> +<caption class="title">Table 63. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -18909,7 +19005,7 @@ <h4 id="update-project-metadata">12.1.21. Update project metadata</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 63. https://localhost:8081/api/admin/project/{projectId}/metadata</caption> +<caption class="title">Table 64. https://localhost:8081/api/admin/project/{projectId}/metadata</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19003,7 +19099,7 @@ <h4 id="admin-changes-project-description">12.1.22. Admin changes project descri <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 64. General request information</caption> +<caption class="title">Table 65. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19033,7 +19129,7 @@ <h4 id="admin-changes-project-description">12.1.22. Admin changes project descri <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 65. https://localhost:8081/api/admin/project/{projectId}</caption> +<caption class="title">Table 66. https://localhost:8081/api/admin/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19158,7 +19254,7 @@ <h4 id="admin-changes-project-access-level">12.1.23. Admin changes project acces <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 66. General request information</caption> +<caption class="title">Table 67. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19188,7 +19284,7 @@ <h4 id="admin-changes-project-access-level">12.1.23. Admin changes project acces <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 67. https://localhost:8081/api/admin/project/{projectId}/accesslevel/{projectAccessLevel}</caption> +<caption class="title">Table 68. https://localhost:8081/api/admin/project/{projectId}/accesslevel/{projectAccessLevel}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19243,7 +19339,133 @@ <h4 id="admin-changes-project-access-level">12.1.23. Admin changes project acces </div> </div> <div class="sect3"> -<h4 id="user-clicks-link-to-get-new-api-token">12.1.24. User clicks link to get new api token</h4> +<h4 id="get-assigned-project-data">12.1.24. get assigned project data</h4> +<div id="section-ucrestdoc-uc-UC_081" class="paragraph"> +<p>REST API for usecase <a href="#section-usecase-UC_081">UC_081-get assigned project data </a></p> +</div> +<div id="section-ucrestdoc-UC_081-" class="paragraph"> +<p><strong class="big">Definition</strong></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 69. General request information</caption> +<colgroup> +<col style="width: 14.2857%;"> +<col style="width: 85.7143%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top"></th> +<th class="tableblock halign-left valign-top">Value</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Path</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">/api/projects</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Method</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">Status code</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">200 OK</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><strong>Path parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<caption class="title">Table 70. https://localhost:8081/api/projects</caption> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +</table> +<div class="paragraph"> +<p><strong>Request headers</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Name</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +</table> +<div class="paragraph"> +<p><strong>Response fields</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 33.3333%;"> +<col style="width: 33.3333%;"> +<col style="width: 33.3334%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Path</th> +<th class="tableblock halign-left valign-top">Type</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].projectId</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Project ID</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].owner</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Name of owner of the Project</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].isOwned</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">If caller is owner of the project</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].assignedUsers</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional: Assigned users (only viewable by owner or admin)</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><strong class="big">Example</strong></p> +</div> +<div class="paragraph"> +<p><strong>Curl request</strong> <br></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/projects' -i -u 'user:secret' -X GET \ + -H 'Content-Type: application/json;charset=UTF-8'</code></pre> +</div> +</div> +<div class="paragraph"> +<p><strong>Response body</strong> <br></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">assignedUsers</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">user2</span><span class="delimiter">"</span></span>],<span class="key"><span class="delimiter">"</span><span class="content">isOwned</span><span class="delimiter">"</span></span>:<span class="value">true</span>}]</code></pre> +</div> +</div> +</div> +<div class="sect3"> +<h4 id="user-clicks-link-to-get-new-api-token">12.1.25. User clicks link to get new api token</h4> <div id="section-ucrestdoc-uc-UC_012" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_012">UC_012-User clicks link to get new api token </a></p> </div> @@ -19251,7 +19473,7 @@ <h4 id="user-clicks-link-to-get-new-api-token">12.1.24. User clicks link to get <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 68. General request information</caption> +<caption class="title">Table 71. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19281,7 +19503,7 @@ <h4 id="user-clicks-link-to-get-new-api-token">12.1.24. User clicks link to get <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 69. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}</caption> +<caption class="title">Table 72. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19317,17 +19539,17 @@ <h4 id="user-clicks-link-to-get-new-api-token">12.1.24. User clicks link to get </div> </div> <div class="sect3"> -<h4 id="user-creates-a-new-sechub-job">12.1.25. User creates a new sechub job</h4> +<h4 id="user-creates-a-new-sechub-job">12.1.26. User creates a new sechub job</h4> <div id="section-ucrestdoc-uc-UC_005" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_005">UC_005-User creates a new sechub job </a></p> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-code-scan">12.1.25.1. Code Scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-code-scan">12.1.26.1. Code Scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 70. General request information</caption> +<caption class="title">Table 73. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19357,7 +19579,7 @@ <h5 id="section-ucrestdoc-UC_005-code-scan">12.1.25.1. Code Scan variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 71. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 74. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19476,17 +19698,17 @@ <h5 id="section-ucrestdoc-UC_005-code-scan">12.1.25.1. Code Scan variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">e985a705-ffb7-49b1-99e6-1407d27226e4</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">7786c4a7-042f-4d2b-8bcf-6c23aabf6e7b</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">12.1.25.2. Code Scan using data section variant</h5> +<h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">12.1.26.2. Code Scan using data section variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 72. General request information</caption> +<caption class="title">Table 75. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19516,7 +19738,7 @@ <h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">12.1.25.2. Code S <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 73. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 76. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19655,17 +19877,17 @@ <h5 id="section-ucrestdoc-UC_005-code-scan-using-data-section">12.1.25.2. Code S </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2210eb32-7fd0-4299-b75b-0d87a5db26a0</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">35ea98be-9e36-4cc6-8c8a-3a157d24ead7</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-secret-scan">12.1.25.3. Secret scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-secret-scan">12.1.26.3. Secret scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 74. General request information</caption> +<caption class="title">Table 77. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19695,7 +19917,7 @@ <h5 id="section-ucrestdoc-UC_005-secret-scan">12.1.25.3. Secret scan variant</h5 <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 75. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 78. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19814,17 +20036,17 @@ <h5 id="section-ucrestdoc-UC_005-secret-scan">12.1.25.3. Secret scan variant</h5 </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a0e2dc56-54fa-4b25-b1e6-688dd47baaf4</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">dc364126-fdc7-40a8-b8e7-ff087eb22bf2</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-license-scan">12.1.25.4. License scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-license-scan">12.1.26.4. License scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 76. General request information</caption> +<caption class="title">Table 79. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -19854,7 +20076,7 @@ <h5 id="section-ucrestdoc-UC_005-license-scan">12.1.25.4. License scan variant</ <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 77. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 80. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -19973,17 +20195,17 @@ <h5 id="section-ucrestdoc-UC_005-license-scan">12.1.25.4. License scan variant</ </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">e7c1d895-bc81-4c70-92ad-7ca117bab44a</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">7ff1f27b-bae9-4593-b4ee-5a5df3e52604</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-infrastructure-scan">12.1.25.5. Infrastructure scan variant</h5> +<h5 id="section-ucrestdoc-UC_005-infrastructure-scan">12.1.26.5. Infrastructure scan variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 78. General request information</caption> +<caption class="title">Table 81. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -20013,7 +20235,7 @@ <h5 id="section-ucrestdoc-UC_005-infrastructure-scan">12.1.25.5. Infrastructure <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 79. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 82. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -20127,17 +20349,17 @@ <h5 id="section-ucrestdoc-UC_005-infrastructure-scan">12.1.25.5. Infrastructure </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">953dff35-71f1-4983-b360-0762a95ca7c0</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">fcf8cb7f-4f7c-413a-9978-ce8a085fbc7f</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">12.1.25.6. Web scan anonymous variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">12.1.26.6. Web scan anonymous variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 80. General request information</caption> +<caption class="title">Table 83. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -20167,7 +20389,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">12.1.25.6. Web scan anonymo <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 81. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 84. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -20296,17 +20518,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-anonymous">12.1.25.6. Web scan anonymo </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">9bb88784-b24d-436e-898a-40e9e9c9d42b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">42566c19-7464-4f4a-95e6-79e722ae39b7</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">12.1.25.7. Web scan with api definition variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">12.1.26.7. Web scan with api definition variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 82. General request information</caption> +<caption class="title">Table 85. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -20336,7 +20558,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">12.1.25.7. Web sc <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 83. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 86. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -20460,17 +20682,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-api-definition">12.1.25.7. Web sc </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">39b31e69-97ca-4543-99a6-50c4f6cc075b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">1ad5cd3b-5a1e-4a7e-8b07-8d5bd87dd515</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">12.1.25.8. Web scan with client certificate definition variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">12.1.26.8. Web scan with client certificate definition variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 84. General request information</caption> +<caption class="title">Table 87. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -20500,7 +20722,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">12 <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 85. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 88. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -20619,17 +20841,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-with-client-certificate-definition">12 </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">df9ee013-ee60-45bb-929a-1f2bb410f153</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">019ef25e-a21a-4c9e-9412-2ec55887f291</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">12.1.25.9. Web Scan login basic variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">12.1.26.9. Web Scan login basic variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 86. General request information</caption> +<caption class="title">Table 89. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -20659,7 +20881,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">12.1.25.9. Web Scan login <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 87. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 90. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -20793,17 +21015,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-basic">12.1.25.9. Web Scan login </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">57628d15-8dd2-4b28-b9fa-42e0c6037c43</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">b7960f36-3dcd-4030-a4d1-fa8ba4f99462</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">12.1.25.10. Web Scan login form scripted variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">12.1.26.10. Web Scan login form scripted variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 88. General request information</caption> +<caption class="title">Table 91. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -20833,7 +21055,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">12.1.25.10. Web S <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 89. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 92. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21012,17 +21234,17 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-login-form-scripted">12.1.25.10. Web S </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d47f3a92-0951-4447-8300-fad04567f65b</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d70e8d78-f3c9-4d16-a57f-9f4957e4723a</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_005-web-scan-headers">12.1.25.11. Web Scan headers variant</h5> +<h5 id="section-ucrestdoc-UC_005-web-scan-headers">12.1.26.11. Web Scan headers variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 90. General request information</caption> +<caption class="title">Table 93. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21052,7 +21274,7 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-headers">12.1.25.11. Web Scan headers <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 91. https://localhost:8081/api/project/{projectId}/job</caption> +<caption class="title">Table 94. https://localhost:8081/api/project/{projectId}/job</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21176,13 +21398,13 @@ <h5 id="section-ucrestdoc-UC_005-web-scan-headers">12.1.25.11. Web Scan headers </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">37527d26-9792-44ae-a2c8-36dfb67fe36c</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">67515a5b-1f33-4d6b-b432-1ed5ba525ee0</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> </div> <div class="sect3"> -<h4 id="user-uploads-source-code">12.1.26. User uploads source code</h4> +<h4 id="user-uploads-source-code">12.1.27. User uploads source code</h4> <div id="section-ucrestdoc-uc-UC_006" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_006">UC_006-User uploads source code </a></p> </div> @@ -21190,7 +21412,7 @@ <h4 id="user-uploads-source-code">12.1.26. User uploads source code</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 92. General request information</caption> +<caption class="title">Table 95. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21220,7 +21442,7 @@ <h4 id="user-uploads-source-code">12.1.26. User uploads source code</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 93. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode</caption> +<caption class="title">Table 96. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21243,6 +21465,27 @@ <h4 id="user-uploads-source-code">12.1.26. User uploads source code</h4> </tbody> </table> <div class="paragraph"> +<p><strong>Query parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>checkSum</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">A sha256 checksum for file upload validation</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> <p><strong>Request headers</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> @@ -21265,7 +21508,7 @@ <h4 id="user-uploads-source-code">12.1.26. User uploads source code</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/dc48eaff-3a7d-414f-82f6-f242dcd9bf74/sourcecode?checkSum=checkSumValue' -i -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/24722135-2100-465e-bcef-4b1dfdae5ffd/sourcecode?checkSum=checkSumValue' -i -X POST \ -H 'Content-Type: multipart/form-data;charset=UTF-8' \ -F 'file=PK �<M test1.txtPK ? @@ -21279,7 +21522,7 @@ <h4 id="user-uploads-source-code">12.1.26. User uploads source code</h4> </div> </div> <div class="sect3"> -<h4 id="user-approves-sechub-job">12.1.27. User approves sechub job</h4> +<h4 id="user-approves-sechub-job">12.1.28. User approves sechub job</h4> <div id="section-ucrestdoc-uc-UC_007" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_007">UC_007-User approves sechub job </a></p> </div> @@ -21287,7 +21530,7 @@ <h4 id="user-approves-sechub-job">12.1.27. User approves sechub job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 94. General request information</caption> +<caption class="title">Table 97. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21317,7 +21560,7 @@ <h4 id="user-approves-sechub-job">12.1.27. User approves sechub job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 95. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve</caption> +<caption class="title">Table 98. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21362,7 +21605,7 @@ <h4 id="user-approves-sechub-job">12.1.27. User approves sechub job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/bb20198d-8bb8-4ff5-961c-4fc6ecddd80d/approve' -i -X PUT \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/64b78b45-b45e-4c2c-8719-bd74688a0e63/approve' -i -X PUT \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -21372,7 +21615,7 @@ <h4 id="user-approves-sechub-job">12.1.27. User approves sechub job</h4> </div> </div> <div class="sect3"> -<h4 id="user-checks-sechub-job-state">12.1.28. User checks sechub job state</h4> +<h4 id="user-checks-sechub-job-state">12.1.29. User checks sechub job state</h4> <div id="section-ucrestdoc-uc-UC_009" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_009">UC_009-User checks sechub job state </a></p> </div> @@ -21380,7 +21623,7 @@ <h4 id="user-checks-sechub-job-state">12.1.28. User checks sechub job state</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 96. General request information</caption> +<caption class="title">Table 99. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21410,7 +21653,7 @@ <h4 id="user-checks-sechub-job-state">12.1.28. User checks sechub job state</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 97. https://localhost:8081/api/project/{projectId}/job/{jobUUID}</caption> +<caption class="title">Table 100. https://localhost:8081/api/project/{projectId}/job/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21514,7 +21757,7 @@ <h4 id="user-checks-sechub-job-state">12.1.28. User checks sechub job state</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/abb3751f-2ca5-4f0c-bae1-04a0e1788550' -i -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/92179639-e089-4894-a4df-14f1e40e453d' -i -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -21523,22 +21766,22 @@ <h4 id="user-checks-sechub-job-state">12.1.28. User checks sechub job state</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">abb3751f-2ca5-4f0c-bae1-04a0e1788550</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">CREATOR1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:44:22.764797265</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:22.764824576</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">result</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">92179639-e089-4894-a4df-14f1e40e453d</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">CREATOR1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:33:44.986322732</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:44.986349833</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">result</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="user-downloads-sechub-job-report">12.1.29. User downloads sechub job report</h4> +<h4 id="user-downloads-sechub-job-report">12.1.30. User downloads sechub job report</h4> <div id="section-ucrestdoc-uc-UC_010" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_010">UC_010-User downloads sechub job report </a></p> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_010-json">12.1.29.1. JSON variant</h5> +<h5 id="section-ucrestdoc-UC_010-json">12.1.30.1. JSON variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 98. General request information</caption> +<caption class="title">Table 101. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21568,7 +21811,7 @@ <h5 id="section-ucrestdoc-UC_010-json">12.1.29.1. JSON variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 99. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> +<caption class="title">Table 102. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21598,19 +21841,19 @@ <h5 id="section-ucrestdoc-UC_010-json">12.1.29.1. JSON variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/7a8b89cc-f4dd-44ac-bae6-212bc2dd01d0' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/9df5834d-4dc1-4a96-8995-926fcae88f9d' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/json'</code></pre> </div> </div> </div> <div class="sect4"> -<h5 id="section-ucrestdoc-UC_010-html">12.1.29.2. HTML variant</h5> +<h5 id="section-ucrestdoc-UC_010-html">12.1.30.2. HTML variant</h5> <div class="paragraph"> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 100. General request information</caption> +<caption class="title">Table 103. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21640,7 +21883,7 @@ <h5 id="section-ucrestdoc-UC_010-html">12.1.29.2. HTML variant</h5> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 101. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> +<caption class="title">Table 104. https://localhost:8081/api/project/{projectId}/report/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21670,7 +21913,7 @@ <h5 id="section-ucrestdoc-UC_010-html">12.1.29.2. HTML variant</h5> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/6f4f16d2-8e58-4ed3-b41c-110b74370d7c' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/72362f49-ecbd-4ad6-9961-cacc3a8e11fa' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/xhtml+xml'</code></pre> </div> @@ -21678,7 +21921,7 @@ <h5 id="section-ucrestdoc-UC_010-html">12.1.29.2. HTML variant</h5> </div> </div> <div class="sect3"> -<h4 id="user-marks-false-positives">12.1.30. User marks false positives</h4> +<h4 id="user-marks-false-positives">12.1.31. User marks false positives</h4> <div id="section-ucrestdoc-uc-UC_044" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_044">UC_044-User marks false positives </a></p> </div> @@ -21686,7 +21929,7 @@ <h4 id="user-marks-false-positives">12.1.30. User marks false positives</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 102. General request information</caption> +<caption class="title">Table 105. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21716,7 +21959,7 @@ <h4 id="user-marks-false-positives">12.1.30. User marks false positives</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 103. https://localhost:8081/api/project/{projectId}/false-positives</caption> +<caption class="title">Table 106. https://localhost:8081/api/project/{projectId}/false-positives</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21852,7 +22095,7 @@ <h4 id="user-marks-false-positives">12.1.30. User marks false positives</h4> </div> </div> <div class="sect3"> -<h4 id="user-unmarks-existing-false-positive-definitons">12.1.31. User unmarks existing false positive definitons</h4> +<h4 id="user-unmarks-existing-false-positive-definitons">12.1.32. User unmarks existing false positive definitons</h4> <div id="section-ucrestdoc-uc-UC_045" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_045">UC_045-User unmarks existing false positive definitons </a></p> </div> @@ -21860,7 +22103,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">12.1.31. User unmarks e <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 104. General request information</caption> +<caption class="title">Table 107. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21890,7 +22133,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">12.1.31. User unmarks e <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 105. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}</caption> +<caption class="title">Table 108. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -21948,7 +22191,7 @@ <h4 id="user-unmarks-existing-false-positive-definitons">12.1.31. User unmarks e </div> </div> <div class="sect3"> -<h4 id="user-fetches-false-positive-configuration-of-project">12.1.32. User fetches false positive configuration of project</h4> +<h4 id="user-fetches-false-positive-configuration-of-project">12.1.33. User fetches false positive configuration of project</h4> <div id="section-ucrestdoc-uc-UC_046" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_046">UC_046-User fetches false positive configuration of project </a></p> </div> @@ -21956,7 +22199,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">12.1.32. User fetc <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 106. General request information</caption> +<caption class="title">Table 109. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -21986,7 +22229,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">12.1.32. User fetc <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 107. https://localhost:8081/api/project/{projectId}/false-positives</caption> +<caption class="title">Table 110. https://localhost:8081/api/project/{projectId}/false-positives</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22209,7 +22452,7 @@ <h4 id="user-fetches-false-positive-configuration-of-project">12.1.32. User fetc </div> </div> <div class="sect3"> -<h4 id="user-uploads-binaries">12.1.33. User uploads binaries</h4> +<h4 id="user-uploads-binaries">12.1.34. User uploads binaries</h4> <div id="section-ucrestdoc-uc-UC_069" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_069">UC_069-User uploads binaries </a></p> </div> @@ -22217,7 +22460,7 @@ <h4 id="user-uploads-binaries">12.1.33. User uploads binaries</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 108. General request information</caption> +<caption class="title">Table 111. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22247,7 +22490,7 @@ <h4 id="user-uploads-binaries">12.1.33. User uploads binaries</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 109. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries</caption> +<caption class="title">Table 112. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22298,7 +22541,7 @@ <h4 id="user-uploads-binaries">12.1.33. User uploads binaries</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/b8b8b952-dadf-44b7-9480-c0276657f991/binaries' -i -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/job/0fd0197f-f865-4068-90ac-fb4a8db4aa30/binaries' -i -X POST \ -H 'Content-Type: multipart/form-data;charset=UTF-8' \ -H 'x-file-size: 10240' \ -F 'file=test1.txt 0000664 0001750 0001750 00000000000 13353454574 012170 0 ustar albert albert ' \ @@ -22311,7 +22554,7 @@ <h4 id="user-uploads-binaries">12.1.33. User uploads binaries</h4> </div> </div> <div class="sect3"> -<h4 id="user-downloads-job-report-in-spdx-format">12.1.34. User downloads job report in SPDX format</h4> +<h4 id="user-downloads-job-report-in-spdx-format">12.1.35. User downloads job report in SPDX format</h4> <div id="section-ucrestdoc-uc-UC_070" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_070">UC_070-User downloads job report in SPDX format </a></p> </div> @@ -22319,7 +22562,7 @@ <h4 id="user-downloads-job-report-in-spdx-format">12.1.34. User downloads job re <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 110. General request information</caption> +<caption class="title">Table 113. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22349,7 +22592,7 @@ <h4 id="user-downloads-job-report-in-spdx-format">12.1.34. User downloads job re <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 111. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}</caption> +<caption class="title">Table 114. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22379,14 +22622,14 @@ <h4 id="user-downloads-job-report-in-spdx-format">12.1.34. User downloads job re </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/spdx/4f730441-ec48-4a4f-ad1d-e57932c4d802' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/project/project1/report/spdx/4500d9f1-4df9-413b-bf2f-dd2bc8c9ee09' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Accept: application/json'</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="user-unmarks-existing-false-positive-project-data-definitons">12.1.35. User unmarks existing false positive project data definitons</h4> +<h4 id="user-unmarks-existing-false-positive-project-data-definitons">12.1.36. User unmarks existing false positive project data definitons</h4> <div id="section-ucrestdoc-uc-UC_078" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_078">UC_078-User unmarks existing false positive project data definitons </a></p> </div> @@ -22394,7 +22637,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">12.1.35. U <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 112. General request information</caption> +<caption class="title">Table 115. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22424,7 +22667,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">12.1.35. U <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 113. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}</caption> +<caption class="title">Table 116. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22478,7 +22721,7 @@ <h4 id="user-unmarks-existing-false-positive-project-data-definitons">12.1.35. U </div> </div> <div class="sect3"> -<h4 id="user-self-registration">12.1.36. User self registration</h4> +<h4 id="user-self-registration">12.1.37. User self registration</h4> <div id="section-ucrestdoc-uc-UC_001" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_001">UC_001-User self registration </a></p> </div> @@ -22486,7 +22729,7 @@ <h4 id="user-self-registration">12.1.36. User self registration</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 114. General request information</caption> +<caption class="title">Table 117. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22565,7 +22808,7 @@ <h4 id="user-self-registration">12.1.36. User self registration</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-open-user-signups">12.1.37. Admin lists open user signups</h4> +<h4 id="admin-lists-open-user-signups">12.1.38. Admin lists open user signups</h4> <div id="section-ucrestdoc-uc-UC_002" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_002">UC_002-Admin lists open user signups </a></p> </div> @@ -22573,7 +22816,7 @@ <h4 id="admin-lists-open-user-signups">12.1.37. Admin lists open user signups</h <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 115. General request information</caption> +<caption class="title">Table 118. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22669,7 +22912,7 @@ <h4 id="admin-lists-open-user-signups">12.1.37. Admin lists open user signups</h </div> </div> <div class="sect3"> -<h4 id="admin-applies-self-registration">12.1.38. Admin applies self registration</h4> +<h4 id="admin-applies-self-registration">12.1.39. Admin applies self registration</h4> <div id="section-ucrestdoc-uc-UC_003" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_003">UC_003-Admin applies self registration </a></p> </div> @@ -22677,7 +22920,7 @@ <h4 id="admin-applies-self-registration">12.1.38. Admin applies self registratio <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 116. General request information</caption> +<caption class="title">Table 119. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22707,7 +22950,7 @@ <h4 id="admin-applies-self-registration">12.1.38. Admin applies self registratio <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 117. https://localhost:8081/api/admin/signup/accept/{userId}</caption> +<caption class="title">Table 120. https://localhost:8081/api/admin/signup/accept/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22757,7 +23000,7 @@ <h4 id="admin-applies-self-registration">12.1.38. Admin applies self registratio </div> </div> <div class="sect3"> -<h4 id="admin-deletes-user-signup">12.1.39. Admin deletes user signup</h4> +<h4 id="admin-deletes-user-signup">12.1.40. Admin deletes user signup</h4> <div id="section-ucrestdoc-uc-UC_019" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_019">UC_019-Admin deletes user signup </a></p> </div> @@ -22765,7 +23008,7 @@ <h4 id="admin-deletes-user-signup">12.1.39. Admin deletes user signup</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 118. General request information</caption> +<caption class="title">Table 121. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22795,7 +23038,7 @@ <h4 id="admin-deletes-user-signup">12.1.39. Admin deletes user signup</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 119. https://localhost:8081/api/admin/signup/{userId}</caption> +<caption class="title">Table 122. https://localhost:8081/api/admin/signup/{userId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22845,7 +23088,7 @@ <h4 id="admin-deletes-user-signup">12.1.39. Admin deletes user signup</h4> </div> </div> <div class="sect3"> -<h4 id="user-requests-new-api-token">12.1.40. User requests new API token</h4> +<h4 id="user-requests-new-api-token">12.1.41. User requests new API token</h4> <div id="section-ucrestdoc-uc-UC_024" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_024">UC_024-User requests new API token </a></p> </div> @@ -22853,7 +23096,7 @@ <h4 id="user-requests-new-api-token">12.1.40. User requests new API token</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 120. General request information</caption> +<caption class="title">Table 123. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -22883,7 +23126,7 @@ <h4 id="user-requests-new-api-token">12.1.40. User requests new API token</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 121. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}</caption> +<caption class="title">Table 124. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -22919,7 +23162,7 @@ <h4 id="user-requests-new-api-token">12.1.40. User requests new API token</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-all-running-jobs">12.1.41. Admin lists all running jobs</h4> +<h4 id="admin-lists-all-running-jobs">12.1.42. Admin lists all running jobs</h4> <div id="section-ucrestdoc-uc-UC_023" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_023">UC_023-Admin lists all running jobs </a></p> </div> @@ -22927,7 +23170,7 @@ <h4 id="admin-lists-all-running-jobs">12.1.41. Admin lists all running jobs</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 122. General request information</caption> +<caption class="title">Table 125. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23029,12 +23272,12 @@ <h4 id="admin-lists-all-running-jobs">12.1.41. Admin lists all running jobs</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">aa8cee6d-756f-414d-8134-3159bdd75f44</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project-name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">owner-userid</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">RUNNING</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">since</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:27.703658282</span><span class="delimiter">"</span></span>}]</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a8503241-c02c-4722-afce-7a54eb0e7ea0</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">projectId</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">project-name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">owner</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">owner-userid</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">RUNNING</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">since</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:49.769371918</span><span class="delimiter">"</span></span>}]</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-cancels-a-job">12.1.42. Admin cancels a job</h4> +<h4 id="admin-cancels-a-job">12.1.43. Admin cancels a job</h4> <div id="section-ucrestdoc-uc-UC_034" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_034">UC_034-Admin cancels a job </a></p> </div> @@ -23042,7 +23285,7 @@ <h4 id="admin-cancels-a-job">12.1.42. Admin cancels a job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 123. General request information</caption> +<caption class="title">Table 126. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23072,7 +23315,7 @@ <h4 id="admin-cancels-a-job">12.1.42. Admin cancels a job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 124. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}</caption> +<caption class="title">Table 127. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -23113,7 +23356,7 @@ <h4 id="admin-cancels-a-job">12.1.42. Admin cancels a job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/cancel/92f9bfd4-051b-455b-b7b8-ffc1f6db45f6' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/cancel/e520e1f5-60b5-45d0-abeb-d9267c54474b' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -23123,7 +23366,7 @@ <h4 id="admin-cancels-a-job">12.1.42. Admin cancels a job</h4> </div> </div> <div class="sect3"> -<h4 id="admin-restarts-a-job">12.1.43. Admin restarts a job</h4> +<h4 id="admin-restarts-a-job">12.1.44. Admin restarts a job</h4> <div id="section-ucrestdoc-uc-UC_041" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_041">UC_041-Admin restarts a job </a></p> </div> @@ -23131,7 +23374,7 @@ <h4 id="admin-restarts-a-job">12.1.43. Admin restarts a job</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 125. General request information</caption> +<caption class="title">Table 128. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23161,7 +23404,7 @@ <h4 id="admin-restarts-a-job">12.1.43. Admin restarts a job</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 126. https://localhost:8081/api/admin/jobs/restart/{jobUUID}</caption> +<caption class="title">Table 129. https://localhost:8081/api/admin/jobs/restart/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -23202,7 +23445,7 @@ <h4 id="admin-restarts-a-job">12.1.43. Admin restarts a job</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart/be57747a-0731-4a35-ab3a-722e4f454077' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart/3c1f4235-016f-4246-bcfd-21531b315fe6' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -23212,7 +23455,7 @@ <h4 id="admin-restarts-a-job">12.1.43. Admin restarts a job</h4> </div> </div> <div class="sect3"> -<h4 id="admin-restarts-a-job-hard">12.1.44. Admin restarts a job (hard)</h4> +<h4 id="admin-restarts-a-job-hard">12.1.45. Admin restarts a job (hard)</h4> <div id="section-ucrestdoc-uc-UC_042" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_042">UC_042-Admin restarts a job (hard) </a></p> </div> @@ -23220,7 +23463,7 @@ <h4 id="admin-restarts-a-job-hard">12.1.44. Admin restarts a job (hard)</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 127. General request information</caption> +<caption class="title">Table 130. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23250,7 +23493,7 @@ <h4 id="admin-restarts-a-job-hard">12.1.44. Admin restarts a job (hard)</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 128. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}</caption> +<caption class="title">Table 131. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -23291,7 +23534,7 @@ <h4 id="admin-restarts-a-job-hard">12.1.44. Admin restarts a job (hard)</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/c9aea17c-1fe0-4c11-b1c5-fe21aa3ec9bb' -i -u 'user:secret' -X POST \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/e2e059a8-c340-4c1d-b68e-921fc0bd5c9c' -i -u 'user:secret' -X POST \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -23301,7 +23544,7 @@ <h4 id="admin-restarts-a-job-hard">12.1.44. Admin restarts a job (hard)</h4> </div> </div> <div class="sect3"> -<h4 id="user-defines-mock-data-configuration-for-project">12.1.45. User defines mock data configuration for project</h4> +<h4 id="user-defines-mock-data-configuration-for-project">12.1.46. User defines mock data configuration for project</h4> <div id="section-ucrestdoc-uc-UC_035" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_035">UC_035-User defines mock data configuration for project </a></p> </div> @@ -23309,7 +23552,7 @@ <h4 id="user-defines-mock-data-configuration-for-project">12.1.45. User defines <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 129. General request information</caption> +<caption class="title">Table 132. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23370,7 +23613,7 @@ <h4 id="user-defines-mock-data-configuration-for-project">12.1.45. User defines </div> </div> <div class="sect3"> -<h4 id="user-retrieves-mock-data-configuration-for-project">12.1.46. User retrieves mock data configuration for project</h4> +<h4 id="user-retrieves-mock-data-configuration-for-project">12.1.47. User retrieves mock data configuration for project</h4> <div id="section-ucrestdoc-uc-UC_036" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_036">UC_036-User retrieves mock data configuration for project </a></p> </div> @@ -23378,7 +23621,7 @@ <h4 id="user-retrieves-mock-data-configuration-for-project">12.1.46. User retrie <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 130. General request information</caption> +<caption class="title">Table 133. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23442,7 +23685,7 @@ <h4 id="user-retrieves-mock-data-configuration-for-project">12.1.46. User retrie </div> </div> <div class="sect3"> -<h4 id="admin-updates-mapping-configuration">12.1.47. Admin updates mapping configuration</h4> +<h4 id="admin-updates-mapping-configuration">12.1.48. Admin updates mapping configuration</h4> <div id="section-ucrestdoc-uc-UC_037" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_037">UC_037-Admin updates mapping configuration </a></p> </div> @@ -23450,7 +23693,7 @@ <h4 id="admin-updates-mapping-configuration">12.1.47. Admin updates mapping conf <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 131. General request information</caption> +<caption class="title">Table 134. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23480,7 +23723,7 @@ <h4 id="admin-updates-mapping-configuration">12.1.47. Admin updates mapping conf <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 132. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> +<caption class="title">Table 135. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -23566,7 +23809,7 @@ <h4 id="admin-updates-mapping-configuration">12.1.47. Admin updates mapping conf </div> </div> <div class="sect3"> -<h4 id="admin-fetches-mapping-configuration">12.1.48. Admin fetches mapping configuration</h4> +<h4 id="admin-fetches-mapping-configuration">12.1.49. Admin fetches mapping configuration</h4> <div id="section-ucrestdoc-uc-UC_038" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_038">UC_038-Admin fetches mapping configuration </a></p> </div> @@ -23574,7 +23817,7 @@ <h4 id="admin-fetches-mapping-configuration">12.1.48. Admin fetches mapping conf <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 133. General request information</caption> +<caption class="title">Table 136. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23604,7 +23847,7 @@ <h4 id="admin-fetches-mapping-configuration">12.1.48. Admin fetches mapping conf <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 134. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> +<caption class="title">Table 137. https://localhost:8081/api/admin/config/mapping/{mappingId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -23693,7 +23936,7 @@ <h4 id="admin-fetches-mapping-configuration">12.1.48. Admin fetches mapping conf </div> </div> <div class="sect3"> -<h4 id="admin-creates-an-executor-configuration">12.1.49. Admin creates an executor configuration</h4> +<h4 id="admin-creates-an-executor-configuration">12.1.50. Admin creates an executor configuration</h4> <div id="section-ucrestdoc-uc-UC_047" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_047">UC_047-Admin creates an executor configuration </a></p> </div> @@ -23701,7 +23944,7 @@ <h4 id="admin-creates-an-executor-configuration">12.1.49. Admin creates an execu <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 135. General request information</caption> +<caption class="title">Table 138. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23824,12 +24067,12 @@ <h4 id="admin-creates-an-executor-configuration">12.1.49. Admin creates an execu </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="plain">85aa1ed2-4c62-41e0-90b8-5aaccda85f11</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="plain">b922b3e7-3416-4d74-8b1a-81fbe61a3f63</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-deletes-executor-configuration">12.1.50. Admin deletes executor configuration</h4> +<h4 id="admin-deletes-executor-configuration">12.1.51. Admin deletes executor configuration</h4> <div id="section-ucrestdoc-uc-UC_048" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_048">UC_048-Admin deletes executor configuration </a></p> </div> @@ -23837,7 +24080,7 @@ <h4 id="admin-deletes-executor-configuration">12.1.50. Admin deletes executor co <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 136. General request information</caption> +<caption class="title">Table 139. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -23867,7 +24110,7 @@ <h4 id="admin-deletes-executor-configuration">12.1.50. Admin deletes executor co <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 137. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 140. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -23908,7 +24151,7 @@ <h4 id="admin-deletes-executor-configuration">12.1.50. Admin deletes executor co </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/01252350-78be-4eed-8103-d4c8dadcb1d5' -i -u 'user:secret' -X DELETE \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/4cfe54a8-c2ce-4bef-b96b-a047a5c4c38f' -i -u 'user:secret' -X DELETE \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -23918,7 +24161,7 @@ <h4 id="admin-deletes-executor-configuration">12.1.50. Admin deletes executor co </div> </div> <div class="sect3"> -<h4 id="admin-fetches-executor-configuration-list">12.1.51. Admin fetches executor configuration list</h4> +<h4 id="admin-fetches-executor-configuration-list">12.1.52. Admin fetches executor configuration list</h4> <div id="section-ucrestdoc-uc-UC_049" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_049">UC_049-Admin fetches executor configuration list </a></p> </div> @@ -23926,7 +24169,7 @@ <h4 id="admin-fetches-executor-configuration-list">12.1.51. Admin fetches execut <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 138. General request information</caption> +<caption class="title">Table 141. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24023,12 +24266,12 @@ <h4 id="admin-fetches-executor-configuration-list">12.1.51. Admin fetches execut </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">executorConfigurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">decbe618-fb22-42fd-ad28-9a98d629f981</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example configuration</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>}],<span class="key"><span class="delimiter">"</span><span class="content">type</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">executorConfigurationList</span><span class="delimiter">"</span></span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">executorConfigurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">fd85ad57-94c1-4671-a1ea-100fcb679201</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example configuration</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>}],<span class="key"><span class="delimiter">"</span><span class="content">type</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">executorConfigurationList</span><span class="delimiter">"</span></span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-fetches-executor-configuration">12.1.52. Admin fetches executor configuration</h4> +<h4 id="admin-fetches-executor-configuration">12.1.53. Admin fetches executor configuration</h4> <div id="section-ucrestdoc-uc-UC_050" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_050">UC_050-Admin fetches executor configuration </a></p> </div> @@ -24036,7 +24279,7 @@ <h4 id="admin-fetches-executor-configuration">12.1.52. Admin fetches executor co <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 139. General request information</caption> +<caption class="title">Table 142. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24066,7 +24309,7 @@ <h4 id="admin-fetches-executor-configuration">12.1.52. Admin fetches executor co <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 140. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 143. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -24176,7 +24419,7 @@ <h4 id="admin-fetches-executor-configuration">12.1.52. Admin fetches executor co </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/d3da4fff-26ac-424d-a207-4653dbff9ca8' -i -u 'user:secret' -X GET \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/cf306d66-846b-4bc2-a66e-5b60055aaa70' -i -u 'user:secret' -X GET \ -H 'Content-Type: application/json;charset=UTF-8'</code></pre> </div> </div> @@ -24185,12 +24428,12 @@ <h4 id="admin-fetches-executor-configuration">12.1.52. Admin fetches executor co </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">d3da4fff-26ac-424d-a207-4653dbff9ca8</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">cf306d66-846b-4bc2-a66e-5b60055aaa70</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-updates-executor-configuration-setup">12.1.53. Admin updates executor configuration setup</h4> +<h4 id="admin-updates-executor-configuration-setup">12.1.54. Admin updates executor configuration setup</h4> <div id="section-ucrestdoc-uc-UC_051" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_051">UC_051-Admin updates executor configuration setup </a></p> </div> @@ -24198,7 +24441,7 @@ <h4 id="admin-updates-executor-configuration-setup">12.1.53. Admin updates execu <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 141. General request information</caption> +<caption class="title">Table 144. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24228,7 +24471,7 @@ <h4 id="admin-updates-executor-configuration-setup">12.1.53. Admin updates execu <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 142. https://localhost:8081/api/admin/config/executor/{uuid}</caption> +<caption class="title">Table 145. https://localhost:8081/api/admin/config/executor/{uuid}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -24333,7 +24576,7 @@ <h4 id="admin-updates-executor-configuration-setup">12.1.53. Admin updates execu </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/150289d5-3831-4eac-80ed-337c2ff30949' -i -u 'user:secret' -X PUT \ +<pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/executor/35803fed-b7b0-4bd8-9387-4773ab128a43' -i -u 'user:secret' -X PUT \ -H 'Content-Type: application/json;charset=UTF-8' \ -d '{"name":"New name","productIdentifier":"PDS_CODESCAN","executorVersion":1,"enabled":false,"setup":{"baseURL":"https://productNew.example.com","credentials":{"user":"env:EXAMPLE_NEW_USENAME","password":"env:EXAMPLE_NEW_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]}}'</code></pre> </div> @@ -24344,7 +24587,7 @@ <h4 id="admin-updates-executor-configuration-setup">12.1.53. Admin updates execu </div> </div> <div class="sect3"> -<h4 id="admin-creates-an-execution-profile">12.1.54. Admin creates an execution profile</h4> +<h4 id="admin-creates-an-execution-profile">12.1.55. Admin creates an execution profile</h4> <div id="section-ucrestdoc-uc-UC_052" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_052">UC_052-Admin creates an execution profile </a></p> </div> @@ -24352,7 +24595,7 @@ <h4 id="admin-creates-an-execution-profile">12.1.54. Admin creates an execution <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 143. General request information</caption> +<caption class="title">Table 146. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24382,7 +24625,7 @@ <h4 id="admin-creates-an-execution-profile">12.1.54. Admin creates an execution <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 144. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 147. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -24473,7 +24716,7 @@ <h4 id="admin-creates-an-execution-profile">12.1.54. Admin creates an execution </div> </div> <div class="sect3"> -<h4 id="admin-deletes-execution-profile">12.1.55. Admin deletes execution profile</h4> +<h4 id="admin-deletes-execution-profile">12.1.56. Admin deletes execution profile</h4> <div id="section-ucrestdoc-uc-UC_053" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_053">UC_053-Admin deletes execution profile </a></p> </div> @@ -24481,7 +24724,7 @@ <h4 id="admin-deletes-execution-profile">12.1.55. Admin deletes execution profil <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 145. General request information</caption> +<caption class="title">Table 148. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24511,7 +24754,7 @@ <h4 id="admin-deletes-execution-profile">12.1.55. Admin deletes execution profil <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 146. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 149. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -24562,7 +24805,7 @@ <h4 id="admin-deletes-execution-profile">12.1.55. Admin deletes execution profil </div> </div> <div class="sect3"> -<h4 id="admin-updates-execution-profile">12.1.56. Admin updates execution profile</h4> +<h4 id="admin-updates-execution-profile">12.1.57. Admin updates execution profile</h4> <div id="section-ucrestdoc-uc-UC_054" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_054">UC_054-Admin updates execution profile </a></p> </div> @@ -24570,7 +24813,7 @@ <h4 id="admin-updates-execution-profile">12.1.56. Admin updates execution profil <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 147. General request information</caption> +<caption class="title">Table 150. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24600,7 +24843,7 @@ <h4 id="admin-updates-execution-profile">12.1.56. Admin updates execution profil <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 148. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 151. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -24677,7 +24920,7 @@ <h4 id="admin-updates-execution-profile">12.1.56. Admin updates execution profil <div class="content"> <pre class="CodeRay highlight"><code data-lang="bash">$ curl 'https://sechub.example.com/api/admin/config/execution/profile/existing-profile-1' -i -u 'user:secret' -X PUT \ -H 'Content-Type: application/json;charset=UTF-8' \ - -d '{"description":"changed description","configurations":[{"uuid":"c0948480-f711-4330-93c3-8167dc71b564","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'</code></pre> + -d '{"description":"changed description","configurations":[{"uuid":"5a8e548a-169d-4642-8d2d-00bed1357847","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'</code></pre> </div> </div> <div class="paragraph"> @@ -24686,7 +24929,7 @@ <h4 id="admin-updates-execution-profile">12.1.56. Admin updates execution profil </div> </div> <div class="sect3"> -<h4 id="admin-fetches-execution-profile">12.1.57. Admin fetches execution profile</h4> +<h4 id="admin-fetches-execution-profile">12.1.58. Admin fetches execution profile</h4> <div id="section-ucrestdoc-uc-UC_055" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_055">UC_055-Admin fetches execution profile </a></p> </div> @@ -24694,7 +24937,7 @@ <h4 id="admin-fetches-execution-profile">12.1.57. Admin fetches execution profil <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 149. General request information</caption> +<caption class="title">Table 152. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24724,7 +24967,7 @@ <h4 id="admin-fetches-execution-profile">12.1.57. Admin fetches execution profil <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 150. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> +<caption class="title">Table 153. https://localhost:8081/api/admin/config/execution/profile/{profileId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -24833,12 +25076,12 @@ <h4 id="admin-fetches-execution-profile">12.1.57. Admin fetches execution profil </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a description</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>,<span class="key"><span class="delimiter">"</span><span class="content">configurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">f8dd3854-ae30-450a-828a-1b715bcd57d3</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value but changed. Remark: the other parameter (example.key2) has been removed by this call</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}],<span class="key"><span class="delimiter">"</span><span class="content">projectIds</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">project-1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">project-2</span><span class="delimiter">"</span></span>]}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">description</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">a description</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">true</span>,<span class="key"><span class="delimiter">"</span><span class="content">configurations</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">uuid</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">006a3f33-85f6-4586-a509-5ef17c40004b</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">name</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">New name</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">productIdentifier</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">PDS_CODESCAN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">setup</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">baseURL</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">https://product.example.com</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">credentials</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">user</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_USENAME</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">env:EXAMPLE_PASSWORD</span><span class="delimiter">"</span></span>},<span class="key"><span class="delimiter">"</span><span class="content">jobParameters</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">key</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">example.key1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">value</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">A value but changed. Remark: the other parameter (example.key2) has been removed by this call</span><span class="delimiter">"</span></span>}]},<span class="key"><span class="delimiter">"</span><span class="content">executorVersion</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">enabled</span><span class="delimiter">"</span></span>:<span class="value">false</span>}],<span class="key"><span class="delimiter">"</span><span class="content">projectIds</span><span class="delimiter">"</span></span>:[<span class="string"><span class="delimiter">"</span><span class="content">project-1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">project-2</span><span class="delimiter">"</span></span>]}</code></pre> </div> </div> </div> <div class="sect3"> -<h4 id="admin-fetches-execution-profile-list">12.1.58. Admin fetches execution profile list</h4> +<h4 id="admin-fetches-execution-profile-list">12.1.59. Admin fetches execution profile list</h4> <div id="section-ucrestdoc-uc-UC_056" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_056">UC_056-Admin fetches execution profile list </a></p> </div> @@ -24846,7 +25089,7 @@ <h4 id="admin-fetches-execution-profile-list">12.1.58. Admin fetches execution p <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 151. General request information</caption> +<caption class="title">Table 154. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24948,7 +25191,7 @@ <h4 id="admin-fetches-execution-profile-list">12.1.58. Admin fetches execution p </div> </div> <div class="sect3"> -<h4 id="admin-assigns-execution-profile-to-project">12.1.59. Admin assigns execution profile to project</h4> +<h4 id="admin-assigns-execution-profile-to-project">12.1.60. Admin assigns execution profile to project</h4> <div id="section-ucrestdoc-uc-UC_057" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_057">UC_057-Admin assigns execution profile to project </a></p> </div> @@ -24956,7 +25199,7 @@ <h4 id="admin-assigns-execution-profile-to-project">12.1.59. Admin assigns execu <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 152. General request information</caption> +<caption class="title">Table 155. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -24986,7 +25229,7 @@ <h4 id="admin-assigns-execution-profile-to-project">12.1.59. Admin assigns execu <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 153. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> +<caption class="title">Table 156. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -25041,7 +25284,7 @@ <h4 id="admin-assigns-execution-profile-to-project">12.1.59. Admin assigns execu </div> </div> <div class="sect3"> -<h4 id="admin-unassigns-execution-profile-from-project">12.1.60. Admin unassigns execution profile from project</h4> +<h4 id="admin-unassigns-execution-profile-from-project">12.1.61. Admin unassigns execution profile from project</h4> <div id="section-ucrestdoc-uc-UC_058" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_058">UC_058-Admin unassigns execution profile from project </a></p> </div> @@ -25049,7 +25292,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">12.1.60. Admin unassigns <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 154. General request information</caption> +<caption class="title">Table 157. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25079,7 +25322,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">12.1.60. Admin unassigns <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 155. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> +<caption class="title">Table 158. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -25134,7 +25377,7 @@ <h4 id="admin-unassigns-execution-profile-from-project">12.1.60. Admin unassigns </div> </div> <div class="sect3"> -<h4 id="admin-fetches-auto-cleanup-configuration">12.1.61. Admin fetches auto cleanup configuration</h4> +<h4 id="admin-fetches-auto-cleanup-configuration">12.1.62. Admin fetches auto cleanup configuration</h4> <div id="section-ucrestdoc-uc-UC_064" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_064">UC_064-Admin fetches auto cleanup configuration </a></p> </div> @@ -25142,7 +25385,7 @@ <h4 id="admin-fetches-auto-cleanup-configuration">12.1.61. Admin fetches auto cl <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 156. General request information</caption> +<caption class="title">Table 159. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25205,7 +25448,7 @@ <h4 id="admin-fetches-auto-cleanup-configuration">12.1.61. Admin fetches auto cl </div> </div> <div class="sect3"> -<h4 id="admin-updates-auto-cleanup-configuration">12.1.62. Admin updates auto cleanup configuration</h4> +<h4 id="admin-updates-auto-cleanup-configuration">12.1.63. Admin updates auto cleanup configuration</h4> <div id="section-ucrestdoc-uc-UC_065" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_065">UC_065-Admin updates auto cleanup configuration </a></p> </div> @@ -25213,7 +25456,7 @@ <h4 id="admin-updates-auto-cleanup-configuration">12.1.62. Admin updates auto cl <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 157. General request information</caption> +<caption class="title">Table 160. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25273,7 +25516,7 @@ <h4 id="admin-updates-auto-cleanup-configuration">12.1.62. Admin updates auto cl </div> </div> <div class="sect3"> -<h4 id="admin-starts-encryption-rotation">12.1.63. Admin starts encryption rotation</h4> +<h4 id="admin-starts-encryption-rotation">12.1.64. Admin starts encryption rotation</h4> <div id="section-ucrestdoc-uc-UC_073" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_073">UC_073-Admin starts encryption rotation </a></p> </div> @@ -25281,7 +25524,7 @@ <h4 id="admin-starts-encryption-rotation">12.1.63. Admin starts encryption rotat <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 158. General request information</caption> +<caption class="title">Table 161. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25345,7 +25588,7 @@ <h4 id="admin-starts-encryption-rotation">12.1.63. Admin starts encryption rotat </div> </div> <div class="sect3"> -<h4 id="admin-fetches-encryption-status">12.1.64. Admin fetches encryption status</h4> +<h4 id="admin-fetches-encryption-status">12.1.65. Admin fetches encryption status</h4> <div id="section-ucrestdoc-uc-UC_076" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_076">UC_076-Admin fetches encryption status </a></p> </div> @@ -25353,7 +25596,7 @@ <h4 id="admin-fetches-encryption-status">12.1.64. Admin fetches encryption statu <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 159. General request information</caption> +<caption class="title">Table 162. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25485,7 +25728,7 @@ <h4 id="admin-fetches-encryption-status">12.1.64. Admin fetches encryption statu </div> </div> <div class="sect3"> -<h4 id="admin-disables-job-processing-in-scheduler">12.1.65. Admin disables job processing in scheduler</h4> +<h4 id="admin-disables-job-processing-in-scheduler">12.1.66. Admin disables job processing in scheduler</h4> <div id="section-ucrestdoc-uc-UC_030" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_030">UC_030-Admin disables job processing in scheduler </a></p> </div> @@ -25493,7 +25736,7 @@ <h4 id="admin-disables-job-processing-in-scheduler">12.1.65. Admin disables job <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 160. General request information</caption> +<caption class="title">Table 163. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25552,7 +25795,7 @@ <h4 id="admin-disables-job-processing-in-scheduler">12.1.65. Admin disables job </div> </div> <div class="sect3"> -<h4 id="admin-enables-scheduler-job-processing">12.1.66. Admin enables scheduler job processing</h4> +<h4 id="admin-enables-scheduler-job-processing">12.1.67. Admin enables scheduler job processing</h4> <div id="section-ucrestdoc-uc-UC_031" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_031">UC_031-Admin enables scheduler job processing </a></p> </div> @@ -25560,7 +25803,7 @@ <h4 id="admin-enables-scheduler-job-processing">12.1.66. Admin enables scheduler <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 161. General request information</caption> +<caption class="title">Table 164. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25619,7 +25862,7 @@ <h4 id="admin-enables-scheduler-job-processing">12.1.66. Admin enables scheduler </div> </div> <div class="sect3"> -<h4 id="admin-get-scheduler-status">12.1.67. Admin get scheduler status</h4> +<h4 id="admin-get-scheduler-status">12.1.68. Admin get scheduler status</h4> <div id="section-ucrestdoc-uc-UC_032" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_032">UC_032-Admin get scheduler status </a></p> </div> @@ -25627,7 +25870,7 @@ <h4 id="admin-get-scheduler-status">12.1.67. Admin get scheduler status</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 162. General request information</caption> +<caption class="title">Table 165. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25686,7 +25929,7 @@ <h4 id="admin-get-scheduler-status">12.1.67. Admin get scheduler status</h4> </div> </div> <div class="sect3"> -<h4 id="admin-lists-status-information">12.1.68. Admin lists status information</h4> +<h4 id="admin-lists-status-information">12.1.69. Admin lists status information</h4> <div id="section-ucrestdoc-uc-UC_033" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_033">UC_033-Admin lists status information </a></p> </div> @@ -25694,7 +25937,7 @@ <h4 id="admin-lists-status-information">12.1.68. Admin lists status information< <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 163. General request information</caption> +<caption class="title">Table 166. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25786,7 +26029,7 @@ <h4 id="admin-lists-status-information">12.1.68. Admin lists status information< </div> </div> <div class="sect3"> -<h4 id="admin-fetches-server-runtime-data">12.1.69. Admin fetches server runtime data</h4> +<h4 id="admin-fetches-server-runtime-data">12.1.70. Admin fetches server runtime data</h4> <div id="section-ucrestdoc-uc-UC_040" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_040">UC_040-Admin fetches server runtime data </a></p> </div> @@ -25794,7 +26037,7 @@ <h4 id="admin-fetches-server-runtime-data">12.1.69. Admin fetches server runtime <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 164. General request information</caption> +<caption class="title">Table 167. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25866,7 +26109,7 @@ <h4 id="admin-fetches-server-runtime-data">12.1.69. Admin fetches server runtime </div> </div> <div class="sect3"> -<h4 id="user-lists-jobs-for-project">12.1.70. User lists jobs for project</h4> +<h4 id="user-lists-jobs-for-project">12.1.71. User lists jobs for project</h4> <div id="section-ucrestdoc-uc-UC_071" class="paragraph"> <p>REST API for usecase <a href="#section-usecase-UC_071">UC_071-User lists jobs for project </a></p> </div> @@ -25874,7 +26117,7 @@ <h4 id="user-lists-jobs-for-project">12.1.70. User lists jobs for project</h4> <p><strong class="big">Definition</strong></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 165. General request information</caption> +<caption class="title">Table 168. General request information</caption> <colgroup> <col style="width: 14.2857%;"> <col style="width: 85.7143%;"> @@ -25904,7 +26147,7 @@ <h4 id="user-lists-jobs-for-project">12.1.70. User lists jobs for project</h4> <p><strong>Path parameters</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> -<caption class="title">Table 166. https://localhost:8081/api/project/{projectId}/jobs</caption> +<caption class="title">Table 169. https://localhost:8081/api/project/{projectId}/jobs</caption> <colgroup> <col style="width: 50%;"> <col style="width: 50%;"> @@ -25923,6 +26166,41 @@ <h4 id="user-lists-jobs-for-project">12.1.70. User lists jobs for project</h4> </tbody> </table> <div class="paragraph"> +<p><strong>Query parameters</strong> <br></p> +</div> +<table class="tableblock frame-all grid-all stretch"> +<colgroup> +<col style="width: 50%;"> +<col style="width: 50%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Parameter</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The wanted (maximum) size for the result set. When not defined, the default will be 1.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>page</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">The wanted page number. When not defined, the default will be 0.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.labels.*</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An optional dynamic query parameter to filter jobs by labels. The syntax is 'metadata.labels.${labelKey}=${labelValue}'.</p> +<p class="tableblock">It is possible to query for multiple labels (up to 10 ). +The filter works as an AND combination: Only jobs having all wanted label key value combinations are returned.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>withMetaData</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An optional parameter to define if meta data shall be fetched as well. When not defined, the default will be false.</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> <p><strong>Request headers</strong> <br></p> </div> <table class="tableblock frame-all grid-all stretch"> @@ -26028,7 +26306,7 @@ <h4 id="user-lists-jobs-for-project">12.1.70. User lists jobs for project</h4> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">page</span><span class="delimiter">"</span></span>:<span class="integer">0</span>,<span class="key"><span class="delimiter">"</span><span class="content">totalPages</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">4fc54538-9eab-4eb5-9da4-9d1cc0897760</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">User1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:42:22.956477277</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:44:22.956508736</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-10-21T16:59:22.956525658</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionState</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionResult</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">metaData</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">labels</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">stage</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}}}]}</code></pre> +<pre class="CodeRay highlight nowrap"><code data-lang="json">{<span class="key"><span class="delimiter">"</span><span class="content">page</span><span class="delimiter">"</span></span>:<span class="integer">0</span>,<span class="key"><span class="delimiter">"</span><span class="content">totalPages</span><span class="delimiter">"</span></span>:<span class="integer">1</span>,<span class="key"><span class="delimiter">"</span><span class="content">content</span><span class="delimiter">"</span></span>:[{<span class="key"><span class="delimiter">"</span><span class="content">jobUUID</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">8d080df1-24cd-470f-b8bd-845baf4b7d60</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executedBy</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">User1</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">created</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:31:45.196835109</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">started</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:33:45.196866799</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">ended</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">2024-11-27T09:48:45.19687809</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionState</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">ENDED</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">trafficLight</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">GREEN</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">executionResult</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">OK</span><span class="delimiter">"</span></span>,<span class="key"><span class="delimiter">"</span><span class="content">metaData</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">labels</span><span class="delimiter">"</span></span>:{<span class="key"><span class="delimiter">"</span><span class="content">stage</span><span class="delimiter">"</span></span>:<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}}}]}</code></pre> </div> </div> <div style="page-break-after: always;"></div> @@ -27873,7 +28151,7 @@ <h6 id="profiles">16.5.2.2.3. Profiles</h6> </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body> diff --git a/docs/latest/sechub-tutorials.html b/docs/latest/sechub-tutorials.html index c25081319c..99615c0d29 100644 --- a/docs/latest/sechub-tutorials.html +++ b/docs/latest/sechub-tutorials.html @@ -531,7 +531,7 @@ <div id="header"> <h1><span class="image"><a class="image" href="https://mercedes-benz.github.io/sechub"><img src="images/sechub-logo.png" alt="sechub logo"></a></span> SecHub Tutorials</h1> <div class="details"> -<span id="revnumber"> Server 2.3.1</span> +<span id="revnumber"> Server 2.3.1 modified (commit 7de5e5c)</span> </div> <div id="toc" class="toc2"> <div id="toctitle">Table of contents</div> @@ -632,7 +632,7 @@ <h2 id="about">1. About</h2> </tbody> </table> <div class="paragraph"> -<p>Documentation version: <code>Server 2.3.1 - Build date: 20241021165905</code></p> +<p>Documentation version: <code>Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)</code></p> </div> <hr> <div style="page-break-after: always;"></div> @@ -1030,7 +1030,7 @@ <h4 id="test-pds-solution-with-sechub-server-and-client">2.2.2. Test PDS solutio </div> <div id="footer"> <div id="footer-text"> - Server 2.3.1<br> + Server 2.3.1 modified (commit 7de5e5c)<br> </div> </div> </body>